LightingPlugin
Defined in: lighting/src/LightingPlugin.ts:15
Installs per-scene lighting worlds and the render-phase lighting system.
Implements
Section titled “Implements”Plugin
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new LightingPlugin(
config?):LightingPlugin
Defined in: lighting/src/LightingPlugin.ts:24
Parameters
Section titled “Parameters”config?
Section titled “config?”LightingConfig = {}
Returns
Section titled “Returns”LightingPlugin
Properties
Section titled “Properties”dependencies
Section titled “dependencies”
readonlydependencies: readonly ["renderer"]
Defined in: lighting/src/LightingPlugin.ts:18
Names of plugins this plugin depends on.
Implementation of
Section titled “Implementation of”Plugin.dependencies
readonlyname:"lighting"="lighting"
Defined in: lighting/src/LightingPlugin.ts:16
Unique plugin name.
Implementation of
Section titled “Implementation of”Plugin.name
version
Section titled “version”
readonlyversion:"1.0.0"="1.0.0"
Defined in: lighting/src/LightingPlugin.ts:17
Semantic version string.
Implementation of
Section titled “Implementation of”Plugin.version
Methods
Section titled “Methods”install()
Section titled “install()”install(
context):void
Defined in: lighting/src/LightingPlugin.ts:28
Install services into the engine context. Called in topological order.
Parameters
Section titled “Parameters”context
Section titled “context”EngineContext
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”Plugin.install
onDestroy()
Section titled “onDestroy()”onDestroy():
void
Defined in: lighting/src/LightingPlugin.ts:67
Called when the engine is destroyed.
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”Plugin.onDestroy
registerSystems()
Section titled “registerSystems()”registerSystems(
scheduler):void
Defined in: lighting/src/LightingPlugin.ts:63
Register systems with the scheduler. Called after install.
Parameters
Section titled “Parameters”scheduler
Section titled “scheduler”SystemScheduler
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”Plugin.registerSystems
Coding agents: fetch https://yage.dev/llms.txt first and prefer the Markdown references it links over these HTML pages. This page's Markdown counterpart is /llms/packages/lighting.md.