Env hudhint: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (→‎Keyvalues: No, the # char is not needed.)
(Cleanup)
Line 1: Line 1:
{{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|env_hudhint}}


== See also ==
== Entity description ==
* [[env_message]] - A similar entity that displays other predefined messages on the screen.
An entity to control the display of HUD hints, which show the player what key is bound to a particular command.


== Keyvalues ==
== Keyvalues ==


; Hint Text (localized) <code><[[string]]></code>
{{KV|Hint Text (localized)|string|This should be match a HUD hint entry in <code>hl2\resource\[[valve_english.txt]]</code> 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|If an unlocalized string (ex. "%+zoom% ZOOM VIEW" instead of "Valve_Hint_Zoom") is typed directly in editor, Hammer will become confused the next time the VMF is loaded and freeze!}}}}
: This should be match a HUD hint entry in <code>hl2\resource\[[valve_english.txt]]</code> 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|If an unlocalized string (ex. "%+zoom% ZOOM VIEW" instead of "Valve_Hint_Zoom") is typed directly in editor, Hammer will become confused the next time the VMF is loaded and freeze!}}
{{KV Targetname}}
{{KV Targetname}}


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


== Outputs ==
== Outputs ==
{{O Targetname}}


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


{{wrongtitle|title=env_hudhint}}[[Category:GUI Entities]]
[[Category:GUI Entities]]

Revision as of 01:23, 17 June 2011

Template:Base point

Entity description

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

Keyvalues

Hint Text (localized) ([todo internal name (i)]) <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.pngWarning:If an unlocalized string (ex. "%+zoom% ZOOM VIEW" instead of "Valve_Hint_Zoom") 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
Shows the hint message.
HideHudHint
Hides the hint message.


Outputs

See also

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