Weapon.h

/*
 * 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,
    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,
    WEAPONFL_CHANGED_NEXTWEAPON,
    WEAPONFL_CHANGED_PREVWEAPON,
} nsweapon_changed_t;
 
typedef enum
{
    WEAPONSTATE_IDLE,
    WEAPONSTATE_COCK,
    WEAPONSTATE_CHARGING,
    WEAPONSTATE_FIRELOOP,
    WEAPONSTATE_RELEASED,
    WEAPONSTATE_OVERHEATED,
    WEAPONSTATE_DRAW,
    WEAPONSTATE_RELOAD_START,
    WEAPONSTATE_RELOAD,
    WEAPONSTATE_RELOAD_END,
    WEAPONSTATE_BURSTFIRING
} nsweapon_state_t;
 
string nsweapon_state_s[] =
{
    "WEAPONSTATE_IDLE",
    "WEAPONSTATE_RELOAD_START",
    "WEAPONSTATE_RELOAD",
    "WEAPONSTATE_RELOAD_END",
    "WEAPONSTATE_CHARGING",
    "WEAPONSTATE_FIRELOOP",
    "WEAPONSTATE_RELEASED",
    "WEAPONSTATE_OVERHEATED"
};
 
typedef enum
{
    WEPEVENT_FIRED,
    WEPEVENT_RELEASED,
    WEPEVENT_RELOADED
} nsweapon_event_t;
 
#define CHAN_LOOP 5
 
class
ncWeapon:ncItem
{
public:
    void ncWeapon(void);
 
    virtual void InputFrame(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);
    virtual void RestoreComplete(void);
    virtual void GiveBonusItems(entity, bool);
    virtual bool ItemBonusCheck(entity);
 
    virtual void EjectBrass(void);
    virtual void EjectCartridge(void);
#endif
 
    virtual bool TestFireAbility(string);
 
#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 UsesSecondaryAmmo(void);
    virtual bool IsEmpty(void);
    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 Idle(void);
    virtual void UpdateGUI(void);
 
    nonvirtual void SetViewModel(string);
    nonvirtual void SetWorldModel(string);
    nonvirtual void SetPlayerModel(string);
    nonvirtual void SetWeaponFrame(float);
    nonvirtual void PlaySound(string, float, bool);
 
    /* state */
    nonvirtual nsweapon_state_t GetWeaponState(void);
 
    virtual void SetAttackNext(float);
    virtual void SetReloadNext(float);
    virtual void SetIdleNext(float);
    virtual bool CanFire(void);
    virtual bool CanIdle(void);
    virtual bool CanReload(void);
    virtual bool UseAmmo(string);
 
    virtual void WeaponStartedFiring(void);
    virtual void WeaponStoppedFiring(void);
    virtual void WeaponStartedReloading(void);
    virtual void WeaponStoppedReloading(void);
 
    virtual void FiredWeaponAttack(string);
    virtual void ReleasedWeaponAttack(string);
 
    virtual void SwitchedToWeapon(void);
    virtual void SwitchedFromWeapon(void);
 
    virtual void UpdateFireInfoCache(void);
    virtual void FireInfoChanged(void);
 
    nonvirtual bool WeaponIsFiring(void);
 
    nonvirtual void SwitchFireInfo(string);
    nonvirtual bool DetonateDef(string);
    nonvirtual void Attack(string);
    
    nonvirtual int GetClip(void);
    nonvirtual int GetClipSize(void);
    nonvirtual bool RequiresAmmo(void);
    nonvirtual int FireInfoSelected(void);
    nonvirtual float OverheatingProgress(void);
    nonvirtual float PlayerSpeedMod(void);
 
    virtual void ReloadCachedAttributes(void);
 
private:
    nonvirtual void _SetWeaponState(nsweapon_state_t);
    nonvirtual void _SwitchedToCallback(void);
    nonvirtual void _SwitchedFromCallback(void);
    nonvirtual void _WeaponStartedFiring(void);
    nonvirtual void _WeaponStoppedFiring(void);
    nonvirtual void _PrimaryAttack(void);
    nonvirtual void _SecondaryAttack(void);
    nonvirtual void _SwitchedWeaponMode(void);
    virtual void _AddedCallback(void);
    virtual void _RemovedCallback(void);
 
    nonvirtual ncWeapon GetNextWeapon(void);
    nonvirtual ncWeapon GetPreviousWeapon(void);
    nonvirtual void EmptySound(void);
    nonvirtual void SetViewZoom(float);
 
#ifdef CLIENT
    virtual void HandleAnimEvent(float, int, string);
#endif
 
#ifdef SERVER
    nonvirtual void _ReloadFinished(void);
