Env instructor hint: Difference between revisions
Jump to navigation
Jump to search
Note:env_instructor_hint currently cannot display more than one hint at the same time.
ThaiGrocer (talk | contribs) m (→Keyvalues) |
ThaiGrocer (talk | contribs) m (→Keyvalues) |
||
Line 6: | Line 6: | ||
==Keyvalues== | ==Keyvalues== | ||
;Name | |||
:The name that other entities refer to this entity by. | |||
;Target Entity | |||
; | |||
:The entity to show this hint on top of. The entity used must exist on the client, info_target_instructor_hint can be parented to server only entities for this purpose. | :The entity to show this hint on top of. The entity used must exist on the client, info_target_instructor_hint can be parented to server only entities for this purpose. | ||
;Positioning | |||
; | |||
:Either show at the position of the Target Entity. Or show the hint directly on the hud at a fixed position. | :Either show at the position of the Target Entity. Or show the hint directly on the hud at a fixed position. | ||
;Allow invisible target | |||
; | |||
:Do we allow the hint to follow entites with nodraw set? | :Do we allow the hint to follow entites with nodraw set? | ||
;Caption | |||
; | |||
:The text of your hint. | :The text of your hint. | ||
;Caption Color | |||
; | |||
:The color of the caption text | :The color of the caption text | ||
;Force caption | |||
; | |||
:Do we show the caption text even if the hint is occluded by a wall? | :Do we show the caption text even if the hint is occluded by a wall? | ||
;Onscreen Icon <code><choices></code> | |||
; | |||
:The [[env_instructor_hint#Icons|icon]] to use when the hint is within the player's view. | :The [[env_instructor_hint#Icons|icon]] to use when the hint is within the player's view. | ||
;Offscreen Icon <code><choices></code> | |||
; | |||
:The [[env_instructor_hint#Icons|icon]] to use when the hint is outside the player's view. | :The [[env_instructor_hint#Icons|icon]] to use when the hint is outside the player's view. | ||
;Show offsreen | |||
; | |||
:When the hint is offscreen, do we show an icon and arrow? | :When the hint is offscreen, do we show an icon and arrow? | ||
;Bound Command | |||
; | |||
:If using 'show key bindings' for the onscreen icon, this field should be the command we want to show bindings for | :If using 'show key bindings' for the onscreen icon, this field should be the command we want to show bindings for | ||
;Icon Height Offset | |||
; | |||
:A height offset from the target entity's origin to display the hint | :A height offset from the target entity's origin to display the hint | ||
;Size Pulsing | |||
; | |||
:The icon size can pulsate | :The icon size can pulsate | ||
;Alpha Pulsing | |||
; | |||
:The icon alpha can pulsate | :The icon alpha can pulsate | ||
;Shaking | |||
; | |||
:The icon can shake | :The icon can shake | ||
;Timeout | |||
; | |||
:The automatic timeout for the hint. 0 will persist until stopped with EndHint. | :The automatic timeout for the hint. 0 will persist until stopped with EndHint. | ||
;Display Range | |||
; | |||
:The visible range of the hint. 0 will show it at any distance. | :The visible range of the hint. 0 will show it at any distance. | ||
;Show on First Sight | |||
; | |||
:When the player first sees it, it will automatically show for them. | :When the player first sees it, it will automatically show for them. | ||
Revision as of 20:30, 12 January 2010
Entity Description

Keyvalues
- Name
- The name that other entities refer to this entity by.
- Target Entity
- The entity to show this hint on top of. The entity used must exist on the client, info_target_instructor_hint can be parented to server only entities for this purpose.
- Positioning
- Either show at the position of the Target Entity. Or show the hint directly on the hud at a fixed position.
- Allow invisible target
- Do we allow the hint to follow entites with nodraw set?
- Caption
- The text of your hint.
- Caption Color
- The color of the caption text
- Force caption
- Do we show the caption text even if the hint is occluded by a wall?
- Onscreen Icon
<choices>
- The icon to use when the hint is within the player's view.
- Offscreen Icon
<choices>
- The icon to use when the hint is outside the player's view.
- Show offsreen
- When the hint is offscreen, do we show an icon and arrow?
- Bound Command
- If using 'show key bindings' for the onscreen icon, this field should be the command we want to show bindings for
- Icon Height Offset
- A height offset from the target entity's origin to display the hint
- Size Pulsing
- The icon size can pulsate
- Alpha Pulsing
- The icon alpha can pulsate
- Shaking
- The icon can shake
- Timeout
- The automatic timeout for the hint. 0 will persist until stopped with EndHint.
- Display Range
- The visible range of the hint. 0 will show it at any distance.
- Show on First Sight
- When the player first sees it, it will automatically show for them.
Icons
show key bindings
This is a special icon that requires setting entity property Bound Command. The following example sets Bound Command to "jump" (without quotations) with Caption set to "Bet you can't jump over me!" (without quotations).
In this case, "+jump" is bound to "SPACE", the space bar on the keyboard. More commands can be found in the Left 4 Dead 2 cfg folder. Open config.cfg in a text editor to review which commands are currently bound to the client.
Flags
There are currently no flags.