Skip to content

Plugin

Plugin

Plugin(engine: Engine, directory: str)

Base plugin implementation for wame plugins.

Instantiate a new plugin instance and register all event listeners and hooks.

PARAMETER DESCRIPTION
engine

The engine instance responsible for running and interfacing with this plugin.

TYPE: Engine

directory

The parent folder/directory of this plugin.

TYPE: str

Warning

This is an internal method and should not be called externally.

directory property

directory: str

The directory that this plugin is located in.

engine property

engine: Engine

The engine instance responsible for running and interfacing with this plugin.

log_critical

log_critical(log: str) -> None

Log a critical error message.

PARAMETER DESCRIPTION
log

The message to log to the console.

TYPE: str

log_debug

log_debug(log: str) -> None

Log a debug message.

PARAMETER DESCRIPTION
log

The message to log to the console.

TYPE: str

log_info

log_info(log: str) -> None

Log an informational message.

PARAMETER DESCRIPTION
log

The message to log to the console.

TYPE: str

log_warn

log_warn(log: str) -> None

Log a warning message.

PARAMETER DESCRIPTION
log

The message to log to the console.

TYPE: str