Env hudhint: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (Switching entry keyvalues to SmartEdit text from actual keyvalue.)
(fmt)
Line 1: Line 1:
{{wrongtitle|title=env_hudhint}}
{{base point}} It is an entity to control the display of HUD hints, which show the player what key is bound to a particular command. __NOTOC__
{{base_point}}[[Category:GUI Entities]]


== Entity description ==
== See also ==
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.
* [[env_message]] - A similar entity that displays other predefined messages on the screen.


{{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]] '''"Hint Text (localized)"'''.}}
== Keyvalues ==


== Availability ==
; Hint Text (localized) <code><[[string]]></code>
{{in game|point}} {{game-base}}
: This should be match a HUD hint entry in <code>hl2\resource\[[valve_english.txt]]</code> or its localized equivalent. {{todo|Should the string start with the # character?}} {{warning|If an unlocalized string (ex. "%+USE to use") is typed directly in editor, Hammer will become confused the next time the VMF is loaded and freeze!}}
In code it is represented by class CEnvHudHint, defined in EnvHudHint.cpp.
{{KV Targetname}}


== Keyvalues ==
== Inputs ==
*{{KV Targetname}}
*'''Hint Text (localized)'''
:<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 or its localized equivalent.


== Inputs ==
; <code>ShowHudHint</code>
*{{i Targetname}}
; {{EP1 add|<code>HideHudHint</code>}}
*'''ShowHudHint'''
: Show/hide the hint message.
:Shows the hint message.
{{I Targetname}}
*'''{{EP1 add|HideHudHint}}'''
: Hides the hint message.


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


== See also ==
{{O Targetname}}
* [[env_message]] - A similar entity that displays other predefined messages on the screen.
 
{{wrongtitle|title=env_hudhint}}[[Category:GUI Entities]]

Revision as of 04:05, 20 July 2009

Template:Base point It is an entity to control the display of HUD hints, which show the player what key is bound to a particular command.

See also

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

Keyvalues

Hint Text (localized) <string>
This should be match a HUD hint entry in hl2\resource\valve_english.txt or its localized equivalent.
Todo: Should the string start with the # character?
Warning.pngWarning:If an unlocalized string (ex. "%+USE to use") is typed directly in editor, Hammer will become confused the next time the VMF is loaded and freeze!
Name (targetname) <string>[ Edit ]
The name that other entities refer to this entity by, via Inputs/Outputs or other keyvalues (e.g. parentname or target).
Also displayed in Hammer's 2D views and Entity Report.
See also:  Generic Keyvalues, Inputs and Outputs available to all entities

Inputs

ShowHudHint
HideHudHint (in all games since Half-Life 2: Episode One)
Show/hide the hint message.


Outputs

Template:Wrongtitle