GitHub/pbot
3
0
Fork 0
mirror of https://github.com/pragma-/pbot.git synced 2024-12-23 11:12:42 +01:00
Code Issues Projects Releases Wiki Activity

EventQueue: add some unnecessary comments

Browse Source
This commit is contained in:
Pragmatic Software 2021-06-22 14:02:51 -07:00
parent db3320195e
commit af0938dfc3
1 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
PBot/EventQueue.pm
View File

@ -30,6 +30,7 @@ sub initialize {
$self->{pbot}->{capabilities}->add('admin', 'can-eventqueue', 1);
}
# eventqueue bot command
sub cmd_eventqueue {
my ($self, $context) = @_;
@ -207,6 +208,7 @@ sub enqueue_event_unless_exists {
$self->enqueue_event($subref, $interval, $id, $repeating);
}
# adds an event to the event queue
sub enqueue_event {
my ($self, $subref, $interval, $id, $repeating) = @_;
@ -231,6 +233,8 @@ sub enqueue_event {
}
}
# removes an event from the event queue, optionally invoking it.
# `id` can contain `.*` and `.*?` for wildcard-matching/globbing.
sub dequeue_event {
my ($self, $id, $execute) = @_;
@ -264,19 +268,21 @@ sub dequeue_event {
return $result;
}
# invoke and remove all events matching regex
# invoke and remove all events matching `id`, which can
# contain `.*` and `.*?` for wildcard-matching/globbing
sub execute_and_dequeue_event {
my ($self, $id) = @_;
return $self->dequeue_event($id, 1);
}
# adds event with repeating defaulting to enabled
# adds an event, with repeating defaulted to enabled
sub enqueue {
my ($self, $subref, $interval, $id, $repeating) = @_;
$repeating //= 1;
$self->enqueue_event($subref, $interval, $id, $repeating);
}
# alias to dequeue_event, for consistency
sub dequeue {
my ($self, $id) = @_;
$self->dequeue_event($id);
@ -324,7 +330,6 @@ sub duration_until_next_event {
}
# invokes the current events and then returns seconds until next upcoming event
sub do_events {
my ($self) = @_;