pelican-engine 0.3.16 → 0.3.18

package/docs/api/REFERENCE.md

@@ -1,4 +1,4 @@
-# pelican 0.3.16 API 索引
+# pelican 0.3.18 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.16"
+SDK_VERSION = "0.3.18"
 ```
 
 ## 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 {
@@ -325,6 +326,8 @@ export interface RopeDefinition {
   bodyColliders?: readonly RopeBodyCollider[];
   /** Resolve sphere contacts on segment interiors; defaults to true for new ropes. */
   segmentCollisions?: boolean;
+  /** Resolve discrete non-adjacent segment self contacts; defaults to true for new ropes. */
+  selfCollisions?: boolean;
   /** Optional segmented presentation using an already-declared material id. */
   visual?: RopeVisualOptions;
   substeps?: number;
@@ -337,7 +340,7 @@ export interface RopeDefinition {
 
 ## RopeContact
 
-来源：`packages/sdk/src/index.ts:169`
+来源：`packages/sdk/src/index.ts:172`
 
 ```ts
 export interface RopeContact {
@@ -351,7 +354,7 @@ export interface RopeContact {
 
 ## RopeSegmentContact
 
-来源：`packages/sdk/src/index.ts:177`
+来源：`packages/sdk/src/index.ts:180`
 
 ```ts
 export interface RopeSegmentContact {
@@ -367,18 +370,36 @@ export interface RopeSegmentContact {
 }
 ```
 
+## RopeSelfContact
+
+来源：`packages/sdk/src/index.ts:192`
+
+```ts
+export interface RopeSelfContact {
+  tick: number;
+  /** Zero-based first endpoint of each non-adjacent segment, ordered ascending. */
+  firstSegment: number; secondSegment: number;
+  /** Last closest-point fractions along the respective segments. */
+  firstFraction: number; secondFraction: number;
+  /** Maximum observed overlap in metres during this tick. */
+  penetration: number;
+}
+```
+
 ## RopeState
 
-来源：`packages/sdk/src/index.ts:188`
+来源：`packages/sdk/src/index.ts:201`
 
 ```ts
 export interface RopeState {
   tick: number; simulatedSeconds: number; disposed: boolean;
   segmentCollisions: boolean;
+  selfCollisions: boolean;
   positions: Vec3[]; velocities: Vec3[];
   anchors: { index: number; position: Vec3 }[];
   contacts: RopeContact[];
   segmentContacts: RopeSegmentContact[];
+  selfContacts: RopeSelfContact[];
   maxDistanceError: number;
   resources: { particles: number; constraints: number; anchors: number; colliders: number };
 }
@@ -386,7 +407,7 @@ export interface RopeState {
 
 ## RopeService
 
-来源：`packages/sdk/src/index.ts:198`
+来源：`packages/sdk/src/index.ts:213`
 
 ```ts
 export interface RopeService {
@@ -405,9 +426,118 @@ export interface RopeService {
 }
 ```
 
+## 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;
+}
+```
+
+## ClothContact
+
+来源：`packages/sdk/src/index.ts:255`
+
+```ts
+export interface ClothContact { tick: number; particle: number; colliderId: string; penetration: number }
+```
+
+## ClothState
+
+来源：`packages/sdk/src/index.ts:256`
+
+```ts
+export interface ClothState {
+  tick: number; simulatedSeconds: number; disposed: boolean;
+  positions: Vec3[]; velocities: Vec3[]; triangles: ClothTriangle[];
+  anchors: { index: number; position: Vec3 }[];
+  contacts: ClothContact[];
+  maxDistanceError: number;
+  resources: { particles: number; triangles: number; constraints: number; anchors: number; colliders: number };
+}
+```
+
+## ClothVisualState
+
+来源：`packages/sdk/src/index.ts:264`
+
+```ts
+export interface ClothVisualState {
+  id: string; material: string; positions: Vec3[]; triangles: ClothTriangle[];
+  uvs: Vec2[]; castShadow: boolean; receiveShadow: boolean;
+}
+```
+
+## ClothService
+
+来源：`packages/sdk/src/index.ts:268`
+
+```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:215`
+来源：`packages/sdk/src/index.ts:284`
 
 ```ts
 export interface NavigationCell { readonly x: number; readonly y: number }
@@ -415,7 +545,7 @@ export interface NavigationCell { readonly x: number; readonly y: number }
 
 ## NavigationObstacleUpdate
 
-来源：`packages/sdk/src/index.ts:217`
+来源：`packages/sdk/src/index.ts:286`
 
 ```ts
 export interface NavigationObstacleUpdate { readonly cell: NavigationCell; readonly blocked: boolean }
@@ -423,7 +553,7 @@ export interface NavigationObstacleUpdate { readonly cell: NavigationCell; reado
 
 ## NavigationGrid
 
-来源：`packages/sdk/src/index.ts:218`
+来源：`packages/sdk/src/index.ts:287`
 
 ```ts
 export interface NavigationGrid {
@@ -439,7 +569,7 @@ export interface NavigationGrid {
 
 ## NavigationService
 
-来源：`packages/sdk/src/index.ts:227`
+来源：`packages/sdk/src/index.ts:296`
 
 ```ts
 export interface NavigationService {
@@ -458,7 +588,7 @@ export interface NavigationService {
 
 ## RenderMode
 
-来源：`packages/sdk/src/index.ts:239`
+来源：`packages/sdk/src/index.ts:308`
 
 ```ts
 export type RenderMode = "raster" | "hybrid" | "path";
@@ -466,7 +596,7 @@ export type RenderMode = "raster" | "hybrid" | "path";
 
 ## RenderCapabilities
 
-来源：`packages/sdk/src/index.ts:240`
+来源：`packages/sdk/src/index.ts:309`
 
 ```ts
 export interface RenderCapabilities {
@@ -478,7 +608,7 @@ export interface RenderCapabilities {
 
 ## RenderSettings
 
-来源：`packages/sdk/src/index.ts:245`
+来源：`packages/sdk/src/index.ts:314`
 
 ```ts
 export interface RenderSettings {
@@ -496,7 +626,7 @@ export interface RenderSettings {
 
 ## RenderService
 
-来源：`packages/sdk/src/index.ts:256`
+来源：`packages/sdk/src/index.ts:325`
 
 ```ts
 export interface RenderService {
@@ -513,7 +643,7 @@ export interface RenderService {
 
 ## MaterialBufferInput
 
-来源：`packages/sdk/src/index.ts:266`
+来源：`packages/sdk/src/index.ts:335`
 
 ```ts
 export interface MaterialBufferInput {
@@ -529,7 +659,7 @@ export interface MaterialBufferInput {
 
 ## RenderBufferReference
 
-来源：`packages/sdk/src/index.ts:275`
+来源：`packages/sdk/src/index.ts:344`
 
 ```ts
 export interface RenderBufferReference {
@@ -541,7 +671,7 @@ export interface RenderBufferReference {
 
 ## RenderBufferBindings
 
-来源：`packages/sdk/src/index.ts:280`
+来源：`packages/sdk/src/index.ts:349`
 
 ```ts
 export interface RenderBufferBindings {
@@ -553,7 +683,7 @@ export interface RenderBufferBindings {
 
 ## MaterialTextureInput
 
-来源：`packages/sdk/src/index.ts:285`
+来源：`packages/sdk/src/index.ts:354`
 
 ```ts
 export interface MaterialTextureInput extends ComputeTextureBinding {
@@ -566,7 +696,7 @@ export interface MaterialTextureInput extends ComputeTextureBinding {
 
 ## RenderTextureReference
 
-来源：`packages/sdk/src/index.ts:291`
+来源：`packages/sdk/src/index.ts:360`
 
 ```ts
 export interface RenderTextureReference extends ComputeTextureSize {
@@ -577,7 +707,7 @@ export interface RenderTextureReference extends ComputeTextureSize {
 
 ## RenderTextureBindings
 
-来源：`packages/sdk/src/index.ts:295`
+来源：`packages/sdk/src/index.ts:364`
 
 ```ts
 export interface RenderTextureBindings {
@@ -589,7 +719,7 @@ export interface RenderTextureBindings {
 
 ## PostProcessState
 
-来源：`packages/sdk/src/index.ts:300`
+来源：`packages/sdk/src/index.ts:369`
 
 ```ts
 export interface PostProcessState {
@@ -601,7 +731,7 @@ export interface PostProcessState {
 
 ## PostProcessService
 
-来源：`packages/sdk/src/index.ts:305`
+来源：`packages/sdk/src/index.ts:374`
 
 ```ts
 export interface PostProcessService {
@@ -618,7 +748,7 @@ export interface PostProcessService {
 
 ## ComputeBufferHandle
 
-来源：`packages/sdk/src/index.ts:315`
+来源：`packages/sdk/src/index.ts:384`
 
 ```ts
 export interface ComputeBufferHandle {
@@ -630,7 +760,7 @@ export interface ComputeBufferHandle {
 
 ## ComputeTaskHandle
 
-来源：`packages/sdk/src/index.ts:320`
+来源：`packages/sdk/src/index.ts:389`
 
 ```ts
 export interface ComputeTaskHandle {
@@ -641,7 +771,7 @@ export interface ComputeTaskHandle {
 
 ## ComputeBufferInput
 
-来源：`packages/sdk/src/index.ts:324`
+来源：`packages/sdk/src/index.ts:393`
 
 ```ts
 export interface ComputeBufferInput {
@@ -654,7 +784,7 @@ export interface ComputeBufferInput {
 
 ## ComputeTextureHandle
 
-来源：`packages/sdk/src/index.ts:330`
+来源：`packages/sdk/src/index.ts:399`
 
 ```ts
 export interface ComputeTextureHandle {
@@ -667,7 +797,7 @@ export interface ComputeTextureHandle {
 
 ## ComputeTextureSize
 
-来源：`packages/sdk/src/index.ts:336`
+来源：`packages/sdk/src/index.ts:405`
 
 ```ts
 export interface ComputeTextureSize {
@@ -678,7 +808,7 @@ export interface ComputeTextureSize {
 
 ## ComputeTextureDataInput
 
-来源：`packages/sdk/src/index.ts:340`
+来源：`packages/sdk/src/index.ts:409`
 
 ```ts
 export interface ComputeTextureDataInput extends ComputeTextureSize {
@@ -691,7 +821,7 @@ export interface ComputeTextureDataInput extends ComputeTextureSize {
 
 ## ComputeTextureAssetInput
 
-来源：`packages/sdk/src/index.ts:346`
+来源：`packages/sdk/src/index.ts:415`
 
 ```ts
 export interface ComputeTextureAssetInput {
@@ -705,7 +835,7 @@ export interface ComputeTextureAssetInput {
 
 ## ComputeTextureInput
 
-来源：`packages/sdk/src/index.ts:353`
+来源：`packages/sdk/src/index.ts:422`
 
 ```ts
 export type ComputeTextureInput = ComputeTextureDataInput | ComputeTextureAssetInput;
@@ -713,7 +843,7 @@ export type ComputeTextureInput = ComputeTextureDataInput | ComputeTextureAssetI
 
 ## ComputeTextureBinding
 
-来源：`packages/sdk/src/index.ts:354`
+来源：`packages/sdk/src/index.ts:423`
 
 ```ts
 export interface ComputeTextureBinding {
@@ -726,7 +856,7 @@ export interface ComputeTextureBinding {
 
 ## ComputeDispatchInput
 
-来源：`packages/sdk/src/index.ts:360`
+来源：`packages/sdk/src/index.ts:429`
 
 ```ts
 export interface ComputeDispatchInput {
@@ -745,7 +875,7 @@ export interface ComputeDispatchInput {
 
 ## ComputeTaskState
 
-来源：`packages/sdk/src/index.ts:372`
+来源：`packages/sdk/src/index.ts:441`
 
 ```ts
 export interface ComputeTaskState {
@@ -756,7 +886,7 @@ export interface ComputeTaskState {
 
 ## ComputeService
 
-来源：`packages/sdk/src/index.ts:376`
+来源：`packages/sdk/src/index.ts:445`
 
 ```ts
 export interface ComputeService {
@@ -783,7 +913,7 @@ export interface ComputeService {
 
 ## InputService
 
-来源：`packages/sdk/src/index.ts:396`
+来源：`packages/sdk/src/index.ts:465`
 
 ```ts
 export interface InputService {
@@ -796,7 +926,7 @@ export interface InputService {
 
 ## PhysicsService
 
-来源：`packages/sdk/src/index.ts:402`
+来源：`packages/sdk/src/index.ts:471`
 
 ```ts
 export interface PhysicsService {
@@ -825,7 +955,7 @@ export interface PhysicsService {
 
 ## AnimationService
 
-来源：`packages/sdk/src/index.ts:424`
+来源：`packages/sdk/src/index.ts:493`
 
 ```ts
 export interface AnimationService {
@@ -844,7 +974,7 @@ export interface AnimationService {
 
 ## CameraService
 
-来源：`packages/sdk/src/index.ts:436`
+来源：`packages/sdk/src/index.ts:505`
 
 ```ts
 export interface CameraService {
@@ -864,7 +994,7 @@ export interface CameraService {
 
 ## UIService
 
-来源：`packages/sdk/src/index.ts:449`
+来源：`packages/sdk/src/index.ts:518`
 
 ```ts
 export interface UIService {
@@ -876,7 +1006,7 @@ export interface UIService {
 
 ## AudioService
 
-来源：`packages/sdk/src/index.ts:454`
+来源：`packages/sdk/src/index.ts:523`
 
 ```ts
 export interface AudioService {
@@ -898,7 +1028,7 @@ export interface AudioService {
 
 ## StorageService
 
-来源：`packages/sdk/src/index.ts:469`
+来源：`packages/sdk/src/index.ts:538`
 
 ```ts
 export interface StorageService {
@@ -914,7 +1044,7 @@ export interface StorageService {
 
 ## SceneService
 
-来源：`packages/sdk/src/index.ts:478`
+来源：`packages/sdk/src/index.ts:547`
 
 ```ts
 export interface SceneService {
@@ -925,7 +1055,7 @@ export interface SceneService {
 
 ## ModelDefinition
 
-来源：`packages/sdk/src/index.ts:482`
+来源：`packages/sdk/src/index.ts:551`
 
 ```ts
 export interface ModelDefinition {
@@ -945,7 +1075,7 @@ export interface ModelDefinition {
 
 ## RigidBodyDefinition
 
-来源：`packages/sdk/src/index.ts:495`
+来源：`packages/sdk/src/index.ts:564`
 
 ```ts
 export interface RigidBodyDefinition {
@@ -966,7 +1096,7 @@ export interface RigidBodyDefinition {
 
 ## CharacterDefinition
 
-来源：`packages/sdk/src/index.ts:509`
+来源：`packages/sdk/src/index.ts:578`
 
 ```ts
 export interface CharacterDefinition {
@@ -981,7 +1111,7 @@ export interface CharacterDefinition {
 
 ## UIElementDefinition
 
-来源：`packages/sdk/src/index.ts:517`
+来源：`packages/sdk/src/index.ts:586`
 
 ```ts
 export interface UIElementDefinition {
@@ -1001,7 +1131,7 @@ export interface UIElementDefinition {
 
 ## SoundDefinition
 
-来源：`packages/sdk/src/index.ts:530`
+来源：`packages/sdk/src/index.ts:599`
 
 ```ts
 export interface SoundDefinition {
@@ -1015,7 +1145,7 @@ export interface SoundDefinition {
 
 ## AudioBusDefinition
 
-来源：`packages/sdk/src/index.ts:537`
+来源：`packages/sdk/src/index.ts:606`
 
 ```ts
 export interface AudioBusDefinition {
@@ -1026,7 +1156,7 @@ export interface AudioBusDefinition {
 
 ## SYSTEM_PHASES
 
-来源：`packages/sdk/src/index.ts:541`
+来源：`packages/sdk/src/index.ts:610`
 
 ```ts
 SYSTEM_PHASES = [
@@ -1041,7 +1171,7 @@ SYSTEM_PHASES = [
 
 ## SystemPhase
 
-来源：`packages/sdk/src/index.ts:549`
+来源：`packages/sdk/src/index.ts:618`
 
 ```ts
 export type SystemPhase = (typeof SYSTEM_PHASES)[number];
@@ -1049,7 +1179,7 @@ export type SystemPhase = (typeof SYSTEM_PHASES)[number];
 
 ## Geometry
 
-来源：`packages/sdk/src/index.ts:550`
+来源：`packages/sdk/src/index.ts:619`
 
 ```ts
 export type Geometry =
@@ -1060,7 +1190,7 @@ export type Geometry =
 
 ## GRAPH_TYPES
 
-来源：`packages/sdk/src/index.ts:554`
+来源：`packages/sdk/src/index.ts:623`
 
 ```ts
 GRAPH_TYPES = ["float", "vec2", "vec3", "vec4", "bool"] as const
@@ -1068,7 +1198,7 @@ GRAPH_TYPES = ["float", "vec2", "vec3", "vec4", "bool"] as const
 
 ## GraphType
 
-来源：`packages/sdk/src/index.ts:555`
+来源：`packages/sdk/src/index.ts:624`
 
 ```ts
 export type GraphType = typeof GRAPH_TYPES[number];
@@ -1076,7 +1206,7 @@ export type GraphType = typeof GRAPH_TYPES[number];
 
 ## GraphValue
 
-来源：`packages/sdk/src/index.ts:556`
+来源：`packages/sdk/src/index.ts:625`
 
 ```ts
 export type GraphValue = number | boolean | Vec2 | Vec3 | Vec4;
@@ -1084,7 +1214,7 @@ export type GraphValue = number | boolean | Vec2 | Vec3 | Vec4;
 
 ## GraphParameter
 
-来源：`packages/sdk/src/index.ts:557`
+来源：`packages/sdk/src/index.ts:626`
 
 ```ts
 export interface GraphParameter {
@@ -1096,7 +1226,7 @@ export interface GraphParameter {
 
 ## GRAPH_INPUT_TYPES
 
-来源：`packages/sdk/src/index.ts:562`
+来源：`packages/sdk/src/index.ts:631`
 
 ```ts
 GRAPH_INPUT_TYPES = {
@@ -1110,7 +1240,7 @@ GRAPH_INPUT_TYPES = {
 
 ## GraphInputName
 
-来源：`packages/sdk/src/index.ts:569`
+来源：`packages/sdk/src/index.ts:638`
 
 ```ts
 export type GraphInputName = keyof typeof GRAPH_INPUT_TYPES;
@@ -1118,7 +1248,7 @@ export type GraphInputName = keyof typeof GRAPH_INPUT_TYPES;
 
 ## GRAPH_OPERATIONS
 
-来源：`packages/sdk/src/index.ts:570`
+来源：`packages/sdk/src/index.ts:639`
 
 ```ts
 GRAPH_OPERATIONS = {
@@ -1130,7 +1260,7 @@ GRAPH_OPERATIONS = {
 
 ## GraphNode
 
-来源：`packages/sdk/src/index.ts:575`
+来源：`packages/sdk/src/index.ts:644`
 
 ```ts
 export type GraphNode =
@@ -1157,7 +1287,7 @@ export type GraphNode =
 
 ## Graph
 
-来源：`packages/sdk/src/index.ts:595`
+来源：`packages/sdk/src/index.ts:664`
 
 ```ts
 export interface Graph {
@@ -1169,7 +1299,7 @@ export interface Graph {
 
 ## MaterialGraphs
 
-来源：`packages/sdk/src/index.ts:600`
+来源：`packages/sdk/src/index.ts:669`
 
 ```ts
 export interface MaterialGraphs {
@@ -1185,7 +1315,7 @@ export interface MaterialGraphs {
 
 ## VertexGraphs
 
-来源：`packages/sdk/src/index.ts:609`
+来源：`packages/sdk/src/index.ts:678`
 
 ```ts
 export interface VertexGraphs {
@@ -1198,7 +1328,7 @@ export interface VertexGraphs {
 
 ## MaterialInput
 
-来源：`packages/sdk/src/index.ts:615`
+来源：`packages/sdk/src/index.ts:684`
 
 ```ts
 export interface MaterialInput {
@@ -1232,7 +1362,7 @@ export interface MaterialInput {
 
 ## MaterialDefinition
 
-来源：`packages/sdk/src/index.ts:642`
+来源：`packages/sdk/src/index.ts:711`
 
 ```ts
 export interface MaterialDefinition extends MaterialInput {
@@ -1242,7 +1372,7 @@ export interface MaterialDefinition extends MaterialInput {
 
 ## PostProcessInput
 
-来源：`packages/sdk/src/index.ts:645`
+来源：`packages/sdk/src/index.ts:714`
 
 ```ts
 export interface PostProcessInput {
@@ -1257,7 +1387,7 @@ export interface PostProcessInput {
 
 ## PostProcessDefinition
 
-来源：`packages/sdk/src/index.ts:653`
+来源：`packages/sdk/src/index.ts:722`
 
 ```ts
 export interface PostProcessDefinition extends PostProcessInput {
@@ -1267,7 +1397,7 @@ export interface PostProcessDefinition extends PostProcessInput {
 
 ## ComputeInput
 
-来源：`packages/sdk/src/index.ts:656`
+来源：`packages/sdk/src/index.ts:725`
 
 ```ts
 export interface ComputeInput {
@@ -1283,7 +1413,7 @@ export interface ComputeInput {
 
 ## ComputeDefinition
 
-来源：`packages/sdk/src/index.ts:665`
+来源：`packages/sdk/src/index.ts:734`
 
 ```ts
 export interface ComputeDefinition extends ComputeInput {
@@ -1293,7 +1423,7 @@ export interface ComputeDefinition extends ComputeInput {
 
 ## AssetInput
 
-来源：`packages/sdk/src/index.ts:668`
+来源：`packages/sdk/src/index.ts:737`
 
 ```ts
 export interface AssetInput {
@@ -1310,7 +1440,7 @@ export interface AssetInput {
 
 ## AssetDefinition
 
-来源：`packages/sdk/src/index.ts:678`
+来源：`packages/sdk/src/index.ts:747`
 
 ```ts
 export interface AssetDefinition extends AssetInput {
@@ -1320,7 +1450,7 @@ export interface AssetDefinition extends AssetInput {
 
 ## MeshDefinition
 
-来源：`packages/sdk/src/index.ts:681`
+来源：`packages/sdk/src/index.ts:750`
 
 ```ts
 export interface MeshDefinition {
@@ -1333,7 +1463,7 @@ export interface MeshDefinition {
 
 ## LightDefinition
 
-来源：`packages/sdk/src/index.ts:687`
+来源：`packages/sdk/src/index.ts:756`
 
 ```ts
 export interface LightDefinition {
@@ -1355,7 +1485,7 @@ export interface LightDefinition {
 
 ## EntityInput
 
-来源：`packages/sdk/src/index.ts:702`
+来源：`packages/sdk/src/index.ts:771`
 
 ```ts
 export interface EntityInput {
@@ -1374,7 +1504,7 @@ export interface EntityInput {
 
 ## PrefabInput
 
-来源：`packages/sdk/src/index.ts:714`
+来源：`packages/sdk/src/index.ts:783`
 
 ```ts
 export interface PrefabInput extends Omit<EntityInput, "prefab" | "parent"> {
@@ -1384,7 +1514,7 @@ export interface PrefabInput extends Omit<EntityInput, "prefab" | "parent"> {
 
 ## PrefabDefinition
 
-来源：`packages/sdk/src/index.ts:717`
+来源：`packages/sdk/src/index.ts:786`
 
 ```ts
 export interface PrefabDefinition extends PrefabInput {
@@ -1394,7 +1524,7 @@ export interface PrefabDefinition extends PrefabInput {
 
 ## SceneInput
 
-来源：`packages/sdk/src/index.ts:720`
+来源：`packages/sdk/src/index.ts:789`
 
 ```ts
 export interface SceneInput {
@@ -1426,7 +1556,7 @@ export interface SceneInput {
 
 ## SceneDefinition
 
-来源：`packages/sdk/src/index.ts:745`
+来源：`packages/sdk/src/index.ts:814`
 
 ```ts
 export interface SceneDefinition extends SceneInput {
@@ -1436,7 +1566,7 @@ export interface SceneDefinition extends SceneInput {
 
 ## SystemInput
 
-来源：`packages/sdk/src/index.ts:748`
+来源：`packages/sdk/src/index.ts:817`
 
 ```ts
 export interface SystemInput {
@@ -1453,7 +1583,7 @@ export interface SystemInput {
 
 ## SystemDefinition
 
-来源：`packages/sdk/src/index.ts:758`
+来源：`packages/sdk/src/index.ts:827`
 
 ```ts
 export interface SystemDefinition extends SystemInput {
@@ -1463,7 +1593,7 @@ export interface SystemDefinition extends SystemInput {
 
 ## GameInput
 
-来源：`packages/sdk/src/index.ts:761`
+来源：`packages/sdk/src/index.ts:830`
 
 ```ts
 export interface GameInput {
@@ -1489,7 +1619,7 @@ export interface GameInput {
 
 ## GameDefinition
 
-来源：`packages/sdk/src/index.ts:780`
+来源：`packages/sdk/src/index.ts:849`
 
 ```ts
 export interface GameDefinition extends GameInput {
@@ -1499,7 +1629,7 @@ export interface GameDefinition extends GameInput {
 
 ## GameInstance
 
-来源：`packages/sdk/src/index.ts:783`
+来源：`packages/sdk/src/index.ts:852`
 
 ```ts
 export interface GameInstance {
@@ -1510,7 +1640,7 @@ export interface GameInstance {
 
 ## defineComponent
 
-来源：`packages/sdk/src/index.ts:787`
+来源：`packages/sdk/src/index.ts:856`
 
 ```ts
 export function defineComponent<const S extends ComponentSchema>(input: {
@@ -1521,7 +1651,7 @@ export function defineComponent<const S extends ComponentSchema>(input: {
 
 ## defineMaterial
 
-来源：`packages/sdk/src/index.ts:793`
+来源：`packages/sdk/src/index.ts:862`
 
 ```ts
 export function defineMaterial(input: MaterialInput): MaterialDefinition;
@@ -1529,7 +1659,7 @@ export function defineMaterial(input: MaterialInput): MaterialDefinition;
 
 ## definePostProcess
 
-来源：`packages/sdk/src/index.ts:796`
+来源：`packages/sdk/src/index.ts:865`
 
 ```ts
 export function definePostProcess(input: PostProcessInput): PostProcessDefinition;
@@ -1537,7 +1667,7 @@ export function definePostProcess(input: PostProcessInput): PostProcessDefinitio
 
 ## defineCompute
 
-来源：`packages/sdk/src/index.ts:799`
+来源：`packages/sdk/src/index.ts:868`
 
 ```ts
 export function defineCompute(input: ComputeInput): ComputeDefinition;
@@ -1545,7 +1675,7 @@ export function defineCompute(input: ComputeInput): ComputeDefinition;
 
 ## defineAsset
 
-来源：`packages/sdk/src/index.ts:802`
+来源：`packages/sdk/src/index.ts:871`
 
 ```ts
 export function defineAsset(input: AssetInput): AssetDefinition;
@@ -1553,7 +1683,7 @@ export function defineAsset(input: AssetInput): AssetDefinition;
 
 ## definePrefab
 
-来源：`packages/sdk/src/index.ts:805`
+来源：`packages/sdk/src/index.ts:874`
 
 ```ts
 export function definePrefab(input: PrefabInput): PrefabDefinition;
@@ -1561,7 +1691,7 @@ export function definePrefab(input: PrefabInput): PrefabDefinition;
 
 ## defineScene
 
-来源：`packages/sdk/src/index.ts:808`
+来源：`packages/sdk/src/index.ts:877`
 
 ```ts
 export function defineScene(input: SceneInput): SceneDefinition;
@@ -1569,7 +1699,7 @@ export function defineScene(input: SceneInput): SceneDefinition;
 
 ## defineSystem
 
-来源：`packages/sdk/src/index.ts:811`
+来源：`packages/sdk/src/index.ts:880`
 
 ```ts
 export function defineSystem(input: SystemInput): SystemDefinition;
@@ -1577,7 +1707,7 @@ export function defineSystem(input: SystemInput): SystemDefinition;
 
 ## defineGame
 
-来源：`packages/sdk/src/index.ts:814`
+来源：`packages/sdk/src/index.ts:883`
 
 ```ts
 export function defineGame(input: GameInput): GameDefinition;
@@ -1585,7 +1715,7 @@ export function defineGame(input: GameInput): GameDefinition;
 
 ## instantiateGame
 
-来源：`packages/sdk/src/index.ts:818`
+来源：`packages/sdk/src/index.ts:887`
 
 ```ts
 export function instantiateGame(