Point message: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (Robot: fixing template case.)
(Cleanup)
Line 1: Line 1:
{{wrongtitle|title=point_message}}
[[File:point_message.png|left|link=]]
{{base_point}}[[Category:GUI Entities]]


==Entity Description==
{{base point|point_message}} It displays a text message in the world, at its origin.
[[Image:{{PAGENAME}}.png|left]]An entity that displays a text message in the world, at its origin.
 
* See also [[game_text]] - A similar entity that displays a custom message directly on the player screen.
{{in code|class=class_c_message_entity.html CMessageEntity|file=message__entity_8cpp-source.html message_entity.cpp}}
{{clr}}
{{clr}}
{{in code|class=class_c_message_entity.html CMessageEntity|file=message__entity_8cpp-source.html message_entity.cpp}}


==Keyvalues==
== Keyvalues ==
*{{KV Targetname}}
{{KV|Entity Message|string|Message to show at this point.}}
*{{KV Parentname}}
{{KV|Show message radius|integer|Distance the player must be within to see this message.}}
*'''message'''
{{KV|Developer Only?|boolean|If set, this message will only be visible when developer mode is on.}}
: <string> Message to show at this point
{{KV Targetname}}
* '''radius'''
{{KV Parentname}}
: <integer> Distance the player must be within to see this message.
 
*'''developeronly'''
== Flags ==
: {{boolean}} If set, this message will only be visible when developer mode is on.
* 1 : Start Disabled
 
== Inputs ==
{{IO|Enable|Start displaying the message text, if the player is within the message radius.}}
{{IO|Disable|Stop displaying the message text.}}
{{I Targetname}}
{{I Parentname}}


==Flags==
== Outputs ==
*1 : Start Disabled
{{O Targetname}}


==Inputs==
== See also ==
*{{i Targetname}}
* [[game_text]] - A similar entity that displays a custom message directly on the player screen.
*{{i Parentname}}
*'''Enable'''
:Start displaying the message text, if the player is within the message radius.
*'''Disable'''
:Stop displaying the message text.


==Outputs==
[[Category:GUI Entities]]
*{{o Targetname}}

Revision as of 05:14, 28 July 2011

Point message.png

Template:Base point It displays a text message in the world, at its origin.

Template:In code

Keyvalues

Entity Message ([todo internal name (i)]) <string>
Message to show at this point.
Show message radius ([todo internal name (i)]) <integer>
Distance the player must be within to see this message.
Developer Only? ([todo internal name (i)]) <boolean>
If set, this message will only be visible when developer mode is on.
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.

Flags

  • 1 : Start Disabled

Inputs

Enable
Start displaying the message text, if the player is within the message radius.
Disable
Stop displaying the message text.


Parentname:
SetParent <stringRedirectInput/string>
Move with this entity. See Entity Hierarchy (parenting).
SetParentAttachment <stringRedirectInput/string>
Change this entity to attach to a specific attachment point on its parent. The entity will teleport so that the position of its root bone matches that of the attachment. Entities must be parented before being sent this input.
SetParentAttachmentMaintainOffset <stringRedirectInput/string>
As above, but without teleporting. The entity retains its position relative to the attachment at the time of the input being received.
ClearParent
Removes this entity from the the movement hierarchy, leaving it free to move independently.

Outputs

See also

  • game_text - A similar entity that displays a custom message directly on the player screen.
Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Point_message&oldid=156175"