About

This plugin is a mapper plugin

don't care about terrains and environment since I ain't graphical

DB

dbbackup

usage: #bp.mapper.dbbackup [-h] [name]

backup the database

positional arguments:
  name        the name to backup to

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

dbclose

usage: #bp.mapper.dbclose [-h]

close the database

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

dbmodify

usage: #bp.mapper.dbmodify [-h] [stmt]

run a sql update/insert against the database

positional arguments:
  stmt        the sql statement

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

dbremove

usage: #bp.mapper.dbremove [-h] [table] [rownumber]

remove a row from a table

positional arguments:
  table       the table to remove the row from
  rownumber   the row number to remove (default: -1)

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

dbselect

usage: #bp.mapper.dbselect [-h] [stmt]

run a sql statement against the database

positional arguments:
  stmt        the sql statement

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

dbvac

usage: #bp.mapper.dbvac [-h]

vacuum the database

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

mapper

area

usage: #bp.mapper.area [-e] [-h] [room] [area]

lookup a room in a specific area

positional arguments:
  room         a string (default: None)
  area         a string (default: None)

optional arguments:
  -e, --exact  the argument is the exact name (default: False)
  -h, --help   show help (default: False)

find

usage: #bp.mapper.find [-e] [-h] [room]

lookup a room

positional arguments:
  room         a string (default: None)

optional arguments:
  -e, --exact  the argument is the exact name (default: False)
  -h, --help   show help (default: False)

goto

usage: #bp.mapper.goto [-h] [room]

goto a room

positional arguments:
  room        the room number (default: None)

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

next

usage: #bp.mapper.next [-h]

goto the next room from the previous search result

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

purgeroom

usage: #bp.mapper.purgeroom [-h] [room]

purge a room

positional arguments:
  room        the room number (default: None)

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

resume

usage: #bp.mapper.resume [-h]

resume going to a room

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

showroom

usage: #bp.mapper.showroom [-h] [room]

show mapper information for a room

positional arguments:
  room        the room number (default: None)

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

spw

usage: #bp.mapper.spw [-h] [start] [end]

get speedwalk for a path

positional arguments:
  start       the room number (default: None)
  end         the room number (default: None)

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

walk

usage: #bp.mapper.walk [-h] [room]

walk to room (no portals)

positional arguments:
  room        the room number (default: None)

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

Base

api

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

reset the plugin

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

save

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

save the plugin state

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

set

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

show plugin stats

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

shownotes

show notes when entering a room

maxdepth

max depth to search

modifymany

mapper.modifymany(stmt, data)

    update many rows in a database


original defined in plugins/core/sqldb.py

modify

mapper.modify(stmt, data=None)

    modify the database


original defined in plugins/core/sqldb.py

select

mapper.select(stmt)

    run a select stmt against the db


original defined in plugins/core/sqldb.py

getrow

mapper.getrow(rowid, ttable)

    get a row from a table


original defined in plugins/core/sqldb.py