Nuclide
Software Development Kit for id Technology
func_dustcloud Class Reference

About this class

Client-Entity: Dust Cloud Volume.

QUAKED func_dustcloud (0 .5 .8) ?

OVERVIEW

Dust cloud emitting brush volume.

KEYS

  • "count" : Number of cloud particles that will float around on average.
  • "Alpha" : Transparency of the clouds. Value from 0 to 255.
  • "SizeMin" : Minimum size of each cloud. In Quake units.
  • "SizeMax" : Maximum size of each cloud. In Quake units.

TRIVIA

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

Inheritance diagram for func_dustcloud:
NSEntity

Public Member Functions

void func_dustcloud (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_dustcloud()

void func_dustcloud::func_dustcloud ( void  )

Member Function Documentation

◆ CanSpawn()

bool func_dustcloud::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_dustcloud::predraw ( void  )
virtual

Reimplemented from NSEntity.

◆ Spawned()

void func_dustcloud::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_dustcloud::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: