Actor.h

/*
 * Copyright (c) 2016-2024 Vera Visions LLC.
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF MIND, USE, DATA OR PROFITS, WHETHER
 * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
 * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
 
 
#define ACTOR_LOG imageToConsole("gfx/icon16/eye", ICN_SIZE, "Actor Log")
 
/* TODO: serverinfo based checks for prediction reasons */
var int autocvar_g_infiniteAmmo = 0i;
var bool autocvar_ai_debugNav = false;
 
void
_ncActor_Log(string className, string functionName, float edictNum, string warnMessage)
{
    if (autocvar_g_logTimestamps)
        printf("%s ^9%f ^5%s (%d) ^7: %s\n", ACTOR_LOG, time, functionName, edictNum, warnMessage);
    else
        printf("%s ^5%s (%d) ^7: %s\n", ACTOR_LOG, functionName, edictNum, warnMessage);
}
#define ncActor_Log(...) if (autocvar_g_logLevel >= LOGLEVEL_DEBUG) _ncActor_Log(classname, __FUNC__, num_for_edict(this), sprintf(__VA_ARGS__))
 
/* for AI identification purposes */
typedef enum
{
    WPNTYPE_INVALID,    /* no logic */
    WPNTYPE_RANGED,     /* will want to keep their distance mostly */
    WPNTYPE_THROW,      /* has to keep some distance, but not too far */
    WPNTYPE_CLOSE,      /* have to get really close */
    WPNTYPE_FULLAUTO,   /* for things that need to be held down */
    WPNTYPE_SEMI        /* semi automatic */
} weapontype_t;

