Env hudhint

From Valve Developer Community
Revision as of 03:42, 20 July 2009 by Fitzroy doll (talk | contribs) (Switching entry keyvalues to SmartEdit text from actual keyvalue.)
Jump to navigation Jump to search

Template:Wrongtitle Template:Base point

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 "Hint Text (localized)".

Availability

Template:In game Template:Game-base In code it is represented by class CEnvHudHint, defined in EnvHudHint.cpp.

Keyvalues

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

  • Hint Text (localized)
<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 or its localized equivalent.

Inputs

  • ShowHudHint
Shows the hint message.
  • HideHudHint (in all games since Half-Life 2: Episode One)
Hides the hint message.

Outputs

See also

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