NSNavAI.h

Go to the documentation of this file.

/*
 * 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.
*/
 
/* TODO: serverinfo based checks for prediction reasons */
var bool autocvar_g_infiniteAmmo = false;
 
var bool autocvar_ai_debugNav = false;
void
_NSActor_Log(string className, string functionName, float edictNum, string warnMessage)
{
        if (autocvar_g_logTimestamps)
                printf("^9%f ^5%s (%d) ^7: %s\n", time, functionName, edictNum, warnMessage);
        else
                printf("^5%s (%d) ^7: %s\n", functionName, edictNum, warnMessage);
}
#define NSActor_Log(...) _NSActor_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
NSActor:NSSurfacePropEntity
{
 
public:
        void NSActor(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 bool IsCrouching(void);
        nonvirtual bool IsProne(void);
        nonvirtual bool IsStanding(void);
        nonvirtual bool IsSprinting(void);
        nonvirtual bool IsLeaning(void);
 
        /* ammo handling */
        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 RemoveItem(string);
        nonvirtual bool AddItem(NSItem);
        nonvirtual bool HasItem(string);
        nonvirtual bool HasExactItem(NSItem);
        nonvirtual bool RemoveAllItems(bool);
        nonvirtual bool RemoveAllWeapons(void);
        nonvirtual string GetCurrentWeapon(void);
        nonvirtual void SwitchToWeapon(string);
        nonvirtual void SwitchToExactWeapon(NSWeapon);
 
        nonvirtual void LaunchProjectile(string, bool, float);
        nonvirtual bool PlantCharge(string);
 
#ifdef SERVER
        /* overrides */
        virtual void Save(float);
        virtual void Restore(string,string);
        virtual void RestoreComplete(void);
        virtual void DebugDraw(void);
 
        /* 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 CheckRoute(void);
        virtual void RouteToPosition(vector);
        virtual void RouteToPositionDenyFlags(vector, int);
        virtual void ChasePath(string startPath);
        virtual void CheckRoute_Path(void);
        virtual void Physics_Run(void);
#endif
 
private:
#ifdef SERVER
        /* pathfinding */
        int m_iNodes;
        int m_iCurNode;
        nodeslist_t *m_pRoute;
        vector m_vecLastNode;
        vector m_vecTurnAngle;
        string m_pathTarget;
        NSEntity m_pathEntity;
        float _m_flRouteGiveUp;
        vector _m_vecRoutePrev;
        vector m_vecRouteEntity;
        entity m_eFollowing;
        float m_flMoveSpeedKey;
#endif
 
        /* These are defined in side defs\*.def, ammo_types and ammo_names */
        int m_iAmmoTypes[MAX_AMMO_TYPES];
        NSItem m_itemList;
        NSWeapon m_activeWeapon;
        NSWeapon m_activeWeapon_net;
        float activeweapon;
        float m_flFirstInventoryItem;
};
 
void NSActor_ListInventory(NSActor);