env_message
- Counter-Strike 2
- Half-Life: Alyx
- Dota 2
- Steam VR
Point Entity
An entity that draws a text message on player's HUDs.
Keyvalues
-
Entity Scripts (
vscripts
) <ScriptList
>
Name(s) of script files that are executed after all entities have spawned. -
Name (
targetname
) <TargetSource
>
The name that other entities refer to this entity by. -
Message Text (
message
) <String
> -
Spawnflags (
spawnflags
) <Flags
>- Play Once
- All Clients
-
Sound Effect (
messagesound
) <Sound
>
When the message is shown, this sound effect will be played, originating from this entity. -
Volume 0-10 (
messagevolume
) <String
>
Volume of the sound effect. -
Sound Radius (
messageattenuation
) <Choices
>- Small Radius
- Medium Radius
- Large Radius
- Play Everywhere
Inputs
-
RunScriptFile <
String
>
Load and execute a script file -
RunScriptCode <
String
>
Execute a fragment of script code -
CallScriptFunction <
String
>
Call a script function -
CallPrivateScriptFunction <
String
>
Calls a script function from this entity's private script scope. -
CallGlobalScriptFunction <
String
>
Calls a script function in the global script scope. -
Kill <
Void
>
Removes this entity from the world. -
KillHierarchy <
Void
>
Removes this entity and all its children from the world. -
KillConstrained <
Void
>
Removes this entity, all its children, and anything constrained to it, from the world. -
AddOutput <
String
>
Adds an entity I/O connection to this entity. Parameter format: outputname>targetname>inputname>parameter>delay>max times to fire (-1 == infinite). Very dangerous, use with care. -
FireUser1 <
Void
>
Causes this entity's OnUser1 output to be fired. -
FireUser2 <
Void
>
Causes this entity's OnUser2 output to be fired. -
FireUser3 <
Void
>
Causes this entity's OnUser3 output to be fired. -
FireUser4 <
Void
>
Causes this entity's OnUser4 output to be fired. -
ShowMessage <
Void
>
Shows the message and plays the sound.
Outputs
-
OnUser1 <
Void
>
Fired in response to FireUser1 input. -
OnUser2 <
Void
>
Fired in response to FireUser2 input. -
OnUser3 <
Void
>
Fired in response to FireUser3 input. -
OnUser4 <
Void
>
Fired in response to FireUser4 input. -
OnKilled <
Void
>
Fired when the entity is killed and removed from the game. Parameter is the inflictor. -
OnShowMessage <
Void
>
Fired when the message is activated.
Point Entity
An entity that draws a text message on player's HUDs.
Keyvalues
-
Entity Scripts (
vscripts
) <ScriptList
>
Name(s) of script files that are executed after all entities have spawned. -
Name (
targetname
) <TargetSource
>
The name that other entities refer to this entity by. -
Message Text (
message
) <String
> -
Spawnflags (
spawnflags
) <Flags
>- Play Once
- All Clients
-
Sound Effect (
messagesound
) <Sound
>
When the message is shown, this sound effect will be played, originating from this entity. -
Volume 0-10 (
messagevolume
) <String
>
Volume of the sound effect. -
Sound Radius (
messageattenuation
) <Choices
>- Small Radius
- Medium Radius
- Large Radius
- Play Everywhere
Inputs
-
RunScriptFile <
String
>
Load and execute a script file -
RunScriptCode <
String
>
Execute a fragment of script code -
CallScriptFunction <
String
>
Call a script function -
CallPrivateScriptFunction <
String
>
Calls a script function from this entity's private script scope. -
CallGlobalScriptFunction <
String
>
Calls a script function in the global script scope. -
Kill <
Void
>
Removes this entity from the world. -
KillHierarchy <
Void
>
Removes this entity and all its children from the world. -
AddOutput <
String
>
Adds an entity I/O connection to this entity. Parameter format: outputname>targetname>inputname>parameter>delay>max times to fire (-1 == infinite). Very dangerous, use with care. -
FireUser1 <
Void
>
Causes this entity's OnUser1 output to be fired. -
FireUser2 <
Void
>
Causes this entity's OnUser2 output to be fired. -
FireUser3 <
Void
>
Causes this entity's OnUser3 output to be fired. -
FireUser4 <
Void
>
Causes this entity's OnUser4 output to be fired. -
ShowMessage <
Void
>
Shows the message and plays the sound.
Outputs
-
OnUser1 <
Void
>
Fired in response to FireUser1 input. -
OnUser2 <
Void
>
Fired in response to FireUser2 input. -
OnUser3 <
Void
>
Fired in response to FireUser3 input. -
OnUser4 <
Void
>
Fired in response to FireUser4 input. -
OnKilled <
Void
>
Fired when the entity is killed and removed from the game. -
OnShowMessage <
Void
>
Fired when the message is activated.
Point Entity
An entity that draws a text message on player's HUDs.
Keyvalues
-
Entity Scripts (
vscripts
) <ScriptList
>
Name(s) of script files that are executed after all entities have spawned. -
Name (
targetname
) <TargetSource
>
The name that other entities refer to this entity by. -
Message Text (
message
) <String
> -
Spawnflags (
spawnflags
) <Flags
>- Play Once
- All Clients
-
Sound Effect (
messagesound
) <Sound
>
When the message is shown, this sound effect will be played, originating from this entity. -
Volume 0-10 (
messagevolume
) <String
>
Volume of the sound effect. -
Sound Radius (
messageattenuation
) <Choices
>- Small Radius
- Medium Radius
- Large Radius
- Play Everywhere
Inputs
-
RunScriptFile <
String
>
Load and execute a script file -
RunScriptCode <
String
>
Execute a fragment of script code -
CallScriptFunction <
String
>
Call a script function -
CallPrivateScriptFunction <
String
>
Calls a script function from this entity's private script scope. -
CallGlobalScriptFunction <
String
>
Calls a script function in the global script scope. -
Kill <
Void
>
Removes this entity from the world. -
KillHierarchy <
Void
>
Removes this entity and all its children from the world. -
KillConstrained <
Void
>
Removes this entity, all its children, and anything constrained to it, from the world. -
AddOutput <
String
>
Adds an entity I/O connection to this entity. Parameter format: outputname>targetname>inputname>parameter>delay>max times to fire (-1 == infinite). Very dangerous, use with care. -
FireUser1 <
Void
>
Causes this entity's OnUser1 output to be fired. -
FireUser2 <
Void
>
Causes this entity's OnUser2 output to be fired. -
FireUser3 <
Void
>
Causes this entity's OnUser3 output to be fired. -
FireUser4 <
Void
>
Causes this entity's OnUser4 output to be fired. -
ShowMessage <
Void
>
Shows the message and plays the sound.
Outputs
-
OnUser1 <
Void
>
Fired in response to FireUser1 input. -
OnUser2 <
Void
>
Fired in response to FireUser2 input. -
OnUser3 <
Void
>
Fired in response to FireUser3 input. -
OnUser4 <
Void
>
Fired in response to FireUser4 input. -
OnKilled <
Void
>
Fired when the entity is killed and removed from the game. Parameter is the inflictor. -
OnShowMessage <
Void
>
Fired when the message is activated.
Point Entity
An entity that draws a text message on player's HUDs.
Keyvalues
-
Entity Scripts (
vscripts
) <ScriptList
>
Name(s) of script files that are executed after all entities have spawned. -
Name (
targetname
) <TargetSource
>
The name that other entities refer to this entity by. -
Message Text (
message
) <String
> -
Spawnflags (
spawnflags
) <Flags
>- Play Once
- All Clients
-
Sound Effect (
messagesound
) <Sound
>
When the message is shown, this sound effect will be played, originating from this entity. -
Volume 0-10 (
messagevolume
) <String
>
Volume of the sound effect. -
Sound Radius (
messageattenuation
) <Choices
>- Small Radius
- Medium Radius
- Large Radius
- Play Everywhere
Inputs
-
RunScriptFile <
String
>
Load and execute a script file -
RunScriptCode <
String
>
Execute a fragment of script code -
CallScriptFunction <
String
>
Call a script function -
CallPrivateScriptFunction <
String
>
Calls a script function from this entity's private script scope. -
CallGlobalScriptFunction <
String
>
Calls a script function in the global script scope. -
Kill <
Void
>
Removes this entity from the world. -
KillHierarchy <
Void
>
Removes this entity and all its children from the world. -
AddOutput <
String
>
Adds an entity I/O connection to this entity. Parameter format: outputname>targetname>inputname>parameter>delay>max times to fire (-1 == infinite). Very dangerous, use with care. -
FireUser1 <
Void
>
Causes this entity's OnUser1 output to be fired. -
FireUser2 <
Void
>
Causes this entity's OnUser2 output to be fired. -
FireUser3 <
Void
>
Causes this entity's OnUser3 output to be fired. -
FireUser4 <
Void
>
Causes this entity's OnUser4 output to be fired. -
ShowMessage <
Void
>
Shows the message and plays the sound.
Outputs
-
OnUser1 <
Void
>
Fired in response to FireUser1 input. -
OnUser2 <
Void
>
Fired in response to FireUser2 input. -
OnUser3 <
Void
>
Fired in response to FireUser3 input. -
OnUser4 <
Void
>
Fired in response to FireUser4 input. -
OnKilled <
Void
>
Fired when the entity is killed and removed from the game. -
OnShowMessage <
Void
>
Fired when the message is activated.