Env hudhint

From Valve Developer Community

This point-based entity is available in all Source games.

Entity description

An entity to control the display of HUD hints. HUD hints are used to show the player what key is bound to a particular command.

Warning: If an unlocalized string (ex. "%+USE to use") is typed directly in editor, then Hammer will become confused the next time that VMF is loaded, and freeze during the process! See Keyvalue "message".

Availability

This point-based entity is available in: all Source games. In code it is represented by class CEnvHudHint (http://localhost/class_c_env_hud_hint.html), defined in EnvHudHint.cpp (http://localhost/_env_hud_hint_8cpp-source.html).

Keyvalues

• targetname <target_source>

Defines the name that other entities refer to this entity by.

• hammerid [Episode Two Update]

<integer readonly> This id is used for debugging purposes in Hammer.

• message

<string> This should be set to match the desired HUD hint entry in the hl2\resource\valve_english.txt file packed within the Steam/SteamApps/source engine.gcf file.

Inputs

• Kill

Removes this entity from the world.

• KillHierarchy

Removes this entity and all its children from the world.

• AddOutput <string>

Evaluates a keyvalue/output on this entity. It can be potentially very dangerous, use with care.

Format: <key> <value>

Format: <output name> <targetname>:<inputname>:<parameter>:<delay>:<max times to fire (-1 == infinite)>

• FireUser1-4

Causes this entity's OnUser1-4 outputs to be fired. See User Inputs and Outputs.

• ShowHudHint

Shows the hint message.

• HideHudHint [Episode One Update]

Hides the hint message.

Outputs

• OnUser1-4

Fired in response to FireUser1-4 inputs. See User Inputs and Outputs.

!activator = activator

See also

• env_message - A similar entity that displays other predefined messages on the screen.