env_spark Class Reference

About this class

Server-Entity: Spark Maker.

QUAKED env_spark (1 .5 0) (-8 -8 -8) (8 8 8) x x x x x TOGGLE START_ON

OVERVIEW

Creates a series (or just one) spark effect with sound when triggered.

KEYS

• "targetname" : Name
• "target" : Target when triggered.
• "killtarget" : Target to kill when triggered.
• "angles" : Sets the pitch, yaw and roll angles of the spark.
• "MaxDelay" : Delay between sparks when start-on (or toggle) is set

INPUTS

• "StartSpark" : Enables a continous spark emitter.
• "StopSpark" : Stops the ongoing spark emitter.
• "ToggleSpark" : Toggles the state of the spark emitter.
• "SparkOnce" : Creates a single spark effect, once.

SPAWNFLAGS

• TOGGLE (32) : When triggered, it'll spark continously with "MaxDelay" dictating the interval.
• START_ON (64) : Start sparking upon spawning, at least waiting til "MaxDelay" seconds has passed.
• SILENT (256) : Do not play a sound.
• DIRECTIONAL (512) : Angles are respected to direct the spark.

NOTES

The spawnflag START_ON (32) automatically enables the TOGGLE (64) flag as well.

TRIVIA

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

Inheritance diagram for env_spark:

Public Member Functions
void	env_spark (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	Respawn (void)
	Server: Called when the entity first spawns or when game-logic requests the entity to return to its original spawn state. More...
virtual void	Trigger (entity, triggermode_t)
	Called whenever we're legacy triggered by another object or function. More...
virtual void	Input (entity, string, string)
	Called when we are being prompted by another object/function with an input message. More...
nonvirtual void	_TimedSpark (void)
nonvirtual void	StartSpark (void)
nonvirtual void	StopSpark (void)
nonvirtual void	ToggleSpark (void)
nonvirtual void	SparkOnce (void)

Constructor & Destructor Documentation

env_spark()

void env_spark::env_spark

(

void

)

Member Function Documentation

_TimedSpark()

void env_spark::_TimedSpark

(

void

)

Input()

void env_spark::Input ( entity  eAct, string  strInput, string  strData  )

virtual

Called when we are being prompted by another object/function with an input message.

Reimplemented from NSEntity.

Respawn()

void env_spark::Respawn ( void  )

virtual

Server: Called when the entity first spawns or when game-logic requests the entity to return to its original spawn state.

Reimplemented from NSPointTrigger.

Restore()

void env_spark::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_spark::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.

SparkOnce()

void env_spark::SparkOnce

(

void

)

Spawned()

void env_spark::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_spark::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.

StartSpark()

void env_spark::StartSpark

(

void

)

StopSpark()

void env_spark::StopSpark

(

void

)

ToggleSpark()

void env_spark::ToggleSpark

(

void

)

Trigger()

void env_spark::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_spark.qc