nuclide/src/shared/NSTrigger.h

/*
 * 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"

/** States for env_global data. */
typedef enum
{
	/** env_global data in question is set to 'off'. */
	GLOBAL_OFF,
	/** env_global data in question is set to 'on'. */
	GLOBAL_ON,
	/** env_global data in question is dead. */
	GLOBAL_DEAD
} globalstate_t;

/** The type of trigger activation. Used by trigger_auto and trigger_relay to specifically trigger states. TRIG_TOGGLE is the safe option, as it'll cause something to happen either way. The way an entity responds to the described state is up to how it is programmed. Many entities do not react to a change in state at all. */
typedef enum
{
	/** Trigger the target 'off', for doors that may tell them to close. */
	TRIG_OFF,
	/** Trigger the target 'on', for doors that may tell them to open. */
	TRIG_ON,
	/** Trigger the target the opposite to whatever they're currently in. */
	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
};


/** NSTrigger handles all the non-input as well as Legacy (Quake, GoldSource) style
trigger behaviour. It also deals with masters, touches, blocking and so on.
*/
class NSTrigger:NSIO
{
public:
	void NSTrigger(void);

	/* touch/blocked */
	/** Called whenever out movement is being blocked by an entity.
		This is currently only relevant on entities that are of `MOVETYPE_PUSH`. */
	virtual void Blocked(entity);
	/** Called when we started touching another entity. */
	virtual void StartTouch(entity);

	/** Called whenever we're touching another entity. */
	virtual void Touch(entity);

	/** Called when we stopped touching the last touched 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);

	/** Called whenever we're legacy triggered by another object or function. */
	virtual void Trigger(entity, triggermode_t);

	/* master feature */
	/** Returns what we will pass onto other's `::GetMaster()` calls if we're their master. */
	/* multisource overrides this, so keep virtual */
	virtual int GetValue(entity);

	/** When called will trigger its legacy targets with a given delay. */
	nonvirtual void UseTargets(entity,int,float);

	/** Sets the legacy target for this entity. */
	nonvirtual void SetTriggerTarget(string);

	/** Returns whether our master allows us to be triggered. The argument specifies who's requesting the info for the master. Required for game_team_master to verify against players. */
	nonvirtual int GetMaster(entity);

	/** Returns the value of a given env_global property */
	nonvirtual globalstate_t GetGlobalValue(string);

	/** Returns the name of the entity group it can trigger (legacy style). */
	nonvirtual string GetTriggerTarget(void);

	/** Returns the first entity named after the target field. */
	nonvirtual entity GetTargetEntity(void);

	/** Returns TRUE if the entity has a legacy trigger target. */
	nonvirtual bool HasTriggerTarget(void);

	/** Returns TRUE if the entity has a name that can be used for messaging. */
	nonvirtual bool HasTargetname(void);

	/** Assigns the entity to a given team value. */
	nonvirtual void SetTeam(float);

	/** Retrives the team value of a given entity. */
	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_oldstrTarget; /* needed due to trigger_changetarget */

	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
};