@zylem/game-lib 0.8.3 → 0.8.6

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

@@ -34,6 +34,7 @@ import { BridgeHandler } from '@zylem/bridge';
 import { GameLoadingPayload as BridgeLoadingPayload } from '@zylem/bridge';
 import { BridgeMessages } from '@zylem/bridge';
 import { BridgeMessageType } from '@zylem/bridge';
+import { BridgePose } from '@zylem/bridge';
 import { BridgeVec3 } from '@zylem/bridge';
 import { BufferGeometry } from 'three';
 import { BurstParticlePresetOptions } from '@zylem/behaviors';
@@ -94,6 +95,7 @@ import { EntityDefinition } from '@zylem/behaviors/core';
 import { EntityHandle } from '@zylem/behaviors/core';
 import { EntitySummaryPayload } from '@zylem/bridge';
 import { EntityThumbnailPayload } from '@zylem/bridge';
+import { EntityTypeDescriptor } from '@zylem/bridge';
 import { exp } from 'three/tsl';
 import { FacingAngle2DEntity } from '@zylem/behaviors';
 import { fireCooldown } from '@zylem/behaviors';
@@ -279,6 +281,7 @@ import { RuntimeTriggerRegion2DEvent } from '@zylem/behaviors/runtime-2d';
 import { RuntimeTriggerRegion2DHandle } from '@zylem/behaviors/runtime-2d';
 import { RuntimeTriggerRegion2DOptions } from '@zylem/behaviors/runtime-2d';
 import { Scene } from 'three';
+import { SceneOperationPayload } from '@zylem/bridge';
 import { ScreenVisibilityBehavior } from '@zylem/behaviors';
 import { ScreenVisibilityChangeContext } from '@zylem/behaviors';
 import { ScreenVisibilityFSM } from '@zylem/behaviors';
@@ -339,6 +342,7 @@ import { StageTopDownPlane } from '@zylem/behaviors/core';
 import { Static } from '@sinclair/typebox';
 import { step } from 'three/tsl';
 import { Texture } from 'three';
+import * as three from 'three';
 import { ThrusterBehavior } from '@zylem/behaviors';
 import { ThrusterBehaviorOptions } from '@zylem/behaviors';
 import { ThrusterEntity } from '@zylem/behaviors';
@@ -715,6 +719,9 @@ export { clamp }
 // @public
 export function clearGlobalSubscriptions(): void;
 
