env_hudcounter Class Reference

About this class

Shared-Entity: HUD Counter.

QUAKED env_hudcounter (0 1 0) (-8 -8 -8) (8 8 8)

OVERVIEW

When active, will display an icon and text at its position that can be seen by players.

KEYS

• "targetname" : Name
• "Image" : Path of the material that the game will use for the icon.
• "model" : If set, will use this (sprite) model instead.
• "Text" : A localised string to display next to it.
• "additive" : When 1, will force the image to be drawn additive.

INPUTS

• "Enable" : Enable the entity.
• "Disable" : Disable the entity.
• "Toggle" : Toggles between enabled/disabled states.
• "SetValue" : Overrides the current counter value.
• "Increment" : Increment by the desired amount.
• "Decrement" : Decrement by the desired amount.

TRIVIA

This entity was introduced in Nuclide in February of 2025.

Inheritance diagram for env_hudcounter:

Public Member Functions
void	env_hudcounter (void)
virtual void	SpawnKey (string, string)
	This method handles entity key/value pairs on map load. More...
virtual void	Save (float)
	Handles saving a copy of this entity to a given filehandle. More...
virtual void	Restore (string, string)
	Similar to ncIO::SpawnKey() but for save-game fields. More...
virtual void	Input (entity, string, string)
	Called when we are being prompted by another object/function with an input message. More...
virtual void	Trigger (entity, triggermode_t)
	Called whenever we're legacy triggered by another object or function. More...
virtual void	EvaluateEntity (void)
	Run each tic after physics are run to determine if we need to send updates over the network. More...
virtual float	SendEntity (entity, float)
	Called by the engine whenever we need to send a client an update about this entity. More...
virtual void	ReceiveEntity (float, float)
	Client: Handles network updates from the server for the associated entity. More...
virtual void	postdraw (void)
	Client: Run after the rendering of 3D world is complete. More...

Constructor & Destructor Documentation

env_hudcounter()

void env_hudcounter::env_hudcounter

(

void

)

Member Function Documentation

EvaluateEntity()

void env_hudcounter::EvaluateEntity ( void  )

virtual

Run each tic after physics are run to determine if we need to send updates over the network.

Reimplemented from ncEntity.

Input()

void env_hudcounter::Input ( entity  eAct, string  strInput, string  strData  )

virtual

Called when we are being prompted by another object/function with an input message.

Reimplemented from ncEntity.

postdraw()

void env_hudcounter::postdraw ( void  )

virtual

Client: Run after the rendering of 3D world is complete.

2D calls can happen here.

Reimplemented from ncEntity.

ReceiveEntity()

void env_hudcounter::ReceiveEntity ( float  flNew, float  flChanged  )

virtual

Client: Handles network updates from the server for the associated entity.

Reimplemented from ncEntity.

Restore()

void env_hudcounter::Restore ( string  strKey, string  strValue  )

virtual

Similar to ncIO::SpawnKey() but for save-game fields.

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

Reimplemented from ncEntity.

Save()

void env_hudcounter::Save ( float  handle )

virtual

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

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

Reimplemented from ncEntity.

SendEntity()

float env_hudcounter::SendEntity ( entity  , float    )

virtual

Called by the engine whenever we need to send a client an update about this entity.

Reimplemented from ncEntity.

SpawnKey()

void env_hudcounter::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 ncIO.

Reimplemented from ncEntity.

Trigger()

void env_hudcounter::Trigger ( entity  act, triggermode_t  state  )

virtual

Called whenever we're legacy triggered by another object or function.

Reimplemented from ncTrigger.

---

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

• src/gs-entbase/shared/env_hudcounter.qc