Skip to main content

EditorToGameMessages

@zylem/game-lib

@zylem/game-lib / bridge / EditorToGameMessages

Type Alias: EditorToGameMessages

EditorToGameMessages = object

Defined in: packages/bridge/src/protocol.ts:416

Commands published by the editor, consumed by the game.

Properties​

add:type:set​

add:type:set: object

Defined in: packages/bridge/src/protocol.ts:441

Arm the add tool with a catalog type, or null to disarm.

props?​

optional props?: Record<string, unknown>

typeId​

typeId: string | null

camera:pose:get​

camera:pose:get: object

Defined in: packages/bridge/src/protocol.ts:462

Ask for the live camera's pose; answered by camera:pose.

requestId​

requestId: string

camera:view:set​

camera:view:set: object

Defined in: packages/bridge/src/protocol.ts:464

Lock the debug orbit camera to a preset, or custom to unlock rotation.

preset​

preset: CameraViewPreset

cutscene:load​

cutscene:load: CutsceneLoadPayload

Defined in: packages/bridge/src/protocol.ts:453

cutscene:pause​

cutscene:pause: Record<string, never>

Defined in: packages/bridge/src/protocol.ts:455

cutscene:play​

cutscene:play: object

Defined in: packages/bridge/src/protocol.ts:454

from?​

optional from?: number

cutscene:seek​

cutscene:seek: object

Defined in: packages/bridge/src/protocol.ts:458

Scrub to a time without firing events.

time​

time: number

cutscene:stop​

cutscene:stop: Record<string, never>

Defined in: packages/bridge/src/protocol.ts:456

cutscene:unload​

cutscene:unload: Record<string, never>

Defined in: packages/bridge/src/protocol.ts:460

Drop the loaded cutscene and hand the camera back to gameplay.

debug:set​

debug:set: object

Defined in: packages/bridge/src/protocol.ts:417

enabled​

enabled: boolean

entity:apply-swatch​

entity:apply-swatch: EntityApplySwatchPayload

Defined in: packages/bridge/src/protocol.ts:452

entity:create​

entity:create: object

Defined in: packages/bridge/src/protocol.ts:429

pose?​

optional pose?: BridgePose

props?​

optional props?: Record<string, unknown>

typeId​

typeId: string

entity:focus​

entity:focus: object

Defined in: packages/bridge/src/protocol.ts:421

uuid​

uuid: string

entity:pick​

entity:pick: EntityPickPayload

Defined in: packages/bridge/src/protocol.ts:451

Raycast at a pointer position; answered by entity:pick:result.

entity:select​

entity:select: EntitySelectPayload

Defined in: packages/bridge/src/protocol.ts:420

entity:transform​

entity:transform: object

Defined in: packages/bridge/src/protocol.ts:422

position?​

optional position?: BridgeVec3

quaternion?​

optional quaternion?: BridgeQuat

rotation?​

optional rotation?: BridgeVec3

scale?​

optional scale?: BridgeVec3

uuid​

uuid: string

grid:set​

grid:set: object

Defined in: packages/bridge/src/protocol.ts:443

visible​

visible: boolean

level:load​

level:load: object

Defined in: packages/bridge/src/protocol.ts:435

Stream a recorded level into the running stage.

buffer​

buffer: LevelBuffer

pick:mode:set​

pick:mode:set: object

Defined in: packages/bridge/src/protocol.ts:449

Arm host-driven hover picking (e.g. while a swatch is being dragged over the viewport). While armed, entity:pick also updates the hover highlight.

enabled​

enabled: boolean

playback:set​

playback:set: object

Defined in: packages/bridge/src/protocol.ts:419

paused​

paused: boolean

scene:operation:apply​

scene:operation:apply: object

Defined in: packages/bridge/src/protocol.ts:436

direction​

direction: "undo" | "redo"

op​

op: SceneOperationPayload

snap:set​

snap:set: SnapSettingsPayload

Defined in: packages/bridge/src/protocol.ts:442

stage:variable:set​

stage:variable:set: object

Defined in: packages/bridge/src/protocol.ts:444

key​

key: string

value​

value: unknown

tool:set​

tool:set: object

Defined in: packages/bridge/src/protocol.ts:418

tool​

tool: BridgeDebugTool