#endif
 
    /* weapon related spawn keys */
    string m_weaponTitle;
    int m_weaponHUDSlot;
    int m_weaponHUDSlotPos;
    string m_weaponHUDIcon;
    string m_weaponHUDIconSel;
    string m_weaponViewModelPath;
    string m_weaponPlayerModelPath;
    string m_weaponScript;
    string m_weaponAmmoType;
    bool m_weaponRequiresAmmo;
    int m_weaponClipStartSize;
    string m_weaponDropsItem;
 
    NETWORKED_INT(m_weaponClip)
    NETWORKED_INT(m_weaponClipSize)
    NETWORKED_FLOAT(m_weaponFireInfoValue)
    NETWORKED_MODELINDEX(m_viewModel)
    NETWORKED_MODELINDEX(m_worldModel)
    NETWORKED_MODELINDEX(m_playerModel)
    NETWORKED_FLOAT(m_weaponFireRate)
    NETWORKED_FLOAT(m_weaponState)
    NETWORKED_BOOL(m_weaponIsFiring)
    NETWORKED_BOOL(m_weaponOverheating)
    NETWORKED_FLOAT(m_burstCount)
 
    /* cached variables. don't save - recalculate! */
    string m_weaponLastFireInfo;
    string m_primaryFireInfo;
    string m_secondaryFireInfo;
    int m_primaryAmmoType;
    int m_secondaryAmmoType;
    float m_jointTrailWorld;
    float m_jointTrailView;
    float m_weaponAmmoRegenTime;
    float m_weaponAmmoDepleteTime;
    string m_animPrefix;
    bool m_altAlternates;
 
    /* extra networking */
    float m_nextWeapon_entnum;
    float m_prevWeapon_entnum;
    ncWeapon m_nextWeapon_net;
    ncWeapon m_prevWeapon_net;
 
    /* cached fireInfo */
    string m_fiMuzzleFlashMaterial;
    string m_fiMuzzleFlashModelPath;
    vector m_fiMuzzleFlashColor;
    float m_fiMuzzleFlashRadius;
    string m_fiFXSmokeParticle;
    bool m_fiFXSmokeContinous;
    float m_fiFXTrail;
    bool m_fiAmmoRequired;
    bool m_fiCocks;
    bool m_fiDrawAfterRelease;
    bool m_fiFireUnderwater;
    bool m_fiLoopingFire;
    bool m_fiSemiAuto;
    bool m_fiWillRelease;
    float m_fiBrassDelay;
    float m_fiCartridgeDelay;
    float m_fiChargeTime;
    float m_fiFireRate;
    float m_fiOverheatLength;
    float m_fiOverheatPoints;
    float m_fiReloadTime;
    int m_fiAmmoPerShot;
    int m_fiAmmoType;
    float m_fiPrimedFuse;
    float m_fiZoomFOV;
    bool m_fiPowerAmmo;
    bool m_fiRemoveOnEmpty;
    bool m_switchOnEmpty;
    string m_fiBrassDef;
    string m_fiCartridgeDef;
    string m_fiDetonateOnFire;
    string m_fiOnFire;
    string m_fiOnRelease;
 
    ncSoundDict m_fiSndDraw;
    ncSoundDict m_fiSndDelay;
    ncSoundDict m_fiSndHolster;
    ncSoundDict m_fiSndReload;
    ncSoundDict m_fiSndReloadStart;
    ncSoundDict m_fiSndReloadEnd;
    ncSoundDict m_fiSndCock;
    ncSoundDict m_fiSndEmpty;
    ncSoundDict m_fiSndFailed;
    ncSoundDict m_fiSndFire;
    ncSoundDict m_fiSndFireLast;
    ncSoundDict m_fiSndFireLoop;
    ncSoundDict m_fiSndFireLoop;
    ncSoundDict m_fiSndFireStart;
    ncSoundDict m_fiSndFireStop;
    ncSoundDict m_fiSndRelease;
    ncSoundDict m_fiSndEjectBrass;
    ncSoundDict m_fiSndEjectCartridge;
    ncSoundDict m_sndRaiseScope;
    ncSoundDict m_sndLowerScope;
    ncSoundDict m_sndModeOn;
    ncSoundDict m_sndModeOff;
 
    vector m_fiPunchAngle;
    vector m_fiPunchSpring;
    float m_fiSpeedMod;
    bool m_fiAltModeSwitch;
    bool m_fiBuggyIdleAnim;
    int m_fiRegenAmmo;
    float m_fiRegenRate;
    int m_fiDepleteAmmo;
    float m_fiDepleteRate;
    float m_fiMaxBurst;
    float m_fiBurstTime;
    float m_fiKnockBack;
    float m_fiKnockBackRelease;
    float m_fiTestDistance;
};
 
.ncWeapon m_nextWeapon;
.ncWeapon m_prevWeapon;