Plugin
Defined in: packages/threeplay/src/core/types.ts:364
A plugin adds functions, components and systems to the engine.
Whatever install returns is merged into k (and into window in global mode).
Type Parameters
Section titled “Type Parameters”API extends object = object
Methods
Section titled “Methods”install()
Section titled “install()”install(
k):API
Defined in: packages/threeplay/src/core/types.ts:370
Sets the plugin up. Use k.hooks for systems and k.load() for async work.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”API
Properties
Section titled “Properties”dependencies?
Section titled “dependencies?”
optionaldependencies?:string[]
Defined in: packages/threeplay/src/core/types.ts:368
Names of plugins that must be installed before this one.
name:
string
Defined in: packages/threeplay/src/core/types.ts:366
Unique name; the API is also reachable at k.plugins[name].