Point worldtext: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
mNo edit summary
m (Added an image to show the fonts available in TF2)
Line 13: Line 13:
{{KV BaseEntity}}
{{KV BaseEntity}}
{{ScrollBox|title=Text Options|}}
{{ScrollBox|title=Text Options|}}
[[File:Point worldtext TF2 fonts.png|thumb|right|Available font varieties in TF2. With the exception of the two noted smaller typefaces, each entity is using the default size of 10.]]
{{KV|Entity Message|intn=message|string|Text that should be displayed. {{tf2}} Newlines can be inserted into the text via the newline character ''\n''.}}
{{KV|Entity Message|intn=message|string|Text that should be displayed. {{tf2}} Newlines can be inserted into the text via the newline character ''\n''.}}
{{KV|Text Size|intn=textsize|float|Size of the text.  Setting this to 0 will display nothing. Negative values will flip the text upside down.}}
{{KV|Text Size|intn=textsize|float|Size of the text.  Setting this to 0 will display nothing. Negative values will flip the text upside down.}}

Revision as of 10:46, 26 January 2023

Template:Entity It is also available in Team Fortress 2 Team Fortress 2.

Example text generated by two point_worldtext entities

It is an entity that displays a text message oriented in the world, at its origin.

Usage

Todo: Update this description for Team Fortress 2, which has a completely different implementation.

point_worldtext displays a specified text message in a set position in the world. It can be of any size and color, but the text outline cannot be changed. You can change the text message in-game by firing AddOutput with the parameter "message" and then the message you want to display. One downside of this text type is that it's stationary in the world and it is not part of the HUD, so you can't ensure that all players see it at all times. If you want to display important information that the player(s) must be constantly aware of, then it is better to use a game_text.

Tip.pngTip:The texture sheet has a bone icon assigned to the "~" character.
Note.pngNote: Text, size and color can be edited real time via AddOutput, making this entity very flexible and useful.

Keyvalues

Text Options:
Available font varieties in TF2. With the exception of the two noted smaller typefaces, each entity is using the default size of 10.
Entity Message (message) <string>
Text that should be displayed. Team Fortress 2 Newlines can be inserted into the text via the newline character \n.
Text Size (textsize) <float>
Size of the text. Setting this to 0 will display nothing. Negative values will flip the text upside down.
Color (color) <color255>
Color of the text. Team Fortress 2 Alpha is also parsed if R G B A format is specified. Otherwise, alpha defaults to 255.
Font (font) <material> (only in Portal 2: Community EditionTeam Fortress 2)
Path to the font material sheet
Todo: Add font gallery for Team Fortress 2. Accepts integer values 0 - 11
Orientation (orientation) <integer> (only in Team Fortress 2)
  • 0: stationary text
  • 1: always face the player.
  • 2: ignores pitch (looking up/down)
Warning.pngWarning:"stationary" text (aka orientation 0) is not centered at origin like other values. Instead, the first character in the message is printed at origin. This will cause your text to "shift" switching to/from 0
Text Spacing X (textspacingx) <float> (only in Team Fortress 2)
Spacing between each letter along the X axis. Negative values will invert the text.
Text Spacing Y (textspacingy) <float> (only in Team Fortress 2)
Spacing between each letter along the Y axis. Only used when newlines are inserted into the text.
Rainbow (rainbow) <boolean> (only in Team Fortress 2)
Enables rainbow text. Cannot be modified by color or SetColor inputs.

Flags

  • 1: Start Disabled
Note.pngNote:Team Fortress 2 Doesn't exist.
PlacementTip.pngWorkaround:Set the alpha to 0 via SetColor.

Inputs

point_worldtext:
Enable  (not in Team Fortress 2)
Start displaying the message text.
Disable  (not in Team Fortress 2)
Stop displaying the message text.
SetMessage <stringRedirectInput/string> (not in Team Fortress 2)
Set the message text.
Icon-Bug.pngBug:Does not work, use AddOutput Message <string> instead.  [todo tested in ?]
SetText <stringRedirectInput/string> (only in Team Fortress 2)
Set the message text.
SetTextSize <floatRedirectInput/float> (only in Team Fortress 2)
Set the message text size. Setting this to 0 will hide the text. Negative values will flip the text upside down.
SetTextSpacingX <floatRedirectInput/float> (only in Team Fortress 2)
Set the spacing between letters along the X axis. Negative values will invert the text.
SetTextSpacingY <floatRedirectInput/float> (only in Team Fortress 2)
Set the spacing between letters along the Y axis. Only used when newlines are inserted into the text.
SetColor <color255RedirectInput/color32> (only in Team Fortress 2)
Set the message color.
SetFont <integerRedirectInput/integer> (only in Team Fortress 2)
Set the message font. Accepts values 0 - 11
SetOrientation <integerRedirectInput/integer> (only in Team Fortress 2)
Set the message orientation
SetRainbow <integerRedirectInput/integer> (only in Team Fortress 2)
Enables Rainbow Text

Outputs

See also

  • point_message - A similar entity which displays a small custom message at a specific position in the game world.