env_instructor_hint
env_instructor_hint is a point entity available
with any version of Mapbase.An entity that allows for creation and control of instructor lessons by map logic
KeyValues
- Replace Key (hint_replace_key) <string>
Hints with the same Replace Key will replace each other when displayed at the same time. Use different values for each hint if you would like to have multiple hints displaying at once.
Hints with the same Replace Key will replace each other when displayed at the same time. Use different values for each hint if you would like to have multiple hints displaying at once.
- Target Entity (hint_target) <target_destination>
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 (hint_static) <choices>
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 (hint_allow_nodraw_target) <choices>
Do we allow the hint to follow entites with nodraw set?
Do we allow the hint to follow entites with nodraw set?
- Caption (hint_caption) <string>
The text of your hint.
The text of your hint.
- Activator Caption (hint_activator_caption) <string>
The text of your hint shown to only the activating player.
The text of your hint shown to only the activating player.
- Caption Color (hint_color) <color255>
The color of the caption text
The color of the caption text
- Force caption (hint_forcecaption) <choices>
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 (hint_icon_onscreen) <choices>
The icon to use when the hint is within the player's view.
The icon to use when the hint is within the player's view.
- Offscreen Icon (hint_icon_offscreen) <choices>
The icon to use when the hint is outside the player's view.
The icon to use when the hint is outside the player's view.
- Show offscreen (hint_nooffscreen) <choices>
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 (hint_binding) <string>
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 (hint_icon_offset) <float>
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 (hint_pulseoption) <choices>
The icon size can pulsate
The icon size can pulsate
- Alpha Pulsing (hint_alphaoption) <choices>
The icon alpha can pulsate
The icon alpha can pulsate
- Shaking (hint_shakeoption) <choices>
The icon can shake
The icon can shake
- Only Local Player (hint_local_player_only) <choices>
The hint will only be shown to the local player.
The hint will only be shown to the local player.
- Timeout (hint_timeout) <integer>
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 (hint_range) <float>
The visible range of the hint.
The visible range of the hint.
- Sound (hint_start_sound) <sound>
The sound to play when the hint is first displayed.
The sound to play when the hint is first displayed.
- Icon Target Position (hint_target_pos) <choices>
Controls where the hint should appear on the icon target.
Controls where the hint should appear on the icon target.
Inputs
- ShowHint
<string>
Start showing the hint. If an entity name is passed as a parameter, the hint is shown only to that entity.
Start showing the hint. If an entity name is passed as a parameter, the hint is shown only to that entity.
- EndHint
<void>
Stop showing the hint if it hasn't already timed out.
Stop showing the hint if it hasn't already timed out.
- SetCaption
<string>
Sets the hint's caption. Does not update hints in progress.
Sets the hint's caption. Does not update hints in progress.