Nuclide
Software Development Kit for id Tech
env_shake Class Reference

Server-Entity: Earthquake Maker. More...

Inheritance diagram for env_shake:
NSPointTrigger

Public Member Functions

void env_shake (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 Trigger (entity, triggermode_t)
 Called whenever we're legacy triggered by another object or function. More...
 
virtual void OnRemoveEntity (void)
 Handles what happens before the entity gets removed from the client game. More...
 

Detailed Description

Server-Entity: Earthquake Maker.

QUAKED env_shake (1 .5 0) (-8 -8 -8) (8 8 8) EVS_GLOBAL

OVERVIEW

Causes an earthquake/shaking effect when triggered.

KEYS

  • "targetname" : Name
  • "target" : Target when triggered.
  • "killtarget" : Target to kill when triggered.
  • "radius" : Radius of the quake/shake effect.
  • "amplitude" : Amplitude of the effect.
  • "duration" : Duration of the effect in seconds.
  • "frequency" : The frequency of the shake.

SPAWNFLAGS

  • EVS_GLOBAL : Affect all clients, ignoring "radius" entirely.

TRIVIA

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

Constructor & Destructor Documentation

◆ env_shake()

void env_shake::env_shake ( void  )

Member Function Documentation

◆ OnRemoveEntity()

void env_shake::OnRemoveEntity ( void  )
virtual

Handles what happens before the entity gets removed from the client game.

Reimplemented from NSEntity.

◆ Restore()

void env_shake::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_shake::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.

◆ SpawnKey()

void env_shake::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_shake::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: