env_hudhint Class Reference

About this class

Server-Entity: Displays HUD Hint Messages.

QUAKED env_hudhint (1 .5 0) (-8 -8 -8) (8 8 8) EHH_ALLPLAYERS

OVERVIEW

Will display a hint message to the client who activates it.

KEYS

• "targetname" : Name
• "target" : Target when triggered.
• "killtarget" : Target to kill when triggered.
• "rendercolor" : RGB8 Color of the fade effect.
• "renderamt" : A8 alpha value we'll hit at max.
• "duration" : Duration of the effect in seconds.
• "holdtime" : How long we'll hold on the max color/alpha.

SPAWNFLAGS

• EHH_ALLPLAYERS (1) : Send the hint notifcation to all connected clients.

TRIVIA

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

Inheritance diagram for env_hudhint:

Public Member Functions
void	env_hudhint (void)
virtual void	Save (float)
	Handles saving a copy of this entity to a given filehandle.
virtual void	Restore (string, string)
	Similar to ncIO::SpawnKey() but for save-game fields.
virtual void	SpawnKey (string, string)
	This method handles entity key/value pairs on map load.
virtual void	Trigger (entity, triggermode_t)
	Called whenever we're legacy triggered by another object or function.

Constructor & Destructor Documentation

env_hudhint()

void env_hudhint::env_hudhint

(

void

)

Member Function Documentation

Restore()

void env_hudhint::Restore ( string keyName, string setValue )

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_hudhint::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.

SpawnKey()

void env_hudhint::SpawnKey ( string keyName, string setValue )

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_hudhint::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/server/env_hudhint.qc