This article's documentation is for anything that uses the Source engine. Click here for more information.

Env hudhint: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (→‎Inputs: Substituted IO templates)
No edit summary
Line 1: Line 1:
{{LanguageBar}}
{{LanguageBar}}
{{this is a|point entity|name=env_hudhint}}  
{{CD|CEnvHudHint}}
{{This is a|logical entity|name=env_hudhint|sprite=1}} {{gmod|not}}


{{infotable
|env_hudhint
|img=[[File:Env hudhint.png]]
|type=e0
|engine=2
|in=0
}}
{{CD|CEnvHudHint}}
__NOTOC__
__NOTOC__
It is used to control the display of HUD hints, which show the player what key is bound to a particular command.
It is used to control the display of HUD hints, which show the player what key is bound to a particular command.


{{note|In {{l4d|4}} and later, the message will only show to the !activator unless it's singleplayer.}}
{{note|In {{l4d|4}} and later, the message will only show to the !activator unless it's singleplayer.}}
{{note|In {{gmod|4}} env_hudhint is removed.}}
 
[[File:Hudhint.png|right]]
[[File:Hudhint.png|right]]


==Flags==
== Flags ==
{{fl|1|All Players {{removed|{{l4d}}}}|Show the message to everyone on the server (otherwise show to !activator only)}}
{{fl|1|All Players {{removed|{{l4d}}}}|Show the message to everyone on the server (otherwise show to !activator only)}}


==Keyvalues==
== Keyvalues ==
{{KV Targetname}}
{{KV|Hint Text (localized)|intn=message|string|This should be match a HUD hint entry in <code>hl2\resource\[[valve_english.txt]]</code> or its localized equivalent. Example: entering "<code>#Valve_Hint_Zoom</code>" (without the quotation marks) will display the following hint text: "%+zoom% ZOOM VIEW", with %+zoom% being the key currently bound to the zoom function.
{{KV|Hint Text (localized)|intn=message|string|This should be match a HUD hint entry in <code>hl2\resource\[[valve_english.txt]]</code> or its localized equivalent. Example: entering "<code>#Valve_Hint_Zoom</code>" (without the quotation marks) will display the following hint text: "%+zoom% ZOOM VIEW", with %+zoom% being the key currently bound to the zoom function.


Line 27: Line 20:
{{note|In {{tf2}} and potentially other games, the % character interacts differently with text.  Displaying keybinds found in the resource folder may force any text after the % character to display on a new line.}}}}
{{note|In {{tf2}} and potentially other games, the % character interacts differently with text.  Displaying keybinds found in the resource folder may force any text after the % character to display on a new line.}}}}


{{KV Targetname}}


==Inputs==
== Inputs ==
{{I|ShowHudHint|Shows the hint message.}}
{{I|ShowHudHint|Shows the hint message.}}
{{I|HideHudHint|Hides the hint message.}}
{{I|HideHudHint|Hides the hint message.}}


==See also==
== See also ==
*{{ent|env_message}} - A similar entity that displays other predefined messages on the screen.
* {{ent|env_message}} - A similar entity that displays other predefined messages on the screen.
*{{ent|env_instructor_hint}} - Another similar entity used in {{l4d2|4}} and newer games.
* {{ent|env_instructor_hint}} - Another similar entity used in {{l4d2|4}} and newer games.
[[Category:GUI Entities]]

Revision as of 04:25, 29 April 2025

English (en)中文 (zh)Translate (Translate)
C++ Class hierarchy
CEnvHudHint
CPointEntity
CBaseEntity
Env hudhint.png

env_hudhint is a logical entity available in all Source Source games. (not in Garry's Mod)


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

Note.pngNote:In Left 4 Dead Left 4 Dead and later, the message will only show to the !activator unless it's singleplayer.
Hudhint.png

Flags

All Players (removed since Left 4 Dead) : [1]
Show the message to everyone on the server (otherwise show to !activator only)

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) (message) <string>
This should be match a HUD hint entry in hl2\resource\valve_english.txt or its localized equivalent. Example: entering "#Valve_Hint_Zoom" (without the quotation marks) will display the following hint text: "%+zoom% ZOOM VIEW", with %+zoom% being the key currently bound to the zoom function.
Warning.pngWarning:Entering raw text will not allow the message to be translated between user languages.
Note.pngNote:In Team Fortress 2 and potentially other games, the % character interacts differently with text. Displaying keybinds found in the resource folder may force any text after the % character to display on a new line.


Inputs

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

See also