Env message: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(raw; needs cleanup)
 
(Cleaned up!)
Line 1: Line 1:
{{cleanup}}
{{wrongtitle|title=env_message}}
env_message


==Entity Description==
An entity that draws a text message on player's HUDs.
An entity that draws a text message on player's HUDs.


KEYS
==Keyvalues==


Name targetname <target_source> The name that other entities refer to this entity by.
* {{kv targetname}}


Message Text message <string>  
* '''message'''
: <string>


spawnflags spawnflags <flags>  
* '''messagesound'''
: <sound> When the message is shown, this sound effect will be played, originating from this entity.


Sound Effect messagesound <sound> When the message is shown, this sound effect will be played, originating from this entity.
* '''messagevolume'''
: <string> Volume of the sound effect.


Volume 0-10 messagevolume <string> Volume of the sound effect.
* '''messageattenuation'''
: <choices>
:{|
! Literal Value || Description
|-
| 0 || Small Radius
|-
| 1 || Medium Radius
|-
| 2 || Large Radius
|-
| 3 || Play Everywhere
|}


Sound Radius messageattenuation <choices>
==Flags==


* 1 : Play Once


INPUTS
* 2 : All Clients


Kill Removes this entity from the world.
==Inputs==


KillHierarchy Removes this entity and all its children from the world.
* {{i targetname}}


AddOutput <string> Adds an entity I/O connection to this entity. Format: <output name> <targetname>:<inputname>:<parameter>:<delay>:<max times to fire (-1 == infinite)>. Very dangerous, use with care.
*'''ShowMessage'''
:Shows the message and plays the sound.


FireUser1 Causes this entity's OnUser1 output to be fired.
==Outputs==


FireUser2 Causes this entity's OnUser2 output to be fired.
* {{o targetname}}


FireUser3 Causes this entity's OnUser3 output to be fired.
*'''OnShowMessage'''
:Fired when the message is activated.


FireUser4 Causes this entity's OnUser4 output to be fired.
[[Category:Entities]]
 
ShowMessage Shows the message and plays the sound.
 
 
OUTPUTS
 
OnUser1 Fired in response to FireUser1 input.
 
OnUser2 Fired in response to FireUser2 input.
 
OnUser3 Fired in response to FireUser3 input.
 
OnUser4 Fired in response to FireUser4 input.
 
OnShowMessage Fired when the message is activated.

Revision as of 02:58, 31 October 2005

Template:Wrongtitle

Entity Description

An entity that draws a text message on player's HUDs.

Keyvalues

  • message
<string>
  • messagesound
<sound> When the message is shown, this sound effect will be played, originating from this entity.
  • messagevolume
<string> Volume of the sound effect.
  • messageattenuation
<choices>
Literal Value Description
0 Small Radius
1 Medium Radius
2 Large Radius
3 Play Everywhere

Flags

  • 1 : Play Once
  • 2 : All Clients

Inputs

  • ShowMessage
Shows the message and plays the sound.

Outputs

  • OnShowMessage
Fired when the message is activated.