File Config.lua
Functions
GwConfig:IsContainer (guild) | Check a guild for membership within the confederation. |
GwConfig:IsPeer (guild) | Check a guild for peer status. |
GwConfig:channelHold (flag) | Check whether the channel hold-down has expired. |
GwConfig:configHold (flag) | Check whether the configuration hold-down has expired. |
GwConfig:dump (keep) | Dump configuration attributes. |
GwConfig:initialize (soft) | Initialize a GwConfig object with the default attributes and state. |
GwConfig:load () | Parse the guild information page to gather configuration information. |
GwConfig:new () | GwConfig constructor function. |
GwConfig:reloadHold (flag) | Check whether the reload hold-down has expired. |
Functions
- GwConfig:IsContainer (guild)
-
Check a guild for membership within the confederation.
Parameters:
-
guild
: The name of the guild to check.
Return value:
- True if the target guild is in the confederation, false otherwise.
-
- GwConfig:IsPeer (guild)
-
Check a guild for peer status.
Parameters:
-
guild
: The name of the guild to check.
Return value:
- True if the target guild is a peer co-guild, false otherwise.
-
- GwConfig:channelHold (flag)
-
Check whether the channel hold-down has expired.
Parameters:
-
flag
: (optional) True to start the hold-down, false to clear the hold-down.
Return value:
- True if the hold-down is still in effect, false if it has expired.
-
- GwConfig:configHold (flag)
-
Check whether the configuration hold-down has expired.
Parameters:
-
flag
: (optional) True to start the hold-down, false to clear the hold-down.
Return value:
- True if the hold-down is still in effect, false if it has expired.
-
- GwConfig:dump (keep)
-
Dump configuration attributes.
Parameters:
-
keep
:
-
- GwConfig:initialize (soft)
-
Initialize a GwConfig object with the default attributes and state.
Parameters:
-
soft
: If true, keep state intact.
Return value:
- The initialized GwConfig instance.
-
- GwConfig:load ()
-
Parse the guild information page to gather configuration information.
Return value:
- True if successful, false otherwise.
- GwConfig:new ()
-
GwConfig constructor function.
Return value:
- An initialized GwConfig instance.
- GwConfig:reloadHold (flag)
-
Check whether the reload hold-down has expired.
Parameters:
-
flag
: (optional) True to start the hold-down, false to clear the hold-down.
Return value:
- True if the hold-down is still in effect, false if it has expired.
-