ChannelAudience

Classes representing various channel audiences

See the Channel guide for usage

Classes

AreaAudience

PartyAudience

PrivateAudience

RoomAudience

WorldAudience

Methods

alterMessage(message) → {string}

Modify the message to be sent

Parameters:
Name Type Description
message string
Returns:
string

configure(options)

Configure the current state for the audience. Called by Channel#send

Parameters:
Name Type Description
options object
Properties
Name Type Description
state GameState
sender Player
message string

getBroadcastTargets() → {Array.<Player>}

Find targets for this audience

Returns:
Array.<Player>