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.
Command.Message.Broadcast(type, target, identifier, data) | |||
Command.Message.Broadcast(type, target, identifier, data, callback) | |||
Parameter | Type | Datatype | Description |
---|---|---|---|
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". |