Game Message Configuration


Messages are either generated directly from the code, can be generated in response to a Team Radio event, or can be generated from inside an Action scope of an objective. The types_message.cfg file contains the most up to date list of available messages.

ConfigureGameMessage(string message)
Multiple
message: Name of the game message being configured.
Interval()
Required
Type(string type)
Optional("Interval::None")
type: The type of interval between messages
  • "Interval::None" no interval.
  • "Interval::Message" time between messages being displayed.
  • "Interval::Trigger" time since the last attempt to trigger.
Time(float time)
Optional(0)
time: Amount of time
Sound()
Required
Type(string type)
Optional("Sound::None")
type: The type of sound to be played
  • "Sound::None" no sound.
  • "Sound::Effect" play the sound using a sound effect.
  • "Sound::Voice" play the sound using a reserved voice.
  • "Sound::Stream" play a sound stream.
UseOwner(bool flag)
Optional(FALSE)
flag: If set then this message won't say two things at the same time.
Add(string filename)
Multiple
filename: Name of sound file to be played
Message()
Required
Type(string type)
Optional("Message::None")
type: The type of message to be displayed
  • "Message::None" no message.
  • "Message::Console" display the message to the console.
Add(string message)
Multiple
message: Message to be displayed
ConfigureLocationMessage(string message)
Multiple
message: Name of the location message being configured.
Interval()
Required
Type(string type)
Optional("Interval::None")
type: The type of interval between messages
  • "Interval::None" no interval.
  • "Interval::Message" time between messages being displayed.
  • "Interval::Trigger" time since the last attempt to trigger.
Time(float time)
Optional(0)
time: Amount of time
Sound()
Required
Type(string type)
Optional("Sound::None")
type: The type of sound to be played
  • "Sound::None" no sound.
  • "Sound::Effect" play the sound using a sound effect.
  • "Sound::Voice" play the sound using a reserved voice.
  • "Sound::Stream" play a sound stream.
  • "Sound::3D" play the sound using a 3D.
UseOwner(bool flag)
Optional(FALSE)
flag: If set then this message won't say two things at the same time.
MaxDistance(int distance)
Optional(200), Range(1, 1000)
distance: The maximum distance at which this sound can be heard.
MinDistance(int distance)
Optional(1), Range(1, MaxDistance)
distance: The distance at which this sound is at its loudest.
Add(string filename)
Multiple
filename: Name of sound file to be played
Message()
Required
Type(string type)
Optional("Message::None")
type: The type of message to be displayed
  • "Message::None" no message.
  • "Message::Console" display the message to the console.
Add(string message)
Multiple
message: Message to be displayed
ConfigureObjMessage(string message)
Multiple
message: Name of the obj message being configured. ObjMessage is actually a series of LocationMessage configurations. When an ObjMessage is triggered it checks to see if the object is in a tag that has a specific message. Then it tests to see if there's a type specific location message. If one is not found then it checks to see if there's a property specific location message. If one is not found then it attempts to use the default. If this too fails then there is no message.
Tag(string tag)
Multiple
tag: Use this configuration for the objects which are in this tag. The contents of this scope are identical to ConfigureLocationMessage.
Type(string type)
Multiple
type: Use this configuration for the objects which match this type. The contents of this scope are identical to ConfigureLocationMessage.
Property(string property1, string property2, ... , string propertyn)
Multiple
property(n): Use this configuration for the objects which have all of these properties. The contents of this scope are identical to ConfigureLocationMessage.
Default()
Optional
The default location message. The contents of this scope are identical to ConfigureLocationMessage.