About

This plugin is an alias plugin

Two types of aliases:

• #bp.alias.add 'oa' 'open all'

  • This type of alias will just replace the oa with open all

• #bp.alias.add 'port (.*)' 'get {1} $portbag|wear {1}|enter|wear amulet|put {1} portbag'

  • This alias can be used with numbered positions

alias

add

usage: #bp.alias.add [-o] [-d] [-g GROUP] [-h] [original] [replacement]

add an alias

positional arguments:
  original              the input to replace
  replacement           the string to replace it with

optional arguments:
  -o, --overwrite       overwrite an alias if it already exists (default:
                        False)
  -d, --disable         disable the alias (default: False)
  -g GROUP, --group GROUP
                        the alias group
  -h, --help            show help (default: False)

detail

usage: #bp.alias.detail [-h] [alias]

get detail for an alias

positional arguments:
  alias       the alias to get details for

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

groupt

usage: #bp.alias.groupt [-d] [-h] [group]

toggle all aliases in a group

positional arguments:
  group          the group to toggle

optional arguments:
  -d, --disable  disable the group (default: False)
  -h, --help     show help (default: False)

list

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

list aliases

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

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

remove

usage: #bp.alias.remove [-h] [alias]

remove an alias

positional arguments:
  alias       the alias to remove

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

toggle

usage: #bp.alias.toggle [-h] [alias]

toggle enabled flag

positional arguments:
  alias       the alias to toggle

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

Base

api

usage: #bp.alias.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.alias.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.alias.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.alias.reset [-h]

reset the plugin

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

save

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

save the plugin state

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

set

usage: #bp.alias.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.alias.stats [-h]

show plugin stats

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

nextnum

the number of the next alias added