Item.h

/*
 * Copyright (c) 2023-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.
*/
 
typedef enumflags {
    ITEMFL_CHANGED_MODELINDEX,
    ITEMFL_CHANGED_ORIGIN_X,
    ITEMFL_CHANGED_ORIGIN_Y,
    ITEMFL_CHANGED_ORIGIN_Z,
    ITEMFL_CHANGED_ANGLES_X,
    ITEMFL_CHANGED_ANGLES_Y,
    ITEMFL_CHANGED_ANGLES_Z,
    ITEMFL_CHANGED_VELOCITY,
    ITEMFL_CHANGED_ANGULARVELOCITY,
    ITEMFL_CHANGED_RENDERPROPS,
    ITEMFL_CHANGED_SIZE,
    ITEMFL_CHANGED_FLAGS,
    ITEMFL_CHANGED_SOLID,
    ITEMFL_CHANGED_FRAME,
    ITEMFL_CHANGED_SKIN,
    ITEMFL_CHANGED_MOVETYPE,
    ITEMFL_CHANGED_EFFECTS,
    ITEMFL_CHANGED_SCALE,
    ITEMFL_CHANGED_ENTITYDEF,
    ITEMFL_CHANGED_CHAIN,
} nsitem_changed_t;
 
class ncItem:ncPhysicsEntity
{
public:
    void ncItem(void);
 
    /* overrides */
#ifdef SERVER
    virtual void Spawned(void);
    virtual bool ItemBonusCheck(entity);
    virtual bool ItemPickupCheck(entity);
    virtual void GiveBonusItems(entity, bool);
    virtual void Touch(entity);
    virtual void Respawn(void);
    virtual void SpawnKey(string, string);
    virtual void Input(entity, string, string);
    virtual void Save(float);
    virtual void Restore(string,string);
    virtual void EvaluateEntity(void);
    virtual float SendEntity(entity,float);
    virtual void OnMapFinishedLoading(void);
 
    /* item related accessors */
    nonvirtual void SetFloating(int);
    nonvirtual bool GetFloating(void);
    nonvirtual void SetSpinning(bool);
    nonvirtual bool GetSpinning(void);
    nonvirtual void PickupRespawn(void);
    nonvirtual void SetRespawnTime(float);
 
    /* only if the entity is usable in the inventory. */
    virtual void OnInventoryUse(void);
 
    virtual void OnPickup(void);
 
    virtual void OnUse(entity);
 
    virtual void PrintDebugInfo(void);
    nonvirtual void BecomePickup(void);
 
    nonvirtual void BecomeSolid(void);
    nonvirtual void BecomeDropped(void);
#endif
 
    virtual void AddedToInventory(void);
    virtual void RemovedFromInventory(void);
 
#ifdef CLIENT
    virtual void ReceiveEntity(float,float);
    virtual void ReceiveEvent(float);
    virtual void PredictPreFrame(void);
    virtual void PredictPostFrame(void);
#endif
 
    virtual bool IsWeapon(void);
    virtual bool InInventory(void);
 
    virtual void OnRemoveEntity(void);
 
private:
    virtual void _AddedCallback(void);
    virtual void _RemovedCallback(void);
 
    int m_itemWasDropped;
 
    /* item related spawn keys */
    string m_sndAcquire;
    string m_sndRespawn;
    float m_itemRespawn;
    string m_sndHum;
    int m_itemPickupFloats;
    bool m_itemPickupSpins;
    string m_itemName;
    string m_itemWeapon;
 
    int m_itemGivesHealth;
    int m_itemGivesArmor;
    float m_itemGivesAir;
    int m_itemGivesBonusHealth;
    int m_itemGivesBonusArmor;
    bool m_itemNoTouch;
    bool m_itemCarries;
    string m_itemRequiresItem;
    bool _m_itemTouchPickup; /* whether the item was touched for pick-up */
 
    int m_itemGivesAmmo[MAX_AMMO_TYPES];
 
#ifdef CLIENT
    NETWORKED_FLOAT(chain_entnum)
    NETWORKED_FLOAT(owner_entnum)
#endif
 
#ifdef SERVER
    float m_hiddenModelIndex;
    float m_hiddenSequence;
#endif
 
    ncItem m_nextItem;
    ncItem m_nextItem_net;
    entity owner_net;
    entity m_oldOwner;
};