clarified functionality comments
This commit is contained in:
parent
e909baf747
commit
e587a6f24a
1 changed files with 12 additions and 2 deletions
|
@ -6,11 +6,21 @@ use std::collections::HashMap;
|
|||
|
||||
/*
|
||||
|
||||
ModulesManager is made of modulesdb , a HashMap of BotModules with a Vector representing their enabled/disabled status based on channel and instance
|
||||
ModulesManager is used to manage Modules and BotActions associated with those modules
|
||||
|
||||
pub struct ModulesManager {
|
||||
statusdb: HashMap<ModType,Vec<ModStatusType>>,
|
||||
botactions: HashMap<ModType,Vec<BotAction>>,
|
||||
}
|
||||
|
||||
- statusdb: HashMap<ModType,Vec<ModStatusType>> - Defines Modules and their ModStatusType (e.g., Enabled at an Instance level, Disabled at a Channel Level)
|
||||
- botactions: HashMap<ModType,Vec<BotAction>> - Defines Modules and their BotActions (e.g., BotCommand , Listener, Routine)
|
||||
|
||||
Example
|
||||
{
|
||||
BotModule("Experiments") , [Enabled(Channel("modulatingforce")) , Disabled(Channel("modulatingforce")), Enabled(Instance)]
|
||||
ModulesManager {
|
||||
statusdb: {BotModule("experiments 004"): [Enabled(Instance)]},
|
||||
botactions: {BotModule("experiments 004"): [C(BotCommand { module: BotModule("experiments 004"), command: "DUPCMD4", alias: ["DUPALIAS4A", "DUPALIAS4B"], help: "DUPCMD4 tester" })]} }
|
||||
}
|
||||
|
||||
*/
|
||||
|
|
Loading…
Reference in a new issue