跳转到内容

签名关联类型:WorldPreparedAuthoritySnapshot – WorldVersion

本页由当前 SDK 声明自动生成。

返回接口索引

WorldPreparedAuthoritySnapshot · WorldRemoteOutcome · WorldResourceEdit · WorldResourceEditBase · WorldResourcePatch · WorldResourceReceipt · WorldResourceTarget · WorldResourceType · WorldRotation · WorldScopeIdentity · WorldScopeOccupancyLock · WorldScopeOccupancySnapshot · WorldScopeVersion · WorldScriptEdit · WorldSomaClipTrack · WorldToolContext · WorldToolContextOutcome · WorldToolContextRequest · WorldToolContextRevokeInput · WorldToolContextRun · WorldToolWritableTarget · WorldTransform · WorldVersion

WorldPreparedAuthoritySnapshot

Production prepare snapshot. The occupancy view is filled from the authoritative durable locks for the same scope; it is a display/preflight fact and never replaces the commit-time gate.

export interface WorldPreparedAuthoritySnapshot extends WorldAuthoritySnapshot {
occupancy: WorldScopeOccupancySnapshot;
}

关联类型:WorldAuthoritySnapshot · WorldScopeOccupancySnapshot

WorldRemoteOutcome

Canvas Remote:Canvas Yjs transport、语义命令 wire、run/cancel、Model MCP report、 提示词片段目录的唯一浏览器出口。所有最终进入 Canvas Service 的协议都在这里。

export type WorldRemoteOutcome<T> = T & {
transportCode?: string;
};

WorldResourceEdit

export type WorldResourceEdit = WorldResourceEditBase & {
resourceType: Exclude<WorldResourceType, 'scene_area'>;
patch?: WorldResourcePatch;
};

关联类型:WorldResourceEditBase · WorldResourceType · WorldResourcePatch

WorldResourceEditBase

The tool-specific strict schema narrows this transport DTO before dispatch.

type WorldResourceEditBase = {
operation: 'create' | 'update' | 'replace' | 'append' | 'patch' | 'delete';
operationId: string;
target?: WorldResourceTarget;
areaId?: string;
expectedVersion?: string;
expectedParentVersion?: string;
title?: string;
transform?: WorldTransform;
settings?: Omit<WorldCameraSettings, "rotation"> & {
rotation?: WorldRotation;
lookAt?: WorldPoint;
};
initialScript?: string;
script?: string;
chunk?: string;
edits?: WorldScriptEdit[];
duration?: number;
loop?: boolean;
};

关联类型:WorldResourceTarget · WorldTransform · WorldCameraSettings · WorldRotation · WorldPoint · WorldScriptEdit

WorldResourcePatch

export type WorldResourcePatch = {
title?: string;
transform?: Partial<Omit<WorldTransform, 'version'>>;
settings?: WorldCameraSettingsPatch & {
lookAt?: WorldPoint;
};
duration?: number;
loop?: boolean;
};

关联类型:WorldTransform · WorldCameraSettingsPatch · WorldPoint

WorldResourceReceipt

Frozen business response stored atomically with the canonical command.

export type WorldResourceReceipt = {
intentHash: string;
target: WorldResourceTarget;
version: string;
deleted?: boolean;
sceneArea?: {
areaId: string;
bounds: GroundAabb;
scopeVersion: string;
resourceVersion: string;
expanded: boolean;
};
historyReplay?: {
sourceCommandId: string;
direction: "undo" | "redo";
};
history?: {
nodes: Array<{
id: string;
before: {
node: ServerCanvas["document"]["nodes"][number];
data: CanvasNodeData | null;
} | null;
after: {
node: ServerCanvas["document"]["nodes"][number];
data: CanvasNodeData | null;
} | null;
}>;
beforeOtherHash: string;
afterOtherHash: string;
beforeEdges: ServerCanvas["document"]["edges"];
afterEdges: ServerCanvas["document"]["edges"];
};
camera?: WorldCameraData;
cameras?: WorldCameraData[];
};

关联类型:WorldResourceTarget · GroundAabb · ServerCanvas · CanvasNodeData · WorldCameraData

成员说明:

  • history:Canonical before/after state for conflict-checked history replay.

WorldResourceTarget

export type WorldResourceTarget = {
areaId: string;
} | {
instanceId: string;
} | {
cameraId: string;
};

WorldResourceType

export type WorldResourceType = 'scene_area' | 'world_model' | 'world_camera' | 'world_model_script' | 'scene_animation_script';

WorldRotation

Right-handed quaternion [u, v, h, w], unit length.

export type WorldRotation = readonly [
number,
number,
number,
number
];

WorldScopeIdentity

Scope IDs are namespaced by kind; a group and area may have the same ID.

export type WorldScopeIdentity = {
kind: "workflow-group-2d";
groupId: WorldId;
} | {
kind: "scene-area";
areaId: WorldId;
} | {
kind: "world-camera";
cameraId: WorldId;
};

