Nuclide
Software Development Kit for id Tech
targ_speaker Class Reference
Inheritance diagram for targ_speaker:
NSPointTrigger

Public Member Functions

void targ_speaker (void)
 
virtual void Save (float)
 Handles saving a copy of this entity to a given filehandle. More...
 
virtual void Restore (string, string)
 Similar to ::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 Trigger (entity, triggermode_t)
 Called whenever we're legacy triggered by another object or function. More...
 

Detailed Description

QUAKED targ_speaker (1 0 0) (-8 -8 -8) (8 8 8)

OVERVIEW

This entity plays a sample upon triggering at a specified volume.

KEYS

  • "targetname" : Name
  • "target" : Target when triggered
  • "killtarget" : Target to kill when triggered
  • "tsnoise" : Path to the sound file
  • "volume" : Volume to play the sound as (normalized, 0.0 - 1.0)

TRIVIA

It was introduced in Gunman Chronicles (2000).

It's not any more useful than an ambient_generic. I suspect it's a carry-over from when Gunman was a Quake II mod, as Quake/Quake II did not have an entity that allowed custom sound samples to be played.

Constructor & Destructor Documentation

◆ targ_speaker()

void targ_speaker::targ_speaker ( void  )

Member Function Documentation

◆ Respawn()

void targ_speaker::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 targ_speaker::Restore ( string  strKey,
string  strValue 
)
virtual

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

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

Reimplemented from NSPointTrigger.

◆ Save()

void targ_speaker::Save ( float  handle)
virtual

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

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

Reimplemented from NSPointTrigger.

◆ SpawnKey()

void targ_speaker::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 targ_speaker::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: