Point worldtext: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(Fixed keyvalues, inputs and cleaned up the page.)
Line 1: Line 1:
{{cleanup}}
{{csgo point | point_worldtext}}
{{csgo point | point_worldtext}}
It displays text in the world. This text can be defined directly in the Hammer editor.
An entity that displays a text message oriented in the world, at its origin.
 
== Usage ==
== Usage ==
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]].
'''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]].


== Keyvalues ==
== Keyvalues ==
{{KV|Message Text|string|Message to display in the world.
:{| class=standard-table
! Literal value || Effect || Description
|-
| 0 || Fade In/Out || The whole text is faded in, and then faded out.
|-
| 1 || Credits || {{todo|Unknown - seems to act like Fade In/Out. Provide description.}}
|-
| 2 || Scan Out || The text is scanned in letter by letter, and the whole text is then faded out.
|}
{{KV|Color1|color255|The primary color used by all the text effects. {{note|The color values seem to be added to the background, so either a bright white background or black text will cause the message to be invisible.}} {{note|This keyvalue will default to black for entities not created in Hammer.}} }}
{{KV|Color2|color255|The scanning color for the letter being scanned if the ''Text Effect'' keyvalue is set to ''Scan Out'' - usually a different shade of Color1.}}
{{KV|Fade in Time (or character scan time)|string|The time it should take for the text to fully fade in.}}
{{KV|Fade Out Time|string|The time it should take for the text to fade out, after the hold time has expired.}}
{{KV|Hold Time|string|The time the text should stay onscreen, after fading in, before it begins to fade out.{{note|This value defaults to zero for entities not created in Hammer.}}}}
{{KV|Scan time (scan effect only)|string|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.}}
{{KV Targetname}}
{{KV Targetname}}
{{KV Parentname}}
{{KV Angles}}
{{ScrollBox|title=Text Options|}}
{{KV|Entity Message (message)|string|Text that should be displayed.}}
{{KV|Text Size (textsize)|float|Size of the text.}}
{{KV|Color|Color255|Color of the text.}}


== Flags ==
== Flags ==
* : start disabled
*1: Start Disabled


== Inputs ==
== Inputs ==
{{I Targetname}}
{{I Targetname}}
{{ScrollBox|title=point_worldtext|}}
{{IO|Enable|Start displaying the message text.}}
{{IO|Disable|Stop displaying the message text.}}
{{IO|SetMessage|Stop displaying the message text.|param=string}}
{{note|Might not work, use '''<code>[[AddOutput]] Message <string></code>''' instead.}}


== Outputs ==
== Outputs ==

Revision as of 09:48, 31 January 2019

point_worldtext is a point entity available in Counter-Strike: Global Offensive Counter-Strike: Global Offensive. An entity that displays a text message oriented in the world, at its origin.

Usage

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.

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

Parentname:
Parent (parentname) <targetname>
Specifies a movement parent. An entity will maintain its initial offset from its parent. An attachment point can be added to the end of the name, separated by a comma.
Pitch Yaw Roll (Y Z X) (angles) <QAngle>
This entity's orientation in the world. Pitch is rotation around the Y axis, yaw is the rotation around the Z axis, roll is the rotation around the X axis.
Text Options:
Entity Message (message) ([todo internal name (i)]) <string>
Text that should be displayed.
Text Size (textsize) ([todo internal name (i)]) <float>
Size of the text.
Color ([todo internal name (i)]) <color255>
Color of the text.

Flags

  • 1: Start Disabled

Inputs

point_worldtext:
Enable
Start displaying the message text.
Disable
Stop displaying the message text.
SetMessage <stringRedirectInput/string>
Stop displaying the message text.
Note.pngNote:Might not work, use AddOutput Message <string> instead.

Outputs

See also

  • point_message - A similar entity that displays a small custom message at a specific position in the game world.
Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Point_worldtext&oldid=222826"