关联类型:WorldId

WorldScopeOccupancyLock

One durable lease lock currently covering an object classified into the selected scope. cancelled still owns the lock until exact stop is confirmed; locks are never expired by time.

export interface WorldScopeOccupancyLock {
target: WorldObjectIdentity;
runId: string;
epoch: number;
state: "active" | "cancelled";
}

关联类型:WorldObjectIdentity

WorldScopeOccupancySnapshot

Read-only occupancy view attached to scene-area-prepare.

  • idle is only valid when the durable store was read and returned no lock for any in-scope object;
  • occupied carries every in-scope lock with its run/epoch/state;
  • unknown means the store could not be read (or a legacy response omitted the field) and MUST NOT be treated as idle.

It deliberately contains no process capability, request or execution identity.

export interface WorldScopeOccupancySnapshot {
version: typeof WORLD_SCOPE_OCCUPANCY_VERSION;
scope: WorldScopeVersion;
state: "idle" | "occupied" | "unknown";
locks: WorldScopeOccupancyLock[];
reason?: "store-unavailable" | "not-reported";
}

关联类型:WorldScopeVersion · WorldScopeOccupancyLock

WorldScopeVersion

export interface WorldScopeVersion {
scope: WorldScopeIdentity;
scopeVersion: WorldVersion;
}

关联类型:WorldScopeIdentity · WorldVersion

WorldScriptEdit

export type WorldScriptEdit = {
oldString: string;
newString: string;
};

WorldSomaClipTrack

Immutable asset identity and bounded playback metadata; never contains NPZ data.

export type WorldSomaClipTrack = {
targetBodyPreset?: SomaBodyPresetId;
adaptationVersion?: typeof SOMA_BODY_ADAPTATION_VERSION;
targetId: string;
assetId: string;
checksum: string;
fps: number;
frameCount: number;
startTime: number;
endTime: number;
sourceStartTime?: number;
blendInDuration?: number;
jointPrefix: string;
rootMotion?: 'in-place' | 'translate';
route?: SomaSceneLapRoute;
};

关联类型:SomaBodyPresetId · SomaSceneLapRoute

WorldToolContext

Issued by the host after eligibility and atomic lease acquisition, never trusted from assistant input. Each writable target has exactly one matching lease with this context’s canvasId, runId, epoch and typed target identity. Targets are unique and the writable and read-only sets are disjoint; read-only references acquire no write lease. Partial containment is read-only. A 2D group’s membership alone grants no world write access. Each submission revalidates the scope, target versions, current spatial eligibility and leases. Scope, object, content or pose changes invalidate affected eligibility; an old context cannot implicitly expand its grant. New objects or expanded grants require a fresh eligibility check and atomic lease acquisition. Cancellation invalidates the grant; locks remain until execution is confirmed stopped, even if a target leaves the scope.

export interface WorldToolContext {
allowSceneAreaExpansion?: boolean;
contextId: WorldId;
canvasId: WorldId;
runId: WorldId;
epoch: number;
scope: WorldScopeVersion;
writableTargets: WorldToolWritableTarget[];
readOnlyReferences: WorldObjectVersion[];
}

关联类型:WorldId · WorldScopeVersion · WorldToolWritableTarget · WorldObjectVersion

WorldToolContextOutcome

export type WorldToolContextOutcome = {
ok: true;
context: WorldToolContext;
run: WorldToolContextRun;
retry: boolean;
} | WorldAuthoringFailure;

关联类型:WorldToolContext · WorldToolContextRun · WorldAuthoringFailure

WorldToolContextRequest

export type WorldToolContextRequest = {
canvasId: string;
requestId: string;
runId: string;
epoch: number;
executionId: string;
scope: WorldScopeVersion["scope"];
allowSceneAreaExpansion?: boolean;
};

关联类型:WorldScopeVersion

WorldToolContextRevokeInput

export interface WorldToolContextRevokeInput {
canvasId: string;
contextId: string;
}

WorldToolContextRun

export interface WorldToolContextRun {
canvasId: string;
requestId: string;
runId: string;
epoch: number;
executionId: string;
state: "active" | "cancelled" | "stopped";
}

WorldToolWritableTarget

export interface WorldToolWritableTarget {
target: WorldObjectVersion;
lease: SpatialLeaseIdentity;
}

关联类型:WorldObjectVersion · SpatialLeaseIdentity

WorldTransform

Position in meters; uniform positive scale. Rotation acts after asset-local transforms. Quaternion composition is parent * child (child applied first). Asset local coordinates remain Y-up; conjugate a world rotation by the basis change before applying it in Bevy.

export interface WorldTransform {
version: typeof SHARED_WORLD_VERSION;
position: WorldPoint;
rotation: WorldRotation;
scale: number;
}

关联类型:WorldPoint · WorldRotation

WorldVersion

export type WorldVersion = string;