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

ActionTrigger: improve docs in comment header

Browse Source
This commit is contained in:
Pragmatic Software 2021-06-23 16:06:15 -07:00
parent 38985e1ac7
commit 8094db4f36
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
Plugins/ActionTrigger.pm
View File

@ -1,10 +1,17 @@
# File: ActionTrigger.pm
#
# Purpose: provides interface to set/remove/modify regular expression triggers
# to execute a command.
# which invoke bot commands when matched against IRC messages.
#
# Usage: actiontrigger add <#channel or global> <capability> <rate-limit (in seconds)> <regex trigger> <command>
#
# Note that ActionTrigger does not match on raw IRC lines. It matches on a
# simplified message format:
#
# "<hostmask> <action> <arguments>"
#
# where <action> can be PRIVMSG, ACTION, KICK, JOIN, PART or QUIT.
#
# Examples:
#
# Greet a nick when they join the channel: