this plugin has a timer interface for internal timers
usage: #bp.timers.detail [-h] [timers [timers ...]]
get details for timers
positional arguments:
timers a list of timers to get details (default: [])
optional arguments:
-h, --help show help (default: False)
usage: #bp.timers.list [-h] [match]
list timers
positional arguments:
match list only events that have this argument in their name
optional arguments:
-h, --help show help (default: False)
usage: #bp.timers.log [-h] [timername]
toggle log flag for a timer
positional arguments:
timername the timer name
optional arguments:
-h, --help show help (default: False)
usage: #bp.timers.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.timers.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.timers.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.timers.reset [-h]
reset the plugin
optional arguments:
-h, --help show help (default: False)
usage: #bp.timers.save [-h]
save the plugin state
optional arguments:
-h, --help show help (default: False)
usage: #bp.timers.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.timers.stats [-h]
show plugin stats
optional arguments:
-h, --help show help (default: False)
timers.add(name, func, seconds, **kwargs)
add a timer
name = The timer name
func = the function to call when firing the timer
seconds = the interval (in seconds) to fire the timer
args arguments:
nodupe = True if no duplicates of this timer are allowed,
False otherwise
onetime = True for a onetime timer, False otherwise
enabled = True if enabled, False otherwise
time = The time to start this timer, e.g. 1300 for 1PM
returns an Event instance
original defined in plugins/core/timers.py
timers.toggle(name, flag)
toggle a timer to be enabled/disabled
name = the name of the timer to toggle
flag = True to enable, False to disable
this function returns no values
original defined in plugins/core/timers.py
timers.remove(name)
remove a timer
name = the name of the timer to remove
this function returns no values
original defined in plugins/core/timers.py
timers.removeplugin(name)
remove a timer
name = the name of the plugin
this function returns no values
original defined in plugins/core/timers.py