Dawn of Light - Class documentation 2900
This is the Dawn of Light project
DOL.GS.Message Class Reference

This class helps sending messages to other players. More...

List of all members.

Static Public Member Functions

static void ChatToArea (GameObject centerObject, string message, eChatType chatType, params GameObject[] excludes)
 Sends a message to the chat window of players inside INFO_DISTANCE radius of the center object.
static void ChatToOthers (GameObject centerObject, string message, eChatType chatType)
 Sends a message to the chat window of players inside INFO_DISTANCE radius of the center object.
static void ChatToArea (GameObject centerObject, string message, eChatType chatType, ushort distance, params GameObject[] excludes)
 Sends a message to the chat window of players inside a specific distance of the center object.
static void SystemToArea (GameObject centerObject, string message, eChatType chatType, params GameObject[] excludes)
 Sends a message to the system window of players inside INFO_DISTANCE radius of the center object.
static void SystemToOthers (GameObject centerObject, string message, eChatType chatType)
 Sends a message to the system window of players inside INFO_DISTANCE radius of the center object.
static void SystemToOthers2 (GameObject centerObject, eChatType chatType, string LanguageMessageID, params object[] args)
 Sends a message to the system window of players inside INFO_DISTANCE radius of the center object.
static void SystemToArea (GameObject centerObject, string message, eChatType chatType, ushort distance, params GameObject[] excludes)
 Sends a message to the system window of players inside a specific distance of the center object.
static void MessageToArea (GameObject centerObject, string message, eChatType chatType, eChatLoc chatLoc, ushort distance, params GameObject[] excludes)
 Sends a text message to players within a specific radius of another object.

Detailed Description

This class helps sending messages to other players.


Member Function Documentation

static void DOL.GS.Message.ChatToArea ( GameObject  centerObject,
string  message,
eChatType  chatType,
params GameObject[]  excludes 
) [static]

Sends a message to the chat window of players inside INFO_DISTANCE radius of the center object.

Parameters:
centerObjectThe center object of the message
messageThe message to send
chatTypeThe type of message to send
excludesAn optional list of excluded players
static void DOL.GS.Message.ChatToArea ( GameObject  centerObject,
string  message,
eChatType  chatType,
ushort  distance,
params GameObject[]  excludes 
) [static]

Sends a message to the chat window of players inside a specific distance of the center object.

Parameters:
centerObjectThe center object of the message
messageThe message to send
chatTypeThe type of message to send
distanceThe distance around the center where players will receive the message
excludesAn optional list of excluded players

If the center object is a player, he will get the message too

static void DOL.GS.Message.ChatToOthers ( GameObject  centerObject,
string  message,
eChatType  chatType 
) [static]

Sends a message to the chat window of players inside INFO_DISTANCE radius of the center object.

Parameters:
centerObjectThe center object of the message
messageThe message to send
chatTypeThe type of message to send

If the centerObject is a player, he won't receive the message

static void DOL.GS.Message.MessageToArea ( GameObject  centerObject,
string  message,
eChatType  chatType,
eChatLoc  chatLoc,
ushort  distance,
params GameObject[]  excludes 
) [static]

Sends a text message to players within a specific radius of another object.

Parameters:
centerObjectThe center object
messageThe message to send
chatTypeThe chat typ
chatLocThe chat location
distanceThe distance
excludesA list of GameObjects to exlude from the message
static void DOL.GS.Message.SystemToArea ( GameObject  centerObject,
string  message,
eChatType  chatType,
ushort  distance,
params GameObject[]  excludes 
) [static]

Sends a message to the system window of players inside a specific distance of the center object.

Parameters:
centerObjectThe center object of the message
messageThe message to send
chatTypeThe type of message to send
distanceThe distance around the center where players will receive the message
excludesAn optional list of excluded players

If the center object is a player, he will get the message too

static void DOL.GS.Message.SystemToArea ( GameObject  centerObject,
string  message,
eChatType  chatType,
params GameObject[]  excludes 
) [static]

Sends a message to the system window of players inside INFO_DISTANCE radius of the center object.

Parameters:
centerObjectThe center object of the message
messageThe message to send
chatTypeThe type of message to send
excludesAn optional list of excluded players
static void DOL.GS.Message.SystemToOthers ( GameObject  centerObject,
string  message,
eChatType  chatType 
) [static]

Sends a message to the system window of players inside INFO_DISTANCE radius of the center object.

Parameters:
centerObjectThe center object of the message
messageThe message to send
chatTypeThe type of message to send

If the centerObject is a player, he won't receive the message

static void DOL.GS.Message.SystemToOthers2 ( GameObject  centerObject,
eChatType  chatType,
string  LanguageMessageID,
params object[]  args 
) [static]

Sends a message to the system window of players inside INFO_DISTANCE radius of the center object.

Parameters:
centerObjectThe center object of the message
chatTypeThe type of message to send
LanguageMessageIDThe language message ID
argsThe Translation args

If the centerObject is a player, he won't receive the message


The documentation for this class was generated from the following file:
 All Classes Namespaces Functions Variables Enumerations Properties Events