PhysicsPlugin
Defined in: physics/src/PhysicsPlugin.ts:29
Physics plugin that installs Rapier2D physics into the YAGE engine.
Creates a PhysicsWorldManager that owns per-scene Rapier worlds, and registers two systems:
- PhysicsSystem (FixedUpdate, priority 0)
- PhysicsInterpolationSystem (Update, priority -100)
Per-scene worlds are created in a beforeEnter scene hook and destroyed
in afterExit. Components access the active scene’s world via
this.use(PhysicsWorldKey).
Implements
Section titled “Implements”Plugin
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new PhysicsPlugin(
config?):PhysicsPlugin
Defined in: physics/src/PhysicsPlugin.ts:39
Parameters
Section titled “Parameters”config?
Section titled “config?”Returns
Section titled “Returns”PhysicsPlugin
Properties
Section titled “Properties”
readonlyname:"physics"="physics"
Defined in: physics/src/PhysicsPlugin.ts:30
Unique plugin name.
Implementation of
Section titled “Implementation of”Plugin.name
version
Section titled “version”
readonlyversion:"3.0.0"="3.0.0"
Defined in: physics/src/PhysicsPlugin.ts:31
Semantic version string.
Implementation of
Section titled “Implementation of”Plugin.version
Methods
Section titled “Methods”install()
Section titled “install()”install(
context):void
Defined in: physics/src/PhysicsPlugin.ts:46
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: physics/src/PhysicsPlugin.ts:79
Called when the engine is destroyed.
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”Plugin.onDestroy
onStart()
Section titled “onStart()”onStart():
void
Defined in: physics/src/PhysicsPlugin.ts:68
Called after all plugins are installed and the engine has started.
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”Plugin.onStart
registerSystems()
Section titled “registerSystems()”registerSystems(
scheduler):void
Defined in: physics/src/PhysicsPlugin.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/physics.md.