About

This plugin is a utility plugin for aardwolf functions

It contains

  • a damages table
  • class abbreviation table
  • a function to convert a level to level, remort, tier, redos
  • a function to convert a level, remort, tier, redos to overall level
  • a function to parse damage lines

Commands

Base

api


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

reset the plugin

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

save


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

save the plugin state

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

set


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

show plugin stats

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

API

rewardtable


aardu.rewardtable()
  get the reward table
    rev  = if True, return the reversed table

    this function returns a dictionary of rewards

original defined in plugins/aardwolf/aardu.py

convertlevel


aardu.convertlevel(level)
  convert a level to redos, tier, remort, level
    level  = the level to convert

    this function returns a dictionary with keys:
      level   = the level
      remort  = the # of remorts
      tier    = the # of tiers
      redo    = the # of redos

original defined in plugins/aardwolf/aardu.py

parsedamageline


aardu.parsedamageline(line)
  parse an Aardwolf damage line from combat
    line  = the line to parse

    this function returns a dictionary with keys:
      damage  = the amount of damage
      hits    = the # of hits
      damtype = the damage type
      damverb = the verb of the damage
      enemy   = the enemy

original defined in plugins/aardwolf/aardu.py

getactuallevel


aardu.getactuallevel(level=None, remort=None, )
  convert level, remort, tier, redos to the total levels
    level  = the level, defaults to GMCP value
    remort  = the # of remorts, default to GMCP value
    tier  = the # of tiers, default to GMCP value
    redos  = the # of redos, default to GMCP value

    this function returns the total levels

original defined in plugins/aardwolf/aardu.py

classabb


aardu.classabb(rev=False)
  get the class abbreviations
    rev  = if True, return the reversed table

    this function returns a dictionary
      original dictionary example:
        'mag' : 'mage'

      reversed dictionary example:
        'mage' : 'mag'

original defined in plugins/aardwolf/aardu.py