NSWeapon.h

Go to the documentation of this file.

/*
 * Copyright (c) 2022 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.
*/
 
typedef enumflags
{
        WEAPONFL_CHANGED_MODELINDEX,
        WEAPONFL_CHANGED_ORIGIN,
        WEAPONFL_CHANGED_ANGLES,
        WEAPONFL_CHANGED_VELOCITY_X,
        WEAPONFL_CHANGED_VELOCITY_Y,
        WEAPONFL_CHANGED_VELOCITY_Z,
        WEAPONFL_CHANGED_ANGULARVELOCITY,
        WEAPONFL_CHANGED_SIZE,
        WEAPONFL_CHANGED_FLAGS,
        WEAPONFL_CHANGED_SOLID,
        WEAPONFL_CHANGED_FRAME,
        WEAPONFL_CHANGED_SKIN,
        WEAPONFL_CHANGED_MOVETYPE,
        WEAPONFL_CHANGED_EFFECTS,
        WEAPONFL_CHANGED_BODY,
        WEAPONFL_CHANGED_SCALE,
        WEAPONFL_CHANGED_ENTITYDEF,
        WEAPONFL_CHANGED_CLIP,
        WEAPONFL_CHANGED_CHAIN,
        WEAPONFL_CHANGED_STATE
} nsweapon_changed_t;
 
typedef enum
{
        WEAPONSTATE_IDLE,
        WEAPONSTATE_RELOAD_START,
        WEAPONSTATE_RELOAD,
        WEAPONSTATE_RELOAD_END,
} nsweapon_state_t;
 
typedef enum
{
        WEPEVENT_FIRED,
        WEPEVENT_RELOADED
} nsweapon_event_t;
 
class
NSWeapon:NSItem
{
public:
        void NSWeapon(void);
 
        virtual void AddedToInventory(void);
        virtual void RemovedFromInventory(void);
 
        /* overrides */
#ifdef SERVER
        virtual void Spawned(void);
        virtual void SpawnKey(string, string);
        virtual void Save(float);
        virtual void Restore(string, string);
        virtual void EvaluateEntity(void);
        virtual float SendEntity(entity,float);
#endif
 
#ifdef CLIENT
        virtual void ClientFX(bool);
        virtual void PredictPreFrame(void);
        virtual void PredictPostFrame(void);
        virtual void ReceiveEntity(float,float);
        virtual void ReceiveEvent(float);
#endif
 
        virtual bool IsWeapon(void);
        virtual bool HasReserveAmmo(void);
 
        virtual void Draw(void);
        virtual void Holster(void);
        virtual void PrimaryAttack(void);
        virtual void SecondaryAttack(void);
        virtual void Reload(void);
        virtual void Release(void);
        virtual void UpdateGUI(void);
 
        nonvirtual void SetViewModel(string);
        nonvirtual void SetWorldModel(string);
        nonvirtual void SetPlayerModel(string);
        nonvirtual void SetWeaponFrame(float);
 
        virtual void SetAttackNext(float);
        virtual void SetIdleNext(float);
        virtual bool CanFire(void);
        virtual bool CanIdle(void);
        virtual bool UseAmmo(string);
 
        virtual void FiredWeapon(string);
        virtual void ReleasedWeapon(string);
 
        virtual void SwitchedToWeapon(void);
        virtual void SwitchedFromWeapon(void);
 
        virtual void UpdateFireInfoCache(void);
 
        nonvirtual void SwitchFireInfo(string);
        nonvirtual bool DetonateDef(string);
        nonvirtual void Attack(string);
 
private:
        nonvirtual void _SwitchedToCallback(void);
        nonvirtual void _SwitchedFromCallback(void);
        nonvirtual void _CacheWeaponDefVariables(void);
 
#ifdef SERVER
        nonvirtual void _ReloadFinished(void);
#endif
 
        /* weapon related spawn keys */
        string m_strWeaponViewModel;
        string m_strWeaponPlayerModel;
        string m_strWeaponScript;
        string m_strAmmoType;
        bool m_bAmmoRequired;
        int m_iClipStartSize;
        string m_strFlashShader;
        string m_strFlashModel;
        vector m_vecFlashColor;
        float m_flFlashRadius;
        string m_strDropItemDef;
        string m_strSmokeParticle;
        bool m_bSmokeContinous;
        float m_fxTrail;
 
        /* extra networking */
        bool m_bFiring;
 
        /* cached variables. don't save - recalculate! */
        string m_primaryFireInfo;
        string m_secondaryFireInfo;
        int m_primaryAmmoType;
        int m_secondaryAmmoType;
        float m_muzzleModelIndex;
        float m_altMuzzleModelIndex;
        string m_meleeDef;
        float m_flPrimedFuse;
        float m_flTriggerDelay;
        float m_flZoomFOV;
        bool m_bPowerAmmo;
        bool m_bRemoveOnEmpty;
        string m_strLastFireInfo;
        float m_jointTrailWorld;
        float m_jointTrailView;
        float m_flSpeedMod;
 
        /* cached fireInfo */
        string m_fiDetonateOnFire;
        float m_fiMeleeRange;
        vector m_fiPunchAngle;
        string m_fiSndFire;
        string m_fiSndEmpty;
        int m_fiAmmoType;
        int m_fiAmmoPerShot;
        bool m_fiAmmoRequired;
        float m_fiFireRate;
        string m_fiOnFire;
        string m_fiOnRelease;
        bool m_fiWillRelease;
        bool m_fiSemiAuto;
        string m_fiSndFireLoop;
 
        NETWORKED_INT(m_iClip)
        NETWORKED_INT(m_iClipSize)
        NETWORKED_FLOAT(m_iMode)
        NETWORKED_MODELINDEX(m_viewModel)
        NETWORKED_MODELINDEX(m_worldModel)
        NETWORKED_MODELINDEX(m_playerModel)
        NETWORKED_FLOAT(m_flFireRate)
        NETWORKED_FLOAT(m_dState)
        NETWORKED_BOOL(m_bFiring)
};
 
/* Helper functions for plugins, the rest of the codebase etc.
 
These are, according to IW, common operations. Makes sense to
handle the implementation ourselves as it'll prevent 
entityDefs changing from breaking plugins as a result.
Some of these don't just do direct look-ups of keys. */
 
string weaponType(string weaponDef);
 
int weaponStartAmmo(string weaponDef);
 
int weaponMaxAmmo(string weaponDef);
 
bool weaponIsSemiAuto(string weaponDef);
 
string weaponInventoryType(string weaponDef);
 
float weaponFireTime(string weaponDef);
 
int weaponClipSize(string weaponDef);
 
string weaponClass(string weaponDef);
 
bool isWeaponClipOnly(string weaponDef);
 
bool isWeaponDetonationTimed(string weaponDef);