API Index

This is an index of all classes, constants, fields, and methods in the Odin API.

Keep in mind that this API is in development! Thus, this documentation is also far from complete. More features will be added here as I write them. ;-)

Odin

Main article

Constants
VERSION Odin version.
BUILD Odin build number.
Methods
static getRunTime Returns the amount of time (in milliseconds) the application has been running.
static term Terminates the application.

Bots

Main article

Methods
static get Gets the bot instance identified by $id.
static getAll Gets all bot instances.
static add Createa a new bot instance. Use $name to give the instance a string identifier for later reference.

Bot

Main article

Methods
create Initializes the instance, associating it with the specified universe server.
login Logs the bot into the universe.
enterWorld
exitWorld
stateChange
setInstance Sets the AW API's current instance to that of this bot.
resetInstance Resets the AW API's current instance to the value before the last call to setInstance.

SysOut

Main article

Constants
OUTLVL_NONE Disabled output level.
OUTLVL_FATAL Fatal error output level.
OUTLVL_ERROR General error output level.
OUTLVL_WARN Warning output level.
OUTLVL_NOTICE Notice output level.
OUTLVL_GENERAL General output level.
OUTLVL_ALL Full output level.
Methods
static setOutLvl Sets the console or file output level.
static enableDebug Enables or disables debug output.
static printMsg Prints a message to the console and log file if the respective output levels are high enough.
static printlnMsg Prints a message with a following line break to the console and log file if the respective output levels are high enough.
static printfMsg Prints a message, which is formatted in the style of printf and sprintf, to the console and log file if the respective output levels are high enough.
static printlnDebug Prints a debugging message to the console and log file if debug printing is enabled.