Athena.systems.plugins ​

Modules ​

• Internal

Functions ​

addAPI ​

Injects a 'plugin' API into the runtime.

The runtime injection can be obtained with Athena.systems.plugins.use.

See that function for additional information.

Export

Parameters ​

Returns ​

void

Defined in ​

server/systems/plugins.ts:122

addCallback ​

After plugins are finished loading; call these callbacks. Useful for using 'Athena API' at the top level of a document.

Parameters ​

Returns ​

void

Defined in ​

server/systems/plugins.ts:85

getPlugins ​

Returns a list of all plugin names that are currently being loaded.

Static

Returns ​

string[]

Defined in ​

server/systems/plugins.ts:73

init ​

Loads all plugins.

Returns ​

void

Defined in ​

server/systems/plugins.ts:46

isDoneLoading ​

Verifies if all plugins are done loading.

Returns ​

Promise<void>

Defined in ​

server/systems/plugins.ts:98

registerPlugin ​

Register a callback for a plugin to begin its initialization period. This ensures that your plugin is ALWAYS loaded last.

Static

Parameters ​

Returns ​

void

Defined in ​

server/systems/plugins.ts:62

useAPI ​

Used to obtain a runtime API and its valid functionality.

This makes it so you can 'import' without knowing the plugin pathways.

As long as you know the 'plugin name' you can import anything.

Export

Type parameters ​

Parameters ​

Returns ​

Promise<ServerPluginAPI[K]>

Defined in ​

server/systems/plugins.ts:143