API Docs (pts)

Back to index...

Name	Type	Description
Command.Message.Accept	function	Sets the environment to accept a given type and identifier of message. Parameters can be replaced...
Command.Message.Broadcast	function	Broadcast an unreliable addon message to some number of targets. This message will be dropped sil...
Command.Message.Reject	function	Sets the environment to reject a given type and identifier of message. Directly cancels out singl...
Command.Message.Send	function	Send an reliable addon message to a single target. The callback will respond with success only o...
Event.Message.Receive		Signals the receipt of an addon message.
Inspect.Message.Accept.Check	function	Checks whether a given message type would be accepted if it were sent to you. Parameters can be r...
Inspect.Message.Accept.List	function	Retrieves the list of accepted message types and identifiers.
Utility.Message.Limits	function	Returns information on the message bandwidth limits.
Utility.Message.Size	function	Returns the size of a message, as used for bandwidth control.

Command.Message.Accept

Sets the environment to accept a given type and identifier of message. Parameters can be replaced with "nil" to act as a wildcard.

Usage:

Parameter	Type	Datatype	Description
Command.Message.Accept(type, identifier)
identifier	parameter	string/nil	The identifier type of the message. Used for the receiver to filter accepted messages via the Command.Message.Accept() function. Must be at least three characters long.
type	parameter	string/nil	The type of message. Valid types include "tell", "channel", "guild", "officer", "party", "raid", "say", "yell", "send".

Broadcast an unreliable addon message to some number of targets. This message will be dropped silently if the targets do not have the available bandwidth to receive it. The callback will respond with failure only if the message's target is invalid. "tell" messages are subject to the same restrictions as Command.Message.Send(). This command is throttled by the "message" throttle type.

Usage:

Parameter	Type	Datatype	Description
Command.Message.Broadcast(type, target, identifier, data)
Command.Message.Broadcast(type, target, identifier, data, callback)
callback	parameter	callbackfunction	A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
data	parameter	string	The data to send. This parameter is binary-safe.
identifier	parameter	string	The identifier type of the message. Used for the receiver to filter accepted messages via the Command.Message.Accept() function. Must be at least three characters long.
target	parameter	string/nil	The target of this message. Required for "channel" or "tell" message types, must be nil otherwise.
type	parameter	string	The type of message to send. Valid types include "tell", "channel", "guild", "officer", "party", "raid", "say", "yell".

Command.Message.Reject

Sets the environment to reject a given type and identifier of message. Directly cancels out single calls to Command.Message.Accept.

Usage:

Parameter	Type	Datatype	Description
Command.Message.Reject(type, identifier)
identifier	parameter	string/nil	The identifier type of the message. Used for the receiver to filter accepted messages via the Command.Message.Accept() function. Must be at least three characters long.
type	parameter	string/nil	The type of message. Valid types include "tell", "channel", "guild", "officer", "party", "raid", "say", "yell", "send".

Command.Message.Send

Send an reliable addon message to a single target. The callback will respond with success only once the server has accepted the message for processing and queueing. Failure may occur if the target is invalid or if the target's receive queue is full. Messages may be sent only to players that are nearby, in your guild, in your party or raid, or that have sent you a message or tell during this session. This command is throttled by the "message" throttle type.

Usage:

Parameter	Type	Datatype	Description
Command.Message.Send(target, identifier, data, callback)
callback	parameter	callbackfunction	A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
data	parameter	string	The data to send. This parameter is binary-safe.
identifier	parameter	string	The identifier type of the message. Used for the receiver to filter accepted messages via the Command.Message.Accept() function. Must be at least three characters long.
target	parameter	string	The name of the player to send the message to.

Event.Message.Receive

Signals the receipt of an addon message.

Usage:

Parameter	Type	Datatype	Description
Event.Message.Receive(from, type, channel, identifier, data)
channel	parameter	<nope>	If type is "channel", the channel that this message was sent to. Otherwise, nil.
data	parameter	<nope>	The data payload for this message type.
from	parameter	variant	The name of the player this message is from.
identifier	parameter	<nope>	The identifier for this message.
type	parameter	<nope>	The type of this message. May be any of "send", "tell", "channel", "guild", "officer", "party", "raid", "say", or "yell".

Inspect.Message.Accept.Check

Checks whether a given message type would be accepted if it were sent to you. Parameters can be replaced by "nil" to check for wildcard acceptance.

Usage:

Parameter	Type	Datatype	Description
accepted = Inspect.Message.Accept.Check(type, identifier)
identifier	parameter	string/nil	The identifier type of the message. Used for the receiver to filter accepted messages via the Command.Message.Accept() function. Must be at least three characters long.
type	parameter	string/nil	The type of message. Valid types include "tell", "channel", "guild", "officer", "party", "raid", "say", "yell", "send".
accepted	result	boolean	True if the message would be transferred to this client.

Inspect.Message.Accept.List

Retrieves the list of accepted message types and identifiers.

Usage:

Parameter	Type	Datatype	Description
accepts = Inspect.Message.Accept.List()
accepts	result	table	List of all accepted message types. Takes the form of a key/value table. The key is a table containing {type, identifier}, where either element may be nil to indicate a wildcard. The value is the number of times this type has been accepted.

Utility.Message.Limits

Returns information on the message bandwidth limits.

Usage:

Parameter	Type	Datatype	Description
data = Utility.Message.Limits()
data	result	table	The requested data.

members

burst	The amount of data that can be sent or received without being subject to throttling.
maximum	Maximum allowed message size.
sustained	Amount of data that can be transferred per second without dropping messages.

Utility.Message.Size

Returns the size of a message, as used for bandwidth control.

Usage:

Parameter	Type	Datatype	Description
size = Utility.Message.Size(to, identifier, data)
data	parameter	string	The data to send. This parameter is binary-safe.
identifier	parameter	string	The identifier type of the message. Used for the receiver to filter accepted messages via the Command.Message.Accept() function. Must be at least three characters long.
to	parameter	string/nil	The name of the player or channel to send to. nil if this is not targeted at a specific player or channel.
size	result	number	The calculated size of the message.