Skip to content
Work in progress. These docs describe Spawnite at launch, and some parts are still being built.

PluginFactory

A plugin’s factory, which definePluginFactory makes and which carries the plugin’s handles: behaviours, whose call a game lists and whose behaviours.systems name its systems.

Type Parameter Default type
Args extends unknown[] never[]
Made extends Plugin Plugin

PluginFactory(…args): Made

A plugin’s factory, which definePluginFactory makes and which carries the plugin’s handles: behaviours, whose call a game lists and whose behaviours.systems name its systems.

Parameter Type
…args Args

Made

Property Modifier Type Description
[pluginFactoryName] readonly string -
collisionLayers readonly Made["collisionLayers"] One handle per declared collision layer.
commands readonly Made["commands"] One handle per declared command, rounds.commands.start.
inputs readonly Made["inputs"] One handle per declared input, characters.inputs.move.
systems readonly Made["systems"] One handle per system, behaviours.systems.chase.