env_hudhint

From Valve Developer Community

Jump to: navigation, search

env_hudhint is a point entity available in all Source games. It is used to control the display of HUD hints, which show the player what key is bound to a particular command.

Contents

Keyvalues

{{KV|Hint Text (localized)|string|This should be match a HUD hint entry in hl2\resource\valve_english.txt or its localized equivalent. Example: entering "Valve_Hint_Zoom" will display the following hint text: "%+zoom% ZOOM VIEW", with %+zoom% being the key currently bound to the zoom function.
Warning:Entering an unlocalized text as a hint will work, though when used in a mod you cannot make it language-specific!

Targetname:

Name <string>
The targetname that other entities refer to this entity by.
Entity Scripts <scriptlist> (New with Left 4 Dead 2)
Name(s) of script files that are executed after all entities have spawned.
Script think function <string> (New with Left 4 Dead 2)
Name of a function in this entity's script which will be called automatically every 100 milliseconds (ten times a second) for the duration of the script. It can be used to create timers or to simulate autonomous behavior.
Note:Try to avoid expensive operations in this function, as it may cause performance problems.

Inputs

ShowHudHint
Shows the hint message.
HideHudHint
Hides the hint message.

Targetname:

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 means infinite>
FireUser1 to FireUser4
Fire the OnUser outputs; see User Inputs and Outputs.
Use  !FGD
Same as a player invoking +use; may not do anything. Can also be invoked by creating an output that does not specify an input.
This input is not included in Valve's FGDs.
RunScriptFile  <script> (New with Left 4 Dead 2)
Execute a game script file from disk.
RunScriptCode  <string> (New with Left 4 Dead 2)
Execute a string of script source code. String quotation may be needed when fired via console.
Warning:Never try to pass string parameters to a script function with this input. It will corrupt the VMF structure because of the nested quotation marks, which then must be removed manually with a text editor.
CallScriptFunction  <string> (New with Left 4 Dead 2)
Execute a game script function.

Outputs

OnUser1 to OnUser4
These Outputs each fire in response to the firing of the like-numbered FireUser1 to FireUser4 Input; see User Inputs and Outputs.
OnKilled  

(New with Left 4 Dead)

This Output fires when the entity is killed and removed from the game.


See also

  • env_message - A similar entity that displays other predefined messages on the screen.
Personal tools
Namespaces
Variants
Actions