Game text: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(Don't fall into the trap I fell in.)
Line 4: Line 4:
[[Image:Game text.png|left]]An entity that displays text on player's screens. This text can be defined directly in the Hammer editor (unlike the similar [[env_message]] entity).
[[Image:Game text.png|left]]An entity that displays text on player's screens. This text can be defined directly in the Hammer editor (unlike the similar [[env_message]] entity).


{{Warning|Do not use quotation characters (") in the ''Text Message'' field in any way. (Not even ''\"'' characters.) These characters will cause the map compiler/loader to misinterpret the character as a termination of the ''Text Message'' argument, will fail to interpret the rest of the VMF file, and will give you the "line <line number>: unexpected symbol '<symbol>'" error. Instead of quotation marks, you can use single or double apostrophe characters "'". (Valve used single apostrophes.)}}
{{Warning|Do not use quotation characters (") in the ''Text Message'' field in any way. (Not even ''\"'' characters.) These characters will cause the map compiler/loader to misinterpret the character as a termination of the ''Text Message'' argument, will fail to interpret the rest of the VMF file, and will give you the "line <line number>: unexpected symbol '<symbol>'" error. Instead of quotation marks, you can use single or double apostrophe characters "'". (Valve used single apostrophes.) It is also possible to use [[VGUI_Documentation#Localization|localized strings]] or titles.}}


{{clr}}
{{clr}}

Revision as of 12:55, 10 September 2006

Template:Wrongtitle

Entity Description

Game text.png

An entity that displays text on player's screens. This text can be defined directly in the Hammer editor (unlike the similar env_message entity).

Warning.pngWarning:Do not use quotation characters (") in the Text Message field in any way. (Not even \" characters.) These characters will cause the map compiler/loader to misinterpret the character as a termination of the Text Message argument, will fail to interpret the rest of the VMF file, and will give you the "line <line number>: unexpected symbol '<symbol>'" error. Instead of quotation marks, you can use single or double apostrophe characters "'". (Valve used single apostrophes.) It is also possible to use localized strings or titles.

Availability

Template:In game Template:Game-base Template:In code

Keyvalues

<target_destination> Legacy support: The name of a master entity. If the master hasn't been activated, this entity will not activate.
  • message
<string> Message to display onscreen. \n signifies a new line in the text.
  • x
<float> Horizontal position on the player's screens to draw the text. The value should be between 0 and 1, where 0 is the far left of the screen and 1 is the far right. -1 centers the text.
  • y
<float> Vertical position on the player's screens to draw the text. The value should be between 0 and 1, where 0 is the top of the screen and 1 is the bottom. -1 centers the text.
  • effect
<choices> Text Effect.
Literal value Description
0 Fade In/Out
1 Credits
2 Scan Out
  • color
<color255> Color1.
  • color2
<color255> Color2.
  • fadein
<float> The time it should take for the text to fully fade in.
  • fadeout
<float> The time it should take for the text to fade out, after the hold time has expired.
  • holdtime
<float> The time the text should stay onscreen, after fading in, before it begins to fade out.
  • fxtime
<float> If the 'Text Effect' is set to Scan Out, this is the time it should take to scan out all the letters in the text.
  • channel
<choices> Text Channel. You can have up to four individual game_text messages onscreen at once, stored in channels. Select which channel this text should be placed in, which will overwrite any active message already in that channel.
Literal value Description
0 Channel 0
1 Channel 1
2 Channel 2
3 Channel 3
4 Channel 4
5 Channel 5

Flags

  • 1 : All Players

Inputs

Display the message text.

Outputs

Also See

  • env_message - A similar entity that displays already defined messages from titles.txt.
  • point_message - A similar entity that displays a small custom message at a specific position in the game world.