About

a plugin to handle global variables, if something goes through send.execute (this includes from the client), a variable can be specified with $varname and will be substituted.

vars

add

usage: #bp.vars.add [-h] [name] [value]

add a variable

positional arguments:
  name        the name of the variable
  value       the value of the variable

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

list

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

list variables

positional arguments:
  match       list only variables that have this argument in their name

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

remove

usage: #bp.vars.remove [-h] [name]

remove a variable

positional arguments:
  name        the variable to remove

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

Base

api

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

reset the plugin

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

save

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

save the plugin state

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

set

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

show plugin stats

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

setv

vars.setv(varname, value)
  set the variable with a specified name to the specified value
    varname  = the variable to set
    value  = the value to set

    this function returns True if the value was set, False if an error was
    encountered


original defined in plugins/client/vars.py

getv

vars.getv(varname)
  get the variable with a specified name
    varname  = the variable to get

    this function returns the value of variable with the name of the argument


original defined in plugins/client/vars.py

replace

vars.replace(data)
replace the variables in data
    data  = the variable to get

    this function returns the data after variable substition


original defined in plugins/client/vars.py