env_global Class Reference

Server-Entity: Global Variable Controller. More...

Inheritance diagram for env_global:

Public Member Functions
void	env_global (void)
virtual void	Save (float)
	Handles saving a copy of this entity to a given filehandle. More...
virtual void	Restore (string, string)
	Similar to NSIO::SpawnKey but for save-game fields. More...
virtual void	SpawnKey (string, string)
	This method handles entity key/value pairs on map load. More...
virtual void	Spawned (void)
	Called when the entity is fulled initialized. More...
virtual void	Trigger (entity, triggermode_t)
	Called whenever we're legacy triggered by another object or function. More...
nonvirtual int	GlobalPresent (string)
nonvirtual void	AddNewGlobal (string, globalstate_t)
nonvirtual void	SetGlobal (string, globalstate_t)

Detailed Description

Server-Entity: Global Variable Controller.

QUAKED env_global (1 .5 0) (-8 -8 -8) (8 8 8) GLOBAL_SETSPAWN

OVERVIEW

Persistent storage for variables that carry over level changes.

KEYS

• "targetname" : Name
• "target" : Target when triggered.
• "killtarget" : Target to kill when triggered.
• "globalstate" : The variable name in which we hold information in.
• "initialstate" : Initial mode: 0 = off, 1 = on, 2 = dead
• "triggermode" : Mode when triggered: 0 = off, 1 = on, 2 = dead

SPAWNFLAGS

• GLOBAL_SETSPAWN (1) : Without this set, it'll only modify existing variables.

TRIVIA

This entity was introduced in Half-Life (1998).

Constructor & Destructor Documentation

env_global()

void env_global::env_global

(

void

)

Member Function Documentation

AddNewGlobal()

void env_global::AddNewGlobal	(	string	strName,
		globalstate_t	newValue
	)

GlobalPresent()

int env_global::GlobalPresent

(

string

strName

)

Restore()

void env_global::Restore ( string  strKey, string  strValue  )

virtual

Similar to NSIO::SpawnKey but for save-game fields.

Whatever you write into file handles within your NSIO::Save() method needs to be read back in here.

Reimplemented from NSPointTrigger.

Save()

void env_global::Save ( float  handle )

virtual

Handles saving a copy of this entity to a given filehandle.

Within you want to use the NSIO::SaveFloat() etc. methods to write the internal member attributes to the specified file handle.

Reimplemented from NSPointTrigger.

SetGlobal()

void env_global::SetGlobal	(	string	strName,
		globalstate_t	newValue
	)

Spawned()

void env_global::Spawned ( void  )

virtual

Called when the entity is fulled initialized.

Any spawn key/value info pairs have already been dealt with. So now we can make full decisions on the entity. Always make sure to call super::Spawned(); inside your method when overriding.

Reimplemented from NSEntity.

SpawnKey()

void env_global::SpawnKey ( string  strKey, string  strValue  )

virtual

This method handles entity key/value pairs on map load.

You can easily convert the strValue parameter using the ReadFloat etc. methods that are part of NSIO.

Reimplemented from NSPointTrigger.

Trigger()

void env_global::Trigger ( entity  act, triggermode_t  state  )

virtual

Called whenever we're legacy triggered by another object or function.

Reimplemented from NSTrigger.

---

The documentation for this class was generated from the following file:

• src/gs-entbase/server/env_global.qc