point_worldtext

This entity is not in the FGD by default.
See below for instructions on making it available.

point_worldtext is a point entity available in all Source games since Counter-Strike: Global Offensive.

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 , 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:The texture sheet has a bone icon assigned to the "~" character.

Note: Text, size and color can be edited real time via AddOutput, making this entity very flexible and useful.

FGD Code

@PointClass base(Targetname, Parentname, Angles) worldtext() = point_worldtext : 
    "An entity that displays a text message oriented in the world, at its origin."
[
    message(string) : "Entity Message" : "" : "Text Message. Newline characters are accepted"
    textsize(float) : "Text Size" : 10 : "Text Size."
    textspacingX(float) : "Text Spacing X" : 0 : "Spacing between each letter along X axis"
    textspacingY(float) : "Text Spacing Y" : 0 : "Spacing between each letter along Y axis"
    color(color255) : "Color" : "255 255 255 255"
    font(choices) : "Font" : "0" =
    [
        0: "TF2 Build"
        1: "TF2 Build (no outline/shadow)"
        2: "TF2"
        3: "TF2 (no outline/shadow)"
        4: "Liberation Sans"
        5: "Liberation Sans (no outline/shadow)"
        6: "TF2 Professor"
        7: "TF2 Professor (no outline/shadow)"
        8: "Roboto Mono"
        9: "Roboto Mono (no outline/shadow)"
        10: "Roboto Mono (shadow only)"
        11: "Roboto Mono (green glow, soft edges)"
        12: "TF2 Build (soft edges)"
    ]
    orientation(choices) : "Orientation" : "0" =
    [
        0: "Stationary"
        1: "Face player"
        2: "Ignore pitch"
    ]
    rainbow(choices) : "Rainbow" : 0 =
    [
        0 : "No"
        1 : "Yes"
    ]

    // Inputs
    input SetText(string) : "Set the message text."
    input SetTextSize(float) : "Set the message text size."
    input SetTextSpacingX(float) : "Set the spacing between letters along the X axis."
    input SetTextSpacingY(float) : "Set the spacing between letters along the Y axis."
    input SetColor(string) : "Set the message color."
    input SetFont(integer) : "Set the font."
    input SetOrientation(integer) : "Set the orientation."
    input SetRainbow(integer) : "Enable rainbow text."
]

Keyvalues

Name (targetname) <string>

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

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. Newlines can be inserted into the text via the newline character \n, but Hammer will automatically change this to /n, so this is only possible through other means such as VScript or through Hammer++.

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. Alpha is also parsed if R G B A format is specified. Otherwise, alpha defaults to 255.

Font (font) <material> (only in )

Path to the font material sheet

Font (font) <integer> (only in )

Selects from a preset list of fonts:

• 0: TF2 Build
• 1: TF2 Build (no outline/shadow)
• 2: TF2
• 3: TF2 (no outline/shadow)
• 4: Liberation Sans
• 5: Liberation Sans (no outline/shadow)
• 6: TF2 Professor
• 7: TF2 Professor (no outline/shadow)
• 8: Roboto Mono
• 9: Roboto Mono (no outline/shadow)
• 10: Roboto Mono (shadow only)
• 11: Roboto Mono (green glow, soft edges)
• 12: TF2 Build (soft edges)

Higher values will repeat font 12 indefinitely.

Todo: Add font 12 to the gallery image.

Orientation (orientation) <integer> (only in )

• 0: stationary text
• 1: always face the player.
• 2: ignores pitch (looking up/down)

Warning:Stationary text (aka orientation 0) is left aligned relative to the origin, while the rotating modes are center aligned. This will cause your text to "shift" if switching to/from 0.

Text Spacing X (textspacingx) <float> (only in )

Spacing between each letter along the X axis. Negative values will invert the text.

Text Spacing Y (textspacingy) <float> (only in )

Spacing between each letter along the Y axis. Only used when newlines are inserted into the text.

Rainbow (rainbow) <boolean> (only in )

Enables rainbow text, overriding the color keyvalue and SetColor input.

Flags

• 1: Start Disabled (not in )

Workaround:Set the alpha to 0 via SetColor.

Inputs

Enable  (not in )

Start displaying the message text.

Disable  (not in )

Stop displaying the message text.

SetMessage <string> (not in )

Set the message text.

Bug:Does not work, use AddOutput Message <string> instead.

Note:This input does work as intended in Jabroni Brawl: Episode 3

  [todo tested in?]

SetText <string> (only in )

Set the message text.

SetTextSize <float> (only in )

Set the message text size. Setting this to 0 will hide the text. Negative values will flip the text upside down.

SetTextSpacingX <float> (only in )

Set the spacing between letters along the X axis. Negative values will invert the text.

SetTextSpacingY <float> (only in )

Set the spacing between letters along the Y axis. Only used when newlines are inserted into the text.

SetColor <color255> (only in )

Set the message color.

SetFont <integer> (only in )

Set the message font. Accepts values 0 - 11

SetOrientation <integer> (only in )

Set the message orientation

SetRainbow <integer> (only in )

Enables Rainbow Text

See also

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