@zylem/game-lib 0.8.2 → 0.8.4

package/dist/api/game-lib.api.md

@@ -5,6 +5,7 @@
 ```ts
 
 import { abs } from 'three/tsl';
+import { announceBridgeReady } from '@zylem/bridge';
 import { asin } from 'three/tsl';
 import { atan } from 'three/tsl';
 import { BehaviorDescriptor } from '@zylem/behaviors';
@@ -26,6 +27,14 @@ import { BoundaryRicochet3DEntity } from '@zylem/behaviors';
 import { BoundaryRicochetCoordinator } from '@zylem/behaviors';
 import { BoundaryRicochetEntity } from '@zylem/behaviors';
 import { BoundaryRicochetUpdate } from '@zylem/behaviors';
+import { BRIDGE_READY_EVENT } from '@zylem/bridge';
+import { BridgeChannel } from '@zylem/bridge';
+import { BridgeDebugTool } from '@zylem/bridge';
+import { BridgeHandler } from '@zylem/bridge';
+import { GameLoadingPayload as BridgeLoadingPayload } from '@zylem/bridge';
+import { BridgeMessages } from '@zylem/bridge';
+import { BridgeMessageType } from '@zylem/bridge';
+import { BridgeVec3 } from '@zylem/bridge';
 import { BufferGeometry } from 'three';
 import { BurstParticlePresetOptions } from '@zylem/behaviors';
 import { Camera } from 'three';
@@ -77,11 +86,14 @@ import { Destructible3DHandle } from '@zylem/behaviors';
 import { DestructibleMesh } from '@zylem/behaviors';
 import { DestructiblePrebakeWorkerAPI } from '@zylem/behaviors';
 import { dot } from 'three/tsl';
+import { EditorToGameMessages } from '@zylem/bridge';
 import { emitRuntimeGoal } from '@zylem/behaviors/runtime-2d';
 import { emitRuntimeRicochet } from '@zylem/behaviors/runtime-2d';
 import { emitRuntimeTriggerRegionEnter } from '@zylem/behaviors/runtime-2d';
 import { EntityDefinition } from '@zylem/behaviors/core';
 import { EntityHandle } from '@zylem/behaviors/core';
+import { EntitySummaryPayload } from '@zylem/bridge';
+import { EntityThumbnailPayload } from '@zylem/bridge';
 import { exp } from 'three/tsl';
 import { FacingAngle2DEntity } from '@zylem/behaviors';
 import { fireCooldown } from '@zylem/behaviors';
@@ -108,11 +120,16 @@ import { FogExp2 } from 'three';
 import { fract } from 'three/tsl';
 import { FractureOptions } from '@zylem/behaviors';
 import { FractureOptionsInput } from '@zylem/behaviors';
+import { GameConfigPayload } from '@zylem/bridge';
+import { GameNoticePayload } from '@zylem/bridge';
+import { GameToEditorMessages } from '@zylem/bridge';
+import { GameVariablePayload } from '@zylem/bridge';
 import { getCooldown } from '@zylem/behaviors';
 import { getCooldownStore } from '@zylem/behaviors';
 import { getEntityFacingAngle2D } from '@zylem/behaviors';
 import { getPosition } from '@zylem/behaviors/core';
 import { getVelocity } from '@zylem/behaviors/core';
+import { getZylemBridge } from '@zylem/bridge';
 import { Group } from 'three';
 import { hasAnyWorldBoundary2DHit } from '@zylem/behaviors';
 import { hasAnyWorldBoundary3DHit } from '@zylem/behaviors';
@@ -308,6 +325,7 @@ import { StageBodyKindValue } from '@zylem/behaviors/core';
 import { StageBoundaryDim } from '@zylem/behaviors/core';
 import { StageColliderConfig } from '@zylem/behaviors/core';
 import { StageColliderShape } from '@zylem/behaviors/core';
+import { StageConfigPayload } from '@zylem/bridge';
 import { StageDebugRender } from '@zylem/behaviors/core';
 import { StageEvent } from '@zylem/behaviors/core';
 import { StageEventType } from '@zylem/behaviors/core';
@@ -316,6 +334,7 @@ import { StageRaycastHit } from '@zylem/behaviors/core';
 import { StageRenderSlot } from '@zylem/behaviors/core';
 import { StageRicochetDim } from '@zylem/behaviors/core';
 import { StageRicochetReflection } from '@zylem/behaviors/core';
+import { StageSnapshotPayload } from '@zylem/bridge';
 import { StageTopDownPlane } from '@zylem/behaviors/core';
 import { Static } from '@sinclair/typebox';
 import { step } from 'three/tsl';
@@ -380,6 +399,7 @@ import { WorldBoundary3DPosition } from '@zylem/behaviors';
 import { WorldBoundary3DState } from '@zylem/behaviors';
 import { wrapAround3D } from '@zylem/behaviors/core';
 import { wrapAroundXY } from '@zylem/behaviors/core';
+import { ZylemBridge } from '@zylem/bridge';
 
 export { abs }
 
@@ -411,6 +431,8 @@ export interface AnalogState {
     value: number;
 }
 
+export { announceBridgeReady }
+
 // Warning: (ae-forgotten-export) The symbol "TransformableEntity" needs to be exported by the entry point public.d.ts
 //
 // @public
@@ -469,6 +491,22 @@ export function boxCollision(opts?: BoxCollisionOptions): CollisionComponent;
 // @public
 export function boxMesh(opts?: BoxMeshOptions): Mesh;
 
+export { BRIDGE_READY_EVENT }
+
+export { BridgeChannel }
+
+export { BridgeDebugTool }
+
+export { BridgeHandler }
+
+export { BridgeLoadingPayload }
+
+export { BridgeMessages }
+
+export { BridgeMessageType }
+
+export { BridgeVec3 }
+
 // @public
 export function buildBoxCollider(size: Vec3Input, options?: RuntimeColliderOptions): StageColliderConfig;
 
@@ -920,13 +958,16 @@ export function cylinderCollision(opts?: CylinderCollisionOptions): CollisionCom
 // @public
 export function cylinderMesh(opts?: CylinderMeshOptions): Mesh;
 
+// @public
+export type DebugEntityResolver = (uuid: string) => GameEntity<any> | null;
+
 // Warning: (ae-forgotten-export) The symbol "DebugState" needs to be exported by the entry point public.d.ts
 //
 // @public (undocumented)
 export const debugState: DebugState;
 
 // @public (undocumented)
-export type DebugTools = 'select' | 'translate' | 'rotate' | 'scale' | 'delete' | 'none';
+export type DebugTools = 'select' | 'translate' | 'rotate' | 'scale' | 'delete' | 'add' | 'none';
 
 // @public
 export function defaultTouchControls(player?: InputPlayer, options?: DefaultTouchControlsOptions): GameInputConfig;
@@ -989,6 +1030,8 @@ export function dispatchStageState(): void;
 
 export { dot }
 
+export { EditorToGameMessages }
+
 export { emitRuntimeGoal }
 
 export { emitRuntimeRicochet }
@@ -998,40 +1041,6 @@ export { emitRuntimeTriggerRegionEnter }
 // @public (undocumented)
 export type EntityBlueprint = Static<typeof EntitySchema>;
 
-// @public
-export interface EntityConfigPayload {
-    bounds?: {
-        width: number;
-        height: number;
-        depth: number;
-    };
-    // (undocumented)
-    name: string;
-    // (undocumented)
-    position: {
-        x: number;
-        y: number;
-        z: number;
-    };
-    // (undocumented)
-    rotation: {
-        x: number;
-        y: number;
-        z: number;
-    };
-    // (undocumented)
-    scale: {
-        x: number;
-        y: number;
-        z: number;
-    };
-    thumbnail?: string | null;
-    // (undocumented)
-    type: string;
-    // (undocumented)
-    uuid: string;
-}
-
 export { EntityDefinition }
 
 // @public (undocumented)
@@ -1138,9 +1147,12 @@ export const EntitySchema: _sinclair_typebox.TObject<{
 // @public (undocumented)
 export function entitySpawner(factory: (x: number, y: number) => Promise<any> | GameEntity<any>): EntitySpawner;
 
+export { EntitySummaryPayload }
+
 // @public
 export class EntityThumbnailCache {
-    constructor(size?: number);
+    constructor(size?: number, maxEntries?: number);
+    get cacheSize(): number;
     // (undocumented)
     clear(): void;
     ensure(uuid: string, object: Object3D | null | undefined): Promise<EntityThumbnailCacheEntry | null>;
@@ -1148,6 +1160,7 @@ export class EntityThumbnailCache {
     get(uuid: string): EntityThumbnailCacheEntry | null;
     // (undocumented)
     invalidate(uuid: string): void;
+    get pendingCount(): number;
     // (undocumented)
     setRenderer(renderer: WebGPURenderer | null): void;
 }
@@ -1161,13 +1174,14 @@ export interface EntityThumbnailCacheEntry extends EntityThumbnailResult {
     uuid: string;
 }
 
+export { EntityThumbnailPayload }
+
 // @public (undocumented)
 export interface EntityThumbnailResult {
     // Warning: (ae-forgotten-export) The symbol "ObjectBounds" needs to be exported by the entry point public.d.ts
     //
     // (undocumented)
     bounds: Pick<ObjectBounds, 'width' | 'height' | 'depth'>;
-    // (undocumented)
     dataUrl: string;
 }
 
@@ -1405,6 +1419,39 @@ export class Game<TGlobals extends BaseGlobals> implements IGame<TGlobals> {
     step(deltaTime?: number): void;
 }
 
+// @public (undocumented)
+export class GameBridge {
+    constructor();
+    connect(host: GameBridgeHost, announceTarget?: EventTarget): void;
+    // (undocumented)
+    disconnect(): void;
+    onEditorAttached(callback: () => void): () => void;
+    // (undocumented)
+    publishConfig(config: GameConfigPayload): void;
+    // (undocumented)
+    publishLoading(payload: BridgeLoadingPayload): void;
+    publishNotice(level: GameNoticePayload['level'], message: string): void;
+    // (undocumented)
+    publishStageSnapshot(snapshot: StageSnapshotPayload): void;
+    // (undocumented)
+    publishStatus(status: {
+        paused?: boolean;
+        debug?: boolean;
+    }): void;
+    publishVariable(payload: GameVariablePayload): void;
+    queueEntityRemoved(uuids: string[]): void;
+    queueEntityUpsert(entities: EntitySummaryPayload[]): void;
+    queueThumbnails(thumbnails: EntityThumbnailPayload[]): void;
+    wantsEntityUpdates(): boolean;
+    wantsThumbnails(): boolean;
+}
+
+// @public
+export interface GameBridgeHost {
+    resolveEntity(uuid: string): GameEntity<any> | null;
+    setStageVariable?(key: string, value: unknown): void;
+}
+
 // @public
 export function gameConfig(config: GameConfigLike): GameConfigLike;
 
@@ -1538,6 +1585,8 @@ export type GameConfigLike = Partial<{
     canvas: HTMLCanvasElement;
 }>;
 
+export { GameConfigPayload }
+
 // @public (undocumented)
 export type GameDeviceConfig = Partial<{
     aspectRatio: AspectRatioValue | keyof typeof AspectRatio;
@@ -1777,7 +1826,6 @@ export type GameEvents = {
     'debug': {
         enabled: boolean;
     };
-    'state:dispatch': StateDispatchPayload;
 };
 
 // @public (undocumented)
@@ -2009,6 +2057,10 @@ export interface GameLoadingPayload extends LoadingEvent {
     stageName?: string;
 }
 
+export { GameToEditorMessages }
+
+export { GameVariablePayload }
+
 export { getCooldown }
 
 export { getCooldownStore }
@@ -2024,6 +2076,12 @@ export function getGlobal<T = unknown>(path: string): T | undefined;
 // @public
 export function getGlobals<T = Record<string, unknown>>(): T;
 
+// @public
+export function getHoveredEntity(): GameEntity<any> | null;
+
+// @public (undocumented)
+export function getHoveredEntityId(): string | null;
+
 export { getPosition }
 
 // @public (undocumented)
@@ -2034,11 +2092,19 @@ export function getPresetResolution(preset: RetroPresetKey, key?: string): Retro
 // @public
 export function getRotation(entity: RotatableEntity): any;
 
+// @public
+export function getSelectedEntity(): GameEntity<any> | null;
+
+// @public (undocumented)
+export function getSelectedEntityId(): string | null;
+
 // @public
 export function getVariable<T = unknown>(target: object, path: string): T | undefined;
 
 export { getVelocity }
 
+export { getZylemBridge }
+
 // @public
 export function globalChange<T = any>(key: string, callback: (value: T, ctx: UpdateContext<any>) => void): (ctx: UpdateContext<any>) => void;
 
@@ -2593,6 +2659,9 @@ export const RECT_TYPE: unique symbol;
 
 export { registerCooldown }
 
+// @public
+export function registerDebugEntityResolver(resolver: DebugEntityResolver): () => void;
+
 // @public
 export function registerEntityFocusContext(context: EntityFocusContext): () => void;
 
@@ -2666,6 +2735,9 @@ export function resolveButtonAccent(theme: TouchTheme, slot: VirtualTouchButtonS
 
 export { ResolvedAim2D }
 
+// @public
+export function resolveDebugEntity(uuid: string | null): GameEntity<any> | null;
+
 // @public (undocumented)
 export interface ResolveGameConfigRuntime {
     // (undocumented)
@@ -2934,6 +3006,9 @@ export function setDebugTool(tool: DebugTools): void;
 // @public
 export function setGlobal(path: string, value: unknown): void;
 
+// @public (undocumented)
+export function setHoveredEntityId(uuid: string | null): void;
+
 // @public (undocumented)
 export function setPaused(paused: boolean): void;
 
@@ -2969,8 +3044,11 @@ export function setRotationY(entity: RotatableEntity, y: number): void;
 // @public
 export function setRotationZ(entity: RotatableEntity, z: number): void;
 
+// @public @deprecated (undocumented)
+export function setSelectedEntity(entity: GameEntity<any> | string | null): void;
+
 // @public (undocumented)
-export function setSelectedEntity(entity: GameEntity<any> | null): void;
+export function setSelectedEntityId(uuid: string | null): void;
 
 // @public (undocumented)
 export function setStageFrameProfilerEnabled(value: boolean): void;
@@ -3055,6 +3133,7 @@ export class SimulationBody implements PhysicsRenderPoseProvider {
     linvel(): PhysicsVector3;
     lockRotations(locked: boolean, _wakeUp?: boolean): void;
     lockTranslations(locked: boolean, _wakeUp?: boolean): void;
+    markPoseDiscontinuity(): void;
     // (undocumented)
     mass(): number;
     // Warning: (ae-forgotten-export) The symbol "PhysicsQuaternion" needs to be exported by the entry point public.d.ts
@@ -3161,6 +3240,15 @@ export type SpriteImage = {
     file: string;
 };
 
+// @public
+export type SpriteSheet = {
+    file: string;
+    columns: number;
+    rows: number;
+    frames: Array<string | null>;
+    filter?: 'nearest' | 'linear';
+};
+
 // @public
 export const STAGE_STATE_CHANGE = "STAGE_STATE_CHANGE";
 
@@ -3226,25 +3314,7 @@ export type StageConfigLike = Partial<{
     postProcessingEffects: ZylemPostEffect[];
 }>;
 
-// @public
-export interface StageConfigPayload {
-    // (undocumented)
-    backgroundColor: string;
-    // (undocumented)
-    backgroundImage: string | null;
-    // (undocumented)
-    gravity: {
-        x: number;
-        y: number;
-        z: number;
-    };
-    // (undocumented)
-    id: string;
-    // (undocumented)
-    inputs: Record<string, string[]>;
-    // (undocumented)
-    variables: Record<string, unknown>;
-}
+export { StageConfigPayload }
 
 export { StageDebugRender }
 
@@ -3407,6 +3477,8 @@ export const StageSchema: _sinclair_typebox.TObject<{
     assets: _sinclair_typebox.TOptional<_sinclair_typebox.TArray<_sinclair_typebox.TString>>;
 }>;
 
+export { StageSnapshotPayload }
+
 // @public (undocumented)
 export const stageState: {
     previous: StageBlueprint | null;
@@ -3446,34 +3518,6 @@ export const standardShader: {
     fragment: string;
 };
 
-// @public
-export interface StateDispatchPayload {
-    // (undocumented)
-    config?: {
-        id: string;
-        aspectRatio: number;
-        fullscreen: boolean;
-        bodyBackground: string | undefined;
-        internalResolution: {
-            width: number;
-            height: number;
-        } | undefined;
-        debug: boolean;
-    } | null;
-    // (undocumented)
-    entities?: EntityConfigPayload[] | null;
-    // (undocumented)
-    path: string;
-    // (undocumented)
-    previousValue?: unknown;
-    // (undocumented)
-    scope: 'game' | 'stage' | 'entity';
-    // (undocumented)
-    stageConfig?: StageConfigPayload | null;
-    // (undocumented)
-    value: unknown;
-}
-
 export { step }
 
 // @public
@@ -4182,6 +4226,8 @@ export class ZylemBox extends GameEntity<ZylemBoxOptions> {
     static type: symbol;
 }
 
+export { ZylemBridge }
+
 // Warning: (ae-forgotten-export) The symbol "ZylemConeOptions" needs to be exported by the entry point public.d.ts
 //
 // @public
@@ -4497,9 +4543,11 @@ export class ZylemSprite extends GameEntity<ZylemSpriteOptions> {
     // (undocumented)
     protected createAnimations(animations: SpriteAnimation[]): void;
     // (undocumented)
+    protected createSpriteFromSheet(sheet: SpriteSheet): void;
+    // (undocumented)
     protected createSpritesFromImages(images: SpriteImage[]): void;
     // (undocumented)
-    protected currentAnimation: any;
+    protected currentAnimation: string | null;
     // (undocumented)
     protected currentAnimationFrame: string;
     // (undocumented)
@@ -4509,9 +4557,14 @@ export class ZylemSprite extends GameEntity<ZylemSpriteOptions> {
     // (undocumented)
     protected currentSpriteIndex: number;
     // (undocumented)
+    protected flippedX: boolean;
+    // (undocumented)
+    isFlippedX(): boolean;
     setAnimation(name: string, delta: number): void;
+    setFlipX(flip: boolean): void;
     // (undocumented)
     setSprite(key: string): void;
+    protected sheetTexture: Texture | null;
     // (undocumented)
     spriteDestroy(params: DestroyContext<ZylemSpriteOptions>): void;
     // (undocumented)
@@ -4592,16 +4645,16 @@ export class ZylemZone extends GameEntity<ZylemZoneOptions> implements Collision
 
 // Warnings were encountered during analysis:
 //
-// dist/entity-BGEq1yfC.d.ts:423:5 - (ae-forgotten-export) The symbol "RenderCategory_2" needs to be exported by the entry point public.d.ts
-// dist/entity-BGEq1yfC.d.ts:424:5 - (ae-forgotten-export) The symbol "RuntimeEntityOptions" needs to be exported by the entry point public.d.ts
-// dist/entity-BGEq1yfC.d.ts:425:5 - (ae-forgotten-export) The symbol "CollisionOptions" needs to be exported by the entry point public.d.ts
-// dist/entity-BGEq1yfC.d.ts:426:5 - (ae-forgotten-export) The symbol "MaterialOptions" needs to be exported by the entry point public.d.ts
-// dist/entity-BGEq1yfC.d.ts:434:9 - (ae-forgotten-export) The symbol "IBuilder" needs to be exported by the entry point public.d.ts
-// dist/entity-BGEq1yfC.d.ts:434:9 - (ae-forgotten-export) The symbol "EntityMeshBuilder" needs to be exported by the entry point public.d.ts
-// dist/entity-BGEq1yfC.d.ts:435:9 - (ae-forgotten-export) The symbol "EntityCollisionBuilder" needs to be exported by the entry point public.d.ts
-// dist/entity-BGEq1yfC.d.ts:436:9 - (ae-forgotten-export) The symbol "MaterialBuilder" needs to be exported by the entry point public.d.ts
-// dist/game-DbqBQiFC.d.ts:937:5 - (ae-forgotten-export) The symbol "StageAssetLoaderConfig" needs to be exported by the entry point public.d.ts
-// dist/game-DbqBQiFC.d.ts:1549:5 - (ae-forgotten-export) The symbol "StageInterface" needs to be exported by the entry point public.d.ts
+// dist/entity-BI7cSlK8.d.ts:423:5 - (ae-forgotten-export) The symbol "RenderCategory_2" needs to be exported by the entry point public.d.ts
+// dist/entity-BI7cSlK8.d.ts:424:5 - (ae-forgotten-export) The symbol "RuntimeEntityOptions" needs to be exported by the entry point public.d.ts
+// dist/entity-BI7cSlK8.d.ts:425:5 - (ae-forgotten-export) The symbol "CollisionOptions" needs to be exported by the entry point public.d.ts
+// dist/entity-BI7cSlK8.d.ts:426:5 - (ae-forgotten-export) The symbol "MaterialOptions" needs to be exported by the entry point public.d.ts
+// dist/entity-BI7cSlK8.d.ts:434:9 - (ae-forgotten-export) The symbol "IBuilder" needs to be exported by the entry point public.d.ts
+// dist/entity-BI7cSlK8.d.ts:434:9 - (ae-forgotten-export) The symbol "EntityMeshBuilder" needs to be exported by the entry point public.d.ts
+// dist/entity-BI7cSlK8.d.ts:435:9 - (ae-forgotten-export) The symbol "EntityCollisionBuilder" needs to be exported by the entry point public.d.ts
+// dist/entity-BI7cSlK8.d.ts:436:9 - (ae-forgotten-export) The symbol "MaterialBuilder" needs to be exported by the entry point public.d.ts
+// dist/game-4fsy55uN.d.ts:951:5 - (ae-forgotten-export) The symbol "StageAssetLoaderConfig" needs to be exported by the entry point public.d.ts
+// dist/game-4fsy55uN.d.ts:1563:5 - (ae-forgotten-export) The symbol "StageInterface" needs to be exported by the entry point public.d.ts
 
 // (No @packageDocumentation comment for this package)