Difference between revisions of "Env hudhint"

From Valve Developer Community
Jump to: navigation, search
(raw; needs cleanup)
 
(bot-assisted cleanup)
Line 1: Line 1:
{{cleanup}}
+
{{wrongtitle|title=env_hudhint}}
env_hudhint
 
  
 +
==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.
 
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.
  
KEYS
+
==Availability==
 +
{{in game|point}} {{game-base}}
 +
{{in code|class=CEnvHudHint|file=EnvHudHint.cpp}}
  
Name targetname <target_source> The name that other entities refer to this entity by.
+
==Keyvalues==
 +
*{{kv Targetname}}
 +
*'''message'''
 +
:<string> This should be set to match the desired HUD hint entry in the <code>hl2\resource\valve_english.txt</code>.
  
Hint Text (localized) message <string> This should be set to match the desired HUD hint entry in the hl2lesourceUalve_english.txt.
+
==Inputs==
 +
*{{i Targetname}}
 +
*'''ShowHudHint'''
 +
:Shows the hint message.
  
 +
==Outputs==
 +
*{{o Targetname}}
  
INPUTS
+
[[Category:Entities]]
 
 
Kill Removes this entity from the world.
 
 
 
KillHierarchy Removes this entity and all its children from the world.
 
 
 
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.
 
 
 
FireUser1 Causes this entity's OnUser1 output to be fired.
 
 
 
FireUser2 Causes this entity's OnUser2 output to be fired.
 
 
 
FireUser3 Causes this entity's OnUser3 output to be fired.
 
 
 
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.
 

Revision as of 19:24, 7 October 2005

Template:Wrongtitle

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.

Availability

Template:In game Template:Game-base In code it is represented by class [1], defined in [2].

Keyvalues

<string> This should be set to match the desired HUD hint entry in the hl2\resource\valve_english.txt.

Inputs

Targetname:

Kill
Removes this entity from the world.
KillHierarchy
Removes this entity and its children from the world.
Note.png Note: Entities already remove orphaned children upon being removed, but this input removes all children on the same frame, being marginally faster than Kill.
AddOutput <string>
Adds a keyvalue/output to this entity. It can be potentially very dangerous, use with care.
KV Format: <key> <value>
I/O Format: <output name> <targetname>:<inputname>:<parameter>:<delay>:<max times to fire, -1 means infinite>
FireUser1 to FireUser4
Fire the OnUser outputs; see User Inputs and Outputs.
Use  !FGD
Same as a player invoking +use; may not do anything depending on the entity. Can also be invoked by firing an output that does not specify an input.
RunScriptFile <script> (in all games since <Left 4 Dead 2>)
Execute a VScript file from disk, without file extension. The script contents are merged with the script scope of the receiving entity.
RunScriptCode <string> (in all games since <Left 4 Dead 2>)
Execute a string of VScript source code in the scope of the entity receiving the input. String quotation may be needed when fired via console.
Bug.png Bug: In <Left 4 Dead 2>, the code is executed in the script scope of the entity that fires the output, not the one receiving the input.
Warning.png Warning: Never try to pass string parameters to a script function with this input. It will corrupt the VMF structure because of the nested quotation marks, which then must be removed manually with a text editor.
CallScriptFunction <string> (in all games since <Left 4 Dead 2>) !FGD
Execute a VScript function in the scope of the receiving entity.
SetLocalOrigin <coordinates> (in all games since <Alien Swarm>) !FGD
Send this entity to a spot in the map. If the entity is parented to something, it will be offset from the parent by this amount.
SetLocalAngles <angles> (in all games since <Alien Swarm>) !FGD
Set this entity's angles.
  • ShowHudHint
Shows the hint message.

Outputs

Targetname:

OnUser1 to OnUser4
These outputs each fire in response to the firing of the like-numbered FireUser1 to FireUser4 Input; see User Inputs and Outputs.
OnKilled  (only in <Left 4 Dead><Left 4 Dead 2>)
This output fires when the entity is killed and removed from the game.