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
(raw; needs cleanup)
 
 
(66 intermediate revisions by 39 users not shown)
Line 1: Line 1:
{{cleanup}}
{{LanguageBar}}
env_hudhint
{{CD|CEnvHudHint}}
{{This is a|logical entity|name=env_hudhint|sprite=1}} {{gmod|not}}


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.
__NOTOC__
It is used to control the display of HUD hints, which show the player what key is bound to a particular command.


KEYS
{{note|In {{l4d|4}} and later, the message will only show to the !activator unless it's singleplayer.}}


Name targetname <target_source> The name that other entities refer to this entity by.
[[File:Hudhint.png|right]]


Hint Text (localized) message <string> This should be set to match the desired HUD hint entry in the hl2lesourceUalve_english.txt.
== Flags ==
{{fl|1|All Players {{removed|{{l4d}}}}|Show the message to everyone on the server (otherwise show to !activator only)}}


== 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.


INPUTS
{{warning|Entering raw text will not allow the message to be translated between user languages.}}
{{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.}}}}


Kill Removes this entity from the world.


KillHierarchy Removes this entity and all its children from the world.
== Inputs ==
{{I|ShowHudHint|Shows the hint message.}}
{{I|HideHudHint|Hides the hint message.}}


AddOutput <string> Adds an entity I/O connection to this entity. Format: <output name> <targetname>:<inputname>:<parameter>:<delay>:<max times to fire (-1 == infinite)>. Very dangerous, use with care.
==Dedicated Console Variables==
{{varcom|start}}
{{varcom|cl_hudhint_sound|1|[[Bool]]|Enable\disable the sound when HUD hint displays.
{{confirm|Works only in {{bms|4}} ?}}
}}
{{varcom|end}}


FireUser1 Causes this entity's OnUser1 output to be fired.
== External links ==
'''Map example .VMF, .BSP and with scripts fix'''
* http://gtamike.tsgk.com/gtamike_TSGK/test_area_hudhint.rar


FireUser2 Causes this entity's OnUser2 output to be fired.
== See also ==
 
* {{ent|env_message}} - A similar entity that displays other predefined messages on the screen.
FireUser3 Causes this entity's OnUser3 output to be fired.
* {{ent|env_instructor_hint}} - Another similar entity used in {{l4d2|4}} and newer games.
 
FireUser4 Causes this entity's OnUser4 output to be fired.
 
ShowHudHint Shows the hint message.
 
 
OUTPUTS
 
OnUser1 Fired in response to FireUser1 input.
 
OnUser2 Fired in response to FireUser2 input.
 
OnUser3 Fired in response to FireUser3 input.
 
OnUser4 Fired in response to FireUser4 input.

Latest revision as of 05:23, 29 August 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.

Dedicated Console Variables

Cvar/Command Parameters or default value Descriptor Effect
cl_hudhint_sound 1 Bool Enable\disable the sound when HUD hint displays.
Confirm:Works only in Black Mesa Black Mesa ?

External links

Map example .VMF, .BSP and with scripts fix

See also