Skip to main content

BehaviorRuntime

@zylem/game-lib


@zylem/game-lib / runtime / BehaviorRuntime

Interface: BehaviorRuntime

Defined in: node_modules/.pnpm/@zylem+behaviors@0.8.9_@types+react@19.3.0_react@19.3.0_three@0.185.1/node_modules/@zylem/behaviors/dist/behavior-system-DkFAwLb_.d.ts:480

Runtime surface behavior systems rely on. WasmStageRuntime is the real wasm-backed implementation; MockBehaviorRuntime (see ./mock-behavior-runtime) implements the same contract for unit tests, so descriptors stay runtime-agnostic.

Methods​

attachFirstPerson()​

attachFirstPerson(handle, opts): boolean

Defined in: node_modules/.pnpm/@zylem+behaviors@0.8.9_@types+react@19.3.0_react@19.3.0_three@0.185.1/node_modules/@zylem/behaviors/dist/behavior-system-DkFAwLb_.d.ts:513

Parameters​

handle​

number

opts​

StageFirstPersonOptions

Returns​

boolean


attachJumper2D()​

attachJumper2D(handle, opts): boolean

Defined in: node_modules/.pnpm/@zylem+behaviors@0.8.9_@types+react@19.3.0_react@19.3.0_three@0.185.1/node_modules/@zylem/behaviors/dist/behavior-system-DkFAwLb_.d.ts:515

Parameters​

handle​

number

opts​

StageJumper2DOptions

Returns​

boolean


attachJumper3D()​

attachJumper3D(handle, opts): boolean

Defined in: node_modules/.pnpm/@zylem+behaviors@0.8.9_@types+react@19.3.0_react@19.3.0_three@0.185.1/node_modules/@zylem/behaviors/dist/behavior-system-DkFAwLb_.d.ts:517

Parameters​

handle​

number

opts​

StageJumper3DOptions

Returns​

boolean


attachPlatformer2D()​

attachPlatformer2D(handle, opts): boolean

Defined in: node_modules/.pnpm/@zylem+behaviors@0.8.9_@types+react@19.3.0_react@19.3.0_three@0.185.1/node_modules/@zylem/behaviors/dist/behavior-system-DkFAwLb_.d.ts:510

Parameters​

handle​

number

opts​

StagePlatformer2DOptions

Returns​

boolean


attachPlatformer3D()​

attachPlatformer3D(handle, opts): boolean

Defined in: node_modules/.pnpm/@zylem+behaviors@0.8.9_@types+react@19.3.0_react@19.3.0_three@0.185.1/node_modules/@zylem/behaviors/dist/behavior-system-DkFAwLb_.d.ts:507

Parameters​

handle​

number

opts​

StagePlatformer3DOptions

Returns​

boolean


attachRicochet()​

attachRicochet(handle, dim, opts): boolean

Defined in: node_modules/.pnpm/@zylem+behaviors@0.8.9_@types+react@19.3.0_react@19.3.0_three@0.185.1/node_modules/@zylem/behaviors/dist/behavior-system-DkFAwLb_.d.ts:506

Parameters​

handle​

number

dim​

StageRicochetDimValue

opts​

StageRicochetOptions

Returns​

boolean


attachScreenWrap()​

attachScreenWrap(handle, opts): boolean

Defined in: node_modules/.pnpm/@zylem+behaviors@0.8.9_@types+react@19.3.0_react@19.3.0_three@0.185.1/node_modules/@zylem/behaviors/dist/behavior-system-DkFAwLb_.d.ts:496

Parameters​

handle​

number

opts​

StageScreenWrapOptions

Returns​

boolean


attachShooter2D()​

attachShooter2D(handle, opts): boolean

Defined in: node_modules/.pnpm/@zylem+behaviors@0.8.9_@types+react@19.3.0_react@19.3.0_three@0.185.1/node_modules/@zylem/behaviors/dist/behavior-system-DkFAwLb_.d.ts:495

Parameters​

handle​

number

opts​

StageShooter2DOptions

Returns​

boolean


attachThruster()​

attachThruster(handle, opts): boolean

Defined in: node_modules/.pnpm/@zylem+behaviors@0.8.9_@types+react@19.3.0_react@19.3.0_three@0.185.1/node_modules/@zylem/behaviors/dist/behavior-system-DkFAwLb_.d.ts:491

Parameters​

handle​

number

opts​

StageThrusterOptions

Returns​

boolean


attachTopDown()​

attachTopDown(handle, opts): boolean

