Skip to main content

ScreenWrapBehavior

@zylem/game-lib

@zylem/game-lib / behavior / ScreenWrapBehavior

Variable: ScreenWrapBehavior

const ScreenWrapBehavior: BehaviorDescriptor<ScreenWrapOptions, Record<string, never>, unknown>

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/screen-wrap.d.ts:42

ScreenWrapBehavior - Wraps entities around 2D bounds

Example​

import { ScreenWrapBehavior } from "@zylem/game-lib/behavior";

const ship = createSprite({ ... });
const wrapRef = ship.use(ScreenWrapBehavior, { width: 20, height: 15 });

// Access FSM to observe edge state
const fsm = wrapRef.getFSM();
console.log(fsm?.getState()); // 'center', 'near-edge-left', 'wrapped', etc.