Env hudhint: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (minor tidy)
Line 1: Line 1:
{{wrongtitle|title=env_hudhint}}
{{wrongtitle|title=env_hudhint}}


==Entity Description==
== 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.
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===
{{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"'''.}}
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 the [[Keyvalue]] '''"message"'''.


==Availability==
== Availability ==
{{in game|point}} {{game-base}}
{{in game|point}} {{game-base}}
{{in code|class=class_c_env_hud_hint.html CEnvHudHint|file=_env_hud_hint_8cpp-source.html EnvHudHint.cpp}}
{{in code|class=class_c_env_hud_hint.html CEnvHudHint|file=_env_hud_hint_8cpp-source.html EnvHudHint.cpp}}


==Keyvalues==
== Keyvalues ==
*{{kv Targetname}}
*{{kv Targetname}}
*'''message'''
*'''message'''
:<string> This should be set to match the desired HUD hint entry in the <code>hl2\resource\[[valve_english.txt]]</code> file packed within the <code>Steam/SteamApps/source engine.gcf</code> file.
:<string> This should be set to match the desired HUD hint entry in the <code>hl2\resource\[[valve_english.txt]]</code> file packed within the <code>Steam/SteamApps/source engine.gcf</code> file.


==Inputs==
== Inputs ==
*{{i Targetname}}
*{{i Targetname}}
*'''ShowHudHint'''
*'''ShowHudHint'''
Line 24: Line 22:
: Hides the hint message.
: Hides the hint message.


==Outputs==
== Outputs ==
*{{o Targetname}}
*{{o Targetname}}


==See Also==
== See also ==
* [[env_message]] - A similar entity that displays other predefined messages on the screen.
* [[env_message]] - A similar entity that displays other predefined messages on the screen.


[[Category:Entities]]
[[Category:Entities]]

Revision as of 17:19, 16 February 2008

Template:Wrongtitle

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

Template:In game Template:Game-base Template:In code

Keyvalues

<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

  • ShowHudHint
Shows the hint message.
Hides the hint message.

Outputs

See also

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