About

This plugin adds the ability to do user defined actions when text is seen from the mud

Example

• #bp.actions.add "test (?P<something>.*)" "gt just got a test $something"
  • The match can use regular expresssions: see Python Regular Expression HOWTO
  • The action can use trigger groups

actions

add

usage: #bp.actions.add [-c] [-d] [-g GROUP] [-o] [-h]
                           [regex] [action]
                           [{execute,traceback,mud,client,error,msg}]

add a action

positional arguments:
  regex                 the regex to match
  action                the action to take
  {execute,traceback,mud,client,error,msg}
                        where to send the action (default: execute)

optional arguments:
  -c, --color           match colors (@colors) (default: False)
  -d, --disable         disable the action (default: False)
  -g GROUP, --group GROUP
                        the action group
  -o, --overwrite       overwrite an action if it already exists (default:
                        False)
  -h, --help            show help (default: False)

detail

usage: #bp.actions.detail [-h] [action]

get detail for an action

positional arguments:
  action      the action to get details for

optional arguments:
  -h, --help  show help (default: False)

groupt

usage: #bp.actions.groupt [-t | -d | -e] [-h] [group]

toggle all actions in a group

positional arguments:
  group          the group to toggle

optional arguments:
  -t, --toggle   toggle the action (default: toggle)
  -d, --disable  disable the action (default: None)
  -e, --enable   enable the action (default: None)
  -h, --help     show help (default: False)

list

usage: #bp.actions.list [-h] [match]

list actions

positional arguments:
  match       list only actions that have this argument in them

optional arguments:
  -h, --help  show help (default: False)

remove

usage: #bp.actions.remove [-h] [action]

remove an action

positional arguments:
  action      the action to remove

optional arguments:
  -h, --help  show help (default: False)

toggle

usage: #bp.actions.toggle [-t | -d | -e] [-h] [action]

toggle enabled flag

positional arguments:
  action         the action to toggle

optional arguments:
  -t, --toggle   toggle the action (default: toggle)
  -d, --disable  disable the action (default: None)
  -e, --enable   enable the action (default: None)
  -h, --help     show help (default: False)

Base

api

usage: #bp.actions.api [-h] [api]

list functions in the api

positional arguments:
  api         api to get details of

optional arguments:
  -h, --help  show help (default: False)

help

usage: #bp.actions.help [-a] [-c] [-h]

show help info for this plugin

optional arguments:
  -a, --api       show functions this plugin has in the api (default: False)
  -c, --commands  show commands in this plugin (default: False)
  -h, --help      show help (default: False)

inspect

usage: #bp.actions.inspect [-m METHOD] [-o OBJECT] [-s] [-h]

inspect a plugin

optional arguments:
  -m METHOD, --method METHOD
                        get code for a method
  -o OBJECT, --object OBJECT
                        show an object of the plugin, can be method or
                        variable
  -s, --simple          show a simple output (default: False)
  -h, --help            show help (default: False)

reset

usage: #bp.actions.reset [-h]

reset the plugin

optional arguments:
  -h, --help  show help (default: False)

save

usage: #bp.actions.save [-h]

save the plugin state

optional arguments:
  -h, --help  show help (default: False)

set

usage: #bp.actions.set [-h] [name] [value]

change a setting in the plugin

if there are no arguments or 'list' is the first argument then
it will list the settings for the plugin

positional arguments:
  name        the setting name (default: list)
  value       the new value of the setting

optional arguments:
  -h, --help  show help (default: False)

stats

usage: #bp.actions.stats [-h]

show plugin stats

optional arguments:
  -h, --help  show help (default: False)

nextnum

the number of the next action added