This plugin handles internal triggers for the proxy
usage: #bp.triggers.detail [-h] [trigger [trigger ...]]
get details of a trigger
positional arguments:
trigger the trigger to detail (default: [])
optional arguments:
-h, --help show help (default: False)
usage: #bp.triggers.list [-h] [match]
list triggers
positional arguments:
match list only triggers that have this argument in them
optional arguments:
-h, --help show help (default: False)
usage: #bp.triggers.api [-h] [api]
list functions in the api
positional arguments:
api api to get details of
optional arguments:
-h, --help show help (default: False)
usage: #bp.triggers.help [-a] [-c] [-h]
show help info for this plugin
optional arguments:
-a, --api show functions this plugin has in the api (default: False)
-c, --commands show commands in this plugin (default: False)
-h, --help show help (default: False)
usage: #bp.triggers.inspect [-m METHOD] [-o OBJECT] [-s] [-h]
inspect a plugin
optional arguments:
-m METHOD, --method METHOD
get code for a method
-o OBJECT, --object OBJECT
show an object of the plugin, can be method or
variable
-s, --simple show a simple output (default: False)
-h, --help show help (default: False)
usage: #bp.triggers.reset [-h]
reset the plugin
optional arguments:
-h, --help show help (default: False)
usage: #bp.triggers.save [-h]
save the plugin state
optional arguments:
-h, --help show help (default: False)
usage: #bp.triggers.set [-h] [name] [value]
change a setting in the plugin
if there are no arguments or 'list' is the first argument then
it will list the settings for the plugin
positional arguments:
name the setting name (default: list)
value the new value of the setting
optional arguments:
-h, --help show help (default: False)
usage: #bp.triggers.stats [-h]
show plugin stats
optional arguments:
-h, --help show help (default: False)
triggers.toggleomit(triggername, flag)
toggle a trigger
triggername = The trigger name
flag = (optional) True to omit the line, False otherwise
this function returns no values
original defined in plugins/core/triggers.py
triggers.add(triggername, regex, plugin=None, **kwargs)
add a trigger
triggername = The trigger name
regex = the regular expression that matches this trigger
plugin = the plugin this comes from, added
automatically if using the api through BaseClass
keyword arguments:
enabled = (optional) whether the trigger is enabled (default: True)
group = (optional) the group the trigger is a member of
omit = (optional) True to omit the line from the client,
False otherwise
argtypes = (optional) a dict of keywords in the regex and their type
priority = (optional) the priority of the trigger, default is 100
stopevaluating = (optional) True to stop trigger evauluation if this
trigger is matched
this function returns no values
original defined in plugins/core/triggers.py
triggers.togglegroup(triggroup, flag)
toggle a trigger group
triggername = The triggergroup name
flag = (optional) True to enable, False otherwise
this function returns no values
original defined in plugins/core/triggers.py
triggers.toggle(triggername, flag)
toggle a trigger
triggername = The trigger name
flag = (optional) True to enable, False otherwise
this function returns no values
original defined in plugins/core/triggers.py
triggers.remove(triggername, force=False)
remove a trigger
triggername = The trigger name
force = True to remove it even if other functions
are registered
(default: False)
this function returns True if the trigger was removed,
False if it wasn't
original defined in plugins/core/triggers.py
triggers.gett(triggername)
get a trigger
triggername = The trigger name
original defined in plugins/core/triggers.py
triggers.removeplugin(plugin)
remove all triggers related to a plugin
plugin = The plugin name
this function returns no values
original defined in plugins/core/triggers.py