ibravo – Interfaces¶
The ibravo module holds the interfaces required to implement plugins and hooks.
These are the base interface classes for Bravo. Plugin developers probably will not inherit from these; they are used purely to express common plugin functionality.
- class bravo.ibravo.IBravoPlugin¶
Interface for plugins.
This interface stores common metadata used during plugin discovery.
- class bravo.ibravo.IAutomaton¶
Automatons are given blocks from chunks which interest them, and may do processing on those blocks.
- class bravo.ibravo.IChatCommand¶
Interface for chat commands.
Chat commands are invoked from the chat inside clients, so they are always called by a specific client.
This interface is specifically designed to exist comfortably side-by-side with IConsoleCommand.
- class bravo.ibravo.IConsoleCommand¶
Interface for console commands.
Console commands are invoked from a console or some other location with two defining attributes: Access restricted to superusers, and no user issuing the command. As such, no access control list applies to them, but they must be given usernames to operate on explicitly.
- class bravo.ibravo.IRecipe¶
A description for creating materials from other materials.
- class bravo.ibravo.ISeason¶
Seasons are transformational stages run during certain days to emulate an environment.
- class bravo.ibravo.ISerializer¶
Class that understands how to serialize several different kinds of objects to and from disk-friendly formats.
Implementors of this interface are expected to provide a uniform implementation of their serialization technique.
- class bravo.ibravo.ITerrainGenerator¶
Interface for terrain generators.
- class bravo.ibravo.IPreBuildHook¶
Hook for actions to be taken before a block is placed.
- class bravo.ibravo.IPostBuildHook¶
Hook for actions to be taken after a block is placed.
- class bravo.ibravo.IDigHook¶
Hook for actions to be taken after a block is dug up.
- class bravo.ibravo.ISignHook¶
Hook for actions to be taken after a sign is updated.
This hook fires both on sign creation and sign editing.