File GreenWall.lua

Functions

GwAbandonChannel (chan) Leave a shared confederation channel and clear current configuration.
GwCmdConfig (key, val) Update or display the value of a user configuration variable.
GwDecodeBroadcast (string) Decode a broadcast message.
GwEncodeBroadcast (action, target, arg) Encode a broadcast message.
GwFlushChannel (chan) Drain a channel's message queue.
GwForceReload () Send a configuration reload request to the rest of the confederation.
GwIsConnected (chan) Check if a connection exists to the common chat.
GwJoinChannel (chan) Join the shared confederation channel.
GwLeaveChannel (chan) Leave a shared confederation channel.
GwNewChannelTable (name, password) Create a new channel control data structure.
GwPrepComms () Clear confederation configuration and request updated guild roster information from the server.
GwRefreshComms () Parse confederation configuration and connect to the common channel.
GwSendConfederationMsg (chan, type, message, sync) Sends an encoded message to the rest of the confederation on the shared channel.
GwSendContainerMsg (type, message) Sends an encoded message to the rest of the same container on the add-on channel.
GwSetDefaults (soft) Initialize options to default values.


Functions

GwAbandonChannel (chan)
Leave a shared confederation channel and clear current configuration.

Parameters:

  • chan: The channel control table.
GwCmdConfig (key, val)
Update or display the value of a user configuration variable.

Parameters:

  • key: The name of the variable.
  • val: The variable value.

Return value:

    True if the key matches a variable name, false otherwise.
GwDecodeBroadcast (string)
Decode a broadcast message.

Parameters:

  • string: An encoded string.

Return values:

  1. The action type.
  2. The target of the action (optional).
  3. Additional data (optional).
GwEncodeBroadcast (action, target, arg)
Encode a broadcast message.

Parameters:

  • action: The action type.
  • target: The target of the action (optional).
  • arg: Additional data (optional).

Return value:

    An encoded string.
GwFlushChannel (chan)
Drain a channel's message queue.

Parameters:

  • chan: Channel control table.

Return value:

    Number of messages flushed.
GwForceReload ()
Send a configuration reload request to the rest of the confederation.
GwIsConnected (chan)
Check if a connection exists to the common chat.

Parameters:

  • chan: A channel control table.

Return value:

    True if connected, otherwise false.
GwJoinChannel (chan)
Join the shared confederation channel.

Parameters:

  • chan: the channel control block.

Return value:

    True if connection success, false otherwise.
GwLeaveChannel (chan)
Leave a shared confederation channel.

Parameters:

  • chan: The channel control table.
GwNewChannelTable (name, password)
Create a new channel control data structure.

Parameters:

  • name: The channel name.
  • password: The channel password.

Return value:

    Channel control table.
GwPrepComms ()
Clear confederation configuration and request updated guild roster information from the server.
GwRefreshComms ()
Parse confederation configuration and connect to the common channel.
GwSendConfederationMsg (chan, type, message, sync)
Sends an encoded message to the rest of the confederation on the shared channel.

Parameters:

  • chan: The channel control table.
  • type: The message type. Accepted values are: chat, achievement, broadcast, notice, and request.
  • message: Text of the message.
  • sync: (optional) Boolean specifying whether to suppress queuing of messages. Default is false.
GwSendContainerMsg (type, message)
Sends an encoded message to the rest of the same container on the add-on channel.

Parameters:

  • type: The message type.
  • message: Text of the message.
GwSetDefaults (soft)
Initialize options to default values.

Parameters:

  • soft: If true, set only undefined options to the default values.

Valid XHTML 1.0!