NSTrigger.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.
*/
 
/* NSTrigger class is responsible for the legacy trigger architecture.
   In the future, NSEntity can be configured so that legacy
   triggers can be disabled. That's why this class is separate from NSIO.
 
   This is a very low-level class. You're never meant to use this.
   Use NSEntity as a basis for your classes.
*/
 
#define CENVGLOBAL_CVAR "env_global_data"
 
typedef enum
{
        GLOBAL_OFF,
        GLOBAL_ON,
        GLOBAL_DEAD
} globalstate_t;
 
typedef enum
{
        TRIG_OFF,
        TRIG_ON,
        TRIG_TOGGLE
} triggermode_t;
 
enumflags
{
        TOUCHFILTER_CLIENTS,
        TOUCHFILTER_NPCS,
        TOUCHFILTER_PUSHABLE,
        TOUCHFILTER_PHYSICS,
        TOUCHFILTER_FRIENDLIES,
        TOUCHFILTER_CLIENTSINVEHICLES,
        TOUCHFILTER_EVERYTHING,
        TOUCHFILTER_PADDING1,
        TOUCHFILTER_PADDING2,
        TOUCHFILTER_CLIENTSNOTINVEHICLES,
        TOUCHFILTER_DEBRIS,
        TOUCHFILTER_NPCSINVEHICLES,
        TOUCHFILTER_NOBOTS
};
 
 
class NSTrigger:NSIO
{
public:
        void NSTrigger(void);
 
        /* touch/blocked */
        virtual void Blocked(entity);
        virtual void StartTouch(entity);
 
        virtual void Touch(entity);
 
        virtual void EndTouch(entity);
 
        /* overrides */
        virtual void SpawnKey(string,string);
 
#ifdef SERVER
        /* overrides */
        virtual void Save(float);
        virtual void Restore(string,string);
        virtual void Respawn(void);
        virtual void Input(entity,string,string);
 
        /* Called to check if the target entity can touch trigger itself. */
        virtual bool CanBeTriggeredBy(entity);
 
        virtual void Trigger(entity, triggermode_t);
 
        /* master feature */
        /* multisource overrides this, so keep virtual */
        virtual int GetValue(entity);
 
        nonvirtual void UseTargets(entity,int,float);
 
        nonvirtual void SetTriggerTarget(string);
 
        nonvirtual int GetMaster(entity);
 
        nonvirtual globalstate_t GetGlobalValue(string);
 
        nonvirtual string GetTriggerTarget(void);
 
        nonvirtual entity GetTargetEntity(void);
 
        nonvirtual bool HasTriggerTarget(void);
 
        nonvirtual bool HasTargetname(void);
 
        nonvirtual void SetTeam(float);
 
        nonvirtual float GetTeam(void);
#endif
 
private:
        /* not needed to be saved right now */
        float m_flTouchTime;
        bool m_beingTouched;
        entity m_eTouchLast;
 
        nonvirtual void _TouchHandler(void);
        nonvirtual void _BlockedHandler(void);
 
#ifdef SERVER
        string m_strGlobalName;
        string m_strGlobalState;
        string m_strKillTarget;
        string m_strMessage;
        string m_strMaster;
        int m_iUseType;
        int m_iValue;
 
        bool m_bEnabled;
        bool m_bStartDisabled;
        bool m_bIsModern;
 
        float team_no;
 
        /* legacy trigger architecture */
        float m_flDelay;
#endif
 
#ifdef CLIENT
        float team;
#endif
};