Env radio message: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(Created page for the env_radio_message entity found in Sin Episodes)
 
No edit summary
 
(3 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{back | List of SE1 entities}}
{{back | List of SE1 entities}}
[[File: se1_radio_message_icons.png | right | 200px]]
[[File: se1_radio_message_icons.png | right | 200px]]
{{se1 point}} Used for sending police radio messages from friendly NPCs to the player. Takes a speaker, message, and a priority. Inputs allow changing these variables and Dispatch issues the message. As the player traverses through the levels, the companions [[Jessica_Cannon | Jessica]] and [[JC_Armack | JC]] will helpout via these police radio messages when not directly present; about what the current objective is and to remind the player in certain intervals of this, when a hectic situation unfolds or just for commenting on something of interest seen in the game world like a poster or scenery. For a list of all the messages available in the game and how to use the entity, refere to the [[List_of_SE1_Radio_Messages | list of radio messages]] page for more information.
{{this is a|point entity|name=env_radio_messsage|game=SiN Episodes}}


Used for sending police radio messages from friendly NPCs to the player. Takes a speaker, message, and a priority. Inputs allow changing these variables and Dispatch issues the message. As the player traverses through the levels, the companions [[Jessica_Cannon | Jessica]] and [[JC_Armack | JC]] will helpout via these police radio messages when not directly present; about what the current objective is and to remind the player in certain intervals of this, when a hectic situation unfolds or just for commenting on something of interest seen in the game world like a poster or scenery. For a list of all the messages available in the game and how to use the entity, refere to the [[List_of_SE1_Radio_Messages | list of radio messages]] page for more information.
{{clr}}
{{clr}}
 
==Key Values==
==Keyvalues==
{{KV Targetname}}
{{KV|[[Targetname|Name]]|string| The [[targetname]] that other entities refer to this entity by.}}
{{KV|Speaker|string| Who is sending the message. Should be a classname (npc_jessica, npc_jc).}}
{{KV|Speaker|string| Who is sending the message. Should be a classname (npc_jessica, npc_jc).}}
{{KV|Message|string|The message to send. This should be the name of a soundscript.}}
{{KV|Message|string|The message to send. This should be the name of a soundscript.}}
Line 15: Line 15:


==Inputs==
==Inputs==
{{IO|SetSpeaker|Set who is sending the message. Should be a classname.|param=string}}
{{I|SetSpeaker|Set who is sending the message. Should be a classname.|param=string}}
{{IO|SetMessage|Set the scene or .wav file of the message.|param=string}}
{{I|SetMessage|Set the scene or .wav file of the message.|param=string}}
{{IO|SetPriority|Set the priority of the message.|param=string}}
{{I|SetPriority|Set the priority of the message.|param=string}}
{{IO|Dispatch|Dispatch a message (if none specified, using the message property). This should be the name of a soundscript.|param=string}}
{{I|Dispatch|Dispatch a message (if none specified, using the message property). This should be the name of a soundscript.|param=string}}
{{IO|Remove|Removes a message that has been dispatched. No longer available to the player.}}
{{I|Remove|Removes a message that has been dispatched. No longer available to the player.}}
{{ScrollBox|title=Targetname|}}
{{IO|[[AddOutput]]|Evaluates a keyvalue/output on this entity. <br/>Format: <code><key> <value></code><br/>Format: <code><output name> <targetname>:<inputname>:<parameter>:<delay>:<max times to fire, -1 means infinite></code>|param=string}}
{{IO|FireUser1|to=FireUser4|Fire the <code>OnUser</code> outputs; see [[User Inputs and Outputs]].}}
{{IO|Kill|Removes this entity and any entities parented to it from the world.}}
{{IO|KillHierarchy|Functions the same as <code>Kill</code>, although this entity and any entities parented to it are killed on the same frame, being marginally faster than <code>Kill</code>.}}


==Outputs==
==Outputs==
{{IO|OnDispatch|Fires when a message from this police radio is dispatched.}}
{{O|OnDispatch|Fires when a message from this police radio is dispatched.}}
{{IO|OnHeard|Fires when a message from this police radio is heard by the player.}}
{{O|OnHeard|Fires when a message from this police radio is heard by the player.}}
{{ScrollBox|title=Targetname|}}
{{O|OnUse|Fires when the <code>Use</code> input is given.}}
{{IO|OnUse|Fires when the <code>Use</code> input is given.}}
{{O BaseEntity}}

Latest revision as of 11:20, 26 September 2024

← List of SE1 entities
Se1 radio message icons.png

env_radio_messsage is a point entity available in SiN Episodes SiN Episodes.

Used for sending police radio messages from friendly NPCs to the player. Takes a speaker, message, and a priority. Inputs allow changing these variables and Dispatch issues the message. As the player traverses through the levels, the companions Jessica and JC will helpout via these police radio messages when not directly present; about what the current objective is and to remind the player in certain intervals of this, when a hectic situation unfolds or just for commenting on something of interest seen in the game world like a poster or scenery. For a list of all the messages available in the game and how to use the entity, refere to the list of radio messages page for more information.

Key Values

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

Speaker ([todo internal name (i)]) <string>
Who is sending the message. Should be a classname (npc_jessica, npc_jc).
Message ([todo internal name (i)]) <string>
The message to send. This should be the name of a soundscript.
Priority ([todo internal name (i)]) <choices>
Priority of the message. Objectives override extraneous messages. You can only have one message of each type at a time. Use extraneous for non-essential messages.
  • 0: Objective
  • 1: Extraneous

Inputs

SetSpeaker <stringRedirectInput/string>
Set who is sending the message. Should be a classname.
SetMessage <stringRedirectInput/string>
Set the scene or .wav file of the message.
SetPriority <stringRedirectInput/string>
Set the priority of the message.
Dispatch <stringRedirectInput/string>
Dispatch a message (if none specified, using the message property). This should be the name of a soundscript.
Remove
Removes a message that has been dispatched. No longer available to the player.

Outputs

OnDispatch
Fires when a message from this police radio is dispatched.
OnHeard
Fires when a message from this police radio is heard by the player.
OnUse
Fires when the Use input is given.
Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Env_radio_message&oldid=455196"