Defined in: node_modules/.pnpm/@zylem+behaviors@0.8.9_@types+react@19.3.0_react@19.3.0_three@0.185.1/node_modules/@zylem/behaviors/dist/behavior-system-DkFAwLb_.d.ts:493

Parameters​

handle​

number

opts​

StageTopDownOptions

Returns​

boolean


attachWorldBoundary()​

attachWorldBoundary(handle, dim, opts): boolean

Defined in: node_modules/.pnpm/@zylem+behaviors@0.8.9_@types+react@19.3.0_react@19.3.0_three@0.185.1/node_modules/@zylem/behaviors/dist/behavior-system-DkFAwLb_.d.ts:501

Parameters​

handle​

number

dim​

StageBoundaryDimValue

opts​

StageWorldBoundaryOptions

Returns​

boolean


getPose()​

getPose(handle, out?): StagePose | null

Defined in: node_modules/.pnpm/@zylem+behaviors@0.8.9_@types+react@19.3.0_react@19.3.0_three@0.185.1/node_modules/@zylem/behaviors/dist/behavior-system-DkFAwLb_.d.ts:481

Parameters​

handle​

number

out?​

StagePose

Returns​

StagePose | null


queryScreenWrap()​

queryScreenWrap(handle): \{ fsm: number; lastWrappedAxes: number; \} | null

Defined in: node_modules/.pnpm/@zylem+behaviors@0.8.9_@types+react@19.3.0_react@19.3.0_three@0.185.1/node_modules/@zylem/behaviors/dist/behavior-system-DkFAwLb_.d.ts:497

Parameters​

handle​

number

Returns​

\{ fsm: number; lastWrappedAxes: number; \} | null


queryWorldBoundary()​

queryWorldBoundary(handle): \{ clamped: [number, number, number]; hits: number; \} | null

Defined in: node_modules/.pnpm/@zylem+behaviors@0.8.9_@types+react@19.3.0_react@19.3.0_three@0.185.1/node_modules/@zylem/behaviors/dist/behavior-system-DkFAwLb_.d.ts:502

Parameters​

handle​

number

Returns​

\{ clamped: [number, number, number]; hits: number; \} | null


readSnapshot()​

readSnapshot(handle, out?): StageBehaviorSnapshot | null

Defined in: node_modules/.pnpm/@zylem+behaviors@0.8.9_@types+react@19.3.0_react@19.3.0_three@0.185.1/node_modules/@zylem/behaviors/dist/behavior-system-DkFAwLb_.d.ts:490

Read the per-slot behavior snapshot written at the end of the previous step.

Parameters​

handle​

number

out?​

StageBehaviorSnapshot

Returns​

StageBehaviorSnapshot | null


setFirstPersonInput()​

setFirstPersonInput(handle, input): void

Defined in: node_modules/.pnpm/@zylem+behaviors@0.8.9_@types+react@19.3.0_react@19.3.0_three@0.185.1/node_modules/@zylem/behaviors/dist/behavior-system-DkFAwLb_.d.ts:514

Parameters​

handle​

number

input​

StageFirstPersonInput

Returns​

void


setJumper2DInput()​

setJumper2DInput(handle, jumpPressed): void

Defined in: node_modules/.pnpm/@zylem+behaviors@0.8.9_@types+react@19.3.0_react@19.3.0_three@0.185.1/node_modules/@zylem/behaviors/dist/behavior-system-DkFAwLb_.d.ts:516

Parameters​

handle​

number

jumpPressed​

boolean

Returns​

void


setJumper3DInput()​

setJumper3DInput(handle, jumpPressed): void

Defined in: node_modules/.pnpm/@zylem+behaviors@0.8.9_@types+react@19.3.0_react@19.3.0_three@0.185.1/node_modules/@zylem/behaviors/dist/behavior-system-DkFAwLb_.d.ts:518

Parameters​

handle​

number

jumpPressed​

boolean

Returns​

void


setPlatformer2DInputAxes()​

setPlatformer2DInputAxes(handle, moveX): void

Defined in: node_modules/.pnpm/@zylem+behaviors@0.8.9_@types+react@19.3.0_react@19.3.0_three@0.185.1/node_modules/@zylem/behaviors/dist/behavior-system-DkFAwLb_.d.ts:511

Parameters​

handle​

number

moveX​

number

Returns​

void


setPlatformer2DInputButtons()​

setPlatformer2DInputButtons(handle, jump, run): void

Defined in: node_modules/.pnpm/@zylem+behaviors@0.8.9_@types+react@19.3.0_react@19.3.0_three@0.185.1/node_modules/@zylem/behaviors/dist/behavior-system-DkFAwLb_.d.ts:512