+// @public
+export function closestAxisValue(ray: GizmoRay, origin: Vector3, axis: Vector3): number | null;
+
 // @public
 export interface CollisionComponent {
     // (undocumented)
@@ -750,6 +757,20 @@ export function coneCollision(opts?: ConeCollisionOptions): CollisionComponent;
 // @public
 export function coneMesh(opts?: ConeMeshOptions): Mesh;
 
+// @public
+export class ConstructionGrid {
+    constructor();
+    // (undocumented)
+    addTo(scene: Scene): void;
+    // (undocumented)
+    dispose(): void;
+    setIncrement(increment: number): void;
+    // (undocumented)
+    setVisible(visible: boolean): void;
+    // (undocumented)
+    get visible(): boolean;
+}
+
 export { CooldownBehavior }
 
 export { CooldownConfig }
@@ -969,6 +990,9 @@ export const debugState: DebugState;
 // @public (undocumented)
 export type DebugTools = 'select' | 'translate' | 'rotate' | 'scale' | 'delete' | 'add' | 'none';
 
+// @public (undocumented)
+export const DEFAULT_SNAP_SETTINGS: SnapSettings;
+
 // @public
 export function defaultTouchControls(player?: InputPlayer, options?: DefaultTouchControlsOptions): GameInputConfig;
 
@@ -987,6 +1011,9 @@ export { defineBehavior }
 
 export { DefineBehaviorConfig }
 
+// @public
+export function degreesToRadians(degrees: number): number;
+
 // @public
 export function delay(ms: number): Action;
 
@@ -1223,6 +1250,9 @@ export interface EntityTypeMap {
     [ZONE_TYPE]: ZylemZone;
 }
 
+// @public
+export function eulerToQuaternion(rotation: Vec3): Quat;
+
 // @public
 export class EventEmitterDelegate<TEvents extends Record<string, unknown>> {
     constructor();
@@ -1426,11 +1456,13 @@ export class GameBridge {
     // (undocumented)
     disconnect(): void;
     onEditorAttached(callback: () => void): () => void;
+    publishCatalog(entities: EntityTypeDescriptor[]): void;
     // (undocumented)
     publishConfig(config: GameConfigPayload): void;
     // (undocumented)
     publishLoading(payload: BridgeLoadingPayload): void;
     publishNotice(level: GameNoticePayload['level'], message: string): void;
+    publishSceneOperation(op: SceneOperationPayload): void;
     // (undocumented)
     publishStageSnapshot(snapshot: StageSnapshotPayload): void;
     // (undocumented)
@@ -1438,17 +1470,19 @@ export class GameBridge {
         paused?: boolean;
         debug?: boolean;
     }): void;
-    // (undocumented)
     publishVariable(payload: GameVariablePayload): void;
     queueEntityRemoved(uuids: string[]): void;
     queueEntityUpsert(entities: EntitySummaryPayload[]): void;
     queueThumbnails(thumbnails: EntityThumbnailPayload[]): void;
     wantsEntityUpdates(): boolean;
+    wantsSceneOperations(): boolean;
     wantsThumbnails(): boolean;
 }
 
 // @public
 export interface GameBridgeHost {
+    applySceneOperation?(op: SceneOperationPayload, direction: 'undo' | 'redo'): void;
+    createEntity?(typeId: string, props: Record<string, unknown> | undefined, pose: BridgePose | undefined): void;
     resolveEntity(uuid: string): GameEntity<any> | null;
     setStageVariable?(key: string, value: unknown): void;
 }
@@ -1632,9 +1666,11 @@ export class GameEntity<O extends GameEntityOptions> extends BaseNode<O> impleme
     clearActions(): void;
     // (undocumented)
     clone(overrides?: Partial<O>): this;
+    colliderBaseline: SimulationColliderDefinition[] | null;
     // (undocumented)
     colliderDesc: SimulationColliderDefinition | undefined;
     colliderDescs: SimulationColliderDefinition[];
+    colliderScaleDirty: boolean;
     // Warning: (ae-forgotten-export) The symbol "CollisionDispatchMetadata" needs to be exported by the entry point public.d.ts
     //
     // (undocumented)
@@ -1682,6 +1718,7 @@ export class GameEntity<O extends GameEntityOptions> extends BaseNode<O> impleme
     getPosition: () => Vector | null;
     // (undocumented)
     getRotation: () => any;
+    getScale(): Vec3;
     // (undocumented)
     getVelocity: () => Vector | null;
     // (undocumented)
@@ -1772,6 +1809,7 @@ export class GameEntity<O extends GameEntityOptions> extends BaseNode<O> impleme
     setRotationY: (y: number) => void;
     // (undocumented)
     setRotationZ: (z: number) => void;
+    setScale(x: number, y: number, z: number): void;
     _setup(params: SetupContext<this>): void;
     _spawnInProgress: boolean;
     _spawnPlacementPending: boolean;
@@ -2099,6 +2137,12 @@ export function getSelectedEntity(): GameEntity<any> | null;
 // @public (undocumented)
 export function getSelectedEntityId(): string | null;
 
+// @public
+export function getSelectedEntityIds(): string[];
+
+// @public
+export function getSnapSettings(): SnapSettings;
+
 // @public
 export function getVariable<T = unknown>(target: object, path: string): T | undefined;
 
@@ -2106,6 +2150,33 @@ export { getVelocity }
 
 export { getZylemBridge }
 
+// @public
+export type GizmoAxis = 'x' | 'y' | 'z' | 'xy' | 'yz' | 'xz' | 'xyz';
+
+// @public
+export type GizmoDelta = {
+    kind: 'translate';
+    offset: Vector3;
+} | {
+    kind: 'rotate';
+    axis: Vector3;
+    angle: number;
+} | {
+    kind: 'scale';
+    factor: Vector3;
+};
+
+// @public (undocumented)
+export type GizmoMode = 'translate' | 'rotate' | 'scale';
+
+// @public
+export interface GizmoRay {
+    // (undocumented)
+    direction: Vector3;
+    // (undocumented)
+    origin: Vector3;
+}
+
 // @public
 export function globalChange<T = any>(key: string, callback: (value: T, ctx: UpdateContext<any>) => void): (ctx: UpdateContext<any>) => void;
 
@@ -2203,6 +2274,9 @@ export interface InputProvider {
 // @public (undocumented)
 export type Inputs = Record<InputPlayer, InputGamepad>;
 
+// @public
+export function intersectPlane(ray: GizmoRay, origin: Vector3, normal: Vector3, target: Vector3): Vector3 | null;
+
 // @public
 export function isGLSLShader(shader: ZylemShader): shader is ZylemShaderObject;
 
@@ -2212,6 +2286,9 @@ export function isManagedRenderEntity(entity: {
     isBundled?: boolean;
 }): boolean;
 
+// @public (undocumented)
+export function isTransformTool(tool: DebugTools): tool is TransformTool;
+
 // @public
 export function isTSLShader(shader: ZylemShader): shader is ZylemTSLShader;
 
@@ -2655,6 +2732,24 @@ export function pyramidCollision(opts?: PyramidCollisionOptions): CollisionCompo
 // @public
 export function pyramidMesh(opts?: PyramidMeshOptions): Mesh;
 
+// @public
+export interface Quat {
+    // (undocumented)
+    w: number;
+    // (undocumented)
+    x: number;
+    // (undocumented)
+    y: number;
+    // (undocumented)
+    z: number;
+}
+
+// @public
+export function quaternionToEuler(rotation: Quat): Vec3;
+
+// @public
+export function radiansToDegrees(radians: number): number;
+
 // @public (undocumented)
 export const RECT_TYPE: unique symbol;
 
@@ -2998,6 +3093,9 @@ export { SemanticParticlePresetOptions }
 // @public
 export function sequence(...actions: Action[]): Action;
 
+// @public
+export function setAddType(typeId: string | null, props?: Record<string, unknown> | null): void;
+
 // @public
 export function setCameraFeed(entity: StageEntity, camera: CameraWrapper, options?: CameraFeedOptions): void;
 
@@ -3007,6 +3105,9 @@ export function setDebugTool(tool: DebugTools): void;
 // @public
 export function setGlobal(path: string, value: unknown): void;
 
+// @public (undocumented)
+export function setGridVisible(visible: boolean): void;
+
 // @public (undocumented)
 export function setHoveredEntityId(uuid: string | null): void;
 
@@ -3051,6 +3152,12 @@ export function setSelectedEntity(entity: GameEntity<any> | string | null): void
 // @public (undocumented)
 export function setSelectedEntityId(uuid: string | null): void;
 
+// @public
+export function setSelectedEntityIds(uuids: string[]): void;
+
+// @public (undocumented)
+export function setSnapSettings(snap: Partial<SnapSettings>): void;
+
 // @public (undocumented)
 export function setStageFrameProfilerEnabled(value: boolean): void;
 
@@ -3134,6 +3241,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
@@ -3186,6 +3294,26 @@ export { sin }
 
 export { smoothstep }
 
+// @public
+export function snapScale(value: Vec3, increment: number): Vec3;
+
+// @public
+export interface SnapSettings {
+    // (undocumented)
+    enabled: boolean;
+    rotate: number;
+    // (undocumented)
+    scale: number;
+    // (undocumented)
+    translate: number;
+}
+
+// @public
+export function snapToIncrement(value: number, increment: number): number;
+
+// @public
+export function snapVec3(value: Vec3, increment: number): Vec3;
+
 // @public (undocumented)
 export const SPHERE_TYPE: unique symbol;
 
@@ -3240,6 +3368,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";
 
@@ -3653,8 +3790,45 @@ export const touchThemes: {
     readonly lagoon: TouchTheme;
 };
 
+// @public
+export const TRANSFORM_TOOLS: readonly ["translate", "rotate", "scale"];
+
 export { TransformComponent }
 
+// @public (undocumented)
+export class TransformGizmo {
+    constructor();
+    // (undocumented)
+    addTo(scene: Scene): void;
+    beginDrag(axis: GizmoAxis, ray: GizmoRay, camera: Camera): boolean;
+    // (undocumented)
+    dispose(): void;
+    // (undocumented)
+    get draggingAxis(): GizmoAxis | null;
+    // (undocumented)
+    endDrag(): void;
+    // (undocumented)
+    getMode(): GizmoMode;
+    // (undocumented)
+    hide(): void;
+    // (undocumented)
+    get isDragging(): boolean;
+    pick(ray: GizmoRay): GizmoAxis | null;
+    // (undocumented)
+    get pivot(): Vector3;
+    // (undocumented)
+    removeFromScene(): void;
+    readonly root: Group<three.Object3DEventMap>;
+    setHighlight(axis: GizmoAxis | null): void;
+    // (undocumented)
+    setMode(mode: GizmoMode): void;
+    show(pivot: Vector3): void;
+    update(camera: Camera): void;
+    updateDrag(ray: GizmoRay, camera: Camera): GizmoDelta | null;
+    // (undocumented)
+    get visible(): boolean;
+}
+
 // @public
 export interface TransformLike {
     // (undocumented)
@@ -3665,6 +3839,9 @@ export interface TransformLike {
 
 export { TransformState }
 
+// @public (undocumented)
+export type TransformTool = (typeof TRANSFORM_TOOLS)[number];
+
 export { uniform }
 
 export { updateBoundaryRicochet }
@@ -4534,9 +4711,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)
@@ -4546,9 +4725,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)
@@ -4629,16 +4813,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-NHkubIfI.d.ts:951:5 - (ae-forgotten-export) The symbol "StageAssetLoaderConfig" needs to be exported by the entry point public.d.ts
-// dist/game-NHkubIfI.d.ts:1563:5 - (ae-forgotten-export) The symbol "StageInterface" needs to be exported by the entry point public.d.ts
+// dist/entity-XZNGBeca.d.ts:332:5 - (ae-forgotten-export) The symbol "RenderCategory_2" needs to be exported by the entry point public.d.ts
+// dist/entity-XZNGBeca.d.ts:333:5 - (ae-forgotten-export) The symbol "RuntimeEntityOptions" needs to be exported by the entry point public.d.ts
+// dist/entity-XZNGBeca.d.ts:334:5 - (ae-forgotten-export) The symbol "CollisionOptions" needs to be exported by the entry point public.d.ts
+// dist/entity-XZNGBeca.d.ts:335:5 - (ae-forgotten-export) The symbol "MaterialOptions" needs to be exported by the entry point public.d.ts
+// dist/entity-XZNGBeca.d.ts:343:9 - (ae-forgotten-export) The symbol "IBuilder" needs to be exported by the entry point public.d.ts
+// dist/entity-XZNGBeca.d.ts:343:9 - (ae-forgotten-export) The symbol "EntityMeshBuilder" needs to be exported by the entry point public.d.ts
+// dist/entity-XZNGBeca.d.ts:344:9 - (ae-forgotten-export) The symbol "EntityCollisionBuilder" needs to be exported by the entry point public.d.ts
+// dist/entity-XZNGBeca.d.ts:345:9 - (ae-forgotten-export) The symbol "MaterialBuilder" needs to be exported by the entry point public.d.ts
+// dist/game-Cy8f6gJm.d.ts:1051:5 - (ae-forgotten-export) The symbol "StageAssetLoaderConfig" needs to be exported by the entry point public.d.ts
+// dist/game-Cy8f6gJm.d.ts:1721:5 - (ae-forgotten-export) The symbol "StageInterface" needs to be exported by the entry point public.d.ts
 
 // (No @packageDocumentation comment for this package)