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 (→‎top: clean up, replaced: {{ModernBug → {{bug)
(-added class hierarchy, cleanup)
Line 7: Line 7:
|engine=2
|engine=2
}}
}}
 
{{CD|CMessageEntity|file1=message_entity.cpp}}
{{this is a|e0|name=point_message}} It displays a text message in the world, at its origin.
{{this is a|e0|name=point_message}} It displays a text message in the world, at its origin.


{{bug|Does not function in multiplayer. In {{tf2}} and {{csgo}}, [[point_worldtext]] can be used as an alternative.}}
{{bug|Does not function in multiplayer. In {{tf2}} and {{csgo}}, [[point_worldtext]] can be used as an alternative.}}


{{Code class|CMessageEntity|message_entity.cpp}}
__NOTOC__
 
 
__TOC__
 
 
== Keyvalues ==
== Keyvalues ==
{{KV Targetname}}
{{KV|Entity Message|intn=message|string|Message to show at this point.}}
{{KV|Entity Message|intn=message|string|Message to show at this point.}}
{{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.}}
{{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|Show message radius|intn=radius|integer|Distance the player must be within to see this message.}}
{{KV|Show message radius|intn=radius|integer|Distance the player must be within to see this message.}}
{{KV|Developer Only?|intn=developeronly|boolean|If set, this message will only be visible when [[developer]] mode is on.}}
{{KV|Developer Only?|intn=developeronly|boolean|If set, this message will only be visible when [[developer]] mode is on.}}
{{KV BaseEntity}}


== 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.}}
{{IO|Enable|Start displaying the message text, if the player is within the message radius.}}
{{IO|Disable|Stop displaying the message text.}}
{{IO|Disable|Stop displaying the message text.}}
{{I BaseEntity}}
== Outputs ==
{{O BaseEntity|l4d=1}}


== See also ==
== See also ==

Revision as of 17:06, 20 February 2024

English (en)Español (es)Translate (Translate)
point_message
Point message.png
TypePoint entity
EngineSource Source
 
C++ Class hierarchy
CMessageEntity
CPointEntity
CBaseEntity
C++ message_entity.cpp

point_message is an e0 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.

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.