training_annotation
Class hierarchy |
---|
CTrainingAnnotation |
entity_training_annotations.cpp
|
training_annotation
is a point entity available in Team Fortress 2.
An in-world location-specific information bubble that displays for all players.
Note:VScript offers a more powerful version of this entity, that allows per-player filtering and showing special effects. Use the SendGlobalGameEvent function with the show_annotation event.
Keyvalues
- Name
(targetname)
<string> - The name that other entities refer to this entity by, via Inputs/Outputs or other keyvalues (e.g.
parentname
ortarget
).
Also displayed in Hammer's 2D views and Entity Report.See also: Generic Keyvalues, Inputs and Outputs available to all entities
- Displayed text
(display_text)
<string> - The text to be displayed in the annotation popup.
- Lifetime
(lifetime)
<float> - How long you want the annotation popup to stick around. If set to 0, it will default to the value in code (1 sec). If it set to -1, it will last forever.
Note:The fade-in effect when an annotation is shown does not work unless lifetime is set to -1
- Vertical offset
(offset)
<float> - The vertical offset.
Inputs
Show
- Shows the annotation bubble.Bug*:Showing an annotation will print an error to console mentioning a missing sound file, the file path cannot be modified.
Hide
- Hides the annotation bubble.Warning:Hide does not work in multiplayer! Use the lifetime keyvalue if you want to use this entity outside of training mode.