This article's documentation is for anything that uses the Source engine. Click here for more information.

Point message: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (→‎Inputs: Substituted IO templates)
 
(21 intermediate revisions by 16 users not shown)
Line 1: Line 1:
[[File:point_message.png|left|link=]]
{{LanguageBar}}
[[Category:GUI Entities]]


{{base point|point_message}} It displays a text message in the world, at its origin.
{{CD|CMessageEntity|file1=message_entity.cpp}}
{{this is a|point entity|name=point_message}} It displays a text message in the world, at its origin.


{{bug|Does not function in {{css}}, {{tf2}} and {{l4d2}}.}}
{{bug|Does not function in multiplayer. In {{tf2}} and {{csgo}}, [[point_worldtext]] can be used as an alternative.}}
 
{{in code|class=class_c_message_entity.html CMessageEntity|file=message__entity_8cpp-source.html message_entity.cpp}}
{{clr}}


__NOTOC__
== Keyvalues ==
== Keyvalues ==
{{KV|Entity Message (message)|string|Message to show at this point.}}
{{KV Targetname}}
{{warning|Never use quotation marks in the message. It will corrupt the [[VMF]] structure because of the nested quotation marks, which then must be removed manually with a text editor.}}
{{KV|Entity Message|intn=message|string|Message to show at this point.}}
{{KV|Show message radius (radius)|integer|Distance the player must be within to see this message.}}
:{{warning|Never use quotation marks in the message. It will corrupt the [[VMF]] structure because of the nested quotation marks, which then must be removed manually with a text editor.}}
{{KV|Developer Only? (developeronly)|boolean|If set, this message will only be visible when [[developer]] mode is on.}}
{{KV|Show message radius|intn=radius|integer|Distance the player must be within to see this message.}}
{{KV BaseEntity}}
{{KV|Developer Only?|intn=developeronly|boolean|If set, this message will only be visible when [[developer]] mode is on.}}


== Flags ==
== Flags ==
* 1 : Start Disabled
{{fl|1|Start Disabled}}


== Inputs ==
== Inputs ==
{{IO|Enable|Start displaying the message text, if the player is within the message radius.}}
{{I|Enable|Start displaying the message text, if the player is within the message radius.}}
{{IO|Disable|Stop displaying the message text.}}
{{I|Disable|Stop displaying the message text.}}
{{I BaseEntity}}
{{I|SetMessage|Set the message's text.}} {{only|{{mapbase}}}}
 
== Outputs ==
{{O BaseEntity|l4d=1}}


== See also ==
== See also ==
* [[game_text]] - A similar entity that displays a custom message directly on the player screen.
* [[game_text]] - Displays a custom message directly on the player screen.
* [[game_text_tf]] - {{tf2}} only. A similar entity that displays a custom HUD message on a team's screen.
* [[game_text_tf]] - {{tf2}} Displays a custom HUD message with icons on a specified team's screen.
 
* [[point_worldtext]] - {{tf2}}{{csgo}} A similar entity that displays a custom message in the world with far more flexibility.
[[Category:GUI Entities]]
* [[training_annotation]] - {{tf2}} A similar entity that points to a specified location in the world.
* [[env_hudhint]] - Displays a custom HUD message.  Commonly used to show key-binds.
* [[env_message]] - Displays a pre-defined message on the players screen.

Latest revision as of 11:12, 21 April 2025

English (en)Español (es)Translate (Translate)
C++ Class hierarchy
CMessageEntity
↳CPointEntity
↳CBaseEntity
C++ message_entity.cpp

point_message is a point entity available in all Source Source games. It displays a text message in the world, at its origin.

Icon-Bug.pngBug:Does not function in multiplayer. In Team Fortress 2 and Counter-Strike: Global Offensive, point_worldtext can be used as an alternative.  [todo tested in ?]


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

Entity Message (message) <string>
Message to show at this point.
Warning.pngWarning:Never use quotation marks in the message. It will corrupt the VMF structure because of the nested quotation marks, which then must be removed manually with a text editor.
Show message radius (radius) <integer>
Distance the player must be within to see this message.
Developer Only? (developeronly) <boolean>
If set, this message will only be visible when developer mode is on.

Flags

Start Disabled : [1]

Inputs

Enable
Start displaying the message text, if the player is within the message radius.
Disable
Stop displaying the message text.
SetMessage
Set the message's text. (only in Mapbase)

See also

  • game_text - Displays a custom message directly on the player screen.
  • game_text_tf - Team Fortress 2 Displays a custom HUD message with icons on a specified team's screen.
  • point_worldtext - Team Fortress 2Counter-Strike: Global Offensive A similar entity that displays a custom message in the world with far more flexibility.
  • training_annotation - Team Fortress 2 A similar entity that points to a specified location in the world.
  • env_hudhint - Displays a custom HUD message. Commonly used to show key-binds.
  • env_message - Displays a pre-defined message on the players screen.
Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Point_message&oldid=472557"