eulerjs API / @eulerjs/core / Plugin

Plugin

Defined in: packages/core/src/plugins.ts:8

World-level extension. Every hook is optional and runs once per fixed step, in this order: beforeStep, then every body's behaviours, then applyForces, then the backend simulates, then afterStep.

Properties

Property	Modifier	Type	Defined in
name	readonly	string	packages/core/src/plugins.ts:9

Methods

afterStep()?

optional afterStep(world, timestep): void;

Defined in: packages/core/src/plugins.ts:15

Parameters

Parameter	Type
world	World
timestep	number

Returns

void

---

applyForces()?

optional applyForces(world, timestep): void;

Defined in: packages/core/src/plugins.ts:14

Add forces to bodies here; the backend simulates them right after.

Parameters

Parameter	Type
world	World
timestep	number

Returns

void

---

beforeStep()?

optional beforeStep(world, timestep): void;

Defined in: packages/core/src/plugins.ts:12

Parameters

Parameter	Type
world	World
timestep	number

Returns

void

---

dispose()?

optional dispose(world): void;

Defined in: packages/core/src/plugins.ts:17

Called by world.removePlugin(plugin) and world.dispose().

Parameters

Parameter	Type
world	World

Returns

void

---

install()?

optional install(world): void;

Defined in: packages/core/src/plugins.ts:11

Called once by world.use(plugin).

Parameters

Parameter	Type
world	World

Returns

void