Limnoria/plugins/Scheduler
Valentin Lorentz efed7d8081 Move the 'ignore=False' trick from callbacks to Scheduler
I fear putting it in callbacks would be overzealous and reset it
within the processing of the same message, eg. when using conditional
to set the 'ignore' tag before other nested commands run.
2023-01-19 10:31:13 +01:00
..
locales all: Update .pot and .po files 2022-02-06 00:14:47 +01:00
__init__.py Revert generic 'The Limnoria Contributors' in copyright notices 2021-10-17 09:57:55 +02:00
config.py Revert generic 'The Limnoria Contributors' in copyright notices 2021-10-17 09:57:55 +02:00
messages.pot all: Update .pot and .po files 2022-02-06 00:14:47 +01:00
plugin.py Move the 'ignore=False' trick from callbacks to Scheduler 2023-01-19 10:31:13 +01:00
README.rst supybot-plugin-doc: Remove extra space + regenerate all READMEs. 2021-12-04 03:19:12 +01:00
test.py callbacks: Fix interference between Scheduler.repeat, Anonymous, and nested commands 2023-01-19 10:19:01 +01:00

Documentation for the Scheduler plugin for Supybot

Purpose

Gives the user the ability to schedule commands to run at a particular time, or repeatedly run at a particular interval. For example, scheduler add [time seconds 30m] "utilities echo [status cpu]" will schedule the command cpu to be sent to the channel in 30 minutes.

Usage

This plugin allows you to schedule commands to execute at a later time.

Commands

add <seconds> <command>

Schedules the command string <command> to run <seconds> seconds in the future. For example, 'scheduler add [seconds 30m] "echo [cpu]"' will schedule the command "cpu" to be sent to the channel the schedule add command was given in (with no prefixed nick, a consequence of using echo). Do pay attention to the quotes in that example.

list takes no arguments

Lists the currently scheduled events.

remind <seconds> <text>

Sets a reminder with string <text> to run <seconds> seconds in the future. For example, 'scheduler remind [seconds 30m] "Hello World"' will return '<nick> Reminder: Hello World' 30 minutes after being set.

remove <id>

Removes the event scheduled with id <id> from the schedule.

repeat [--delay <delay>] <name> <seconds> <command>

Schedules the command <command> to run every <seconds> seconds, starting now (i.e., the command runs now, and every <seconds> seconds thereafter). <name> is a name by which the command can be unscheduled. If --delay is given, starts in <delay> seconds instead of now.

Configuration

supybot.plugins.Scheduler.public

This config variable defaults to "True", is not network-specific, and is not channel-specific.

Determines whether this plugin is publicly visible.