Nuclide
Software Development Kit for id Technology
Public Member Functions | List of all members
env_shockwave Class Reference
Shared Game | Entities » Point Entities

About this class

Shared-Entity: Shockwave Effect.

QUAKED env_shockwave (1 .5 0) (-8 -8 -8) (8 8 8) CENTERED REPEATABLE

OVERVIEW

A temporary shockwave effect is produced when triggered.

KEYS

  • "targetname" : Name
  • "m_iszPosition" : Entity name to attach the effect too. Runs effect on self if empty.
  • "netname" : Path to the sprite to use.
  • "rendercolor" : Color of the shockwave effect.
  • "renderamt" : Opacity of the effect.
  • "m_iTime" : Shockwave life time.
  • "m_iRadius" : Final radius of the shockwave effect. In game units.
  • "m_iHeight" : Vertical height of the shockwave effect.
  • "m_iScrollRate": TODO: Speed at which the texture scrolls.
  • "m_iNoise" : Scrolling distortion.
  • "m_iFrameRate" : TODO: Framerate at which the texture animates, independent from scrolling.
  • "m_iStartFrame" : Frame at which to start animating.

SPAWNFLAGS

  • CENTERED (1) : Center the effect on the target. We ignore this for now, but make sure to set it for when we get around to it.
  • REPEATABLE (2) : If set, will not delete the effect after being triggered.

TRIVIA

This entity was introduced in Spirit of Half-Life (2000).

Inheritance diagram for env_shockwave:
NSEntity

Public Member Functions

void env_shockwave (void)
 
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 float predraw (void)
 

Constructor & Destructor Documentation

◆ env_shockwave()

void env_shockwave::env_shockwave ( void  )

Member Function Documentation

◆ predraw()

float env_shockwave::predraw ( void  )
virtual

Reimplemented from NSEntity.

◆ SpawnKey()

void env_shockwave::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.

◆ Trigger()

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