mirror of
https://github.com/pragma-/pbot.git
synced 2025-02-17 05:50:56 +01:00
EventQueue: add some unnecessary comments
This commit is contained in:
parent
db3320195e
commit
af0938dfc3
@ -30,6 +30,7 @@ sub initialize {
|
|||||||
$self->{pbot}->{capabilities}->add('admin', 'can-eventqueue', 1);
|
$self->{pbot}->{capabilities}->add('admin', 'can-eventqueue', 1);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
# eventqueue bot command
|
||||||
sub cmd_eventqueue {
|
sub cmd_eventqueue {
|
||||||
my ($self, $context) = @_;
|
my ($self, $context) = @_;
|
||||||
|
|
||||||
@ -207,6 +208,7 @@ sub enqueue_event_unless_exists {
|
|||||||
$self->enqueue_event($subref, $interval, $id, $repeating);
|
$self->enqueue_event($subref, $interval, $id, $repeating);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
# adds an event to the event queue
|
||||||
sub enqueue_event {
|
sub enqueue_event {
|
||||||
my ($self, $subref, $interval, $id, $repeating) = @_;
|
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 {
|
sub dequeue_event {
|
||||||
my ($self, $id, $execute) = @_;
|
my ($self, $id, $execute) = @_;
|
||||||
|
|
||||||
@ -264,19 +268,21 @@ sub dequeue_event {
|
|||||||
return $result;
|
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 {
|
sub execute_and_dequeue_event {
|
||||||
my ($self, $id) = @_;
|
my ($self, $id) = @_;
|
||||||
return $self->dequeue_event($id, 1);
|
return $self->dequeue_event($id, 1);
|
||||||
}
|
}
|
||||||
|
|
||||||
# adds event with repeating defaulting to enabled
|
# adds an event, with repeating defaulted to enabled
|
||||||
sub enqueue {
|
sub enqueue {
|
||||||
my ($self, $subref, $interval, $id, $repeating) = @_;
|
my ($self, $subref, $interval, $id, $repeating) = @_;
|
||||||
$repeating //= 1;
|
$repeating //= 1;
|
||||||
$self->enqueue_event($subref, $interval, $id, $repeating);
|
$self->enqueue_event($subref, $interval, $id, $repeating);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
# alias to dequeue_event, for consistency
|
||||||
sub dequeue {
|
sub dequeue {
|
||||||
my ($self, $id) = @_;
|
my ($self, $id) = @_;
|
||||||
$self->dequeue_event($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
|
# invokes the current events and then returns seconds until next upcoming event
|
||||||
|
|
||||||
sub do_events {
|
sub do_events {
|
||||||
my ($self) = @_;
|
my ($self) = @_;
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user