Game text tf: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
mNo edit summary
(Updated the entity description.)
Line 1: Line 1:
{{tf2 point|game_text_tf}}
{{tf2 point|game_text_tf}} Similar to [[game_text]], it is an entity that displays text on players' screens. The text is displayed in a colored box with an optional image texture next to it. This text can be defined directly in the Hammer editor. This entity is suitable for stand alone bsp maps, if they are not to be [[VGUI_Documentation#Localization|localized]].
 
==Entity description==
[[File:Game text.png|left]]An entity that displays text on players' screens. This text can be defined directly in the Hammer editor (unlike the similar [[env_message]] entity). This entity is suitable for stand alone bsp maps, if they are not to be [[VGUI_Documentation#Localization|localized]].
 
{{Warning|Don't use quotation characters (") in the ''Text Message'' field (not even <code>\"</code> characters). It will cause fatal errors with opening and/or compiling your map and may need to be fixed by manually editing the [[VMF]] in a [[text editor]]. Instead, you use detailed quotes (i.e. <tt>&ldquo;</tt> and <tt>&rdquo;</tt>).}}
{{Warning|Don't use quotation characters (") in the ''Text Message'' field (not even <code>\"</code> characters). It will cause fatal errors with opening and/or compiling your map and may need to be fixed by manually editing the [[VMF]] in a [[text editor]]. Instead, you use detailed quotes (i.e. <tt>&ldquo;</tt> and <tt>&rdquo;</tt>).}}
{{clr}}
{{clr}}
{{Note|This entity will not display when using the TF2 minimal HUD.}}
{{Warning|This entity will not display when using the TF2 minimal HUD. Use either a [[game_text]] or an [[env_screenoverlay]] entity if you have vital information to display.}}


==Keyvalues==
==Keyvalues==

Revision as of 04:51, 3 October 2019

Team Fortress 2 game_text_tf is a point entity available in Team Fortress 2 Team Fortress 2. Similar to game_text, it is an entity that displays text on players' screens. The text is displayed in a colored box with an optional image texture next to it. This text can be defined directly in the Hammer editor. This entity is suitable for stand alone bsp maps, if they are not to be localized.

Warning.pngWarning:Don't use quotation characters (") in the Text Message field (not even \" characters). It will cause fatal errors with opening and/or compiling your map and may need to be fixed by manually editing the VMF in a text editor. Instead, you use detailed quotes (i.e. and ).
Warning.pngWarning:This entity will not display when using the TF2 minimal HUD. Use either a game_text or an env_screenoverlay entity if you have vital information to display.

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

Message Text ([todo internal name (i)]) <string>
Message to display onscreen.
Icon ([todo internal name (i)]) <string>
Hud icon ( from mod_textures.res ) to display.
Audience ([todo internal name (i)]) <choices>
Filters which team(s) will see this message.
  • 0 : Everyone
  • 2 : Red Team Only
  • 3 : Blue Team Only
Background Panel Color ([todo internal name (i)]) <choices>
Color of the text panel.
  • 0 : Grey
  • 2 : Red
  • 3 : Blue

Inputs

Display
Display the message text.

Outputs