Nuclide
Software Development Kit for id Technology
func_smokevolume Class Reference

About this class

Client-Entity: Smoke Cloud Volume.

QUAKED func_smokevolume (0 .5 .8) ? FULLBRIGHT

OVERVIEW

Smoke cloud emitting brush volume.

KEYS

  • "ParticleDrawWidth" : Size of the particles in Quake units.
  • "SizeMax" : Maximum size of each cloud. In Quake units.
  • "Color1" : Primary color
  • "Color2" : Secondary color
  • "MaxDrawDistance" : Maximum draw distance. Set to 0 if infinite.

TRIVIA

This entity was introduced in Half-Life 2 (2004).

Inheritance diagram for func_smokevolume:
NSEntity

Public Member Functions

void func_smokevolume (void)
 
virtual void Spawned (void)
 Called when the entity is fulled initialized. More...
 
virtual float predraw (void)
 
virtual void SpawnKey (string, string)
 This method handles entity key/value pairs on map load. More...
 
virtual bool CanSpawn (bool)
 Returns if this entity can spawned from the map file. More...
 

Constructor & Destructor Documentation

◆ func_smokevolume()

void func_smokevolume::func_smokevolume ( void  )

Member Function Documentation

◆ CanSpawn()

bool func_smokevolume::CanSpawn ( bool  clientSide)
virtual

Returns if this entity can spawned from the map file.

Parameters
clientSideIf it's being spawned on the client-side.

Reimplemented from NSEntity.

◆ predraw()

float func_smokevolume::predraw ( void  )
virtual

Reimplemented from NSEntity.

◆ Spawned()

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


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