Nuclide
Software Development Kit for id Tech
trigger_gravity Class Reference

Shared-Entity: Gravity Controller Volume. More...

Inheritance diagram for trigger_gravity:
NSBrushTrigger

Public Member Functions

void trigger_gravity (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 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 Touch (entity)
 Called whenever we're touching another entity. More...
 

Detailed Description

Shared-Entity: Gravity Controller Volume.

QUAKED trigger_gravity (.5 .5 .5) ?

OVERVIEW

Volume that will, when an entity enters it, permanently alters how it experiences gravity.

KEYS

"targetname" : Name "gravity" : Gravity multiplier.

NOTES

Entities leaving the volume will NOT lose the gravity modifier. If you don't desire this behaviour, then make sure a trigger_gravity with a modifier value of "1.0" surrounds the aforementioned volume so it can reset itself. Other than that gravity will naturally reset when the entity respawns.

TRIVIA

This entity was introduced in Quake II (1997).

Constructor & Destructor Documentation

◆ trigger_gravity()

void trigger_gravity::trigger_gravity ( void  )

Member Function Documentation

◆ Respawn()

void trigger_gravity::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 NSBrushTrigger.

◆ Restore()

void trigger_gravity::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 NSEntity.

◆ Save()

void trigger_gravity::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 NSEntity.

◆ SpawnKey()

void trigger_gravity::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 NSEntity.

◆ Touch()

void trigger_gravity::Touch ( entity  eToucher)
virtual

Called whenever we're touching another entity.

Reimplemented from NSTrigger.


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