File Channel.lua
Functions
GwChannel:getRoles (player) | Find channel roles for a player. |
GwChannel:initialize () | Initialize a GwChannel object with the default attributes and state. |
GwChannel:isConnected () | Check if a connection exists to the custom channel. |
GwChannel:join () | Join a bridge channel. |
GwChannel:leave () | Leave a bridge channel. |
GwChannel:new (name, password) | GwChannel constructor function. |
GwChannel:send (message, type) | Sends an encoded message on the shared channel. |
Functions
- GwChannel:getRoles (player)
-
Find channel roles for a player.
Parameters:
-
player
: Name of the player to check.
Return values:
- True if target is the channel owner, false otherwise.
- True if target is a channel moderator, false otherwise.
-
- GwChannel:initialize ()
-
Initialize a GwChannel object with the default attributes and state.
Return value:
- The initialized GwChannel instance.
- GwChannel:isConnected ()
-
Check if a connection exists to the custom channel.
Return value:
- True if connected, otherwise false.
- GwChannel:join ()
-
Join a bridge channel.
Return value:
- True if connection success, false otherwise.
- GwChannel:leave ()
- Leave a bridge channel.
- GwChannel:new (name, password)
-
GwChannel constructor function.
Parameters:
-
name
: The name of the custom channel. -
password
: The password for the custom channel (optional).
Return value:
- An initialized GwChannel instance.
-
- GwChannel:send (message, type)
-
Sends an encoded message on the shared channel.
Parameters:
-
message
: Text of the message. -
type
: (optional) The message type. Accepted values are: GW_CTYPE_CHAT, GW_CTYPE_ACHIEVEMENT, GW_CTYPE_BROADCAST, GW_CTYPE_NOTICE, GW_CTYPE_REQUEST, GW_CTYPE_ADDON. Default is GW_CTYPE_CHAT.
-