pelican-engine 0.3.17 → 0.3.19

package/docs/api/REFERENCE.md

@@ -1,4 +1,4 @@
-# pelican 0.3.17 API 索引
+# pelican 0.3.19 API 索引
 
 Installed declarations: `lib/sdk/index.d.ts` (relative to the package root).
 The signatures below come from the same public SDK source as repository games.
@@ -11,7 +11,7 @@ Source-file paths and line numbers are build-time provenance only; TypeScript so
 来源：`packages/sdk/src/index.ts:2`
 
 ```ts
-SDK_VERSION = "0.3.17"
+SDK_VERSION = "0.3.19"
 ```
 
 ## Vec2
@@ -255,12 +255,13 @@ export interface SystemContext extends EngineFacade {
   readonly compute: ComputeService;
   readonly navigation: NavigationService;
   readonly ropes: RopeService;
+  readonly cloth: ClothService;
 }
 ```
 
 ## RopeCollider
 
-来源：`packages/sdk/src/index.ts:123`
+来源：`packages/sdk/src/index.ts:124`
 
 ```ts
 export type RopeCollider =
@@ -270,7 +271,7 @@ export type RopeCollider =
 
 ## RopeBodyCollider
 
-来源：`packages/sdk/src/index.ts:127`
+来源：`packages/sdk/src/index.ts:128`
 
 ```ts
 export interface RopeBodyCollider { readonly id: string; readonly entity: string }
@@ -278,7 +279,7 @@ export interface RopeBodyCollider { readonly id: string; readonly entity: string
 
 ## RopeVisualOptions
 
-来源：`packages/sdk/src/index.ts:129`
+来源：`packages/sdk/src/index.ts:130`
 
 ```ts
 export interface RopeVisualOptions {
@@ -292,7 +293,7 @@ export interface RopeVisualOptions {
 
 ## RopeVisualState
 
-来源：`packages/sdk/src/index.ts:137`
+来源：`packages/sdk/src/index.ts:138`
 
 ```ts
 export interface RopeVisualState {
@@ -308,7 +309,7 @@ export interface RopeVisualState {
 
 ## RopeDefinition
 
-来源：`packages/sdk/src/index.ts:146`
+来源：`packages/sdk/src/index.ts:147`
 
 ```ts
 export interface RopeDefinition {
@@ -339,7 +340,7 @@ export interface RopeDefinition {
 
 ## RopeContact
 
-来源：`packages/sdk/src/index.ts:171`
+来源：`packages/sdk/src/index.ts:172`
 
 ```ts
 export interface RopeContact {
@@ -353,7 +354,7 @@ export interface RopeContact {
 
 ## RopeSegmentContact
 
-来源：`packages/sdk/src/index.ts:179`
+来源：`packages/sdk/src/index.ts:180`
 
 ```ts
 export interface RopeSegmentContact {
@@ -371,7 +372,7 @@ export interface RopeSegmentContact {
 
 ## RopeSelfContact
 
-来源：`packages/sdk/src/index.ts:191`
+来源：`packages/sdk/src/index.ts:192`
 
 ```ts
 export interface RopeSelfContact {
@@ -387,7 +388,7 @@ export interface RopeSelfContact {
 
 ## RopeState
 
-来源：`packages/sdk/src/index.ts:200`
+来源：`packages/sdk/src/index.ts:201`
 
 ```ts
 export interface RopeState {
@@ -406,7 +407,7 @@ export interface RopeState {
 
 ## RopeService
 
-来源：`packages/sdk/src/index.ts:212`
+来源：`packages/sdk/src/index.ts:213`
 
 ```ts
 export interface RopeService {
@@ -425,17 +426,136 @@ export interface RopeService {
 }
 ```
 
-## NavigationCell
+## ClothCollider
+
+来源：`packages/sdk/src/index.ts:228`
+
+```ts
+export type ClothCollider = RopeCollider;
+```
+
+## ClothTriangle
 
 来源：`packages/sdk/src/index.ts:229`
 
+```ts
+export type ClothTriangle = readonly [number, number, number];
+```
+
+## ClothVisualOptions
+
+来源：`packages/sdk/src/index.ts:230`
+
+```ts
+export interface ClothVisualOptions {
+  material: string;
+  /** Optional per-particle UV coordinates; defaults to a planar projection. */
+  uvs?: readonly Vec2[];
+  castShadow?: boolean;
+  receiveShadow?: boolean;
+}
+```
+
+## ClothDefinition
+
+来源：`packages/sdk/src/index.ts:237`
+
+```ts
+export interface ClothDefinition {
+  id: string;
+  points: readonly Vec3[];
+  triangles: readonly ClothTriangle[];
+  /** Kilograms per movable particle. */
+  mass: number;
+  radius?: number;
+  fixedDt?: number;
+  autoStep?: boolean;
+  substeps?: number;
+  iterations?: number;
+  damping?: number;
+  gravity?: Vec3;
+  /** Distance-based bending approximation across shared triangle edges; defaults to true. */
+  bending?: boolean;
+  anchors?: readonly { index: number; position: Vec3 }[];
+  visual?: ClothVisualOptions;
+  /** Discrete non-adjacent particle self-contact; defaults to true for new cloth. */
+  selfCollisions?: boolean;
+}
+```
+
+## ClothContact
+
+来源：`packages/sdk/src/index.ts:257`
+
+```ts
+export interface ClothContact { tick: number; particle: number; colliderId: string; penetration: number }
+```
+
+## ClothSelfContact
+
+来源：`packages/sdk/src/index.ts:258`
+
+```ts
+export interface ClothSelfContact { tick: number; firstParticle: number; secondParticle: number; penetration: number }
+```
+
+## ClothState
+
+来源：`packages/sdk/src/index.ts:259`
+
+```ts
+export interface ClothState {
+  tick: number; simulatedSeconds: number; disposed: boolean; selfCollisions: boolean;
+  positions: Vec3[]; velocities: Vec3[]; triangles: ClothTriangle[];
+  anchors: { index: number; position: Vec3 }[];
+  contacts: ClothContact[]; selfContacts: ClothSelfContact[];
+  maxDistanceError: number;
+  resources: { particles: number; triangles: number; constraints: number; anchors: number; colliders: number };
+}
+```
+
+## ClothVisualState
+
+来源：`packages/sdk/src/index.ts:267`
+
+```ts
+export interface ClothVisualState {
+  id: string; material: string; positions: Vec3[]; triangles: ClothTriangle[];
+  uvs: Vec2[]; castShadow: boolean; receiveShadow: boolean;
+}
+```
+
+## ClothService
+
+来源：`packages/sdk/src/index.ts:271`
+
+```ts
+export interface ClothService {
+  create(definition: ClothDefinition): void;
+  /** Explicit ticks for manual cloth only; automatic cloth rejects this call. */
+  step(id: string, ticks?: number): ClothState;
+  inspect(id: string): ClothState;
+  visuals(): readonly ClothVisualState[];
+  setColliders(id: string, colliders: readonly ClothCollider[]): void;
+  setAnchor(id: string, index: number, position: Vec3): void;
+  releaseAnchor(id: string, index: number): void;
+  applyForce(id: string, index: number, force: Vec3): void;
+  applyImpulse(id: string, index: number, impulse: Vec3): void;
+  destroy(id: string): void;
+}
+```
+
+## NavigationCell
+
+来源：`packages/sdk/src/index.ts:287`
+
 ```ts
 export interface NavigationCell { readonly x: number; readonly y: number }
 ```
 
 ## NavigationObstacleUpdate
 
-来源：`packages/sdk/src/index.ts:231`
+来源：`packages/sdk/src/index.ts:289`
 
 ```ts
 export interface NavigationObstacleUpdate { readonly cell: NavigationCell; readonly blocked: boolean }
@@ -443,7 +563,7 @@ export interface NavigationObstacleUpdate { readonly cell: NavigationCell; reado
 
 ## NavigationGrid
 
-来源：`packages/sdk/src/index.ts:232`
+来源：`packages/sdk/src/index.ts:290`
 
 ```ts
 export interface NavigationGrid {
@@ -459,7 +579,7 @@ export interface NavigationGrid {
 
 ## NavigationService
 
-来源：`packages/sdk/src/index.ts:241`
+来源：`packages/sdk/src/index.ts:299`
 
 ```ts
 export interface NavigationService {
@@ -478,7 +598,7 @@ export interface NavigationService {
 
 ## RenderMode
 
-来源：`packages/sdk/src/index.ts:253`
+来源：`packages/sdk/src/index.ts:311`
 
 ```ts
 export type RenderMode = "raster" | "hybrid" | "path";
@@ -486,7 +606,7 @@ export type RenderMode = "raster" | "hybrid" | "path";
 
 ## RenderCapabilities
 
-来源：`packages/sdk/src/index.ts:254`
+来源：`packages/sdk/src/index.ts:312`
 
 ```ts
 export interface RenderCapabilities {
@@ -498,7 +618,7 @@ export interface RenderCapabilities {
 
 ## RenderSettings
 
-来源：`packages/sdk/src/index.ts:259`
+来源：`packages/sdk/src/index.ts:317`
 
 ```ts
 export interface RenderSettings {
@@ -516,7 +636,7 @@ export interface RenderSettings {
 
 ## RenderService
 
-来源：`packages/sdk/src/index.ts:270`
+来源：`packages/sdk/src/index.ts:328`
 
 ```ts
 export interface RenderService {
@@ -533,7 +653,7 @@ export interface RenderService {
 
 ## MaterialBufferInput
 
-来源：`packages/sdk/src/index.ts:280`
+来源：`packages/sdk/src/index.ts:338`
 
 ```ts
 export interface MaterialBufferInput {
@@ -549,7 +669,7 @@ export interface MaterialBufferInput {
 
 ## RenderBufferReference
 
-来源：`packages/sdk/src/index.ts:289`
+来源：`packages/sdk/src/index.ts:347`
 
 ```ts
 export interface RenderBufferReference {
@@ -561,7 +681,7 @@ export interface RenderBufferReference {
 
 ## RenderBufferBindings
 
-来源：`packages/sdk/src/index.ts:294`
+来源：`packages/sdk/src/index.ts:352`
 
 ```ts
 export interface RenderBufferBindings {
@@ -573,7 +693,7 @@ export interface RenderBufferBindings {
 
 ## MaterialTextureInput
 
-来源：`packages/sdk/src/index.ts:299`
+来源：`packages/sdk/src/index.ts:357`
 
 ```ts
 export interface MaterialTextureInput extends ComputeTextureBinding {
@@ -586,7 +706,7 @@ export interface MaterialTextureInput extends ComputeTextureBinding {
 
 ## RenderTextureReference
 
-来源：`packages/sdk/src/index.ts:305`
+来源：`packages/sdk/src/index.ts:363`
 
 ```ts
 export interface RenderTextureReference extends ComputeTextureSize {
@@ -597,7 +717,7 @@ export interface RenderTextureReference extends ComputeTextureSize {
 
 ## RenderTextureBindings
 
-来源：`packages/sdk/src/index.ts:309`
+来源：`packages/sdk/src/index.ts:367`
 
 ```ts
 export interface RenderTextureBindings {
@@ -609,7 +729,7 @@ export interface RenderTextureBindings {
 
 ## PostProcessState
 
-来源：`packages/sdk/src/index.ts:314`
+来源：`packages/sdk/src/index.ts:372`
 
 ```ts
 export interface PostProcessState {
@@ -621,7 +741,7 @@ export interface PostProcessState {
 
 ## PostProcessService
 
-来源：`packages/sdk/src/index.ts:319`
+来源：`packages/sdk/src/index.ts:377`
 
 ```ts
 export interface PostProcessService {
@@ -638,7 +758,7 @@ export interface PostProcessService {
 
 ## ComputeBufferHandle
 
-来源：`packages/sdk/src/index.ts:329`
+来源：`packages/sdk/src/index.ts:387`
 
 ```ts
 export interface ComputeBufferHandle {
@@ -650,7 +770,7 @@ export interface ComputeBufferHandle {
 
 ## ComputeTaskHandle
 
-来源：`packages/sdk/src/index.ts:334`
+来源：`packages/sdk/src/index.ts:392`
 
 ```ts
 export interface ComputeTaskHandle {
@@ -661,7 +781,7 @@ export interface ComputeTaskHandle {
 
 ## ComputeBufferInput
 
-来源：`packages/sdk/src/index.ts:338`
+来源：`packages/sdk/src/index.ts:396`
 
 ```ts
 export interface ComputeBufferInput {
@@ -674,7 +794,7 @@ export interface ComputeBufferInput {
 
 ## ComputeTextureHandle
 
-来源：`packages/sdk/src/index.ts:344`
+来源：`packages/sdk/src/index.ts:402`
 
 ```ts
 export interface ComputeTextureHandle {
@@ -687,7 +807,7 @@ export interface ComputeTextureHandle {
 
 ## ComputeTextureSize
 
-来源：`packages/sdk/src/index.ts:350`
+来源：`packages/sdk/src/index.ts:408`
 
 ```ts
 export interface ComputeTextureSize {
@@ -698,7 +818,7 @@ export interface ComputeTextureSize {
 
 ## ComputeTextureDataInput
 
-来源：`packages/sdk/src/index.ts:354`
+来源：`packages/sdk/src/index.ts:412`
 
 ```ts
 export interface ComputeTextureDataInput extends ComputeTextureSize {
@@ -711,7 +831,7 @@ export interface ComputeTextureDataInput extends ComputeTextureSize {
 
 ## ComputeTextureAssetInput
 
-来源：`packages/sdk/src/index.ts:360`
+来源：`packages/sdk/src/index.ts:418`
 
 ```ts
 export interface ComputeTextureAssetInput {
@@ -725,7 +845,7 @@ export interface ComputeTextureAssetInput {
 
 ## ComputeTextureInput
 
-来源：`packages/sdk/src/index.ts:367`
+来源：`packages/sdk/src/index.ts:425`
 
 ```ts
 export type ComputeTextureInput = ComputeTextureDataInput | ComputeTextureAssetInput;
@@ -733,7 +853,7 @@ export type ComputeTextureInput = ComputeTextureDataInput | ComputeTextureAssetI
 
 ## ComputeTextureBinding
 
-来源：`packages/sdk/src/index.ts:368`
+来源：`packages/sdk/src/index.ts:426`
 
 ```ts
 export interface ComputeTextureBinding {
@@ -746,7 +866,7 @@ export interface ComputeTextureBinding {
 
 ## ComputeDispatchInput
 
-来源：`packages/sdk/src/index.ts:374`
+来源：`packages/sdk/src/index.ts:432`
 
 ```ts
 export interface ComputeDispatchInput {
@@ -765,7 +885,7 @@ export interface ComputeDispatchInput {
 
 ## ComputeTaskState
 
-来源：`packages/sdk/src/index.ts:386`
+来源：`packages/sdk/src/index.ts:444`
 
 ```ts
 export interface ComputeTaskState {
@@ -776,7 +896,7 @@ export interface ComputeTaskState {
 
 ## ComputeService
 
-来源：`packages/sdk/src/index.ts:390`
+来源：`packages/sdk/src/index.ts:448`
 
 ```ts
 export interface ComputeService {
@@ -803,7 +923,7 @@ export interface ComputeService {
 
 ## InputService
 
-来源：`packages/sdk/src/index.ts:410`
+来源：`packages/sdk/src/index.ts:468`
 
 ```ts
 export interface InputService {
@@ -816,7 +936,7 @@ export interface InputService {
 
 ## PhysicsService
 
-来源：`packages/sdk/src/index.ts:416`
+来源：`packages/sdk/src/index.ts:474`
 
 ```ts
 export interface PhysicsService {
@@ -845,7 +965,7 @@ export interface PhysicsService {
 
 ## AnimationService
 
-来源：`packages/sdk/src/index.ts:438`
+来源：`packages/sdk/src/index.ts:496`
 
 ```ts
 export interface AnimationService {
@@ -864,7 +984,7 @@ export interface AnimationService {
 
 ## CameraService
 
-来源：`packages/sdk/src/index.ts:450`
+来源：`packages/sdk/src/index.ts:508`
 
 ```ts
 export interface CameraService {
@@ -884,7 +1004,7 @@ export interface CameraService {
 
 ## UIService
 
-来源：`packages/sdk/src/index.ts:463`
+来源：`packages/sdk/src/index.ts:521`
 
 ```ts
 export interface UIService {
@@ -896,7 +1016,7 @@ export interface UIService {
 
 ## AudioService
 
-来源：`packages/sdk/src/index.ts:468`
+来源：`packages/sdk/src/index.ts:526`
 
 ```ts
 export interface AudioService {
@@ -918,7 +1038,7 @@ export interface AudioService {
 
 ## StorageService
 
-来源：`packages/sdk/src/index.ts:483`
+来源：`packages/sdk/src/index.ts:541`
 
 ```ts
 export interface StorageService {
@@ -934,7 +1054,7 @@ export interface StorageService {
 
 ## SceneService
 
-来源：`packages/sdk/src/index.ts:492`
+来源：`packages/sdk/src/index.ts:550`
 
 ```ts
 export interface SceneService {
@@ -945,7 +1065,7 @@ export interface SceneService {
 
 ## ModelDefinition
 
-来源：`packages/sdk/src/index.ts:496`
+来源：`packages/sdk/src/index.ts:554`
 
 ```ts
 export interface ModelDefinition {
@@ -965,7 +1085,7 @@ export interface ModelDefinition {
 
 ## RigidBodyDefinition
 
-来源：`packages/sdk/src/index.ts:509`
+来源：`packages/sdk/src/index.ts:567`
 
 ```ts
 export interface RigidBodyDefinition {
@@ -986,7 +1106,7 @@ export interface RigidBodyDefinition {
 
 ## CharacterDefinition
 
-来源：`packages/sdk/src/index.ts:523`
+来源：`packages/sdk/src/index.ts:581`
 
 ```ts
 export interface CharacterDefinition {
@@ -1001,7 +1121,7 @@ export interface CharacterDefinition {
 
 ## UIElementDefinition
 
-来源：`packages/sdk/src/index.ts:531`
+来源：`packages/sdk/src/index.ts:589`
 
 ```ts
 export interface UIElementDefinition {
@@ -1021,7 +1141,7 @@ export interface UIElementDefinition {
 
 ## SoundDefinition
 
-来源：`packages/sdk/src/index.ts:544`
+来源：`packages/sdk/src/index.ts:602`
 
 ```ts
 export interface SoundDefinition {
@@ -1035,7 +1155,7 @@ export interface SoundDefinition {
 
 ## AudioBusDefinition
 
-来源：`packages/sdk/src/index.ts:551`
+来源：`packages/sdk/src/index.ts:609`
 
 ```ts
 export interface AudioBusDefinition {
@@ -1046,7 +1166,7 @@ export interface AudioBusDefinition {
 
 ## SYSTEM_PHASES
 
-来源：`packages/sdk/src/index.ts:555`
+来源：`packages/sdk/src/index.ts:613`
 
 ```ts
 SYSTEM_PHASES = [
@@ -1061,7 +1181,7 @@ SYSTEM_PHASES = [
 
 ## SystemPhase
 
-来源：`packages/sdk/src/index.ts:563`
+来源：`packages/sdk/src/index.ts:621`
 
 ```ts
 export type SystemPhase = (typeof SYSTEM_PHASES)[number];
@@ -1069,7 +1189,7 @@ export type SystemPhase = (typeof SYSTEM_PHASES)[number];
 
 ## Geometry
 
-来源：`packages/sdk/src/index.ts:564`
+来源：`packages/sdk/src/index.ts:622`
 
 ```ts
 export type Geometry =
@@ -1080,7 +1200,7 @@ export type Geometry =
 
 ## GRAPH_TYPES
 
-来源：`packages/sdk/src/index.ts:568`
+来源：`packages/sdk/src/index.ts:626`
 
 ```ts
 GRAPH_TYPES = ["float", "vec2", "vec3", "vec4", "bool"] as const
@@ -1088,7 +1208,7 @@ GRAPH_TYPES = ["float", "vec2", "vec3", "vec4", "bool"] as const
 
 ## GraphType
 
-来源：`packages/sdk/src/index.ts:569`
+来源：`packages/sdk/src/index.ts:627`
 
 ```ts
 export type GraphType = typeof GRAPH_TYPES[number];
@@ -1096,7 +1216,7 @@ export type GraphType = typeof GRAPH_TYPES[number];
 
 ## GraphValue
 
-来源：`packages/sdk/src/index.ts:570`
+来源：`packages/sdk/src/index.ts:628`
 
 ```ts
 export type GraphValue = number | boolean | Vec2 | Vec3 | Vec4;
@@ -1104,7 +1224,7 @@ export type GraphValue = number | boolean | Vec2 | Vec3 | Vec4;
 
 ## GraphParameter
 
-来源：`packages/sdk/src/index.ts:571`
+来源：`packages/sdk/src/index.ts:629`
 
 ```ts
 export interface GraphParameter {
@@ -1116,7 +1236,7 @@ export interface GraphParameter {
 
 ## GRAPH_INPUT_TYPES
 
-来源：`packages/sdk/src/index.ts:576`
+来源：`packages/sdk/src/index.ts:634`
 
 ```ts
 GRAPH_INPUT_TYPES = {
@@ -1130,7 +1250,7 @@ GRAPH_INPUT_TYPES = {
 
 ## GraphInputName
 
-来源：`packages/sdk/src/index.ts:583`
+来源：`packages/sdk/src/index.ts:641`
 
 ```ts
 export type GraphInputName = keyof typeof GRAPH_INPUT_TYPES;
@@ -1138,7 +1258,7 @@ export type GraphInputName = keyof typeof GRAPH_INPUT_TYPES;
 
 ## GRAPH_OPERATIONS
 
-来源：`packages/sdk/src/index.ts:584`
+来源：`packages/sdk/src/index.ts:642`
 
 ```ts
 GRAPH_OPERATIONS = {
@@ -1150,7 +1270,7 @@ GRAPH_OPERATIONS = {
 
 ## GraphNode
 
-来源：`packages/sdk/src/index.ts:589`
+来源：`packages/sdk/src/index.ts:647`
 
 ```ts
 export type GraphNode =
@@ -1177,7 +1297,7 @@ export type GraphNode =
 
 ## Graph
 
-来源：`packages/sdk/src/index.ts:609`
+来源：`packages/sdk/src/index.ts:667`
 
 ```ts
 export interface Graph {
@@ -1189,7 +1309,7 @@ export interface Graph {
 
 ## MaterialGraphs
 
-来源：`packages/sdk/src/index.ts:614`
+来源：`packages/sdk/src/index.ts:672`
 
 ```ts
 export interface MaterialGraphs {
@@ -1205,7 +1325,7 @@ export interface MaterialGraphs {
 
 ## VertexGraphs
 
-来源：`packages/sdk/src/index.ts:623`
+来源：`packages/sdk/src/index.ts:681`
 
 ```ts
 export interface VertexGraphs {
@@ -1218,7 +1338,7 @@ export interface VertexGraphs {
 
 ## MaterialInput
 
-来源：`packages/sdk/src/index.ts:629`
+来源：`packages/sdk/src/index.ts:687`
 
 ```ts
 export interface MaterialInput {
@@ -1252,7 +1372,7 @@ export interface MaterialInput {
 
 ## MaterialDefinition
 
-来源：`packages/sdk/src/index.ts:656`
+来源：`packages/sdk/src/index.ts:714`
 
 ```ts
 export interface MaterialDefinition extends MaterialInput {
@@ -1262,7 +1382,7 @@ export interface MaterialDefinition extends MaterialInput {
 
 ## PostProcessInput
 
-来源：`packages/sdk/src/index.ts:659`
+来源：`packages/sdk/src/index.ts:717`
 
 ```ts
 export interface PostProcessInput {
@@ -1277,7 +1397,7 @@ export interface PostProcessInput {
 
 ## PostProcessDefinition
 
-来源：`packages/sdk/src/index.ts:667`
+来源：`packages/sdk/src/index.ts:725`
 
 ```ts
 export interface PostProcessDefinition extends PostProcessInput {
@@ -1287,7 +1407,7 @@ export interface PostProcessDefinition extends PostProcessInput {
 
 ## ComputeInput
 
-来源：`packages/sdk/src/index.ts:670`
+来源：`packages/sdk/src/index.ts:728`
 
 ```ts
 export interface ComputeInput {
@@ -1303,7 +1423,7 @@ export interface ComputeInput {
 
 ## ComputeDefinition
 
-来源：`packages/sdk/src/index.ts:679`
+来源：`packages/sdk/src/index.ts:737`
 
 ```ts
 export interface ComputeDefinition extends ComputeInput {
@@ -1313,7 +1433,7 @@ export interface ComputeDefinition extends ComputeInput {
 
 ## AssetInput
 
-来源：`packages/sdk/src/index.ts:682`
+来源：`packages/sdk/src/index.ts:740`
 
 ```ts
 export interface AssetInput {
@@ -1330,7 +1450,7 @@ export interface AssetInput {
 
 ## AssetDefinition
 
-来源：`packages/sdk/src/index.ts:692`
+来源：`packages/sdk/src/index.ts:750`
 
 ```ts
 export interface AssetDefinition extends AssetInput {
@@ -1340,7 +1460,7 @@ export interface AssetDefinition extends AssetInput {
 
 ## MeshDefinition
 
-来源：`packages/sdk/src/index.ts:695`
+来源：`packages/sdk/src/index.ts:753`
 
 ```ts
 export interface MeshDefinition {
@@ -1353,7 +1473,7 @@ export interface MeshDefinition {
 
 ## LightDefinition
 
-来源：`packages/sdk/src/index.ts:701`
+来源：`packages/sdk/src/index.ts:759`
 
 ```ts
 export interface LightDefinition {
@@ -1375,7 +1495,7 @@ export interface LightDefinition {
 
 ## EntityInput
 
-来源：`packages/sdk/src/index.ts:716`
+来源：`packages/sdk/src/index.ts:774`
 
 ```ts
 export interface EntityInput {
@@ -1394,7 +1514,7 @@ export interface EntityInput {
 
 ## PrefabInput
 
-来源：`packages/sdk/src/index.ts:728`
+来源：`packages/sdk/src/index.ts:786`
 
 ```ts
 export interface PrefabInput extends Omit<EntityInput, "prefab" | "parent"> {
@@ -1404,7 +1524,7 @@ export interface PrefabInput extends Omit<EntityInput, "prefab" | "parent"> {
 
 ## PrefabDefinition
 
-来源：`packages/sdk/src/index.ts:731`
+来源：`packages/sdk/src/index.ts:789`
 
 ```ts
 export interface PrefabDefinition extends PrefabInput {
@@ -1414,7 +1534,7 @@ export interface PrefabDefinition extends PrefabInput {
 
 ## SceneInput
 
-来源：`packages/sdk/src/index.ts:734`
+来源：`packages/sdk/src/index.ts:792`
 
 ```ts
 export interface SceneInput {
@@ -1446,7 +1566,7 @@ export interface SceneInput {
 
 ## SceneDefinition
 
-来源：`packages/sdk/src/index.ts:759`
+来源：`packages/sdk/src/index.ts:817`
 
 ```ts
 export interface SceneDefinition extends SceneInput {
@@ -1456,7 +1576,7 @@ export interface SceneDefinition extends SceneInput {
 
 ## SystemInput
 
-来源：`packages/sdk/src/index.ts:762`
+来源：`packages/sdk/src/index.ts:820`
 
 ```ts
 export interface SystemInput {
@@ -1473,7 +1593,7 @@ export interface SystemInput {
 
 ## SystemDefinition
 
-来源：`packages/sdk/src/index.ts:772`
+来源：`packages/sdk/src/index.ts:830`
 
 ```ts
 export interface SystemDefinition extends SystemInput {
@@ -1483,7 +1603,7 @@ export interface SystemDefinition extends SystemInput {
 
 ## GameInput
 
-来源：`packages/sdk/src/index.ts:775`
+来源：`packages/sdk/src/index.ts:833`
 
 ```ts
 export interface GameInput {
@@ -1509,7 +1629,7 @@ export interface GameInput {
 
 ## GameDefinition
 
-来源：`packages/sdk/src/index.ts:794`
+来源：`packages/sdk/src/index.ts:852`
 
 ```ts
 export interface GameDefinition extends GameInput {
@@ -1519,7 +1639,7 @@ export interface GameDefinition extends GameInput {
 
 ## GameInstance
 
-来源：`packages/sdk/src/index.ts:797`
+来源：`packages/sdk/src/index.ts:855`
 
 ```ts
 export interface GameInstance {
@@ -1530,7 +1650,7 @@ export interface GameInstance {
 
 ## defineComponent
 
-来源：`packages/sdk/src/index.ts:801`
+来源：`packages/sdk/src/index.ts:859`
 
 ```ts
 export function defineComponent<const S extends ComponentSchema>(input: {
@@ -1541,7 +1661,7 @@ export function defineComponent<const S extends ComponentSchema>(input: {
 
 ## defineMaterial
 
-来源：`packages/sdk/src/index.ts:807`
+来源：`packages/sdk/src/index.ts:865`
 
 ```ts
 export function defineMaterial(input: MaterialInput): MaterialDefinition;
@@ -1549,7 +1669,7 @@ export function defineMaterial(input: MaterialInput): MaterialDefinition;
 
 ## definePostProcess
 
-来源：`packages/sdk/src/index.ts:810`
+来源：`packages/sdk/src/index.ts:868`
 
 ```ts
 export function definePostProcess(input: PostProcessInput): PostProcessDefinition;
@@ -1557,7 +1677,7 @@ export function definePostProcess(input: PostProcessInput): PostProcessDefinitio
 
 ## defineCompute
 
-来源：`packages/sdk/src/index.ts:813`
+来源：`packages/sdk/src/index.ts:871`
 
 ```ts
 export function defineCompute(input: ComputeInput): ComputeDefinition;
@@ -1565,7 +1685,7 @@ export function defineCompute(input: ComputeInput): ComputeDefinition;
 
 ## defineAsset
 
-来源：`packages/sdk/src/index.ts:816`
+来源：`packages/sdk/src/index.ts:874`
 
 ```ts
 export function defineAsset(input: AssetInput): AssetDefinition;
@@ -1573,7 +1693,7 @@ export function defineAsset(input: AssetInput): AssetDefinition;
 
 ## definePrefab
 
-来源：`packages/sdk/src/index.ts:819`
+来源：`packages/sdk/src/index.ts:877`
 
 ```ts
 export function definePrefab(input: PrefabInput): PrefabDefinition;
@@ -1581,7 +1701,7 @@ export function definePrefab(input: PrefabInput): PrefabDefinition;
 
 ## defineScene
 
-来源：`packages/sdk/src/index.ts:822`
+来源：`packages/sdk/src/index.ts:880`
 
 ```ts
 export function defineScene(input: SceneInput): SceneDefinition;
@@ -1589,7 +1709,7 @@ export function defineScene(input: SceneInput): SceneDefinition;
 
 ## defineSystem
 
-来源：`packages/sdk/src/index.ts:825`
+来源：`packages/sdk/src/index.ts:883`
 
 ```ts
 export function defineSystem(input: SystemInput): SystemDefinition;
@@ -1597,7 +1717,7 @@ export function defineSystem(input: SystemInput): SystemDefinition;
 
 ## defineGame
 
-来源：`packages/sdk/src/index.ts:828`
+来源：`packages/sdk/src/index.ts:886`
 
 ```ts
 export function defineGame(input: GameInput): GameDefinition;
@@ -1605,7 +1725,7 @@ export function defineGame(input: GameInput): GameDefinition;
 
 ## instantiateGame
 
-来源：`packages/sdk/src/index.ts:832`
+来源：`packages/sdk/src/index.ts:890`
 
 ```ts
 export function instantiateGame(