Parameters​

handle​

number

jump​

boolean

run​

boolean

Returns​

void


setPlatformer3DInputAxes()​

setPlatformer3DInputAxes(handle, moveX, moveZ): void

Defined in: node_modules/.pnpm/@zylem+behaviors@0.8.9_@types+react@19.3.0_react@19.3.0_three@0.185.1/node_modules/@zylem/behaviors/dist/behavior-system-DkFAwLb_.d.ts:508

Parameters​

handle​

number

moveX​

number

moveZ​

number

Returns​

void


setPlatformer3DInputButtons()​

setPlatformer3DInputButtons(handle, jump, run): void

Defined in: node_modules/.pnpm/@zylem+behaviors@0.8.9_@types+react@19.3.0_react@19.3.0_three@0.185.1/node_modules/@zylem/behaviors/dist/behavior-system-DkFAwLb_.d.ts:509

Parameters​

handle​

number

jump​

boolean

run​

boolean

Returns​

void


setPosition()​

setPosition(handle, x, y, z): boolean

Defined in: node_modules/.pnpm/@zylem+behaviors@0.8.9_@types+react@19.3.0_react@19.3.0_three@0.185.1/node_modules/@zylem/behaviors/dist/behavior-system-DkFAwLb_.d.ts:482

Parameters​

handle​

number

x​

number

y​

number

z​

number

Returns​

boolean


setRotation()​

setRotation(handle, x, y, z, w): boolean

Defined in: node_modules/.pnpm/@zylem+behaviors@0.8.9_@types+react@19.3.0_react@19.3.0_three@0.185.1/node_modules/@zylem/behaviors/dist/behavior-system-DkFAwLb_.d.ts:483

Parameters​

handle​

number

x​

number

y​

number

z​

number

w​

number

Returns​

boolean


setThrusterInput()​

setThrusterInput(handle, thrust, rotate, vectorX?, vectorY?): void

Defined in: node_modules/.pnpm/@zylem+behaviors@0.8.9_@types+react@19.3.0_react@19.3.0_three@0.185.1/node_modules/@zylem/behaviors/dist/behavior-system-DkFAwLb_.d.ts:492

Parameters​

handle​

number

thrust​

number

rotate​

number

vectorX?​

number

vectorY?​

number

Returns​

void


setTopDownInput()​

setTopDownInput(handle, moveX, moveY): void

Defined in: node_modules/.pnpm/@zylem+behaviors@0.8.9_@types+react@19.3.0_react@19.3.0_three@0.185.1/node_modules/@zylem/behaviors/dist/behavior-system-DkFAwLb_.d.ts:494

Parameters​

handle​

number

moveX​

number

moveY​

number

Returns​

void


writeInputAxes()​

writeInputAxes(handle, axisA, axisB): boolean

Defined in: node_modules/.pnpm/@zylem+behaviors@0.8.9_@types+react@19.3.0_react@19.3.0_three@0.185.1/node_modules/@zylem/behaviors/dist/behavior-system-DkFAwLb_.d.ts:484

Parameters​

handle​

number

axisA​

number

axisB​

number

Returns​

boolean


writeInputButton()​

writeInputButton(handle, buttonMask, pressed): boolean

Defined in: node_modules/.pnpm/@zylem+behaviors@0.8.9_@types+react@19.3.0_react@19.3.0_three@0.185.1/node_modules/@zylem/behaviors/dist/behavior-system-DkFAwLb_.d.ts:488

Parameters​

handle​

number

buttonMask​

number

pressed​

boolean

Returns​

boolean


writeInputLook()​

writeInputLook(handle, yawDelta, pitchDelta): boolean

Defined in: node_modules/.pnpm/@zylem+behaviors@0.8.9_@types+react@19.3.0_react@19.3.0_three@0.185.1/node_modules/@zylem/behaviors/dist/behavior-system-DkFAwLb_.d.ts:485

Parameters​

handle​

number

yawDelta​

number

pitchDelta​

number

Returns​

boolean


writeInputReserved()​

writeInputReserved(handle, reservedA, reservedB): boolean

Defined in: node_modules/.pnpm/@zylem+behaviors@0.8.9_@types+react@19.3.0_react@19.3.0_three@0.185.1/node_modules/@zylem/behaviors/dist/behavior-system-DkFAwLb_.d.ts:487

Write reserved input slots (thruster world-space vector X/Y).

Parameters​

handle​

number

reservedA​

number

reservedB​

number

Returns​

boolean