File Config.lua
Functions
GwConfig:dump (keep) | Dump configuration attributes. |
GwConfig:dump_status () | Dump a status summary. |
GwConfig:initialize_param () | Initialize a GwConfig object with the default parameters. |
GwConfig:initialize_state () | Initialize a GwConfig object with the default state. |
GwConfig:is_container (guild) | Check a guild for membership within the confederation. |
GwConfig:is_peer (guild) | Check a guild for peer status. |
GwConfig:load () | Parse the guild information page to gather configuration information. |
GwConfig:new () | GwConfig constructor function. |
GwConfig:refresh () | Initiate a refresh of the configuration. |
GwConfig:refresh_channels () | Refresh the channel state. |
GwConfig:reload () | Initiate a reload of the configuration. |
GwConfig:reset () | Initiate a reset and reload of the configuration. |
Functions
- GwConfig:dump (keep)
-
Dump configuration attributes.
Parameters:
-
keep
:
-
- GwConfig:dump_status ()
- Dump a status summary.
- GwConfig:initialize_param ()
-
Initialize a GwConfig object with the default parameters.
Return value:
- The initialized GwConfig instance.
- GwConfig:initialize_state ()
-
Initialize a GwConfig object with the default state.
Return value:
- The initialized GwConfig instance.
- GwConfig:is_container (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:is_peer (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: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:refresh ()
-
Initiate a refresh of the configuration. This is a reload protected by a hold-down timer.
Return value:
- True is refresh submitted, false otherwise.
- GwConfig:refresh_channels ()
- Refresh the channel state.
- GwConfig:reload ()
-
Initiate a reload of the configuration.
Return value:
- True is refresh submitted, false otherwise.
- GwConfig:reset ()
-
Initiate a reset and reload of the configuration. This is a disruptive reset of the configuration and state.
Return value:
- True is refresh submitted, false otherwise.