Maiden-Counter

About

This agent provides simple, silly counter functionality. It detects messages by a regex and then increases a counter and replies with a message.

How To

There's several commands to manage the counters.

::add counter foo \\bfoo|bar|baz|ban\\b "~a examples have been posted."

When a message is encountered that contains foo, bar, baz, or ban, the counter is increased and a response is given as specified above. Simple stuff. See the symbol index for the other commands.

The command handler is an activatable handler, so it must be activated explicitly first. See maiden-activatable.

Copyright

maiden-counter is licensed under the Artistic license. © Nicolas Hafner <shinmera@tymoon.eu> . This library can be obtained on https://github.com/Shinmera/maiden.

Package Index

MAIDEN-COUNTER (ORG.SHIRAKUMO.MAIDEN.AGENTS.COUNTER)

class
ADD
```
 
```
class
CHANGE
```
 
```

class

`COUNTER`

This agent provides a simple regex based matcher that increases a counter every time it sees a matching message.

class
LIST
```
 
```
class
REMOVE
```
 
```

accessor (

`COUNTER`

NAME)

Direct accessor to the counter storage.

A counter is a plist of the following keys:
- :NAME      The name of the counter
- :MATCH     The regex that matches an applicable message.
- :RESPONSE  The response string to use when a message matches. Should be a format string that contains a single placeholder that is filled with the current counter value.
- :COUNT     The actual counter value of how many times the counter was invoked.

See REMOVE-COUNTER
See LIST-COUNTERS
See SET-COUNTER

function (

`LIST-COUNTERS`

)

Return a list of all the counters in the storage.

See COUNTER
See REMOVE-COUNTER

function (

`REMOVE-COUNTER`

NAME)

Remove a counter from the storage.

See COUNTER
See LIST-COUNTERS

function (

`SET-COUNTER`

NAME MATCH &KEY RESPONSE COUNT)

More conveniently update or create a counter in the storage.

See COUNTER

command (

`add counter`

NAME MATCH &OPTIONAL RESPONSE)

Add a new counter. MATCH should be a regular expression. RESPONSE, if specified, is the message displayed when the counter matches.

command (
change counter
NAME &KEY MATCH RESPONSE)
```
Update an existing counter definition.
```

command

`list counters`

List the names of all existing counter definitions.

command (
remove counter
NAME)
```
Remove an existing counter definition.
```

maiden-counter

About

How To

Copyright

Package Index

MAIDEN-COUNTER (ORG.SHIRAKUMO.MAIDEN.AGENTS.COUNTER)

`ADD`

`CHANGE`

`COUNTER`

`LIST`

`REMOVE`

`COUNTER`

`LIST-COUNTERS`

`REMOVE-COUNTER`

`SET-COUNTER`

`add counter`

`change counter`

`list counters`

`remove counter`