class
ncActor:ncSurfacePropEntity
{
 
public:
    void ncActor(void);

    virtual bool CanSprint(void);
    virtual bool CanProne(void);
    virtual bool CanCrouch(void);
    virtual bool CanLean(void);

    virtual float GetForwardSpeed(void);
    virtual float GetSideSpeed(void);
    virtual float GetBackSpeed(void);
    
 
    nonvirtual float GetStamina(void);

    nonvirtual bool IsCrouching(void);
    nonvirtual bool IsProne(void);
    nonvirtual bool IsStanding(void);
    nonvirtual bool IsSprinting(void);
    nonvirtual bool IsLeaning(void);
 
    /* ammo handling */
    nonvirtual bool MaxAmmo(int);
    nonvirtual bool GiveAmmo(int, int);
    nonvirtual bool UseAmmo(int, int);
    nonvirtual bool HasAmmo(int, int);
    nonvirtual int GetReserveAmmo(int);
 
    /* inventory handling */
    nonvirtual bool GiveItem(string);
    nonvirtual bool GiveExactItem(ncItem);
    nonvirtual bool RemoveItem(string);
    nonvirtual bool AddItem(ncItem);
    nonvirtual ncItem GetItem(string);
    nonvirtual bool HasItem(string);
    nonvirtual bool HasExactItem(ncItem);
    nonvirtual bool RemoveAllItems(bool);
    nonvirtual bool RemoveAllWeapons(void);
    nonvirtual bool RemoveWeaponInSlot(int);
    nonvirtual bool DropWeaponInSlot(int);
    nonvirtual string GetCurrentWeapon(void);
    nonvirtual void SwitchToWeapon(string);
    nonvirtual void SwitchToExactWeapon(ncWeapon);
    nonvirtual void SwitchToBestWeapon(bool);
 
    nonvirtual void LaunchProjectile(string, bool, float);
    nonvirtual bool PlantCharge(string);

    virtual ncWeapon SortWeaponChain(void);
    nonvirtual ncWeapon GetNextWeapon(void);
    nonvirtual ncWeapon GetPreviousWeapon(void);
    nonvirtual ncWeapon GetLastWeapon(void);
 
    virtual void AddedItemCallback(ncItem);
    virtual void SpawnKey(string,string);
    virtual void ReloadCachedAttributes(void);
    virtual void SetAnimationPrefix(string animPrefix);
 
#ifdef CLIENT
    virtual void ReceiveEvent(float eventID);
#endif
 
#ifdef SERVER
    /* overrides */
    virtual void Save(float);
    virtual void Restore(string,string);
    virtual void RestoreComplete(void);
    virtual void Respawn(void);
    virtual void Spawned(void);
    virtual void Input(entity, string, string);
    virtual void DebugDraw(void);
    virtual void OnRemoveEntity(void);
    virtual void Death(entity inflictor, entity attacker, int damagePoints, vector dir, vector absImpactPos, int hitBody);

    virtual void SelectNewSchedule(void);
    nonvirtual void ThinkSchedules(void);

    nonvirtual bool CancelSchedule(void);
    nonvirtual void PerformSchedule(string);
    nonvirtual void MessageSchedule(string);
    nonvirtual bool IsPerforming(void);
    
    nonvirtual int PathNodeCount(void);
    nonvirtual int PathCurrentNode(void);
    nonvirtual vector PathDestination(void);

    nonvirtual ncEntity MakeCorpse(float deathSequence);
 
    /* methods we'd like others to override */
    virtual bool CanCrouch(void);
    nonvirtual vector GetRouteMovevalues(void);
    nonvirtual vector GetRouteDirection(void);
    nonvirtual void SetMoveSpeedScale(float);
    nonvirtual float GetMoveSpeedScale(void);

    virtual void RouteEnded(void);
    virtual void RouteClear(void);
    virtual void CheckRouteProgression(void);
    virtual void RouteToPosition(vector);
    virtual void RouteToPositionDenyFlags(vector, int);
    virtual void ChasePath(string startPath);
    virtual void CheckRouteProgression_Path(void);
    virtual void Physics_Run(void);
#endif
 
    virtual void FiredWeapon(string, string);
    nonvirtual void __FiredWeapon(string, string);
 
    virtual void Event_DrawWeapon(void);
    virtual void Event_FireWeapon(void);
    virtual void Event_ReloadWeaponStart(void);
    virtual void Event_ReloadWeapon(void);
    virtual void Event_ReloadWeaponEnd(void);
    virtual void Event_HolsterWeapon(void);
 
 
 
private:
 
 
    nonvirtual float __ActForPrefix(string actName, string animPrefix, string emotionString);
 
#ifdef SERVER
    bool m_pvsSleep;
 
    /* pathfinding */
    int m_pathfindingNodeCount;
    int m_pathfindingCurrentNode;
    nodeslist_t *m_pathfindingGraph;
    vector m_pathfindingDestination;
    string m_pathTarget;
    ncEntity m_pathEntity;
    float m_timeUntilDroppingRoute;
    vector m_pathfindingLastPos;
    entity m_followingEntity;
    float m_moveSpeedKey;
    string m_mindset;
    entity m_hook;
#endif
 
    /* These are defined in side defs\*.def, ammo_types and ammo_names */
    int m_ammoTypes[MAX_AMMO_TYPES];
    float activeweapon;
    NETWORKED_FLOAT(m_itemStart)
    NETWORKED_FLOAT(m_currentStamina)
    float m_weaponCookingTime;
 
    /* networking/prediction */
    ncWeapon m_activeWeapon_net;
 
    /* non-state heavy cached values, reloaded frequently. */
    string m_sndStepLadderLeft;
    string m_sndStepLadderRight;
    string m_sndDeath;
    string m_sndFall;
    string m_sndPainSmall;
    string m_sndPainMedium;
    string m_sndPainLarge;
    string m_sndPainHuge;
    string m_sndLandSoft;
    string m_sndLandHard;
    string m_sndHitArmor;
    string m_sndHitFlesh;
    string m_sndAirGaspHeavy;
    string m_sndAirGaspLight;
    string m_sndNoAir;
    string m_sndTeleportExit;
    string m_sndTeleportStart;
    string m_sndWaterExit;
    string m_sndWaterEnter;
    string m_sndWaterWade;
    string m_sndWaterSwim;
    string m_sndBurn;
    string m_sndHealthtake;
    string m_sndUseDeny;
    string m_sndUseSuccess;
    string m_sndJump;
 
    /* recalculate these */
    float m_actIdle;
    float m_actIdleCrouch;
    float m_actIdleProne;
    float m_actWalk;
    float m_actWalkCrouch;
    float m_actWalkProne;
    float m_actRun;
    float m_actJump;
    float m_actAim;
    float m_actDraw;
    float m_actAttack;
    float m_actReloadStart;
    float m_actReload;
    float m_actReloadEnd;
    float m_actHolster;
    int m_boneSpine;
    int m_torsoFirst;
    int m_torsoLast;
    int m_torsoTwistYaw;
};
 
/* for now here to make debugging easier */
.ncItem m_itemList;
.ncWeapon m_activeWeapon;
.ncWeapon m_firstWeapon;
.bool _isActor;
 
void ncActor_ListInventory(ncActor);