Skip to content

A fast 2D and 3D game engine — TypeScript SDK, C++/WebAssembly core, visual editor. Ship one project to web, desktop, WeChat MiniGames, playable ads, and native Android / iOS.

feat(api): stability becomes a decision instead of the absence of one

yhh3d0e58dcd4ab
diff --git a/desktop/tests/api-baseline.test.ts b/desktop/tests/api-baseline.test.ts
new file mode 100644
index 000000000..fec3956ed
--- /dev/null
+++ b/desktop/tests/api-baseline.test.ts
@@ -0,0 +1,94 @@
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-FileCopyrightText: Copyright (c) 2024-present ESEngine Team
+/**
+ * @file api-baseline.test.ts — the rule that decides a broken API promise.
+ *
+ * It only fires the release AFTER a symbol is frozen, so without these it would
+ * first be exercised on the day it had to be right.
+ */
+import { describe, it, expect } from 'vitest';
+// @ts-expect-error — a repo tool, shipped as .mjs with no declarations
+import { parseSnapshot, baselineFindings, UNCLAIMED } from '../../tools/lib/apiSnapshot.mjs';
+
+type Entry = { kind: string; tier: string; deprecated: boolean; body: string };
+
+function snapshot(...sections: string[]): Map<string, Entry> {
+ return parseSnapshot(`# API surface — esengine/test\n\n${sections.join('\n\n')}\n`);
+}
+
+const sig = (heading: string, body: string) => `## ${heading}\n\`\`\`\n${body}\n\`\`\``;
+
+describe('parseSnapshot', () => {
+ it('reads the tier and the deprecation as separate axes', () => {
+ const s = snapshot(
+ sig('defineComponent — function @public', '(name: string): ComponentDef'),
+ sig('oldThing — function @public @deprecated', '(): void'),
+ sig('graph — const @beta', 'MaterialGraph'),
+ );
+ expect(s.get('defineComponent')).toMatchObject({ tier: 'public', deprecated: false });
+ expect(s.get('oldThing')).toMatchObject({ tier: 'public', deprecated: true });
+ expect(s.get('graph')).toMatchObject({ tier: 'beta', deprecated: false });
+ });
+
+ it('reads a snapshot written before the tiers existed as claiming nothing', () => {
+ const s = snapshot(sig('Query — class', 'call ()'));
+ expect(s.get('Query')?.tier).toBe(UNCLAIMED);
+ });
+});
+
+describe('baselineFindings', () => {
+ const frozen = snapshot(sig('Commands — class @public', 'spawn(): Entity'));
+
+ it('passes when the frozen signature is untouched', () => {
+ const now = snapshot(sig('Commands — class @public', 'spawn(): Entity'));
+ expect(baselineFindings(frozen, now).failures).toEqual([]);
+ });
+
+ it('fails a removal that never went through @deprecated', () => {
+ const now = snapshot(sig('Other — class @public', 'x(): void'));
+ expect(baselineFindings(frozen, now).failures).toEqual([
+ expect.stringContaining('Commands — removed while @public and never @deprecated'),
+ ]);
+ });
+
+ it('allows a removal that was deprecated in the release before it', () => {
+ const was = snapshot(sig('Commands — class @public @deprecated', 'spawn(): Entity'));
+ expect(baselineFindings(was, snapshot()).failures).toEqual([]);
+ });
+
+ it('fails a changed signature', () => {
+ const now = snapshot(sig('Commands — class @public', 'spawn(name: string): Entity'));
+ expect(baselineFindings(frozen, now).failures).toEqual([
+ expect.stringContaining('@public signature changed'),
+ ]);
+ });
+
+ it('fails a kind change', () => {
+ const now = snapshot(sig('Commands — interface @public', 'spawn(): Entity'));
+ expect(baselineFindings(frozen, now).failures).toEqual([
+ expect.stringContaining('class became a interface'),
+ ]);
+ });
+
+ it('fails a thaw back to a weaker tier', () => {
+ const now = snapshot(sig('Commands — class @public', 'spawn(): Entity')
+ .replace('@public', '@beta'));
+ expect(baselineFindings(frozen, now).failures).toEqual([
+ expect.stringContaining('a freeze does not thaw'),
+ ]);
+ });
+
+ it('notes but does not fail a @beta change', () => {
+ const was = snapshot(sig('graph — const @beta', 'MaterialGraph'));
+ const { failures, notes } = baselineFindings(was, snapshot());
+ expect(failures).toEqual([]);
+ expect(notes).toEqual([expect.stringContaining('@beta removed')]);
+ });
+
+ it('claims nothing about a symbol no release tiered', () => {
+ const was = snapshot(sig('legacy — function', '(): void'));
+ const { failures, notes } = baselineFindings(was, snapshot());
+ expect(failures).toEqual([]);
+ expect(notes).toEqual([]);
+ });
+});
diff --git a/sdk/etc/dragonbones.api.md b/sdk/etc/dragonbones.api.md
index 34901f545..5e7a95117 100644
--- a/sdk/etc/dragonbones.api.md
+++ b/sdk/etc/dragonbones.api.md
@@ -1,27 +1,27 @@
# API surface — esengine/dragonbones
<!-- Generated by tools/api-surface.mjs — do not edit. Run --update to accept changes. -->
-Symbols: 18 stable · 0 beta · 0 deprecated
+Symbols: 0 public · 0 beta · 18 experimental · 0 deprecated
-## DragonBones — const
+## DragonBones — const @experimental
```
ResourceDef<DragonBonesManager | null>
```
-## DragonBonesArmatureNames — interface
+## DragonBonesArmatureNames — interface @experimental
```
animations: string[]
name: string
```
-## DragonBonesAssetInfo — interface
+## DragonBonesAssetInfo — interface @experimental
```
atlasJson: string
skeletonData: string | Uint8Array<ArrayBufferLike>
textureId: number
```
-## DragonBonesEntityOptions — interface
+## DragonBonesEntityOptions — interface @experimental
```
animation: string | undefined
armature: string
@@ -33,7 +33,7 @@ loop: boolean | undefined
skeletonScale: number | undefined
```
-## DragonBonesManager — class
+## DragonBonesManager — class @experimental
```
addEntity: (entity: Entity, skeletonHandle: number, options: DragonBonesEntityOptions) => boolean
boundEntities: () => Iterable<Entity>
@@ -59,7 +59,7 @@ static new (controller: DragonBonesModuleController): DragonBonesManager
static prototype: DragonBonesManager
```
-## DragonBonesModuleController — class
+## DragonBonesModuleController — class @experimental
```
createInstance: (skeletonHandle: number, armatureName: string) => number
destroyInstance: (instanceId: number) => void
@@ -83,12 +83,12 @@ static new (raw: DragonBonesWasmModule, api: DragonBonesWrappedAPI): DragonBones
static prototype: DragonBonesModuleController
```
-## DragonBonesModuleFactory — type
+## DragonBonesModuleFactory — type @experimental
```
(options?: { wasmBinary?: Uint8Array }) => Promise<DragonBonesWasmModule>
```
-## DragonBonesPlugin — class
+## DragonBonesPlugin — class @experimental
```
acquire: () => Promise<DragonBonesManager | null>
build: (app: App) => void
@@ -99,7 +99,7 @@ static new (manager?: DragonBonesManager): DragonBonesPlugin
static prototype: DragonBonesPlugin
```
-## DragonBonesWasmModule — interface
+## DragonBonesWasmModule — interface @experimental
```
HEAP32: Int32Array<ArrayBufferLike>
HEAPF32: Float32Array<ArrayBufferLike>
@@ -110,7 +110,7 @@ _malloc: (size: number) => number
cwrap: (name: string, ret: string | null, sig: string[]) => (...args: unknown[]) => unknown
```
-## DragonBonesWrappedAPI — interface
+## DragonBonesWrappedAPI — interface @experimental
```
createInstance: (handle: number, armatureName: string) => number
destroyInstance: (instanceId: number) => void
@@ -135,7 +135,7 @@ unloadSkeleton: (handle: number) => void
update: (instanceId: number, dt: number) => void
```
-## RuntimeAssetSource — interface
+## RuntimeAssetSource — interface @experimental
```
backend: Backend
decodePixels: (path: string, flip: boolean) => Promise<{ width: number; height: number; pixels: Uint8Array; }>
@@ -145,37 +145,37 @@ resolveRef: ((ref: string) => string) | undefined
textureImportSettings: ((ref: string) => ParsedTextureImportSettings | undefined) | undefined
```
-## applyDragonBonesEntities — function
+## applyDragonBonesEntities — function @experimental
```
(opts: { manager: DragonBonesManager; sceneData: SceneData; entityMap: Map<number, Entity>; assetInfo: Map<string, DragonBonesAssetInfo>; }): void
```
-## dragonBonesEntityProps — function
+## dragonBonesEntityProps — function @experimental
```
(d: Record<string, unknown>): { skeletonScale: number; flipX: boolean; flipY: boolean; layer: number; timeScale: number; playing: boolean; color: { r: number; g: number; b: number; a: number; }; }
```
-## dragonBonesPlugin — const
+## dragonBonesPlugin — const @experimental
```
() => DragonBonesPlugin
```
-## loadDragonBonesAssets — function
+## loadDragonBonesAssets — function @experimental
```
(module: ESEngineModule | null, source: RuntimeAssetSource, pairs: ReadonlyArray<{ skeleton: string; atlas: string; }>, transcoderProvider?: TranscoderProvider): Promise<Map<string, DragonBonesAssetInfo>>
```
-## loadDragonBonesSceneEntities — function
+## loadDragonBonesSceneEntities — function @experimental
```
(opts: { module: ESEngineModule | null; source: RuntimeAssetSource; manager: DragonBonesManager; sceneData: SceneData; entityMap: Map<number, Entity>; transcoderProvider?: TranscoderProvider; }): Promise<void>
```
-## parseDragonBonesNames — function
+## parseDragonBonesNames — function @experimental
```
(source: string | object): DragonBonesArmatureNames[]
```
-## wrapDragonBonesModule — function
+## wrapDragonBonesModule — function @experimental
```
(raw: DragonBonesWasmModule): DragonBonesWrappedAPI
```
diff --git a/sdk/etc/index.api.md b/sdk/etc/index.api.md
index da54cf5bf..94c944dab 100644
--- a/sdk/etc/index.api.md
+++ b/sdk/etc/index.api.md
@@ -1,29 +1,29 @@
# API surface — esengine/index
<!-- Generated by tools/api-surface.mjs — do not edit. Run --update to accept changes. -->
-Symbols: 1487 stable · 17 beta · 1 deprecated
+Symbols: 0 public · 17 beta · 1488 experimental · 1 deprecated
-## ABI_LAYOUT_HASH — const
+## ABI_LAYOUT_HASH — const @experimental
```
"7b8797b9ae911eeb"
```
-## ANCHOR_AXES — const
+## ANCHOR_AXES — const @experimental
```
readonly AnchorAxis[]
```
-## ANIM_CLIP_FORMAT_VERSION — const
+## ANIM_CLIP_FORMAT_VERSION — const @experimental
```
"1.4"
```
-## ASSET_GROUP_MODES — const
+## ASSET_GROUP_MODES — const @experimental
```
readonly ["local", "subpackage", "remote"]
```
-## AchievementProvider — interface
+## AchievementProvider — interface @experimental
```
getStat: (name: string) => number
platformBacked: boolean
@@ -34,12 +34,12 @@ unlock: (id: string) => Promise<void>
unlocked: (id: string) => boolean
```
-## Achievements — const
+## Achievements — const @experimental
```
ResourceDef<AchievementsAPI>
```
-## AchievementsAPI — class
+## AchievementsAPI — class @experimental
```
available: boolean
getStat: (name: string) => number
@@ -54,18 +54,18 @@ static new (): AchievementsAPI
static prototype: AchievementsAPI
```
-## ActionDef — interface
+## ActionDef — interface @experimental
```
bindings: Binding[]
type: ActionType
```
-## ActionType — type
+## ActionType — type @experimental
```
'button' | 'axis' | 'axis2d'
```
-## ActivationTrack — interface
+## ActivationTrack — interface @experimental
```
childPath: string
name: string
@@ -73,18 +73,18 @@ ranges: ActivationRange[]
type: "activation"
```
-## AdProvider — interface
+## AdProvider — interface @experimental
```
createInterstitialAd: (adUnitId: string) => PlatformInterstitialAd
createRewardedAd: (adUnitId: string) => PlatformRewardedAd
```
-## Added — function
+## Added — function @experimental
```
<T extends AnyComponentDef>(component: T): AddedWrapper<T>
```
-## AddedEntity — interface
+## AddedEntity — interface @experimental
```
components: ComponentData[]
name: string
@@ -93,26 +93,26 @@ prefabEntityId: string
visible: boolean
```
-## AddedWrapper — interface
+## AddedWrapper — interface @experimental
```
_component: T
_filterType: "added"
```
-## AddressableAssetType — type
+## AddressableAssetType — type @experimental
```
| 'texture' | 'material' | 'spine' | 'bitmap-font' | 'font'
| 'prefab' | 'json' | 'text' | 'binary' | 'audio'
```
-## AddressableManifest — interface
+## AddressableManifest — interface @experimental
```
groups: Record<string, AddressableManifestGroup>
revision: string | undefined
version: "2.0"
```
-## AddressableManifestAsset — interface
+## AddressableManifestAsset — interface @experimental
```
address: string | undefined
compressedFormats: string[] | undefined
@@ -125,19 +125,19 @@ textureImport: ParsedTextureImportSettings | undefined
type: AddressableAssetType
```
-## AddressableManifestGroup — interface
+## AddressableManifestGroup — interface @experimental
```
assets: Record<string, AddressableManifestAsset>
bundleMode: string
labels: string[]
```
-## Ads — const
+## Ads — const @experimental
```
ResourceDef<AdsAPI>
```
-## AdsAPI — class
+## AdsAPI — class @experimental
```
available: boolean
preloadRewarded: (adUnitId: string) => Promise<void>
@@ -149,7 +149,7 @@ static new (takeover: Takeover): AdsAPI
static prototype: AdsAPI
```
-## AiAction — type
+## AiAction — type @experimental
```
(
ctx: Ctx,
@@ -159,30 +159,30 @@ static prototype: AdsAPI
) => void | Status
```
-## AiActionInput — interface
+## AiActionInput — interface @experimental
```
arg: string | undefined
params: Readonly<Record<string, AiParamValue>> | undefined
```
-## AiActionSpec — interface
+## AiActionSpec — interface @experimental
```
params: readonly AiParamDef[] | undefined
run: AiAction<Ctx>
separator: string | undefined
```
-## AiBt — const
+## AiBt — const @experimental
```
ResourceDef<BehaviorTrees>
```
-## AiCondition — type
+## AiCondition — type @experimental
```
(ctx: Ctx, bb: Blackboard) => boolean
```
-## AiContext — interface
+## AiContext — interface @experimental
```
blackboard: Blackboard
commands: CommandsInstance
@@ -194,12 +194,12 @@ set: <C extends AnyComponentDef>(component: C, data: ComponentData<C>) => void
world: World
```
-## AiFsm — const
+## AiFsm — const @experimental
```
ResourceDef<StateMachines>
```
-## AiParamDef — interface
+## AiParamDef — interface @experimental
```
label: string | undefined
max: number | undefined
@@ -212,17 +212,17 @@ tooltip: string | undefined
type: "string" | "number" | "bool" | "enum"
```
-## AiParamValue — type
+## AiParamValue — type @experimental
```
string | number | boolean
```
-## AiParams — type
+## AiParams — type @experimental
```
Readonly<Record<string, AiParamValue>>
```
-## AiRegistry — class
+## AiRegistry — class @experimental
```
actionNames: () => string[]
clear: () => void
@@ -239,17 +239,17 @@ static new <Ctx = unknown>(): AiRegistry<Ctx>
static prototype: AiRegistry<any>
```
-## AlignContent — type
+## AlignContent — type @experimental
```
(typeof AlignContent)[keyof typeof AlignContent]
```
-## AlignItems — type
+## AlignItems — type @experimental
```
(typeof AlignItems)[keyof typeof AlignItems]
```
-## AlignSelf — enum
+## AlignSelf — enum @experimental
```
Auto = 0
Center = 2
@@ -258,7 +258,7 @@ Start = 1
Stretch = 4
```
-## AnchorAxis — enum
+## AnchorAxis — enum @experimental
```
Center = 1
End = 2
@@ -266,7 +266,7 @@ Start = 0
Stretch = 3
```
-## AnchorFields — interface
+## AnchorFields — interface @experimental
```
height: Dimension | undefined
insetBottom: Dimension
@@ -281,18 +281,18 @@ position: number
width: Dimension | undefined
```
-## AnchorPreset — interface
+## AnchorPreset — interface @experimental
```
h: AnchorAxis
v: AnchorAxis
```
-## And — function
+## And — function @experimental
```
(...filters: FilterExpr[]): FilterExpr
```
-## AnimClipAssetData — interface
+## AnimClipAssetData — interface @experimental
```
events: AnimClipEventData[] | undefined
fps: number | undefined
@@ -304,14 +304,14 @@ type: "animation-clip"
version: string
```
-## AnimClipEventData — interface
+## AnimClipEventData — interface @experimental
```
data: unknown
frame: number
name: string
```
-## AnimClipFrameData — interface
+## AnimClipFrameData — interface @experimental
```
atlasFrame: { x: number; y: number; width: number; height: number; pageWidth: number; pageHeight: number; } | undefined
cell: number | undefined
@@ -320,13 +320,13 @@ pivot: AnimClipPivotData | undefined
texture: string | undefined
```
-## AnimClipPivotData — interface
+## AnimClipPivotData — interface @experimental
```
x: number
y: number
```
-## AnimClipSheetData — interface
+## AnimClipSheetData — interface @experimental
```
cellHeight: number
cellWidth: number
@@ -337,7 +337,7 @@ spacing: number
texture: string
```
-## AnimFramesTrack — interface
+## AnimFramesTrack — interface @experimental
```
childPath: string
frames: AnimFrame[]
@@ -345,7 +345,7 @@ name: string
type: "animFrames"
```
-## AnimationPlugin — class
+## AnimationPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -354,18 +354,18 @@ static new (): AnimationPlugin
static prototype: AnimationPlugin
```
-## Animator — const
+## Animator — const @experimental
```
ComponentDef<AnimatorData>
```
-## AnimatorBlend1D — interface
+## AnimatorBlend1D — interface @experimental
```
parameter: string
thresholds: AnimatorBlendThreshold[]
```
-## AnimatorBlendThreshold — interface
+## AnimatorBlendThreshold — interface @experimental
```
clip: string
loop: boolean | undefined
@@ -373,18 +373,18 @@ speed: number | undefined
value: number
```
-## AnimatorCondition — type
+## AnimatorCondition — type @experimental
```
| { param: string; op: 'gt' | 'lt' | 'eq' | 'neq'; value: number }
| { param: string; op: 'true' | 'false' | 'trigger' }
```
-## AnimatorController — const
+## AnimatorController — const @experimental
```
ResourceDef<AnimatorControllerAPI>
```
-## AnimatorControllerAPI — class
+## AnimatorControllerAPI — class @experimental
```
clearControllers: () => void
getBool: (entity: Entity, name: string) => boolean
@@ -403,7 +403,7 @@ static new (): AnimatorControllerAPI
static prototype: AnimatorControllerAPI
```
-## AnimatorControllerDef — interface
+## AnimatorControllerDef — interface @experimental
```
anyStateTransitions: AnimatorTransition[] | undefined
initialState: string
@@ -411,59 +411,59 @@ parameters: AnimatorParam[]
states: AnimatorState[]
```
-## AnimatorData — interface
+## AnimatorData — interface @experimental
```
controller: string
currentState: string
enabled: boolean
```
-## AnimatorEdge — type
+## AnimatorEdge — type @experimental
```
GraphEdge<AnimatorTransition>
```
-## AnimatorEvalResult — interface
+## AnimatorEvalResult — interface @experimental
```
consumedTriggers: string[]
next: string | null
```
-## AnimatorParam — interface
+## AnimatorParam — interface @experimental
```
default: number | boolean | undefined
name: string
type: AnimatorParamType
```
-## AnimatorParamType — type
+## AnimatorParamType — type @experimental
```
'float' | 'bool' | 'trigger'
```
-## AnimatorParamValues — type
+## AnimatorParamValues — type @experimental
```
Readonly<Record<string, number | boolean>>
```
-## AnimatorPathEvalResult — interface
+## AnimatorPathEvalResult — interface @experimental
```
consumedTriggers: string[]
nextPath: string | null
```
-## AnimatorScope — type
+## AnimatorScope — type @experimental
```
Pick<AnimatorControllerDef, 'states' | 'initialState' | 'anyStateTransitions'>
```
-## AnimatorSpineMotion — interface
+## AnimatorSpineMotion — interface @experimental
```
animation: string
loop: boolean | undefined
```
-## AnimatorState — interface
+## AnimatorState — interface @experimental
```
blend: AnimatorBlend1D | undefined
clip: string | undefined
@@ -477,26 +477,26 @@ x: number | undefined
y: number | undefined
```
-## AnimatorSubMachine — interface
+## AnimatorSubMachine — interface @experimental
```
anyStateTransitions: AnimatorTransition[] | undefined
initialState: string
states: AnimatorState[]
```
-## AnimatorTransition — interface
+## AnimatorTransition — interface @experimental
```
conditions: AnimatorCondition[]
hasExitTime: boolean | undefined
to: string
```
-## AnyComponentDef — type
+## AnyComponentDef — type @experimental
```
ComponentDef<any> | BuiltinComponentDef<any>
```
-## App — class
+## App — class @experimental
```
addBundleSystems: (entries: ReadonlyArray<{ schedule: number; system: SystemDef | SystemSet; }>) => App
addEvent: <T>(event: EventDef<T>) => App
@@ -558,7 +558,7 @@ static new: () => App
static prototype: App
```
-## AppContext — class
+## AppContext — class @experimental
```
componentRegistry: Map<string, any>
drainPendingSystems: () => PendingSystemEntry[]
@@ -572,12 +572,12 @@ static new (): AppContext
static prototype: AppContext
```
-## ApplyTilesetRefs — type
+## ApplyTilesetRefs — type @experimental
```
(entity: number, refs: readonly string[]) => void
```
-## ArrayDataSource — class
+## ArrayDataSource — class @experimental
```
append: (items: readonly T[]) => void
getCount: () => number
@@ -591,34 +591,34 @@ static new <T>(items?: readonly T[]): ArrayDataSource<T>
static prototype: ArrayDataSource<any>
```
-## AssetBuildTransform — type
+## AssetBuildTransform — type @experimental
```
(content: string, context: unknown) => string
```
-## AssetContentType — type
+## AssetContentType — type @experimental
```
'json' | 'text' | 'binary' | 'image' | 'audio'
```
-## AssetFieldType — type
+## AssetFieldType — type @experimental
```
'texture' | 'material' | 'font' | 'anim-clip' | 'audio' | 'video' | 'tilemap' | 'tileset' | 'timeline' | 'statemachine' | 'behaviortree' | 'animatorcontroller'
```
-## AssetGroupDef — interface
+## AssetGroupDef — interface @experimental
```
alwaysInclude: boolean | undefined
folder: string
mode: "local" | "subpackage" | "remote"
```
-## AssetGroupMode — type
+## AssetGroupMode — type @experimental
```
typeof ASSET_GROUP_MODES[number]
```
-## AssetGroupsConfig — interface
+## AssetGroupsConfig — interface @experimental
```
activeProfile: string | undefined
atlases: Record<string, AtlasDef> | undefined
@@ -627,7 +627,7 @@ profiles: Record<string, BuildProfile> | undefined
version: string
```
-## AssetPlugin — class
+## AssetPlugin — class @experimental
```
build: (app: App) => void
name: string
@@ -635,7 +635,7 @@ static new (): AssetPlugin
static prototype: AssetPlugin
```
-## AssetRefCounter — class
+## AssetRefCounter — class @experimental
```
addFontRef: (path: string, entity: number) => void
addMaterialRef: (path: string, entity: number) => void
@@ -660,14 +660,14 @@ static new (): AssetRefCounter
static prototype: AssetRefCounter
```
-## AssetRefInfo — interface
+## AssetRefInfo — interface @experimental
```
assetPath: string
entities: number[]
refCount: number
```
-## AssetTypeEntry — interface
+## AssetTypeEntry — interface @experimental
```
addressableType: AddressableAssetType | null
buildTransform: AssetBuildTransform | undefined
@@ -679,17 +679,17 @@ suffixes: string[] | undefined
wechatPackInclude: boolean
```
-## Assets — const
+## Assets — const @experimental
```
ResourceDef<AssetsClass>
```
-## AssetsData — type
+## AssetsData — type @experimental
```
AssetsClass
```
-## AsyncCache — class
+## AsyncCache — class @experimental
```
clear: () => void
clearAll: () => void
@@ -706,24 +706,24 @@ static new <T>(dispose_?: ((value: T) => void) | undefined): AsyncCache<T>
static prototype: AsyncCache<any>
```
-## AtlasDef — interface
+## AtlasDef — interface @experimental
```
folder: string
```
-## AttenuationModel — enum
+## AttenuationModel — enum @experimental
```
Exponential = 2
Inverse = 1
Linear = 0
```
-## Audio — const
+## Audio — const @experimental
```
ResourceDef<AudioAPI>
```
-## AudioAPI — class
+## AudioAPI — class @experimental
```
baseUrl: string
bufferBudget: number
@@ -771,20 +771,20 @@ static new (backend: PlatformAudioBackend, mixer?: AudioMixer | null): AudioAPI
static prototype: AudioAPI
```
-## AudioBackendInitOptions — interface
+## AudioBackendInitOptions — interface @experimental
```
initialPoolSize: number | undefined
mixerConfig: AudioMixerConfig | undefined
```
-## AudioBufferHandle — interface
+## AudioBufferHandle — interface @experimental
```
bytes: number | undefined
duration: number
id: number
```
-## AudioBufferStats — interface
+## AudioBufferStats — interface @experimental
```
bufferBudget: number
bufferBytes: number
@@ -792,7 +792,7 @@ bufferCount: number
evictableCount: number
```
-## AudioBus — class
+## AudioBus — class @experimental
```
addChild: (child: AudioBus) => void
connect: (destination: AudioBus | AudioNode) => void
@@ -808,7 +808,7 @@ static new (context: AudioContext, config: AudioBusConfig): AudioBus
static prototype: AudioBus
```
-## AudioBusConfig — interface
+## AudioBusConfig — interface @experimental
```
muted: boolean | undefined
name: string
@@ -816,7 +816,7 @@ parent: string | undefined
volume: number | undefined
```
-## AudioBusDecl — interface
+## AudioBusDecl — interface @experimental
```
duck: BusDuckRule | undefined
effects: BusEffectDef[] | undefined
@@ -826,7 +826,7 @@ parent: string | undefined
volume: number | undefined
```
-## AudioHandle — interface
+## AudioHandle — interface @experimental
```
currentTime: number
duration: number
@@ -842,17 +842,17 @@ setVolume: (volume: number) => void
stop: () => void
```
-## AudioListener — const
+## AudioListener — const @experimental
```
ComponentDef<AudioListenerData>
```
-## AudioListenerData — interface
+## AudioListenerData — interface @experimental
```
enabled: boolean
```
-## AudioMixer — class
+## AudioMixer — class @experimental
```
busNames: () => string[]
createBus: (config: AudioBusConfig) => AudioBus
@@ -869,7 +869,7 @@ static new (context: AudioContext, config?: AudioMixerConfig): AudioMixer
static prototype: AudioMixer
```
-## AudioMixerConfig — interface
+## AudioMixerConfig — interface @experimental
```
masterVolume: number | undefined
musicVolume: number | undefined
@@ -878,7 +878,7 @@ uiVolume: number | undefined
voiceVolume: number | undefined
```
-## AudioPlugin — class
+## AudioPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -888,7 +888,7 @@ static new (config?: AudioPluginConfig): AudioPlugin
static prototype: AudioPlugin
```
-## AudioPluginConfig — interface
+## AudioPluginConfig — interface @experimental
```
initialPoolSize: number | undefined
masterVolume: number | undefined
@@ -896,7 +896,7 @@ musicVolume: number | undefined
sfxVolume: number | undefined
```
-## AudioPool — class
+## AudioPool — class @experimental
```
acquire: () => PooledAudioNode
activeCount: number
@@ -906,17 +906,17 @@ static new (context: AudioContext, initialSize?: number): AudioPool
static prototype: AudioPool
```
-## AudioProjectConfig — interface
+## AudioProjectConfig — interface @experimental
```
buses: AudioBusDecl[] | undefined
```
-## AudioSource — const
+## AudioSource — const @experimental
```
ComponentDef<AudioSourceData>
```
-## AudioSourceData — interface
+## AudioSourceData — interface @experimental
```
attenuationModel: number
bus: string
@@ -933,7 +933,7 @@ spatial: boolean
volume: number
```
-## AudioTrack — interface
+## AudioTrack — interface @experimental
```
childPath: string
events: AudioEvent[]
@@ -941,37 +941,37 @@ name: string
type: "audio"
```
-## Axis1D — const
+## Axis1D — const @experimental
```
(...bindings: Binding[]) => ActionDef
```
-## Axis2D — const
+## Axis2D — const @experimental
```
(...bindings: Binding[]) => ActionDef
```
-## BUILTIN_SHADER_TEMPLATES — const
+## BUILTIN_SHADER_TEMPLATES — const @experimental
```
readonly BuiltinShaderTemplate[]
```
-## BUILTIN_UI_PREFABS — const
+## BUILTIN_UI_PREFABS — const @experimental
```
Record<string, PrefabData>
```
-## BUILTIN_UI_WIDGET_NAMES — const
+## BUILTIN_UI_WIDGET_NAMES — const @experimental
```
readonly ["Button", "Toggle", "Slider", "Dialog", "TextInput", "Progress", "Dropdown", "ListView", "ScrollView"]
```
-## BUNDLE_MODES — const
+## BUNDLE_MODES — const @experimental
```
readonly BundleMode[]
```
-## Backend — interface
+## Backend — interface @experimental
```
fetchBinary: (path: string) => Promise<ArrayBuffer>
fetchText: (path: string) => Promise<string>
@@ -979,7 +979,7 @@ resolveUrl: (path: string) => string
setBaseUrl: ((url: string) => void) | undefined
```
-## BehaviorContext — interface
+## BehaviorContext — interface @experimental
```
commands: CommandsInstance
entity: number
@@ -992,7 +992,7 @@ time: TimeData
world: World
```
-## BehaviorDef — interface
+## BehaviorDef — interface @experimental
```
destroy: ((ctx: BehaviorContext<S>) => void) | undefined
metadata: ComponentMetadata | undefined
@@ -1002,18 +1002,18 @@ state: S | undefined
update: ((ctx: BehaviorContext<S>, dt: number) => void) | undefined
```
-## BehaviorTreeAgent — const
+## BehaviorTreeAgent — const @experimental
```
ComponentDef<BehaviorTreeAgentData>
```
-## BehaviorTreeAgentData — interface
+## BehaviorTreeAgentData — interface @experimental
```
bt: string
status: string
```
-## BehaviorTrees — class
+## BehaviorTrees — class @experimental
```
blackboard: (entity: Entity) => Blackboard
status: (entity: Entity) => string | null
@@ -1021,7 +1021,7 @@ static new (states: Map<Entity, BtAgentState>): BehaviorTrees
static prototype: BehaviorTrees
```
-## BezierPoints — interface
+## BezierPoints — interface @experimental
```
p1x: number
p1y: number
@@ -1029,12 +1029,12 @@ p2x: number
p2y: number
```
-## BinaryHandler — type
+## BinaryHandler — type @experimental
```
(payload: Uint8Array) => void
```
-## Binding — type
+## Binding — type @experimental
```
| { kind: 'key'; code: string }
| { kind: 'mouse'; button: number }
@@ -1046,7 +1046,7 @@ p2y: number
| { kind: 'virtual'; id: string }
```
-## BitmapCache — interface
+## BitmapCache — interface @experimental
```
_rt: RenderTextureHandle | null
height: number
@@ -1055,12 +1055,12 @@ valid: boolean
width: number
```
-## BitmapText — const
+## BitmapText — const @experimental
```
BuiltinComponentDef<BitmapTextData>
```
-## BitmapTextData — interface
+## BitmapTextData — interface @experimental
```
align: number
color: Color
@@ -1073,7 +1073,7 @@ spacing: number
text: string
```
-## Blackboard — class
+## Blackboard — class @experimental
```
clearTriggers: () => void
consume: (trigger: string) => void
@@ -1087,19 +1087,19 @@ static new (): Blackboard
static prototype: Blackboard
```
-## BlackboardGuard — interface
+## BlackboardGuard — interface @experimental
```
key: string
op: CompareOp
value: string | number | boolean | undefined
```
-## BlendCurve — type
+## BlendCurve — type @experimental
```
(typeof BlendCurve)[keyof typeof BlendCurve]
```
-## BlendMode — enum
+## BlendMode — enum @experimental
```
Additive = 1
Darken = 7
@@ -1113,19 +1113,19 @@ PremultipliedAlpha = 4
Screen = 3
```
-## BodyType — enum
+## BodyType — enum @experimental
```
Dynamic = 2
Kinematic = 1
Static = 0
```
-## BoxCollider — const
+## BoxCollider — const @experimental
```
BuiltinComponentDef<BoxColliderData>
```
-## BoxColliderData — interface
+## BoxColliderData — interface @experimental
```
categoryBits: number
density: number
@@ -1139,20 +1139,20 @@ radius: number
restitution: number
```
-## BtDefinition — interface
+## BtDefinition — interface @experimental
```
orphans: BtNode[] | undefined
root: BtNode
```
-## BtEdge — interface
+## BtEdge — interface @experimental
```
from: string
id: string
to: string
```
-## BtNode — interface
+## BtNode — interface @experimental
```
arg: string | undefined
children: BtNode[] | undefined
@@ -1167,7 +1167,7 @@ x: number | undefined
y: number | undefined
```
-## BtNodeType — type
+## BtNodeType — type @experimental
```
| 'sequence' | 'selector' | 'parallel'
// decorators (one child)
@@ -1176,7 +1176,7 @@ y: number | undefined
| 'action' | 'condition'
```
-## BtPlugin — class
+## BtPlugin — class @experimental
```
build: (app: App) => void
name: string
@@ -1184,12 +1184,12 @@ static new (): BtPlugin
static prototype: BtPlugin
```
-## BtRunState — type
+## BtRunState — type @experimental
```
Map<string, NodeState>
```
-## BuildNavGridOptions — interface
+## BuildNavGridOptions — interface @experimental
```
blockedTileIds: Iterable<number> | undefined
cellSize: number
@@ -1199,12 +1199,12 @@ origin: Vec2 | undefined
width: number
```
-## BuildProfile — interface
+## BuildProfile — interface @experimental
```
remoteRoot: string | undefined
```
-## BuiltinBridge — class
+## BuiltinBridge — class @experimental
```
connect: (cppRegistry: CppRegistry, module?: ESEngineModule, options?: BridgeConnectOptions) => void
deleteFromEntitySets: (entity: Entity) => string[]
@@ -1229,7 +1229,7 @@ static new (): BuiltinBridge
static prototype: BuiltinBridge
```
-## BuiltinComponentDef — interface
+## BuiltinComponentDef — interface @experimental
```
_builtin: true
_cppName: string
@@ -1249,7 +1249,7 @@ skeletalFields: SkeletalFieldMeta | undefined
transient: boolean
```
-## BuiltinShaderTemplate — interface
+## BuiltinShaderTemplate — interface @experimental
```
defaults: Record<string, unknown>
description: string
@@ -1258,17 +1258,17 @@ label: string
source: string
```
-## BuiltinSideModuleId — type
+## BuiltinSideModuleId — type @experimental
```
'physics' | 'basis' | 'videodec' | 'dragonbones' | `spine:${SpineVersion}`
```
-## BundleMode — type
+## BundleMode — type @experimental
```
'local' | 'lazy' | 'remote'
```
-## BusDuckRule — interface
+## BusDuckRule — interface @experimental
```
amount: number
attack: number | undefined
@@ -1277,24 +1277,24 @@ threshold: number | undefined
trigger: string
```
-## BusEffectDef — type
+## BusEffectDef — type @experimental
```
FilterEffectDef | ReverbEffectDef | CompressorEffectDef
```
-## Button — const
+## Button — const @experimental
```
(...bindings: Binding[]) => ActionDef
```
-## ButtonHandle — interface
+## ButtonHandle — interface @experimental
```
dispose: () => void
entity: number
setDisabled: (disabled: boolean) => void
```
-## ButtonOptions — interface
+## ButtonOptions — interface @experimental
```
background: UIVisualInit | undefined
disabled: boolean | undefined
@@ -1310,39 +1310,39 @@ text: string | TextInit | undefined
world: World
```
-## ButtonStateVisual — interface
+## ButtonStateVisual — interface @experimental
```
color: Color | undefined
scale: number | undefined
sprite: number | undefined
```
-## CAPSULE_ARC_SEGMENTS — const
+## CAPSULE_ARC_SEGMENTS — const @experimental
```
16
```
-## CHUNK_SIZE — const
+## CHUNK_SIZE — const @experimental
```
16
```
-## COLLISION_BRUSHES — const
+## COLLISION_BRUSHES — const @experimental
```
CollisionBrush[]
```
-## COLLISION_PALETTE_REF — const
+## COLLISION_PALETTE_REF — const @experimental
```
"builtin:collision"
```
-## CacheAsBitmap — const
+## CacheAsBitmap — const @experimental
```
ComponentDef<CacheAsBitmapData>
```
-## CacheAsBitmapData — interface
+## CacheAsBitmapData — interface @experimental
```
dirty: boolean
enabled: boolean
@@ -1350,22 +1350,22 @@ height: number
width: number
```
-## CacheBitmap — const
+## CacheBitmap — const @experimental
```
{ create(width: number, height: number): BitmapCache; release(cache: BitmapCache): void; beginDraw(cache: BitmapCache, viewProjection: Float32Array): void; endDraw(): void; resize(cache: BitmapCache, width: number, height: number): void; }
```
-## Camera — const
+## Camera — const @experimental
```
BuiltinComponentDef<CameraData>
```
-## CameraBounds — const
+## CameraBounds — const @experimental
```
ComponentDef<CameraBoundsData>
```
-## CameraBoundsData — interface
+## CameraBoundsData — interface @experimental
```
maxX: number
maxY: number
@@ -1373,7 +1373,7 @@ minX: number
minY: number
```
-## CameraData — interface
+## CameraData — interface @experimental
```
aspectRatio: number
clearFlags: number
@@ -1390,12 +1390,12 @@ showFrustum: boolean
viewport: Vec4
```
-## CameraDirector — const
+## CameraDirector — const @experimental
```
ResourceDef<CameraDirectorState>
```
-## CameraDirectorState — interface
+## CameraDirectorState — interface @experimental
```
blending: boolean
currentMain: CameraPOV | null
@@ -1412,7 +1412,7 @@ startTime: number
target: number
```
-## CameraExtents — interface
+## CameraExtents — interface @experimental
```
cameraX: number
cameraY: number
@@ -1421,7 +1421,7 @@ halfH: number
halfW: number
```
-## CameraPOV — interface
+## CameraPOV — interface @experimental
```
clearFlags: number
cullingMask: number
@@ -1441,7 +1441,7 @@ y: number
z: number
```
-## CameraRenderParams — interface
+## CameraRenderParams — interface @experimental
```
cameraEntity: number | undefined
clearColor: { x: number; y: number; z: number; w: number; } | undefined
@@ -1453,12 +1453,12 @@ viewProjection: Float32Array<ArrayBufferLike>
viewportPixels: Viewport
```
-## CameraView — const
+## CameraView — const @experimental
```
ResourceDef<CameraViewAPI>
```
-## CameraViewAPI — class
+## CameraViewAPI — class @experimental
```
getWorldBounds: () => { left: number; right: number; bottom: number; top: number; } | null
getWorldMousePosition: () => { x: number; y: number; } | null
@@ -1468,12 +1468,12 @@ static new (app_: App): CameraViewAPI
static prototype: CameraViewAPI
```
-## Canvas — const
+## Canvas — const @experimental
```
BuiltinComponentDef<CanvasData>
```
-## CanvasData — interface
+## CanvasData — interface @experimental
```
backgroundColor: Color
designResolution: Vec2
@@ -1483,19 +1483,19 @@ pixelsPerUnit: number
scaleMode: number
```
-## CanvasScale — interface
+## CanvasScale — interface @experimental
```
designResolution: { x: number; y: number; }
matchWidthOrHeight: number
scaleMode: number
```
-## CapsuleCollider — const
+## CapsuleCollider — const @experimental
```
BuiltinComponentDef<CapsuleColliderData>
```
-## CapsuleColliderData — interface
+## CapsuleColliderData — interface @experimental
```
categoryBits: number
density: number
@@ -1509,7 +1509,7 @@ radius: number
restitution: number
```
-## Catalog — class
+## Catalog — class @experimental
```
getAllLabels: () => string[]
getAtlasFrame: (path: string) => AtlasFrameInfo | null
@@ -1527,7 +1527,7 @@ static new (entries: Map<string, CatalogEntry>, addresses: Map<string, string>,
static prototype: Catalog
```
-## CatalogData — interface
+## CatalogData — interface @experimental
```
addresses: Record<string, string> | undefined
entries: Record<string, CatalogEntry>
@@ -1535,7 +1535,7 @@ labels: Record<string, string[]> | undefined
version: number
```
-## CatalogEntry — interface
+## CatalogEntry — interface @experimental
```
atlas: string | undefined
buildPath: string | undefined
@@ -1546,27 +1546,27 @@ type: string
uv: { offset: [number, number]; scale: [number, number]; } | undefined
```
-## Cell — interface
+## Cell — interface @experimental
```
x: number
y: number
```
-## Census — interface
+## Census — interface @experimental
```
atMs: number
entries: ReadonlyMap<string, CensusEntry>
failedProbes: readonly string[]
```
-## CensusContext — interface
+## CensusContext — interface @experimental
```
app: App | undefined
module: ESEngineModule | null | undefined
world: World | undefined
```
-## CensusDelta — interface
+## CensusDelta — interface @experimental
```
after: number
before: number
@@ -1576,7 +1576,7 @@ tier: CensusTier
unit: "count" | "bytes"
```
-## CensusEntry — interface
+## CensusEntry — interface @experimental
```
key: string
tier: CensusTier
@@ -1584,13 +1584,13 @@ unit: "count" | "bytes"
value: number
```
-## CensusProbe — interface
+## CensusProbe — interface @experimental
```
id: string
read: (ctx: CensusContext) => readonly CensusEntry[] | undefined
```
-## CensusReport — interface
+## CensusReport — interface @experimental
```
cycles: number
failedProbes: readonly string[]
@@ -1600,7 +1600,7 @@ projectCycles: number
verdicts: readonly CensusVerdict[]
```
-## CensusSeriesOptions — interface
+## CensusSeriesOptions — interface @experimental
```
boundedSlopeTolerance: number | undefined
projectCycles: number | undefined
@@ -1608,12 +1608,12 @@ trendByteBudgetPerCycle: number | undefined
warmupCycles: number | undefined
```
-## CensusTier — type
+## CensusTier — type @experimental
```
'conserved' | 'bounded' | 'trend' | 'info'
```
-## CensusVerdict — interface
+## CensusVerdict — interface @experimental
```
confidentSlopePerCycle: number
first: number
@@ -1628,28 +1628,28 @@ tier: CensusTier
unit: "count" | "bytes"
```
-## ChainCollider — const
+## ChainCollider — const @experimental
```
ComponentDef<ChainColliderData>
```
-## Changed — function
+## Changed — function @experimental
```
<T extends AnyComponentDef>(component: T): ChangedWrapper<T>
```
-## ChangedWrapper — interface
+## ChangedWrapper — interface @experimental
```
_component: T
_filterType: "changed"
```
-## CharacterController — const
+## CharacterController — const @experimental
```
ComponentDef<CharacterControllerData>
```
-## CharacterControllerData — interface
+## CharacterControllerData — interface @experimental
```
floorMaxAngle: number
floorNormal: Vec2
@@ -1666,22 +1666,22 @@ up: Vec2
velocity: Vec2
```
-## Children — const
+## Children — const @experimental
```
BuiltinComponentDef<ChildrenData>
```
-## ChildrenData — interface
+## ChildrenData — interface @experimental
```
entities: number[]
```
-## CircleCollider — const
+## CircleCollider — const @experimental
```
BuiltinComponentDef<CircleColliderData>
```
-## CircleColliderData — interface
+## CircleColliderData — interface @experimental
```
categoryBits: number
density: number
@@ -1694,7 +1694,7 @@ radius: number
restitution: number
```
-## ClearFlags — enum
+## ClearFlags — enum @experimental
```
Color = 1
ColorAndDepth = 3
@@ -1702,20 +1702,20 @@ Depth = 2
Nothing = 0
```
-## ColliderInstance — interface
+## ColliderInstance — interface @experimental
```
enabled: boolean
isSensor: boolean
shape: ColliderShape
```
-## ColliderOutline — interface
+## ColliderOutline — interface @experimental
```
circles: { c: Vec2; r: number; }[]
polylines: Vec2[][]
```
-## ColliderShape — type
+## ColliderShape — type @experimental
```
| { kind: 'box'; halfExtents: Vec2; offset: Vec2 }
| { kind: 'circle'; radius: number; offset: Vec2 }
@@ -1725,14 +1725,14 @@ polylines: Vec2[][]
| { kind: 'chain'; points: Vec2[]; isLoop: boolean }
```
-## CollisionBrush — interface
+## CollisionBrush — interface @experimental
```
collision: ResolvedTileCollision
id: number
key: string
```
-## CollisionEnterEvent — interface
+## CollisionEnterEvent — interface @experimental
```
contactX: number
contactY: number
@@ -1742,7 +1742,7 @@ normalX: number
normalY: number
```
-## CollisionHitEvent — interface
+## CollisionHitEvent — interface @experimental
```
approachSpeed: number
entityA: number
@@ -1753,14 +1753,14 @@ pointX: number
pointY: number
```
-## CollisionMaterial — interface
+## CollisionMaterial — interface @experimental
```
density: number | undefined
friction: number | undefined
restitution: number | undefined
```
-## Color — interface
+## Color — interface @experimental
```
a: number
b: number
@@ -1768,22 +1768,22 @@ g: number
r: number
```
-## ColorRole — type
+## ColorRole — type @experimental
```
keyof ThemeColors
```
-## Commands — function
+## Commands — function @experimental
```
(): CommandsDescriptor
```
-## CommandsDescriptor — interface
+## CommandsDescriptor — interface @experimental
```
_type: "commands"
```
-## CommandsInstance — class
+## CommandsInstance — class @experimental
```
despawn: (entity: Entity) => CommandsInstance
entity: (entity: Entity) => EntityCommands
@@ -1797,18 +1797,18 @@ static new (world: World, resources: ResourceStorage): CommandsInstance
static prototype: CommandsInstance
```
-## CompareOp — type
+## CompareOp — type @experimental
```
'==' | '!=' | '<' | '<=' | '>' | '>=' | 'truthy' | 'falsy'
```
-## CompiledFsm — interface
+## CompiledFsm — interface @experimental
```
initial: string
states: Map<string, FsmState>
```
-## Completable — interface
+## Completable — interface @experimental
```
cancel: () => void
pause: () => void
@@ -1816,14 +1816,14 @@ resume: () => void
state: TweenState
```
-## ComponentData — type
+## ComponentData — type @experimental
```
C extends BuiltinComponentDef<infer T> ? T :
C extends ComponentDef<infer T> ? T :
never
```
-## ComponentDef — interface
+## ComponentDef — interface @experimental
```
_builtin: false
_default: T
@@ -1843,7 +1843,7 @@ skeletalFields: SkeletalFieldMeta | undefined
transient: boolean
```
-## ComponentMetadata — interface
+## ComponentMetadata — interface @experimental
```
animatableFields: string[] | undefined
assetFields: AssetFieldMeta[] | undefined
@@ -1857,7 +1857,7 @@ skeletalFields: SkeletalFieldMeta | undefined
transient: boolean | undefined
```
-## CompressorEffectDef — interface
+## CompressorEffectDef — interface @experimental
```
attack: number | undefined
kneeDb: number | undefined
@@ -1867,14 +1867,14 @@ thresholdDb: number | undefined
type: "compressor"
```
-## ControllerState — interface
+## ControllerState — interface @experimental
```
current: string
name: string
pages: string[]
```
-## CookedAtlasInfo — interface
+## CookedAtlasInfo — interface @experimental
```
frame: { x: number; y: number; width: number; height: number; }
page: number | undefined
@@ -1882,7 +1882,7 @@ pageHeight: number
pageWidth: number
```
-## CppRegistry — interface
+## CppRegistry — interface @experimental
```
addBitmapText: (entity: Entity, component: BitmapText) => void
addBoxCollider: (entity: Entity, component: BoxCollider) => void
@@ -2012,7 +2012,7 @@ setParent: (child: Entity, parent: Entity) => void
valid: (entity: Entity) => boolean
```
-## CppResourceManager — interface
+## CppResourceManager — interface @experimental
```
acquireTextureByPath: (path: string) => number
createLabelAtlasFont: (textureHandle: number, texWidth: number, texHeight: number, chars: string, charWidth: number, charHeight: number) => number
@@ -2044,7 +2044,7 @@ updateTextureSubregion: (handle: number, x: number, y: number, width: number, he
updateTextureSubregionFromBytes: ((handle: number, x: number, y: number, width: number, height: number, pixels: Uint8Array) => void) | undefined
```
-## CreateListViewOptions — interface
+## CreateListViewOptions — interface @experimental
```
background: UIVisualInit | undefined
data: DataSource<T> | readonly T[]
@@ -2063,7 +2063,7 @@ wheelSpeed: number | undefined
world: World
```
-## CreateWebAppOptions — interface
+## CreateWebAppOptions — interface @experimental
```
colorSpace: "gamma" | "linear" | undefined
depthLayers: number | undefined
@@ -2077,109 +2077,109 @@ wasmBaseUrl: string | undefined
ySortLayers: number | undefined
```
-## CullMode — enum
+## CullMode — enum @experimental
```
Back = 1
Front = 2
None = 0
```
-## DARK_TOKENS — const
+## DARK_TOKENS — const @experimental
```
ThemeTokens
```
-## DEFAULT_ANIM_CLIP_PIVOT — const
+## DEFAULT_ANIM_CLIP_PIVOT — const @experimental
```
AnimClipPivotData
```
-## DEFAULT_DESIGN_HEIGHT — const
+## DEFAULT_DESIGN_HEIGHT — const @experimental
```
number
```
-## DEFAULT_DESIGN_WIDTH — const
+## DEFAULT_DESIGN_WIDTH — const @experimental
```
number
```
-## DEFAULT_EDITOR_GRID — const
+## DEFAULT_EDITOR_GRID — const @experimental
```
EditorGridData
```
-## DEFAULT_EDITOR_VIEW — const
+## DEFAULT_EDITOR_VIEW — const @experimental
```
EditorViewData
```
-## DEFAULT_FALLBACK_DT — const
+## DEFAULT_FALLBACK_DT — const @experimental
```
number
```
-## DEFAULT_FIXED_TIMESTEP — const
+## DEFAULT_FIXED_TIMESTEP — const @experimental
```
number
```
-## DEFAULT_FONT_FAMILY — const
+## DEFAULT_FONT_FAMILY — const @experimental
```
"Arial"
```
-## DEFAULT_FONT_SIZE — const
+## DEFAULT_FONT_SIZE — const @experimental
```
24
```
-## DEFAULT_GRAVITY — const
+## DEFAULT_GRAVITY — const @experimental
```
{ x: number; y: number; }
```
-## DEFAULT_LINE_HEIGHT — const
+## DEFAULT_LINE_HEIGHT — const @experimental
```
1.2
```
-## DEFAULT_MAX_DELTA_TIME — const
+## DEFAULT_MAX_DELTA_TIME — const @experimental
```
0.5
```
-## DEFAULT_PIXELS_PER_UNIT — const
+## DEFAULT_PIXELS_PER_UNIT — const @experimental
```
number
```
-## DEFAULT_SCREEN_SCALING — const
+## DEFAULT_SCREEN_SCALING — const @experimental
```
ScreenScalingData
```
-## DEFAULT_SPINE_SKIN — const
+## DEFAULT_SPINE_SKIN — const @experimental
```
"default"
```
-## DEFAULT_SPRITE_SIZE — const
+## DEFAULT_SPRITE_SIZE — const @experimental
```
{ x: number; y: number; }
```
-## DEFAULT_TEXT_CANVAS_SIZE — const
+## DEFAULT_TEXT_CANVAS_SIZE — const @experimental
```
512
```
-## DEFAULT_UI_CAMERA_INFO — const
+## DEFAULT_UI_CAMERA_INFO — const @experimental
```
{ readonly viewProjection: Float32Array<ArrayBuffer>; readonly vpX: 0; readonly vpY: 0; readonly vpW: 0; readonly vpH: 0; readonly screenW: 0; readonly screenH: 0; readonly worldLeft: 0; readonly worldBottom: 0; readonly worldRight: 0; readonly worldTop: 0; readonly worldMouseX: 0; readonly worldMouseY: 0; readonly valid: false; }
```
-## DataSource — interface
+## DataSource — interface @experimental
```
getCount: () => number
getItem: (index: number) => T
@@ -2188,7 +2188,7 @@ getItemType: ((index: number) => string) | undefined
subscribe: ((listener: (change: DataSourceChange) => void) => Unsubscribe) | undefined
```
-## DataSourceChange — type
+## DataSourceChange — type @experimental
```
| { type: 'insert'; index: number; count: number }
| { type: 'remove'; index: number; count: number }
@@ -2196,7 +2196,7 @@ subscribe: ((listener: (change: DataSourceChange) => void) => Unsubscribe) | und
| { type: 'reset' }
```
-## DataType — enum
+## DataType — enum @experimental
```
Float = 1
Float2 = 2
@@ -2208,21 +2208,21 @@ Int3 = 7
Int4 = 8
```
-## DecodedChunk — interface
+## DecodedChunk — interface @experimental
```
tiles: Uint16Array<ArrayBufferLike>
x: number
y: number
```
-## DecodedPixels — interface
+## DecodedPixels — interface @experimental
```
height: number
pixels: Uint8Array<ArrayBufferLike>
width: number
```
-## DeviceIdentity — interface
+## DeviceIdentity — interface @experimental
```
backend: string
renderer: string
@@ -2230,17 +2230,17 @@ vendor: string
version: string
```
-## DeviceLostReason — const
+## DeviceLostReason — const @experimental
```
{ readonly Unknown: 0; readonly ContextLost: 1; readonly OutOfMemory: 2; readonly Reset: 3; readonly Removed: 4; readonly Destroyed: 5; readonly Validation: 6; readonly Internal: 7; }
```
-## DeviceStatus — const
+## DeviceStatus — const @experimental
```
{ readonly Live: 0; readonly Lost: 1; readonly Recovering: 2; readonly Dead: 3; }
```
-## DiagnosticEvent — interface
+## DiagnosticEvent — interface @experimental
```
context: Record<string, unknown> | undefined
count: number
@@ -2253,7 +2253,7 @@ source: string | undefined
stack: string | undefined
```
-## DiagnosticKind — type
+## DiagnosticKind — type @experimental
```
| 'engine'
/** Reached the host with nobody catching it: `window.onerror`,
@@ -2272,7 +2272,7 @@ stack: string | undefined
| 'game'
```
-## DiagnosticReport — interface
+## DiagnosticReport — interface @experimental
```
context: Record<string, unknown> | undefined
error: unknown
@@ -2281,12 +2281,12 @@ message: string
source: string | undefined
```
-## Diagnostics — const
+## Diagnostics — const @experimental
```
ResourceDef<DiagnosticsAPI>
```
-## DiagnosticsAPI — class
+## DiagnosticsAPI — class @experimental
```
clear: () => void
dropped: number
@@ -2300,13 +2300,13 @@ static new (options?: DiagnosticsOptions): DiagnosticsAPI
static prototype: DiagnosticsAPI
```
-## DiagnosticsOptions — interface
+## DiagnosticsOptions — interface @experimental
```
flushIntervalSec: number | undefined
maxDistinct: number | undefined
```
-## DiagnosticsPlugin — class
+## DiagnosticsPlugin — class @experimental
```
build: (app: App) => void
cleanup: (app: App) => void
@@ -2315,19 +2315,19 @@ static new (options_?: DiagnosticsPluginOptions): DiagnosticsPlugin
static prototype: DiagnosticsPlugin
```
-## DiagnosticsPluginOptions — interface
+## DiagnosticsPluginOptions — interface @experimental
```
captureLevel: LogLevel | undefined
flushIntervalSec: number | undefined
maxDistinct: number | undefined
```
-## DiagnosticsSink — type
+## DiagnosticsSink — type @experimental
```
(events: readonly DiagnosticEvent[]) => void
```
-## DialogHandle — interface
+## DialogHandle — interface @experimental
```
close: () => void
dispose: () => void
@@ -2337,7 +2337,7 @@ open: () => void
panelEntity: number
```
-## DialogOptions — interface
+## DialogOptions — interface @experimental
```
backdropNode: UINodeInit | undefined
backdropVisual: UIVisualInit | undefined
@@ -2352,35 +2352,35 @@ startHidden: boolean | undefined
world: World
```
-## DiffOptions — interface
+## DiffOptions — interface @experimental
```
floatEpsilon: number | undefined
ignoreEntityNames: readonly string[] | undefined
ignoreMetadataKeys: readonly string[] | undefined
```
-## Dimension — interface
+## Dimension — interface @experimental
```
unit: number
value: number
```
-## DimensionUnit — type
+## DimensionUnit — type @experimental
```
(typeof DimensionUnit)[keyof typeof DimensionUnit]
```
-## Disabled — const
+## Disabled — const @experimental
```
ComponentDef<{}>
```
-## DistanceJoint — const
+## DistanceJoint — const @experimental
```
ComponentDef<DistanceJointData>
```
-## DragPlugin — class
+## DragPlugin — class @experimental
```
build: (app: App) => void
dependencies: "uiInteraction"[]
@@ -2389,12 +2389,12 @@ static new (): DragPlugin
static prototype: DragPlugin
```
-## DragState — const
+## DragState — const @experimental
```
ComponentDef<DragStateData>
```
-## DragStateData — interface
+## DragStateData — interface @experimental
```
currentWorldPos: { x: number; y: number; }
deltaWorld: { x: number; y: number; }
@@ -2404,12 +2404,12 @@ startWorldPos: { x: number; y: number; }
totalDeltaWorld: { x: number; y: number; }
```
-## Draggable — const
+## Draggable — const @experimental
```
ComponentDef<DraggableData>
```
-## DraggableData — interface
+## DraggableData — interface @experimental
```
constraintMax: { x: number; y: number; } | null
constraintMin: { x: number; y: number; } | null
@@ -2419,17 +2419,17 @@ lockX: boolean
lockY: boolean
```
-## DragonBones — const
+## DragonBones — const @experimental
```
ResourceDef<DragonBonesManager | null>
```
-## DragonBonesAnimation — const
+## DragonBonesAnimation — const @experimental
```
BuiltinComponentDef<DragonBonesAnimationData>
```
-## DragonBonesAnimationData — interface
+## DragonBonesAnimationData — interface @experimental
```
animation: string
armature: string
@@ -2448,7 +2448,7 @@ skeletonScale: number
timeScale: number
```
-## DragonBonesPlugin — class
+## DragonBonesPlugin — class @experimental
```
acquire: () => Promise<DragonBonesManager | null>
build: (app: App) => void
@@ -2459,12 +2459,12 @@ static new (manager?: DragonBonesManager): DragonBonesPlugin
static prototype: DragonBonesPlugin
```
-## Draw — const
+## Draw — const @experimental
```
DrawAPI
```
-## DrawAPI — interface
+## DrawAPI — interface @experimental
```
begin: (viewProjection: Float32Array) => void
circle: (center: Vec2, radius: number, color: Color, filled?: boolean, segments?: number) => void
@@ -2485,7 +2485,7 @@ texture: (position: Vec2, size: Vec2, textureHandle: number, tint?: Color) => vo
textureRotated: (position: Vec2, size: Vec2, rotation: number, textureHandle: number, tint?: Color) => void
```
-## DrawCallInfo — interface
+## DrawCallInfo — interface @experimental
```
blendMode: number
cameraIndex: number
@@ -2513,12 +2513,12 @@ type: RenderType
vertexCount: number
```
-## DrawCallback — type
+## DrawCallback — type @experimental
```
(elapsed: number) => void
```
-## DrawRank — interface
+## DrawRank — interface @experimental
```
layer: number
order: LayerOrder
@@ -2526,7 +2526,7 @@ worldY: number
worldZ: number
```
-## DropShadowFilterOptions — interface
+## DropShadowFilterOptions — interface @experimental
```
blur: number | undefined
color: { r: number; g: number; b: number; a: number; } | undefined
@@ -2535,7 +2535,7 @@ offsetY: number | undefined
texelSize: { x: number; y: number; } | undefined
```
-## DropdownHandle — interface
+## DropdownHandle — interface @experimental
```
close: () => void
dispose: () => void
@@ -2548,7 +2548,7 @@ open: () => void
setSelectedIndex: (index: number) => void
```
-## DropdownOptions — interface
+## DropdownOptions — interface @experimental
```
buttonStates: { normal?: Color; hover?: Color; pressed?: Color; } | undefined
disabled: boolean | undefined
@@ -2565,17 +2565,17 @@ tabIndex: number | undefined
world: World
```
-## EDITOR_UI_ANCHOR — const
+## EDITOR_UI_ANCHOR — const @experimental
```
{ readonly x: 0; readonly y: 0; }
```
-## EDITOR_VIEW_ENTITY — const
+## EDITOR_VIEW_ENTITY — const @experimental
```
-1
```
-## ESEngineModule — interface
+## ESEngineModule — interface @experimental
```
EstellaContext: new () => CppEngineContext
FS: EmscriptenFS
@@ -2797,12 +2797,12 @@ ui_getCullBit: ((registry: CppRegistry, entity: number) => number) | undefined
ui_getRenderOrder: ((registry: CppRegistry, entity: number) => number) | undefined
```
-## EasingType — type
+## EasingType — type @experimental
```
(typeof EasingType)[keyof typeof EasingType]
```
-## EditorAssetType — type
+## EditorAssetType — type @experimental
```
| 'texture' | 'material' | 'shader' | 'spine-atlas' | 'spine-skeleton'
| 'dragonbones-atlas' | 'dragonbones-skeleton'
@@ -2811,7 +2811,7 @@ ui_getRenderOrder: ((registry: CppRegistry, entity: number) => number) | undefin
| 'unknown'
```
-## EditorBridge — interface
+## EditorBridge — interface @experimental
```
onComponentAdded: ((entity: number, component: string) => void) | undefined
onComponentChanged: ((entity: number, component: string) => void) | undefined
@@ -2822,12 +2822,12 @@ onParentChanged: ((child: number, parent: number | null) => void) | undefined
registerComponent: (name: string, defaults: Record<string, unknown>, isTag: boolean) => void
```
-## EditorGrid — const
+## EditorGrid — const @experimental
```
ResourceDef<EditorGridData>
```
-## EditorGridData — interface
+## EditorGridData — interface @experimental
```
axisX: GridColor
axisY: GridColor
@@ -2838,12 +2838,12 @@ majorEvery: number
spacing: number
```
-## EditorView — const
+## EditorView — const @experimental
```
ResourceDef<EditorViewData>
```
-## EditorViewData — interface
+## EditorViewData — interface @experimental
```
active: boolean
distance: number
@@ -2855,7 +2855,7 @@ x: number
y: number
```
-## EffectDef — interface
+## EffectDef — interface @experimental
```
factory: () => ShaderHandle
label: string
@@ -2865,7 +2865,7 @@ type: string
uniforms: EffectUniformDef[]
```
-## EffectUniformDef — interface
+## EffectUniformDef — interface @experimental
```
defaultValue: number
label: string
@@ -2876,18 +2876,18 @@ neutralValue: number | undefined
step: number
```
-## EmbeddedSideModuleEntry — interface
+## EmbeddedSideModuleEntry — interface @experimental
```
glueBase64: string
wasmBase64: string
```
-## EmbeddedSideModuleRegistry — type
+## EmbeddedSideModuleRegistry — type @experimental
```
Partial<Record<SideModuleId, EmbeddedSideModuleEntry>>
```
-## EmitterShape — enum
+## EmitterShape — enum @experimental
```
Circle = 1
Cone = 3
@@ -2895,17 +2895,17 @@ Point = 0
Rectangle = 2
```
-## EngineApi — type
+## EngineApi — type @experimental
```
NativeEngineApi & Partial<NativeHeap>
```
-## Entity — type
+## Entity — type @experimental
```
number
```
-## EntityCommands — class
+## EntityCommands — class @experimental
```
finalize: () => void
id: () => Entity
@@ -2915,7 +2915,7 @@ static new (commands: CommandsInstance, entity: Entity | null, name?: string): E
static prototype: EntityCommands
```
-## EntityEvent — interface
+## EntityEvent — interface @experimental
```
currentTarget: number
data: TData
@@ -2927,12 +2927,12 @@ target: number
type: string
```
-## EntityEventHandler — type
+## EntityEventHandler — type @experimental
```
(event: EntityEvent<TData>) => void
```
-## EntityEventQueue — class
+## EntityEventQueue — class @experimental
```
clear: () => void
drain: () => readonly EntityEvent[]
@@ -2946,22 +2946,22 @@ static new (): EntityEventQueue
static prototype: EntityEventQueue
```
-## EntityEvents — const
+## EntityEvents — const @experimental
```
ResourceDef<EntityEventQueue>
```
-## EventBinding — const
+## EventBinding — const @experimental
```
ComponentDef<EventBindingData>
```
-## EventBindingData — interface
+## EventBindingData — interface @experimental
```
rows: EventBindingRow[]
```
-## EventBindingPlugin — class
+## EventBindingPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -2970,7 +2970,7 @@ static new (): EventBindingPlugin
static prototype: EventBindingPlugin
```
-## EventBindingRow — interface
+## EventBindingRow — interface @experimental
```
action: string
arg: string | undefined
@@ -2982,25 +2982,25 @@ params: Record<string, AiParamValue> | undefined
target: string | undefined
```
-## EventDef — interface
+## EventDef — interface @experimental
```
_id: symbol
_name: string
_phantom: T | undefined
```
-## EventReader — function
+## EventReader — function @experimental
```
<T>(event: EventDef<T>): EventReaderDescriptor<T>
```
-## EventReaderDescriptor — interface
+## EventReaderDescriptor — interface @experimental
```
_event: EventDef<T>
_type: "event_reader"
```
-## EventReaderInstance — class
+## EventReaderInstance — class @experimental
```
isEmpty: () => boolean
toArray: () => T[]
@@ -3008,7 +3008,7 @@ static new <T>(bus: EventBus<T>): EventReaderInstance<T>
static prototype: EventReaderInstance<any>
```
-## EventRegistry — class
+## EventRegistry — class @experimental
```
getBus: <T>(event: EventDef<T>) => EventBus<T>
register: <T>(event: EventDef<T>) => void
@@ -3017,25 +3017,25 @@ static new (): EventRegistry
static prototype: EventRegistry
```
-## EventWriter — function
+## EventWriter — function @experimental
```
<T>(event: EventDef<T>): EventWriterDescriptor<T>
```
-## EventWriterDescriptor — interface
+## EventWriterDescriptor — interface @experimental
```
_event: EventDef<T>
_type: "event_writer"
```
-## EventWriterInstance — class
+## EventWriterInstance — class @experimental
```
send: (event: T) => void
static new <T>(bus: EventBus<T>): EventWriterInstance<T>
static prototype: EventWriterInstance<any>
```
-## ExternalEntityRef — interface
+## ExternalEntityRef — interface @experimental
```
componentType: string
entityId: number
@@ -3043,7 +3043,7 @@ field: string
target: number
```
-## ExtractEntity — interface
+## ExtractEntity — interface @experimental
```
children: number[]
components: ComponentData[]
@@ -3053,12 +3053,12 @@ parent: number | null
visible: boolean | undefined
```
-## FILL_AXIS — const
+## FILL_AXIS — const @experimental
```
Record<LinearFillDirection, readonly [FillMethod, FillOrigin]>
```
-## FieldMeta — interface
+## FieldMeta — interface @experimental
```
advanced: boolean | undefined
bitmask: { bits?: number; source?: string; } | undefined
@@ -3078,7 +3078,7 @@ tooltip: string | undefined
unit: string | undefined
```
-## FillMethod — enum
+## FillMethod — enum @experimental
```
Horizontal = 0
Radial180 = 4
@@ -3087,7 +3087,7 @@ Radial90 = 3
Vertical = 1
```
-## FillOrigin — enum
+## FillOrigin — enum @experimental
```
Bottom = 2
Left = 0
@@ -3095,7 +3095,7 @@ Right = 1
Top = 3
```
-## FilterEffectDef — interface
+## FilterEffectDef — interface @experimental
```
filter: "lowpass" | "highpass" | "bandpass" | "lowshelf" | "highshelf" | "peaking" | "notch"
frequency: number
@@ -3104,7 +3104,7 @@ q: number | undefined
type: "filter"
```
-## FilterExpr — type
+## FilterExpr — type @experimental
```
| { readonly kind: 'with'; readonly component: AnyComponentDef }
| { readonly kind: 'without'; readonly component: AnyComponentDef }
@@ -3113,12 +3113,12 @@ type: "filter"
| { readonly kind: 'not'; readonly filter: FilterExpr }
```
-## Filters — const
+## Filters — const @experimental
```
{ identityMatrix(): number[]; grayscaleMatrix(): number[]; sepiaMatrix(): number[]; brightnessMatrix(value: number): number[]; contrastMatrix(value: number): number[]; saturationMatrix(value: number): number[]; invertMatrix(): number[]; getColorMatrixShader: () => ShaderHandle; colorMatrixUniforms(matrix: number[]): Record<string, number[]>; }
```
-## FlattenContext — interface
+## FlattenContext — interface @experimental
```
allocateId: () => number
depth: number | undefined
@@ -3126,18 +3126,18 @@ loadPrefab: (path: string) => PrefabData | null
visited: Set<string> | undefined
```
-## FlattenResult — interface
+## FlattenResult — interface @experimental
```
entities: ProcessedEntity[]
rootId: number
```
-## FlexContainer — const
+## FlexContainer — const @experimental
```
BuiltinComponentDef<FlexContainerData>
```
-## FlexContainerData — interface
+## FlexContainerData — interface @experimental
```
alignContent: AlignContent
alignItems: AlignItems
@@ -3148,17 +3148,17 @@ padding: Padding
wrap: FlexWrap
```
-## FlexDirection — type
+## FlexDirection — type @experimental
```
(typeof FlexDirection)[keyof typeof FlexDirection]
```
-## FlexWrap — type
+## FlexWrap — type @experimental
```
(typeof FlexWrap)[keyof typeof FlexWrap]
```
-## FlushReason — enum
+## FlushReason — enum @experimental
```
BatchFull = 0
BlendModeChange = 5
@@ -3171,12 +3171,12 @@ TextureSlotsFull = 1
TypeChange = 7
```
-## FocusManager — const
+## FocusManager — const @experimental
```
ResourceDef<FocusManagerState>
```
-## FocusManagerState — class
+## FocusManagerState — class @experimental
```
blur: () => Entity | null
focus: (entity: Entity, visible?: boolean) => Entity | null
@@ -3187,7 +3187,7 @@ static new (): FocusManagerState
static prototype: FocusManagerState
```
-## FocusPlugin — class
+## FocusPlugin — class @experimental
```
build: (app: App) => void
dependencies: "uiInteraction"[]
@@ -3196,23 +3196,23 @@ static new (): FocusPlugin
static prototype: FocusPlugin
```
-## Focusable — const
+## Focusable — const @experimental
```
ComponentDef<FocusableData>
```
-## FocusableData — interface
+## FocusableData — interface @experimental
```
isFocused: boolean
tabIndex: number
```
-## FollowTarget — const
+## FollowTarget — const @experimental
```
ComponentDef<FollowTargetData>
```
-## FollowTargetData — interface
+## FollowTargetData — interface @experimental
```
damping: number
deadzone: number
@@ -3221,12 +3221,12 @@ offsetY: number
target: number
```
-## FontHandle — type
+## FontHandle — type @experimental
```
number
```
-## ForceFieldType — enum
+## ForceFieldType — enum @experimental
```
Directional = 0
Drag = 3
@@ -3234,13 +3234,13 @@ Point = 1
Vortex = 2
```
-## FrameCaptureData — interface
+## FrameCaptureData — interface @experimental
```
cameraCount: number
drawCalls: DrawCallInfo[]
```
-## FrameHistory — class
+## FrameHistory — class @experimental
```
count: number
getAll: () => FrameSnapshot[]
@@ -3251,14 +3251,14 @@ static new (capacity?: number): FrameHistory
static prototype: FrameHistory
```
-## FrameSnapshot — interface
+## FrameSnapshot — interface @experimental
```
frameTimeMs: number
phaseTimings: Map<string, number>
systemTimings: Map<string, number>
```
-## FrameStats — interface
+## FrameStats — interface @experimental
```
culled: number
drawCalls: number
@@ -3274,23 +3274,23 @@ text: number
triangles: number
```
-## FsmActionRef — type
+## FsmActionRef — type @experimental
```
string | { name: string; arg?: string; params?: Record<string, AiParamValue> }
```
-## FsmDefinition — interface
+## FsmDefinition — interface @experimental
```
initial: string
states: FsmState[]
```
-## FsmEdge — type
+## FsmEdge — type @experimental
```
GraphEdge<FsmTransition>
```
-## FsmPlugin — class
+## FsmPlugin — class @experimental
```
build: (app: App) => void
name: string
@@ -3298,14 +3298,14 @@ static new (): FsmPlugin
static prototype: FsmPlugin
```
-## FsmRunState — interface
+## FsmRunState — interface @experimental
```
current: string
entered: boolean
previous: string | null
```
-## FsmState — interface
+## FsmState — interface @experimental
```
name: string
onEnter: FsmActionRef | undefined
@@ -3316,7 +3316,7 @@ x: number | undefined
y: number | undefined
```
-## FsmTransition — interface
+## FsmTransition — interface @experimental
```
condition: string | undefined
guard: BlackboardGuard | BlackboardGuard[] | undefined
@@ -3324,12 +3324,12 @@ to: string
trigger: string | undefined
```
-## GLDebug — const
+## GLDebug — const @experimental
```
{ enable(): void; disable(): void; check(context: string): number; diagnose(): void; }
```
-## GameSocket — class
+## GameSocket — class @experimental
```
close: (code?: number, reason?: string) => void
connect: () => void
@@ -3340,12 +3340,12 @@ static new (options: GameSocketOptions): GameSocket
static prototype: GameSocket
```
-## GameSocketOptions — type
+## GameSocketOptions — type @experimental
```
PlatformSocketOptions
```
-## GamepadAxis — enum
+## GamepadAxis — enum @experimental
```
LeftX = 0
LeftY = 1
@@ -3353,7 +3353,7 @@ RightX = 2
RightY = 3
```
-## GamepadButton — enum
+## GamepadButton — enum @experimental
```
Back = 8
DpadDown = 13
@@ -3374,7 +3374,7 @@ Start = 9
West = 2
```
-## GamepadSnapshot — interface
+## GamepadSnapshot — interface @experimental
```
axes: number[]
buttons: number[]
@@ -3383,7 +3383,7 @@ index: number
mapping: string
```
-## GearBinding — interface
+## GearBinding — interface @experimental
```
component: string
controller: string
@@ -3392,28 +3392,28 @@ property: string
tween: GearTween | undefined
```
-## GearTween — interface
+## GearTween — interface @experimental
```
duration: number
easing: EasingType
```
-## GearValue — type
+## GearValue — type @experimental
```
number | boolean | string | Color | Vec2 | Vec3
```
-## Geometry — const
+## Geometry — const @experimental
```
{ create(options: GeometryOptions): GeometryHandle; updateVertices(handle: GeometryHandle, vertices: Float32Array, offset?: number): void; release(handle: GeometryHandle): void; isValid(handle: GeometryHandle): boolean; createQuad(width?: number, height?: number): GeometryHandle; createCircle(radius?: number, segments?: number): GeometryHandle; createPolygon(points: Array<{ x: number; y: number; }>): GeometryHandle; }
```
-## GeometryHandle — type
+## GeometryHandle — type @experimental
```
number
```
-## GeometryOptions — interface
+## GeometryOptions — interface @experimental
```
dynamic: boolean | undefined
indices: Uint16Array<ArrayBufferLike> | Uint32Array<ArrayBufferLike> | undefined
@@ -3421,7 +3421,7 @@ layout: VertexAttributeDescriptor[]
vertices: Float32Array<ArrayBufferLike>
```
-## GestureDetector — class
+## GestureDetector — class @experimental
```
onLongPress: ((x: number, y: number) => void) | null
onPinch: ((scale: number, centerX: number, centerY: number) => void) | null
@@ -3433,22 +3433,22 @@ static new (input: InputState): GestureDetector
static prototype: GestureDetector
```
-## GetWorld — function
+## GetWorld — function @experimental
```
(): GetWorldDescriptor
```
-## GetWorldDescriptor — interface
+## GetWorldDescriptor — interface @experimental
```
_type: "get_world"
```
-## GpAxis — const
+## GpAxis — const @experimental
```
(axis: number, pad?: number, scale?: number) => Binding
```
-## GpButton — const
+## GpButton — const @experimental
```
(button: number, pad?: number) => Binding
```
@@ -3479,7 +3479,7 @@ _type: "get_world"
'float' | 'vec2' | 'vec3' | 'vec4'
```
-## Graphics — class
+## Graphics — class @experimental
```
arc: (cx: number, cy: number, radius: number, startAngle: number, endAngle: number, anticlockwise?: boolean, segments?: number) => void
beginFill: (color: Color) => void
@@ -3503,12 +3503,12 @@ static new (): Graphics
static prototype: Graphics
```
-## GridColor — type
+## GridColor — type @experimental
```
[number, number, number, number]
```
-## GridLayoutProvider — class
+## GridLayoutProvider — class @experimental
```
getContentSize: (count: number) => Vec2
getItemRect: (index: number) => Rect
@@ -3517,20 +3517,20 @@ static new (opts: GridLayoutOptions): GridLayoutProvider
static prototype: GridLayoutProvider
```
-## HeadlessAppOptions — interface
+## HeadlessAppOptions — interface @experimental
```
plugins: Plugin[] | undefined
sideModules: SideModuleHost | undefined
```
-## HitAreaShape — type
+## HitAreaShape — type @experimental
```
| { type: 'rect'; x: number; y: number; width: number; height: number }
| { type: 'circle'; cx: number; cy: number; radius: number }
| { type: 'polygon'; points: number[] }
```
-## HttpBackend — class
+## HttpBackend — class @experimental
```
fetchBinary: (path: string) => Promise<ArrayBuffer>
fetchText: (path: string) => Promise<string>
@@ -3540,42 +3540,42 @@ static new (options: HttpBackendOptions): HttpBackend
static prototype: HttpBackend
```
-## INTERACTION_CONTROLLER — const
+## INTERACTION_CONTROLLER — const @experimental
```
"$interaction"
```
-## INTERACTION_PAGES — const
+## INTERACTION_PAGES — const @experimental
```
readonly ["normal", "hover", "pressed", "disabled", "focused"]
```
-## INVALID_ENTITY — const
+## INVALID_ENTITY — const @experimental
```
number
```
-## INVALID_FONT — const
+## INVALID_FONT — const @experimental
```
number
```
-## INVALID_MATERIAL — const
+## INVALID_MATERIAL — const @experimental
```
0
```
-## INVALID_TEXTURE — const
+## INVALID_TEXTURE — const @experimental
```
number
```
-## Identity — const
+## Identity — const @experimental
```
ResourceDef<IdentityAPI>
```
-## IdentityAPI — class
+## IdentityAPI — class @experimental
```
available: boolean
login: () => Promise<LoginResult>
@@ -3584,7 +3584,7 @@ static new (): IdentityAPI
static prototype: IdentityAPI
```
-## ImageSegment — interface
+## ImageSegment — interface @experimental
```
height: number
offsetX: number
@@ -3597,7 +3597,7 @@ valign: ImageValign
width: number
```
-## InferParam — type
+## InferParam — type @experimental
```
P extends QueryDescriptor<infer C> ? QueryInstance<C> :
P extends ResDescriptor<infer T> ? T :
@@ -3610,19 +3610,19 @@ P extends QueryDescriptor<infer C> ? QueryInstance<C> :
never
```
-## InferParams — type
+## InferParams — type @experimental
```
{
[K in keyof P]: InferParam<P[K]>;
}
```
-## Input — const
+## Input — const @experimental
```
ResourceDef<InputState>
```
-## InputHandler — interface
+## InputHandler — interface @experimental
```
onKeyDown: ((code: string, mods: Modifiers) => boolean | void) | undefined
onKeyUp: ((code: string, mods: Modifiers) => boolean | void) | undefined
@@ -3636,7 +3636,7 @@ onTouchStart: ((id: number, x: number, y: number) => boolean | void) | undefined
onWheel: ((deltaX: number, deltaY: number, mods: Modifiers) => boolean | void) | undefined
```
-## InputMap — class
+## InputMap — class @experimental
```
actions: () => string[]
axis2d: (name: string) => Vec2
@@ -3660,13 +3660,13 @@ static new (actions: Record<string, ActionDef>): InputMap
static prototype: InputMap
```
-## InputMapAsset — interface
+## InputMapAsset — interface @experimental
```
actions: Record<string, ActionDef>
version: number
```
-## InputPlugin — class
+## InputPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -3675,7 +3675,7 @@ static new (target?: unknown): InputPlugin
static prototype: InputPlugin
```
-## InputRouter — class
+## InputRouter — class @experimental
```
currentMods: Modifiers
dispatchKeyDown: (code: string) => boolean
@@ -3694,7 +3694,7 @@ static new (): InputRouter
static prototype: InputRouter
```
-## InputState — class
+## InputState — class @experimental
```
beginFixedStep: () => void
clearFrameState: () => void
@@ -3753,7 +3753,7 @@ static new (): InputState
static prototype: InputState
```
-## InstantiatePrefabOptions — interface
+## InstantiatePrefabOptions — interface @experimental
```
assetBaseUrl: string | undefined
assets: Assets | undefined
@@ -3761,57 +3761,57 @@ overrides: PrefabOverride[] | undefined
parent: number | undefined
```
-## InstantiatePrefabResult — interface
+## InstantiatePrefabResult — interface @experimental
```
entities: Map<number, number>
root: number
```
-## Interactable — const
+## Interactable — const @experimental
```
BuiltinComponentDef<InteractableData>
```
-## InteractableData — interface
+## InteractableData — interface @experimental
```
blockRaycast: boolean
enabled: boolean
raycastTarget: boolean
```
-## InterestPolicy — type
+## InterestPolicy — type @experimental
```
(view: InterestView) => ReadonlySet<Entity> | 'all'
```
-## InterestView — interface
+## InterestView — interface @experimental
```
candidates: readonly number[]
connectionId: number
world: World
```
-## InterpType — type
+## InterpType — type @experimental
```
(typeof InterpType)[keyof typeof InterpType]
```
-## JsonResult — interface
+## JsonResult — interface @experimental
```
data: T
```
-## JustifyContent — type
+## JustifyContent — type @experimental
```
(typeof JustifyContent)[keyof typeof JustifyContent]
```
-## Key — const
+## Key — const @experimental
```
(code: string) => Binding
```
-## Keyframe — interface
+## Keyframe — interface @experimental
```
inTangent: number
interpolation: InterpType | undefined
@@ -3820,17 +3820,17 @@ time: number
value: number
```
-## Keys1D — const
+## Keys1D — const @experimental
```
(neg: string, pos: string) => Binding
```
-## Keys2D — const
+## Keys2D — const @experimental
```
(up: string, down: string, left: string, right: string) => Binding
```
-## KineticScroll — class
+## KineticScroll — class @experimental
```
beginDrag: () => void
endDrag: () => void
@@ -3845,31 +3845,31 @@ static new (opts?: KineticScrollOptions): KineticScroll
static prototype: KineticScroll
```
-## LIGHT_TOKENS — const
+## LIGHT_TOKENS — const @experimental
```
ThemeTokens
```
-## LayerOrder — enum
+## LayerOrder — enum @experimental
```
Depth = 2
Painter = 0
YSort = 1
```
-## LayoutProvider — interface
+## LayoutProvider — interface @experimental
```
getContentSize: (count: number) => Vec2
getItemRect: (index: number) => Rect
getVisibleRange: (viewport: Rect, count: number) => [start: number, end: number]
```
-## Leaderboard — const
+## Leaderboard — const @experimental
```
ResourceDef<LeaderboardAPI>
```
-## LeaderboardAPI — class
+## LeaderboardAPI — class @experimental
```
available: boolean
dispose: () => void
@@ -3884,7 +3884,7 @@ static new (module_: () => ESEngineModule | null): LeaderboardAPI
static prototype: LeaderboardAPI
```
-## LeaderboardOptions — interface
+## LeaderboardOptions — interface @experimental
```
key: string | undefined
limit: number | undefined
@@ -3893,18 +3893,18 @@ scope: LeaderboardScope | undefined
style: LeaderboardStyle | undefined
```
-## LeaderboardProvider — interface
+## LeaderboardProvider — interface @experimental
```
canvas: () => PlatformCanvas | null
post: (message: Record<string, unknown>) => void
```
-## LeaderboardScope — type
+## LeaderboardScope — type @experimental
```
'friends' | 'group'
```
-## LeaderboardStyle — interface
+## LeaderboardStyle — interface @experimental
```
avatars: boolean | undefined
background: string | undefined
@@ -3916,22 +3916,22 @@ rowHeight: number | undefined
selfColor: string | undefined
```
-## Lifecycle — const
+## Lifecycle — const @experimental
```
ResourceDef<LifecycleManager>
```
-## LifecycleEvent — type
+## LifecycleEvent — type @experimental
```
'show' | 'hide' | 'pause' | 'resume'
```
-## LifecycleListener — type
+## LifecycleListener — type @experimental
```
(event: LifecycleEvent) => void
```
-## LifecycleManager — class
+## LifecycleManager — class @experimental
```
autoPause: boolean
emit_: (event: LifecycleEvent) => void
@@ -3946,7 +3946,7 @@ static new (autoPause?: boolean): LifecycleManager
static prototype: LifecycleManager
```
-## LifecyclePlugin — class
+## LifecyclePlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -3955,17 +3955,17 @@ static new (options_?: LifecyclePluginOptions | undefined): LifecyclePlugin
static prototype: LifecyclePlugin
```
-## LifecyclePluginOptions — interface
+## LifecyclePluginOptions — interface @experimental
```
autoPause: boolean | undefined
```
-## Light2D — const
+## Light2D — const @experimental
```
BuiltinComponentDef<Light2DData>
```
-## Light2DData — interface
+## Light2DData — interface @experimental
```
color: Color
direction: Vec2
@@ -3979,7 +3979,7 @@ shadowSoftness: number
type: number
```
-## Light2DType — enum
+## Light2DType — enum @experimental
```
Ambient = 2
Directional = 1
@@ -3987,12 +3987,12 @@ Point = 0
Spot = 3
```
-## LinearFillDirection — type
+## LinearFillDirection — type @experimental
```
'right' | 'left' | 'up' | 'down'
```
-## LinearLayoutProvider — class
+## LinearLayoutProvider — class @experimental
```
getContentSize: (count: number) => Vec2
getItemRect: (index: number) => Rect
@@ -4001,20 +4001,20 @@ static new (opts: LinearLayoutOptions): LinearLayoutProvider
static prototype: LinearLayoutProvider
```
-## ListItemTemplate — interface
+## ListItemTemplate — interface @experimental
```
bind: (entity: Entity, data: T, index: number) => void
create: (world: World, parent: Entity) => Entity
```
-## ListLayoutSpec — type
+## ListLayoutSpec — type @experimental
```
| { itemHeight: number | ((index: number) => number); spacing?: number; direction?: 'column' }
| { itemWidth: number; spacing?: number; direction: 'row' }
| { columns: number; itemSize: Vec2; spacing?: Vec2 }
```
-## ListView — class
+## ListView — class @experimental
```
dispose: () => void
getContentSize: () => Vec2
@@ -4029,7 +4029,7 @@ static new <T = unknown>(opts: ListViewOptions<T>): ListView<T>
static prototype: ListView<any>
```
-## ListViewHandle — interface
+## ListViewHandle — interface @experimental
```
content: number
data: DataSource<T>
@@ -4042,7 +4042,7 @@ scrollToIndex: (index: number) => void
view: ListView<T>
```
-## ListViewHost — interface
+## ListViewHost — interface @experimental
```
attachScrollContainer: (entity: Entity, container: ScrollContainer) => void
detachScrollContainer: (entity: Entity) => void
@@ -4050,7 +4050,7 @@ registerListView: (list: ListView<unknown>) => void
unregisterListView: (list: ListView<unknown>) => void
```
-## ListViewOptions — interface
+## ListViewOptions — interface @experimental
```
dataSource: DataSource<T>
layout: LayoutProvider
@@ -4064,14 +4064,14 @@ viewportSize: Vec2
world: World
```
-## ListenOptions — interface
+## ListenOptions — interface @experimental
```
gamepad: boolean | undefined
keyboard: boolean | undefined
mouse: boolean | undefined
```
-## LoadRuntimeSceneOptions — interface
+## LoadRuntimeSceneOptions — interface @experimental
```
app: App
module: ESEngineModule | null
@@ -4087,7 +4087,7 @@ uiTheme: "dark" | "light" | undefined
uiThemeOverrides: ThemeOverrides | undefined
```
-## LoadedTilemapLayer — interface
+## LoadedTilemapLayer — interface @experimental
```
chunks: LoadedTilemapChunk[]
height: number
@@ -4097,7 +4097,7 @@ tiles: Uint16Array<ArrayBufferLike>
width: number
```
-## LoadedTilemapSource — interface
+## LoadedTilemapSource — interface @experimental
```
collisionTileIds: number[] | undefined
hexSideLength: number | undefined
@@ -4114,7 +4114,7 @@ tileWidth: number
tilesets: LoadedTilemapTileset[]
```
-## LoadedTilemapTileset — interface
+## LoadedTilemapTileset — interface @experimental
```
columns: number
firstId: number
@@ -4124,52 +4124,52 @@ spacing: number
textureHandle: number
```
-## LocalLeaderboardOptions — interface
+## LocalLeaderboardOptions — interface @experimental
```
friends: readonly CloudPlayer[] | undefined
height: number | undefined
width: number | undefined
```
-## LocalTransform — const
+## LocalTransform — const @experimental
```
BuiltinComponentDef<TransformData>
```
-## LocalTransformData — type
+## LocalTransformData — type @experimental
```
TransformData
```
-## LocaleCatalog — type
+## LocaleCatalog — type @experimental
```
Record<string, LocaleEntry>
```
-## LocaleEntry — type
+## LocaleEntry — type @experimental
```
string | PluralForms
```
-## LocaleResult — interface
+## LocaleResult — interface @experimental
```
keyCount: number
locale: string
```
-## LocaleTableAsset — interface
+## LocaleTableAsset — interface @experimental
```
entries: LocaleCatalog
locale: string
version: number
```
-## Localization — const
+## Localization — const @experimental
```
ResourceDef<LocalizationAPI>
```
-## LocalizationAPI — class
+## LocalizationAPI — class @experimental
```
addCatalog: (locale: string, entries: LocaleCatalog) => void
availableLocales: () => string[]
@@ -4184,7 +4184,7 @@ static new (locale?: string, fallback?: string): LocalizationAPI
static prototype: LocalizationAPI
```
-## LocalizationOptions — interface
+## LocalizationOptions — interface @experimental
```
catalogs: Record<string, LocaleCatalog> | undefined
fallback: string | undefined
@@ -4192,7 +4192,7 @@ locale: string | undefined
tables: string[] | undefined
```
-## LocalizationPlugin — class
+## LocalizationPlugin — class @experimental
```
build: (app: App) => void
name: string
@@ -4200,7 +4200,7 @@ static new (opts?: LocalizationOptions): LocalizationPlugin
static prototype: LocalizationPlugin
```
-## LogEntry — interface
+## LogEntry — interface @experimental
```
category: string
data: unknown
@@ -4209,12 +4209,12 @@ message: string
timestamp: number
```
-## LogHandler — interface
+## LogHandler — interface @experimental
```
handle: (entry: LogEntry) => void
```
-## LogLevel — enum
+## LogLevel — enum @experimental
```
Debug = 0
Error = 3
@@ -4222,7 +4222,7 @@ Info = 1
Warn = 2
```
-## Logger — class
+## Logger — class @experimental
```
addHandler: (handler: LogHandler) => void
clearHandlers: () => void
@@ -4236,17 +4236,17 @@ static new (): Logger
static prototype: Logger
```
-## LoginResult — interface
+## LoginResult — interface @experimental
```
code: string
```
-## LoopMode — type
+## LoopMode — type @experimental
```
(typeof LoopMode)[keyof typeof LoopMode]
```
-## ManifestModel — class
+## ManifestModel — class @experimental
```
allAssets: () => AddressableManifestAsset[]
assetByKey: (key: string) => AddressableManifestAsset | null
@@ -4270,28 +4270,28 @@ static new (manifest: AddressableManifest): ManifestModel
static prototype: ManifestModel
```
-## Marker — const
+## Marker — const @experimental
```
ComponentDef<MarkerData>
```
-## MarkerData — interface
+## MarkerData — interface @experimental
```
properties: Record<string, string>
type: string
```
-## MaskMode — type
+## MaskMode — type @experimental
```
(typeof MaskMode)[keyof typeof MaskMode]
```
-## Material — const
+## Material — const @experimental
```
{ createShader(vertexSrc: string, fragmentSrc: string): ShaderHandle; releaseShader(shader: ShaderHandle): void; create(options: MaterialOptions): MaterialHandle; compileShader(esshaderSource: string, features?: string[]): ShaderHandle; getSwitch(material: MaterialHandle, name: string): boolean; setSwitch(material: MaterialHandle, name: string, on: boolean): void; get(material: MaterialHandle): MaterialData | undefined; setUniform(material: MaterialHandle, name: string, value: UniformValue): void; getUniform(material: MaterialHandle, name: string): UniformValue | undefined; setBlendMode(material: MaterialHandle, mode: BlendMode): void; getBlendMode(material: MaterialHandle): BlendMode; setDepthTest(material: MaterialHandle, enabled: boolean): void; setDepthWrite(material: MaterialHandle, enabled: boolean): void; setCull(material: MaterialHandle, cull: CullMode): void; getShader(material: MaterialHandle): ShaderHandle; release(material: MaterialHandle): void; isValid(material: MaterialHandle): boolean; renderPreview(material: MaterialHandle, w: number, h: number): Promise<ImageData | null>; releaseAll(): void; createFromAsset(data: MaterialAssetData, shaderHandle: ShaderHandle, parentHandle?: MaterialHandle): MaterialHandle; createInstance(source: MaterialHandle): MaterialHandle; toAssetData(material: MaterialHandle, shaderPath: string, parentPath?: string): MaterialAssetData | null; getUniforms(material: MaterialHandle): Map<string, UniformValue>; tex(textureId: number, slot?: number): TextureRef; }
```
-## MaterialAssetData — interface
+## MaterialAssetData — interface @experimental
```
blendMode: number | undefined
cull: number | undefined
@@ -4305,7 +4305,7 @@ type: "material"
version: string
```
-## MaterialData — interface
+## MaterialData — interface @experimental
```
blendMode: BlendMode
cachedBuffer_: Float32Array<ArrayBufferLike> | null
@@ -4339,12 +4339,12 @@ x: number | undefined
y: number | undefined
```
-## MaterialHandle — type
+## MaterialHandle — type @experimental
```
number
```
-## MaterialOptions — interface
+## MaterialOptions — interface @experimental
```
blendMode: BlendMode | undefined
cull: CullMode | undefined
@@ -4355,7 +4355,7 @@ switches: Record<string, boolean> | undefined
uniforms: Record<string, UniformValue> | undefined
```
-## MeasureTextOptions — interface
+## MeasureTextOptions — interface @experimental
```
bold: boolean | undefined
fontFamily: string | undefined
@@ -4366,7 +4366,7 @@ lineHeight: number | undefined
maxWidth: number | undefined
```
-## MeasuredLinearLayoutProvider — class
+## MeasuredLinearLayoutProvider — class @experimental
```
getContentSize: (count: number) => Vec2
getItemRect: (index: number) => Rect
@@ -4376,7 +4376,7 @@ static new (opts: MeasuredLinearLayoutOptions): MeasuredLinearLayoutProvider
static prototype: MeasuredLinearLayoutProvider
```
-## MemoryTransport — class
+## MemoryTransport — class @experimental
```
dropPending: () => void
flush: (limit?: number) => void
@@ -4388,12 +4388,12 @@ static pair: (options?: MemoryTransportOptions) => [MemoryTransport, MemoryTrans
static prototype: MemoryTransport
```
-## Mesh2D — const
+## Mesh2D — const @experimental
```
BuiltinComponentDef<Mesh2DData>
```
-## Mesh2DAPI — class
+## Mesh2DAPI — class @experimental
```
clearGeometry: (entity: Entity) => void
getGeometry: (entity: Entity) => Mesh2DGeometry | undefined
@@ -4402,7 +4402,7 @@ static new (module_: NonNullable<EngineApi>, registry_: CppRegistry): Mesh2DAPI
static prototype: Mesh2DAPI
```
-## Mesh2DData — interface
+## Mesh2DData — interface @experimental
```
color: Color
enabled: boolean
@@ -4414,7 +4414,7 @@ parallax: Vec2
texture: number
```
-## Mesh2DGeometry — interface
+## Mesh2DGeometry — interface @experimental
```
colors: number[] | undefined
indices: number[]
@@ -4422,7 +4422,7 @@ positions: number[]
uvs: number[] | undefined
```
-## Mesh2DPlugin — class
+## Mesh2DPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -4431,24 +4431,24 @@ static new (): Mesh2DPlugin
static prototype: Mesh2DPlugin
```
-## Meshes2D — const
+## Meshes2D — const @experimental
```
ResourceDef<Mesh2DAPI>
```
-## MessageHandler — type
+## MessageHandler — type @experimental
```
(payload: T) => void
```
-## MessagePortLike — interface
+## MessagePortLike — interface @experimental
```
close: (() => void) | undefined
onmessage: ((event: { data: unknown; }) => void) | null
postMessage: (data: unknown) => void
```
-## MessagePortTransport — class
+## MessagePortTransport — class @experimental
```
close: () => void
on: (event: "message", handler: (data: string | ArrayBuffer) => void) => () => void
@@ -4457,7 +4457,7 @@ static new (port: MessagePortLike | MessagePort): MessagePortTransport
static prototype: MessagePortTransport
```
-## MigrationResult — interface
+## MigrationResult — interface @experimental
```
data: PrefabData
fromVersion: string
@@ -4465,7 +4465,7 @@ migrated: boolean
toVersion: string
```
-## MiniGameSocket — class
+## MiniGameSocket — class @experimental
```
close: (code?: number, reason?: string) => void
connect: () => void
@@ -4476,25 +4476,25 @@ static new (options: GameSocketOptions, global: MiniGameGlobal): MiniGameSocket
static prototype: MiniGameSocket
```
-## MissingAssetCallback — type
+## MissingAssetCallback — type @experimental
```
(missing: MissingAsset[]) => void
```
-## MissingAssetsError — class
+## MissingAssetsError — class @experimental
```
missing: MissingAsset[]
static new (missing: MissingAsset[]): MissingAssetsError
static prototype: MissingAssetsError
```
-## MockAdProviderOptions — interface
+## MockAdProviderOptions — interface @experimental
```
completed: boolean | undefined
durationMs: number | undefined
```
-## Modifiers — interface
+## Modifiers — interface @experimental
```
alt: boolean
ctrl: boolean
@@ -4502,22 +4502,22 @@ meta: boolean
shift: boolean
```
-## MotorJoint — const
+## MotorJoint — const @experimental
```
ComponentDef<MotorJointData>
```
-## MouseButton — const
+## MouseButton — const @experimental
```
(button: number) => Binding
```
-## Mut — function
+## Mut — function @experimental
```
<T extends AnyComponentDef>(component: T): MutWrapper<T>
```
-## MutWrapper — interface
+## MutWrapper — interface @experimental
```
_component: T
_type: "mut"
@@ -4528,27 +4528,27 @@ _type: "mut"
Record<GraphNodeType, NodeSpec>
```
-## Name — const
+## Name — const @experimental
```
ComponentDef<NameData>
```
-## NameData — interface
+## NameData — interface @experimental
```
value: string
```
-## Nav — const
+## Nav — const @experimental
```
ResourceDef<Navigation>
```
-## NavAgent — const
+## NavAgent — const @experimental
```
ComponentDef<NavAgentData>
```
-## NavAgentData — interface
+## NavAgentData — interface @experimental
```
arriveRadius: number
arrived: boolean
@@ -4560,7 +4560,7 @@ targetX: number
targetY: number
```
-## NavGrid — class
+## NavGrid — class @experimental
```
cellSize: number
cellToWorld: (gx: number, gy: number) => Vec2
@@ -4580,7 +4580,7 @@ static new (opts: NavGridOptions): NavGrid
static prototype: NavGrid
```
-## NavGridOptions — interface
+## NavGridOptions — interface @experimental
```
cellSize: number
height: number
@@ -4589,7 +4589,7 @@ walkable: ArrayLike<number> | undefined
width: number
```
-## NavPlugin — class
+## NavPlugin — class @experimental
```
build: (app: App) => void
name: string
@@ -4597,7 +4597,7 @@ static new (): NavPlugin
static prototype: NavPlugin
```
-## Navigation — class
+## Navigation — class @experimental
```
findWorldPath: (from: Vec2, to: Vec2, opts?: PathfindOptions & { radius?: number; }) => Vec2[] | null
grid: NavGrid | null
@@ -4607,18 +4607,18 @@ static new (): Navigation
static prototype: Navigation
```
-## NestedPrefabRef — interface
+## NestedPrefabRef — interface @experimental
```
overrides: PrefabOverride[]
prefabPath: string
```
-## Net — const
+## Net — const @experimental
```
ResourceDef<NetSession>
```
-## NetChannel — class
+## NetChannel — class @experimental
```
dispose: (reason?: string) => void
handle: <Req = unknown, Res = unknown>(type: string, handler: RequestHandler<Req, Res>) => () => void
@@ -4631,22 +4631,22 @@ static new (transport: NetTransport, opts?: NetChannelOptions): NetChannel
static prototype: NetChannel
```
-## NetChannelOptions — interface
+## NetChannelOptions — interface @experimental
```
requestTimeoutMs: number | undefined
```
-## NetGhost — const
+## NetGhost — const @experimental
```
ComponentDef<{}>
```
-## NetRoleKind — type
+## NetRoleKind — type @experimental
```
'offline' | 'server' | 'client'
```
-## NetSession — class
+## NetSession — class @experimental
```
client: ReplicationClient | null
connect: (transport: NetTransport, options?: ReplicationClientOptions) => Promise<ReplicationClient>
@@ -4658,7 +4658,7 @@ static new (app_: App): NetSession
static prototype: NetSession
```
-## NetTransport — interface
+## NetTransport — interface @experimental
```
on: (event: "message", handler: (data: string | ArrayBuffer) => void) => () => void
send: (data: string | ArrayBuffer) => void
@@ -4686,39 +4686,39 @@ output: GraphType | null
params: NodeParamSpec[]
```
-## Not — function
+## Not — function @experimental
```
(filter: FilterExpr): FilterExpr
```
-## OneWayPlatform — const
+## OneWayPlatform — const @experimental
```
ComponentDef<OneWayPlatformData>
```
-## Or — function
+## Or — function @experimental
```
(...filters: FilterExpr[]): FilterExpr
```
-## OutlineFilterOptions — interface
+## OutlineFilterOptions — interface @experimental
```
color: { r: number; g: number; b: number; a: number; } | undefined
texelSize: { x: number; y: number; } | undefined
width: number | undefined
```
-## PREFAB_FORMAT_VERSION — const
+## PREFAB_FORMAT_VERSION — const @experimental
```
"2"
```
-## PTR_LAYOUTS — const
+## PTR_LAYOUTS — const @experimental
```
Record<string, PtrLayout>
```
-## PackagedAssetIndex — interface
+## PackagedAssetIndex — interface @experimental
```
addressOf: (ref: string) => string | null
assetPaths: () => string[]
@@ -4729,13 +4729,13 @@ resolvePath: (ref: string) => string
textureImport: (ref: string) => ParsedTextureImportSettings | undefined
```
-## PackagedAssetSourceOptions — interface
+## PackagedAssetSourceOptions — interface @experimental
```
backend: Backend | undefined
decodePixels: ((path: string, flip: boolean) => Promise<{ width: number; height: number; pixels: Uint8Array; }>) | undefined
```
-## PackagedGameConfig — interface
+## PackagedGameConfig — interface @experimental
```
achievements: string[] | undefined
audioConfig: AudioProjectConfig | undefined
@@ -4754,17 +4754,17 @@ uiThemeColors: Record<string, string> | undefined
ySortLayers: number | undefined
```
-## Parent — const
+## Parent — const @experimental
```
BuiltinComponentDef<ParentData>
```
-## ParentData — interface
+## ParentData — interface @experimental
```
entity: number
```
-## ParsedTextureImportSettings — interface
+## ParsedTextureImportSettings — interface @experimental
```
filter: "linear" | "nearest" | undefined
sliceBorder: { left: number; right: number; top: number; bottom: number; } | undefined
@@ -4772,12 +4772,12 @@ srgb: boolean | undefined
wrap: "repeat" | "clamp" | "mirror" | undefined
```
-## Particle — const
+## Particle — const @experimental
```
ResourceDef<ParticleAPI>
```
-## ParticleAPI — class
+## ParticleAPI — class @experimental
```
getAliveCount: (entity: Entity) => number
play: (entity: Entity) => void
@@ -4790,7 +4790,7 @@ static new (module: NonNullable<EngineApi>, registry: CppRegistry): ParticleAPI
static prototype: ParticleAPI
```
-## ParticleEasing — enum
+## ParticleEasing — enum @experimental
```
EaseIn = 1
EaseInOut = 3
@@ -4798,12 +4798,12 @@ EaseOut = 2
Linear = 0
```
-## ParticleEmitter — const
+## ParticleEmitter — const @experimental
```
BuiltinComponentDef<ParticleEmitterData>
```
-## ParticleEmitterData — interface
+## ParticleEmitterData — interface @experimental
```
angleSpreadMax: number
angleSpreadMin: number
@@ -4867,12 +4867,12 @@ trailPoints: number
trailWidth: number
```
-## ParticleForceField — const
+## ParticleForceField — const @experimental
```
BuiltinComponentDef<ParticleForceFieldData>
```
-## ParticleForceFieldData — interface
+## ParticleForceFieldData — interface @experimental
```
direction: Vec2
enabled: boolean
@@ -4882,7 +4882,7 @@ strength: number
type: number
```
-## ParticlePlugin — class
+## ParticlePlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -4891,19 +4891,19 @@ static new (): ParticlePlugin
static prototype: ParticlePlugin
```
-## PathfindOptions — interface
+## PathfindOptions — interface @experimental
```
clearance: number | undefined
diagonal: boolean | undefined
snapRadius: number | undefined
```
-## Payment — const
+## Payment — const @experimental
```
ResourceDef<PaymentAPI>
```
-## PaymentAPI — class
+## PaymentAPI — class @experimental
```
available: boolean
request: (request: PaymentRequest) => Promise<void>
@@ -4911,33 +4911,33 @@ static new (): PaymentAPI
static prototype: PaymentAPI
```
-## PaymentFailure — interface
+## PaymentFailure — interface @experimental
```
code: number | undefined
```
-## PaymentRequest — type
+## PaymentRequest — type @experimental
```
PlatformPaymentRequest
```
-## Perceiver — const
+## Perceiver — const @experimental
```
ComponentDef<PerceiverData>
```
-## PerceiverData — interface
+## PerceiverData — interface @experimental
```
fovDegrees: number
range: number
```
-## Perception — const
+## Perception — const @experimental
```
ComponentDef<PerceptionData>
```
-## PerceptionData — interface
+## PerceptionData — interface @experimental
```
dirX: number
dirY: number
@@ -4947,7 +4947,7 @@ targetY: number
visible: boolean
```
-## PerceptionPlugin — class
+## PerceptionPlugin — class @experimental
```
build: (app: App) => void
name: string
@@ -4955,34 +4955,34 @@ static new (): PerceptionPlugin
static prototype: PerceptionPlugin
```
-## PerceptionTarget — const
+## PerceptionTarget — const @experimental
```
ComponentDef<{}>
```
-## Physics — const
+## Physics — const @experimental
```
ResourceDef<PhysicsAPI>
```
-## PhysicsContactEventData — interface
+## PhysicsContactEventData — interface @experimental
```
approachSpeed: number | undefined
isSensor: boolean | undefined
other: number
```
-## PhysicsEventType — type
+## PhysicsEventType — type @experimental
```
typeof PhysicsEventType[keyof typeof PhysicsEventType]
```
-## PhysicsEvents — const
+## PhysicsEvents — const @experimental
```
ResourceDef<PhysicsEventsData>
```
-## PhysicsEventsData — interface
+## PhysicsEventsData — interface @experimental
```
collisionEnters: CollisionEnterEvent[]
collisionExits: { entityA: Entity; entityB: Entity; }[]
@@ -4991,12 +4991,12 @@ sensorEnters: SensorEvent[]
sensorExits: SensorEvent[]
```
-## PhysicsModuleFactory — type
+## PhysicsModuleFactory — type @experimental
```
(config?: Record<string, unknown>) => Promise<PhysicsWasmModule>
```
-## PhysicsPlugin — class
+## PhysicsPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -5005,7 +5005,7 @@ static new (wasmUrl: string, config?: PhysicsPluginConfig, factory?: PhysicsModu
static prototype: PhysicsPlugin
```
-## PhysicsPluginConfig — interface
+## PhysicsPluginConfig — interface @experimental
```
collisionLayerMasks: number[] | undefined
contactDampingRatio: number | undefined
@@ -5020,7 +5020,7 @@ restitutionThreshold: number | undefined
subStepCount: number | undefined
```
-## PhysicsWasmModule — interface
+## PhysicsWasmModule — interface @experimental
```
HEAPF32: Float32Array<ArrayBufferLike>
HEAPU32: Uint32Array<ArrayBufferLike>
@@ -5143,7 +5143,7 @@ _physics_step: (dt: number) => void
_physics_updateBodyProperties: (entityId: number, bodyType: number, gravityScale: number, linearDamping: number, angularDamping: number, fixedRotation: number, bullet: number) => void
```
-## PlatformAdapter — interface
+## PlatformAdapter — interface @experimental
```
bindInputEvents: (callbacks: InputEventCallbacks, target?: unknown) => void
canPay: (() => boolean) | undefined
@@ -5198,7 +5198,7 @@ unbindInputEvents: (() => void) | undefined
writeCacheFile: ((key: string, bytes: ArrayBuffer) => Promise<void>) | undefined
```
-## PlatformAudioBackend — interface
+## PlatformAudioBackend — interface @experimental
```
dispose: () => void
ensureResumed: () => Promise<void>
@@ -5215,14 +5215,14 @@ suspend: () => void
unloadBuffer: (handle: AudioBufferHandle) => void
```
-## PlatformCanvas — interface
+## PlatformCanvas — interface @experimental
```
getContext: (contextId: "2d", options?: PlatformCanvasContextAttributes) => PlatformCanvas2DContext | null
height: number
width: number
```
-## PlatformCanvas2DContext — interface
+## PlatformCanvas2DContext — interface @experimental
```
clearRect: (x: number, y: number, w: number, h: number) => void
drawImage: (image: PlatformImageSource, dx: number, dy: number) => void
@@ -5235,7 +5235,7 @@ textAlign: string
textBaseline: string
```
-## PlatformImage — interface
+## PlatformImage — interface @experimental
```
crossOrigin: string | null | undefined
height: number
@@ -5245,7 +5245,7 @@ src: string
width: number
```
-## PlatformRequestOptions — interface
+## PlatformRequestOptions — interface @experimental
```
body: string | ArrayBuffer | undefined
headers: Record<string, string> | undefined
@@ -5254,7 +5254,7 @@ responseType: "json" | "text" | "arraybuffer" | undefined
timeout: number | undefined
```
-## PlatformResponse — interface
+## PlatformResponse — interface @experimental
```
arrayBuffer: () => Promise<ArrayBuffer>
headers: Record<string, string>
@@ -5265,7 +5265,7 @@ statusText: string
text: () => Promise<string>
```
-## PlatformSocket — interface
+## PlatformSocket — interface @experimental
```
close: (code?: number, reason?: string) => void
connect: () => void
@@ -5274,7 +5274,7 @@ readyState: PlatformSocketReadyState
send: (data: string | ArrayBuffer) => void
```
-## PlatformSocketEvents — interface
+## PlatformSocketEvents — interface @experimental
```
close: [code: number, reason: string]
error: [error: unknown]
@@ -5282,30 +5282,30 @@ message: [data: string | ArrayBuffer]
open: []
```
-## PlatformSocketOptions — interface
+## PlatformSocketOptions — interface @experimental
```
protocols: string | string[] | undefined
url: string
```
-## PlatformSocketReadyState — type
+## PlatformSocketReadyState — type @experimental
```
'connecting' | 'open' | 'closing' | 'closed'
```
-## PlatformType — type @deprecated
+## PlatformType — type @experimental @deprecated
```
PlatformName
```
-## PlatformVideoBackend — interface
+## PlatformVideoBackend — interface @experimental
```
createStream: (url: string, options: VideoStreamOptions) => VideoStreamHandle
dispose: () => void
name: string
```
-## PlayConfig — interface
+## PlayConfig — interface @experimental
```
bus: string | undefined
loop: boolean | undefined
@@ -5316,7 +5316,7 @@ startOffset: number | undefined
volume: number | undefined
```
-## PlayRealmRuntimeConfig — interface
+## PlayRealmRuntimeConfig — interface @experimental
```
achievements: string[] | undefined
app: App
@@ -5341,12 +5341,12 @@ uiThemeOverrides: ThemeOverrides | undefined
wasmBaseUrl: string | undefined
```
-## PlayableAdBridge — interface
+## PlayableAdBridge — interface @experimental
```
cta: (() => void) | undefined
```
-## PlayableRuntimeConfig — interface
+## PlayableRuntimeConfig — interface @experimental
```
app: App
assetPathMap: Record<string, string> | undefined
@@ -5365,7 +5365,7 @@ uiThemeOverrides: ThemeOverrides | undefined
ySortLayers: number | undefined
```
-## Plugin — interface
+## Plugin — interface @experimental
```
after: string[] | undefined
before: string[] | undefined
@@ -5376,17 +5376,17 @@ finish: ((app: App) => void) | undefined
name: string | undefined
```
-## PluginDependency — type
+## PluginDependency — type @experimental
```
string | ResourceDef<any>
```
-## PluralCategory — type
+## PluralCategory — type @experimental
```
'zero' | 'one' | 'two' | 'few' | 'many' | 'other'
```
-## PluralForms — interface
+## PluralForms — interface @experimental
```
few: string | undefined
many: string | undefined
@@ -5396,17 +5396,17 @@ two: string | undefined
zero: string | undefined
```
-## PluralSelector — type
+## PluralSelector — type @experimental
```
(count: number) => PluralCategory
```
-## PolygonCollider — const
+## PolygonCollider — const @experimental
```
ComponentDef<PolygonColliderData>
```
-## PooledAudioNode — interface
+## PooledAudioNode — interface @experimental
```
gain: GainNode
inUse: boolean
@@ -5415,12 +5415,12 @@ source: AudioBufferSourceNode | null
startTime: number
```
-## PostProcess — const
+## PostProcess — const @experimental
```
ResourceDef<PostProcessAPI>
```
-## PostProcessAPI — class
+## PostProcessAPI — class @experimental
```
_applyForCamera: (camera: Entity) => void
_applyScreenStack: () => void
@@ -5449,7 +5449,7 @@ static new (): PostProcessAPI
static prototype: PostProcessAPI
```
-## PostProcessPlugin — class
+## PostProcessPlugin — class @experimental
```
build: (app: App) => void
cleanup: (app?: App) => void
@@ -5458,7 +5458,7 @@ static new (): PostProcessPlugin
static prototype: PostProcessPlugin
```
-## PostProcessStack — class
+## PostProcessStack — class @experimental
```
addPass: (name: string, shader: ShaderHandle) => PostProcessStack
clearDirty: () => void
@@ -5480,12 +5480,12 @@ static new (state: PostProcessState): PostProcessStack
static prototype: PostProcessStack
```
-## PostProcessVolume — const
+## PostProcessVolume — const @experimental
```
ComponentDef<PostProcessVolumeData>
```
-## PostProcessVolumeData — interface
+## PostProcessVolumeData — interface @experimental
```
blendDistance: number
effects: { type: string; enabled: boolean; uniforms: Record<string, number>; textures?: Record<string, string>; }[]
@@ -5496,38 +5496,38 @@ size: { x: number; y: number; }
weight: number
```
-## PreSceneDrawCallback — type
+## PreSceneDrawCallback — type @experimental
```
(info: PreSceneDrawInfo) => void
```
-## PreSceneDrawInfo — interface
+## PreSceneDrawInfo — interface @experimental
```
elapsed: number
height: number
width: number
```
-## PredictionOptions — interface
+## PredictionOptions — interface @experimental
```
apply: (world: World, entity: Entity, actions: Record<string, unknown>, dt: number) => void
maxPendingInputs: number | undefined
smoothing: PredictionSmoothing | undefined
```
-## PredictionSmoothing — interface
+## PredictionSmoothing — interface @experimental
```
halfLife: number
maxError: number | undefined
```
-## PrefabComponentData — interface
+## PrefabComponentData — interface @experimental
```
data: Record<string, unknown>
type: string
```
-## PrefabData — interface
+## PrefabData — interface @experimental
```
basePrefab: string | undefined
entities: PrefabEntityData[]
@@ -5537,7 +5537,7 @@ rootEntityId: string
version: string
```
-## PrefabDiagnostic — interface
+## PrefabDiagnostic — interface @experimental
```
code: string
entityId: string | undefined
@@ -5546,12 +5546,12 @@ message: string
severity: PrefabDiagnosticSeverity
```
-## PrefabDiagnosticSeverity — type
+## PrefabDiagnosticSeverity — type @experimental
```
'error' | 'warning'
```
-## PrefabEntityData — interface
+## PrefabEntityData — interface @experimental
```
children: string[]
components: ComponentData[]
@@ -5563,12 +5563,12 @@ prefabEntityId: string
visible: boolean
```
-## PrefabEntityId — type
+## PrefabEntityId — type @experimental
```
string
```
-## PrefabInstanceDelta — interface
+## PrefabInstanceDelta — interface @experimental
```
added: AddedEntity[]
overrides: PrefabOverride[]
@@ -5576,7 +5576,7 @@ prefab: string
removed: string[]
```
-## PrefabInstanceEntry — interface
+## PrefabInstanceEntry — interface @experimental
```
added: AddedEntity[]
id: number
@@ -5586,7 +5586,7 @@ prefab: string
removed: string[]
```
-## PrefabOverride — interface
+## PrefabOverride — interface @experimental
```
componentData: ComponentData | undefined
componentType: string | undefined
@@ -5597,19 +5597,19 @@ type: "property" | "component_added" | "component_replaced" | "component_removed
value: unknown
```
-## PrefabServer — class
+## PrefabServer — class @experimental
```
instantiate: (pathOrAddress: string, options?: { baseUrl?: string; parent?: Entity; overrides?: SpawnOverride[]; scene?: boolean; }) => Promise<InstantiatePrefabResult>
static new (world: World, getAssets: () => AssetsClass, getScenes?: () => SceneManagerState | null): PrefabServer
static prototype: PrefabServer
```
-## Prefabs — const
+## Prefabs — const @experimental
```
ResourceDef<PrefabServer>
```
-## PrefabsPlugin — class
+## PrefabsPlugin — class @experimental
```
build: (app: App) => void
dependencies: ResourceDef<AssetsClass>[]
@@ -5618,7 +5618,7 @@ static new (): PrefabsPlugin
static prototype: PrefabsPlugin
```
-## PreviewPlugin — class
+## PreviewPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -5628,18 +5628,18 @@ static new (sceneUrl: string, baseUrl?: string): PreviewPlugin
static prototype: PreviewPlugin
```
-## PrismaticJoint — const
+## PrismaticJoint — const @experimental
```
ComponentDef<PrismaticJointData>
```
-## ProbedRegistrations — interface
+## ProbedRegistrations — interface @experimental
```
fingerprint: string
pending: PendingSystemEntry[]
```
-## ProcessedEntity — interface
+## ProcessedEntity — interface @experimental
```
children: number[]
components: ComponentData[]
@@ -5651,7 +5651,7 @@ prefabEntityId: string
visible: boolean
```
-## ProgressHandle — interface
+## ProgressHandle — interface @experimental
```
dispose: () => void
entity: number
@@ -5660,7 +5660,7 @@ getValue: () => number
setValue: (v: number) => void
```
-## ProgressOptions — interface
+## ProgressOptions — interface @experimental
```
background: UIVisualInit | undefined
direction: LinearFillDirection | undefined
@@ -5672,19 +5672,19 @@ value: number | undefined
world: World
```
-## ProjectionType — enum
+## ProjectionType — enum @experimental
```
Orthographic = 1
Perspective = 0
```
-## PropertyChannel — interface
+## PropertyChannel — interface @experimental
```
keyframes: Keyframe[]
property: string
```
-## PropertyTrack — interface
+## PropertyTrack — interface @experimental
```
channels: PropertyChannel[]
childPath: string
@@ -5693,13 +5693,13 @@ name: string
type: "property"
```
-## PtrLayout — interface
+## PtrLayout — interface @experimental
```
fields: readonly PtrFieldDesc[]
ptrFn: string
```
-## Quat — interface
+## Quat — interface @experimental
```
w: number
x: number
@@ -5707,12 +5707,12 @@ y: number
z: number
```
-## Query — function
+## Query — function @experimental
```
<C extends QueryArg[]>(...components: C): QueryBuilder<C>
```
-## QueryBuilder — interface
+## QueryBuilder — interface @experimental
```
_addedFilters: { index: number; component: AnyComponentDef; }[]
_changedFilters: { index: number; component: AnyComponentDef; }[]
@@ -5727,7 +5727,7 @@ with: (...components: AnyComponentDef[]) => QueryBuilder<C>
without: (...components: AnyComponentDef[]) => QueryBuilder<C>
```
-## QueryDescriptor — interface
+## QueryDescriptor — interface @experimental
```
_addedFilters: { index: number; component: AnyComponentDef; }[]
_changedFilters: { index: number; component: AnyComponentDef; }[]
@@ -5739,7 +5739,7 @@ _with: AnyComponentDef[]
_without: AnyComponentDef[]
```
-## QueryInstance — class
+## QueryInstance — class @experimental
```
count: () => number
forEach: (callback: (entity: Entity, ...components: ComponentsData<C>) => void) => void
@@ -5751,7 +5751,7 @@ static new <C extends readonly QueryArg[]>(world: World, descriptor: QueryDescri
static prototype: QueryInstance<any>
```
-## QueryResult — type
+## QueryResult — type @experimental
```
[
Entity,
@@ -5759,44 +5759,44 @@ static prototype: QueryInstance<any>
]
```
-## REPLICATION_CHANNEL — const
+## REPLICATION_CHANNEL — const @experimental
```
1
```
-## REPLICATION_PROTOCOL_VERSION — const
+## REPLICATION_PROTOCOL_VERSION — const @experimental
```
2
```
-## RETIRED_COMPONENT_TYPES — const
+## RETIRED_COMPONENT_TYPES — const @experimental
```
ReadonlySet<string>
```
-## RadiusInterestOptions — interface
+## RadiusInterestOptions — interface @experimental
```
position: ((world: World, entity: Entity) => { x: number; y: number; } | null) | undefined
```
-## ReadonlySignal — interface
+## ReadonlySignal — interface @experimental
```
get: () => T
subscribe: (fn: (value: T) => void) => () => void
```
-## Removed — function
+## Removed — function @experimental
```
<T extends AnyComponentDef>(component: T): RemovedQueryDescriptor<T>
```
-## RemovedQueryDescriptor — interface
+## RemovedQueryDescriptor — interface @experimental
```
_component: T
_type: "removed"
```
-## RemovedQueryInstance — class
+## RemovedQueryInstance — class @experimental
```
isEmpty: () => boolean
resetTick: (tick: number) => void
@@ -5805,7 +5805,7 @@ static new <T extends AnyComponentDef>(world: World, component: T, lastRunTick:
static prototype: RemovedQueryInstance<any>
```
-## RenderParams — interface
+## RenderParams — interface @experimental
```
clearColor: { x: number; y: number; z: number; w: number; } | undefined
elapsed: number
@@ -5815,7 +5815,7 @@ viewProjection: Float32Array<ArrayBufferLike>
width: number
```
-## RenderPipeline — class
+## RenderPipeline — class @experimental
```
addPreFlushCallback: (cb: (registry: { _cpp: CppRegistry; }) => void) => void
beginFrame: (elapsedSec?: number) => void
@@ -5831,7 +5831,7 @@ static new (): RenderPipeline
static prototype: RenderPipeline
```
-## RenderStage — enum
+## RenderStage — enum @experimental
```
Background = 0
Opaque = 1
@@ -5839,7 +5839,7 @@ Overlay = 3
Transparent = 2
```
-## RenderStats — interface
+## RenderStats — interface @experimental
```
culled: number
drawCalls: number
@@ -5850,24 +5850,24 @@ text: number
triangles: number
```
-## RenderSurfaceSource — type
+## RenderSurfaceSource — type @experimental
```
| { readonly kind: 'gl-context'; readonly handle: number }
| { readonly kind: 'webgpu'; readonly canvasSelector?: string }
| { readonly kind: 'default' }
```
-## RenderTargetHandle — type
+## RenderTargetHandle — type @experimental
```
number
```
-## RenderTexture — const
+## RenderTexture — const @experimental
```
{ create(options: RenderTextureOptions): RenderTextureHandle; release(rt: RenderTextureHandle): void; resize(rt: RenderTextureHandle, width: number, height: number): RenderTextureHandle; begin(rt: RenderTextureHandle, viewProjection: Float32Array): void; end(): void; getDepthTexture(rt: RenderTextureHandle): number; }
```
-## RenderTextureHandle — interface
+## RenderTextureHandle — interface @experimental
```
_depth: boolean
_filter: "linear" | "nearest"
@@ -5878,7 +5878,7 @@ textureId: number
width: number
```
-## RenderTextureOptions — interface
+## RenderTextureOptions — interface @experimental
```
depth: boolean | undefined
filter: "linear" | "nearest" | undefined
@@ -5886,7 +5886,7 @@ height: number
width: number
```
-## RenderType — enum
+## RenderType — enum @experimental
```
ExternalMesh = 3
Mesh = 2
@@ -5898,23 +5898,23 @@ Text = 4
UIElement = 7
```
-## Renderer — const
+## Renderer — const @experimental
```
{ init(width: number, height: number): void; resize(width: number, height: number): void; beginFrame(elapsedSec?: number): void; updateTransforms(registry: { _cpp: CppRegistry; }): void; begin(viewProjection: Float32Array, target?: RenderTargetHandle, clearFlags?: number, clearColor?: { x: number; y: number; z: number; w: number; }, clearRect?: { x: number; y: number; w: number; h: number; }): void; flush(): void; end(): void; submitAll(registry: { _cpp: CppRegistry; }, skipFlags: number, vpX: number, vpY: number, vpW: number, vpH: number): void; setStage(stage: RenderStage): void; createRenderTarget(width: number, height: number, flags?: number): RenderTargetHandle; releaseRenderTarget(handle: RenderTargetHandle): void; getTargetTexture(handle: RenderTargetHandle): number; getTargetDepthTexture(handle: RenderTargetHandle): number; setClearColor(r: number, g: number, b: number, a: number): void; setViewport(x: number, y: number, w: number, h: number): void; setYSortLayers(mask: number): void; setDepthLayers(mask: number): void; setCullingMask(mask: number): void; setTextureParams(textureId: number, minFilter: number, magFilter: number, wrapS: number, wrapT: number): void; measureBitmapText(fontHandle: number, text: string, fontSize: number, spacing: number): { width: number; height: number; }; getStats(): RenderStats; captureNextFrame(): void; getCapturedData(): FrameCaptureData | null; hasCapturedData(): boolean; replayToDrawCall(drawCallIndex: number): void; getSnapshotImageData(): Promise<ImageData | null>; }
```
-## Replicated — const
+## Replicated — const @experimental
```
ComponentDef<ReplicatedData>
```
-## ReplicatedData — interface
+## ReplicatedData — interface @experimental
```
netId: number
owner: number
```
-## ReplicationClient — class
+## ReplicationClient — class @experimental
```
applyPending: () => void
connect: (transport: NetTransport) => Promise<void>
@@ -5934,7 +5934,7 @@ static new (world: World, options?: ReplicationClientOptions): ReplicationClient
static prototype: ReplicationClient
```
-## ReplicationPlugin — class
+## ReplicationPlugin — class @experimental
```
build: (app: App) => void
name: string
@@ -5942,7 +5942,7 @@ static new (): ReplicationPlugin
static prototype: ReplicationPlugin
```
-## ReplicationServer — class
+## ReplicationServer — class @experimental
```
attachConnection: (transport: NetTransport) => number
beginTick: (fixedDelta: number) => void
@@ -5959,34 +5959,34 @@ static new (world: World): ReplicationServer
static prototype: ReplicationServer
```
-## RequestHandler — type
+## RequestHandler — type @experimental
```
(payload: Req) => Res | Promise<Res>
```
-## Res — function
+## Res — function @experimental
```
<T>(resource: ResourceDef<T>): ResDescriptor<T>
```
-## ResDescriptor — interface
+## ResDescriptor — interface @experimental
```
_resource: ResourceDef<T>
_type: "res"
```
-## ResMut — function
+## ResMut — function @experimental
```
<T>(resource: ResourceDef<T>): ResMutDescriptor<T>
```
-## ResMutDescriptor — interface
+## ResMutDescriptor — interface @experimental
```
_resource: ResourceDef<T>
_type: "res_mut"
```
-## ResMutInstance — class
+## ResMutInstance — class @experimental
```
get: () => T
modify: (fn: (value: T) => void) => void
@@ -5996,20 +5996,20 @@ static new <T>(value: T, setter: (v: T) => void): ResMutInstance<T>
static prototype: ResMutInstance<any>
```
-## ResolvedAssetGroup — interface
+## ResolvedAssetGroup — interface @experimental
```
alwaysInclude: boolean
delivery: BundleMode
name: string
```
-## ResolvedAtlas — interface
+## ResolvedAtlas — interface @experimental
```
folder: string
name: string
```
-## ResolvedTileCollision — interface
+## ResolvedTileCollision — interface @experimental
```
density: number | undefined
friction: number | undefined
@@ -6019,7 +6019,7 @@ sensor: boolean | undefined
shape: { type: "box"; } | { type: "polygon"; points: [number, number][]; } | { type: "circle"; cx: number; cy: number; r: number; }
```
-## ResolvedTileset — interface
+## ResolvedTileset — interface @experimental
```
asset: TilesetAsset
textureHandle: number
@@ -6027,14 +6027,14 @@ textureHeight: number | undefined
textureWidth: number | undefined
```
-## ResourceDef — interface
+## ResourceDef — interface @experimental
```
_default: T
_id: symbol
_name: string
```
-## ResourceStats — interface
+## ResourceStats — interface @experimental
```
cacheHits: number
cacheMisses: number
@@ -6047,7 +6047,7 @@ textureEvictableCount: number
vertexBufferCount: number
```
-## ReverbEffectDef — interface
+## ReverbEffectDef — interface @experimental
```
decay: number | undefined
seconds: number | undefined
@@ -6055,22 +6055,22 @@ type: "reverb"
wet: number | undefined
```
-## RevoluteJoint — const
+## RevoluteJoint — const @experimental
```
ComponentDef<RevoluteJointData>
```
-## RichTextRun — type
+## RichTextRun — type @experimental
```
TextSegment | ImageSegment
```
-## RigidBody — const
+## RigidBody — const @experimental
```
BuiltinComponentDef<RigidBodyData>
```
-## RigidBodyData — interface
+## RigidBodyData — interface @experimental
```
angularDamping: number
bodyType: number
@@ -6081,12 +6081,12 @@ gravityScale: number
linearDamping: number
```
-## RunCondition — type
+## RunCondition — type @experimental
```
() => boolean
```
-## RuntimeAssetSource — interface
+## RuntimeAssetSource — interface @experimental
```
backend: Backend
decodePixels: (path: string, flip: boolean) => Promise<{ width: number; height: number; pixels: Uint8Array; }>
@@ -6096,7 +6096,7 @@ resolveRef: ((ref: string) => string) | undefined
textureImportSettings: ((ref: string) => ParsedTextureImportSettings | undefined) | undefined
```
-## RuntimeBuildConfig — interface
+## RuntimeBuildConfig — interface @experimental
```
assetFailureCooldown: number | undefined
assetLoadTimeout: number | undefined
@@ -6112,12 +6112,12 @@ textCanvasSize: number | undefined
textureCacheBudget: number | undefined
```
-## RuntimeConfig — const
+## RuntimeConfig — const @experimental
```
{ sceneTransitionDuration: number; sceneTransitionColor: { r: number; g: number; b: number; a: number; }; defaultFontFamily: string; canvasScaleMode: number; canvasMatchWidthOrHeight: number; maxDeltaTime: number; maxFixedSteps: number; textCanvasSize: number; assetLoadTimeout: number; assetFailureCooldown: number; textureCacheBudget: number; audioCacheBudget: number; }
```
-## RuntimeInitConfig — interface
+## RuntimeInitConfig — interface @experimental
```
achievements: string[] | undefined
app: App
@@ -6142,42 +6142,42 @@ uiTheme: "dark" | "light" | undefined
uiThemeOverrides: ThemeOverrides | undefined
```
-## RuntimeOnly — const
+## RuntimeOnly — const @experimental
```
ComponentDef<{}>
```
-## SCENE_FORMAT_VERSION — const
+## SCENE_FORMAT_VERSION — const @experimental
```
1
```
-## SCREEN_FIT_OFF — const
+## SCREEN_FIT_OFF — const @experimental
```
-1
```
-## SIDE_MODULES — const
+## SIDE_MODULES — const @experimental
```
Record<BuiltinSideModuleId, SideModuleDescriptor>
```
-## SPINE_VERSIONS — const
+## SPINE_VERSIONS — const @experimental
```
readonly SpineVersion[]
```
-## STATE_PATH_SEP — const
+## STATE_PATH_SEP — const @experimental
```
"/"
```
-## SafeArea — const
+## SafeArea — const @experimental
```
ComponentDef<SafeAreaData>
```
-## SafeAreaData — interface
+## SafeAreaData — interface @experimental
```
applyBottom: boolean
applyLeft: boolean
@@ -6185,7 +6185,7 @@ applyRight: boolean
applyTop: boolean
```
-## SafeAreaPlugin — class
+## SafeAreaPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -6195,33 +6195,33 @@ static new (): SafeAreaPlugin
static prototype: SafeAreaPlugin
```
-## SampleDeps — interface
+## SampleDeps — interface @experimental
```
getComponent: (name: string) => AnyComponentDef | undefined
resolveChild: (root: Entity, childPath: string) => Entity | null
world: SampleWorld
```
-## SampleOptions — interface
+## SampleOptions — interface @experimental
```
skipChannel: ((childPath: string, component: string, property: string) => boolean) | undefined
```
-## SampleWorld — interface
+## SampleWorld — interface @experimental
```
get: (entity: Entity, def: AnyComponentDef) => Record<string, unknown>
has: (entity: Entity, def: AnyComponentDef) => boolean
set: (entity: Entity, def: AnyComponentDef, data: Record<string, unknown>) => void
```
-## SaveEnvelope — interface
+## SaveEnvelope — interface @experimental
```
data: T
savedAt: number
version: number
```
-## SaveManager — class
+## SaveManager — class @experimental
```
has: (slot: string) => boolean
load: <T>(slot: string) => T | null
@@ -6232,7 +6232,7 @@ static new (opts: SaveManagerOptions): SaveManager
static prototype: SaveManager
```
-## SaveManagerOptions — interface
+## SaveManagerOptions — interface @experimental
```
keyPrefix: string | undefined
migrations: Record<number, SaveMigration> | undefined
@@ -6241,12 +6241,12 @@ storage: SaveStorage | undefined
version: number
```
-## SaveMigration — type
+## SaveMigration — type @experimental
```
(data: unknown) => unknown
```
-## SaveStorage — interface
+## SaveStorage — interface @experimental
```
getJSON: <T>(key: string, defaultValue?: T) => T | undefined
has: (key: string) => boolean
@@ -6254,12 +6254,12 @@ remove: (key: string) => void
setJSON: <T>(key: string, value: T) => void
```
-## ScaleMode — type
+## ScaleMode — type @experimental
```
(typeof ScaleMode)[keyof typeof ScaleMode]
```
-## SceneAssetRefs — interface
+## SceneAssetRefs — interface @experimental
```
byType: Map<string, Set<string>>
dragonBones: SpineAssetRef[]
@@ -6269,20 +6269,20 @@ spines: SpineAssetRef[]
unresolved: string[]
```
-## SceneComponentCodec — interface
+## SceneComponentCodec — interface @experimental
```
exportData: ((entity: number, data: Record<string, unknown>) => void) | undefined
importData: ((entity: number, outOfBand: Record<string, unknown>) => void) | undefined
outOfBandFields: readonly string[] | undefined
```
-## SceneComponentData — interface
+## SceneComponentData — interface @experimental
```
data: Record<string, unknown>
type: string
```
-## SceneConfig — interface
+## SceneConfig — interface @experimental
```
cleanup: ((ctx: SceneContext) => void) | undefined
data: SceneData | undefined
@@ -6292,7 +6292,7 @@ setup: ((ctx: SceneContext) => void | Promise<void>) | undefined
systems: { schedule: Schedule; system: SystemDef; }[] | undefined
```
-## SceneContext — interface
+## SceneContext — interface @experimental
```
adopt: (entity: Entity) => void
bindPostProcess: (camera: Entity, stack: PostProcessStack) => void
@@ -6306,7 +6306,7 @@ trackAssets: (byType: ReadonlyMap<string, ReadonlySet<string>>) => void
unbindPostProcess: (camera: Entity) => void
```
-## SceneData — interface
+## SceneData — interface @experimental
```
entities: SceneEntityData[]
generator: string | undefined
@@ -6315,7 +6315,7 @@ textureMetadata: Record<string, TextureMetadata> | undefined
version: string | number
```
-## SceneEntityData — interface
+## SceneEntityData — interface @experimental
```
children: number[]
components: SceneComponentData[]
@@ -6325,13 +6325,13 @@ parent: number | null
visible: boolean | undefined
```
-## SceneLoadCancelled — class
+## SceneLoadCancelled — class @experimental
```
static new (name: string): SceneLoadCancelled
static prototype: SceneLoadCancelled
```
-## SceneLoadOptions — interface
+## SceneLoadOptions — interface @experimental
```
abortOnMissingAssets: boolean | undefined
assetBaseUrl: string | undefined
@@ -6341,17 +6341,17 @@ onMissingAssets: MissingAssetCallback | undefined
onProgress: SceneLoadProgressCallback | undefined
```
-## SceneLoadProgressCallback — type
+## SceneLoadProgressCallback — type @experimental
```
(loaded: number, total: number) => void
```
-## SceneManager — const
+## SceneManager — const @experimental
```
ResourceDef<SceneManagerState>
```
-## SceneManagerState — class
+## SceneManagerState — class @experimental
```
bringToTop: (name: string) => void
getActive: () => string | null
@@ -6383,7 +6383,7 @@ static new (app: App): SceneManagerState
static prototype: SceneManagerState
```
-## SceneMigrationResult — interface
+## SceneMigrationResult — interface @experimental
```
data: SceneData
fromVersion: number
@@ -6391,23 +6391,23 @@ migrated: boolean
toVersion: number
```
-## SceneOwner — const
+## SceneOwner — const @experimental
```
ComponentDef<SceneOwnerData>
```
-## SceneOwnerData — interface
+## SceneOwnerData — interface @experimental
```
persistent: boolean
scene: string
```
-## SceneStatus — type
+## SceneStatus — type @experimental
```
'loading' | 'running' | 'paused' | 'sleeping' | 'unloading'
```
-## SceneStreamHost — interface
+## SceneStreamHost — interface @experimental
```
isLoaded: (name: string) => boolean
isSleeping: (name: string) => boolean
@@ -6417,19 +6417,19 @@ unload: (name: string) => Promise<void>
wake: (name: string) => void
```
-## SceneStreaming — const
+## SceneStreaming — const @experimental
```
ResourceDef<SceneStreamingController>
```
-## SceneStreamingConfig — interface
+## SceneStreamingConfig — interface @experimental
```
loadRadius: number
policy: StreamPolicy | undefined
unloadRadius: number
```
-## SceneStreamingController — class
+## SceneStreamingController — class @experimental
```
clear: () => void
configure: (config: SceneStreamingConfig) => void
@@ -6444,7 +6444,7 @@ static new (host: SceneStreamHost, config?: SceneStreamingConfig): SceneStreamin
static prototype: SceneStreamingController
```
-## Schedule — enum
+## Schedule — enum @experimental
```
First = 1
FixedPostUpdate = 12
@@ -6457,7 +6457,7 @@ Startup = 0
Update = 3
```
-## ScreenInfo — class
+## ScreenInfo — class @experimental
```
dpr: number
height: number
@@ -6469,19 +6469,19 @@ static new (): ScreenInfo
static prototype: ScreenInfo
```
-## ScreenInfoEvents — interface
+## ScreenInfoEvents — interface @experimental
```
orientationchange: [orientation: ScreenOrientation]
resize: [width: number, height: number]
```
-## ScreenOrientation — enum
+## ScreenOrientation — enum @experimental
```
Landscape = "landscape"
Portrait = "portrait"
```
-## ScreenRect — interface
+## ScreenRect — interface @experimental
```
h: number
w: number
@@ -6489,12 +6489,12 @@ x: number
y: number
```
-## ScreenScaling — const
+## ScreenScaling — const @experimental
```
ResourceDef<ScreenScalingData>
```
-## ScreenScalingData — interface
+## ScreenScalingData — interface @experimental
```
designHeight: number
designWidth: number
@@ -6502,7 +6502,7 @@ matchWidthOrHeight: number
scaleMode: number
```
-## ScrollContainer — class
+## ScrollContainer — class @experimental
```
dispose: () => void
getContentSize: () => Vec2
@@ -6522,7 +6522,7 @@ static new (opts: ScrollContainerOptions): ScrollContainer
static prototype: ScrollContainer
```
-## ScrollViewHandle — interface
+## ScrollViewHandle — interface @experimental
```
content: number
dispose: () => void
@@ -6532,7 +6532,7 @@ scrollTo: (offset: Vec2) => void
setContentSize: (size: Vec2) => void
```
-## ScrollViewOptions — interface
+## ScrollViewOptions — interface @experimental
```
background: UIVisualInit | undefined
contentSize: Vec2
@@ -6548,12 +6548,12 @@ wheelSpeed: number | undefined
world: World
```
-## SegmentCollider — const
+## SegmentCollider — const @experimental
```
BuiltinComponentDef<SegmentColliderData>
```
-## SenseResult — interface
+## SenseResult — interface @experimental
```
dirX: number
dirY: number
@@ -6561,13 +6561,13 @@ distance: number
visible: boolean
```
-## SensorEvent — interface
+## SensorEvent — interface @experimental
```
sensorEntity: number
visitorEntity: number
```
-## ServicesPlugin — class
+## ServicesPlugin — class @experimental
```
build: (app: App) => void
name: string
@@ -6575,12 +6575,12 @@ static new (): ServicesPlugin
static prototype: ServicesPlugin
```
-## ShaderHandle — type
+## ShaderHandle — type @experimental
```
number
```
-## ShaderParam — interface
+## ShaderParam — interface @experimental
```
default: number[]
defaultTexture: string | undefined
@@ -6591,39 +6591,39 @@ type: ShaderParamType
ui: string | undefined
```
-## ShaderParamType — type
+## ShaderParamType — type @experimental
```
'float' | 'vec2' | 'vec3' | 'vec4' | 'color' | 'int' | 'texture'
```
-## ShaderReflection — interface
+## ShaderReflection — interface @experimental
```
domain: string
params: ShaderParam[]
```
-## ShaderSources — const
+## ShaderSources — const @experimental
```
{ SPRITE_VERTEX: string; SPRITE_FRAGMENT: string; COLOR_VERTEX: string; COLOR_FRAGMENT: string; }
```
-## ShadowCaster2D — const
+## ShadowCaster2D — const @experimental
```
BuiltinComponentDef<ShadowCaster2DData>
```
-## ShadowCaster2DData — interface
+## ShadowCaster2DData — interface @experimental
```
enabled: boolean
size: Vec2
```
-## ShapeRenderer — const
+## ShapeRenderer — const @experimental
```
BuiltinComponentDef<ShapeRendererData>
```
-## ShapeRendererData — interface
+## ShapeRendererData — interface @experimental
```
color: Color
cornerRadius: number
@@ -6634,19 +6634,19 @@ shapeType: number
size: Vec2
```
-## ShapeType — enum
+## ShapeType — enum @experimental
```
Capsule = 1
Circle = 0
RoundedRect = 2
```
-## Share — const
+## Share — const @experimental
```
ResourceDef<ShareAPI>
```
-## ShareAPI — class
+## ShareAPI — class @experimental
```
available: boolean
setShareCard: (card: ShareCard | (() => ShareCard)) => void
@@ -6655,28 +6655,28 @@ static new (): ShareAPI
static prototype: ShareAPI
```
-## ShareCard — type
+## ShareCard — type @experimental
```
PlatformShareOptions
```
-## SideModuleDescriptor — interface
+## SideModuleDescriptor — interface @experimental
```
file: string
globalName: string | undefined
```
-## SideModuleHost — interface
+## SideModuleHost — interface @experimental
```
acquire: (id: SideModuleId) => Promise<SideModule | null>
```
-## SideModuleId — type
+## SideModuleId — type @experimental
```
BuiltinSideModuleId | (string & {})
```
-## Signal — interface
+## Signal — interface @experimental
```
get: () => T
set: (value: T) => void
@@ -6684,13 +6684,13 @@ subscribe: (fn: (value: T) => void) => () => void
update: (fn: (prev: T) => T) => void
```
-## SimulationSpace — enum
+## SimulationSpace — enum @experimental
```
Local = 1
World = 0
```
-## SliceBorder — interface
+## SliceBorder — interface @experimental
```
bottom: number
left: number
@@ -6698,7 +6698,7 @@ right: number
top: number
```
-## SliderHandle — interface
+## SliderHandle — interface @experimental
```
dispose: () => void
entity: number
@@ -6709,7 +6709,7 @@ setValue: (value: number) => void
trackEntity: number
```
-## SliderOptions — interface
+## SliderOptions — interface @experimental
```
disabled: boolean | undefined
events: UIEventQueue
@@ -6729,19 +6729,19 @@ value: number | undefined
world: World
```
-## SocketReadyState — type
+## SocketReadyState — type @experimental
```
PlatformSocketReadyState
```
-## SourceDelta — interface
+## SourceDelta — interface @experimental
```
added: readonly AddedEntity[]
overrides: readonly PrefabOverride[]
removed: readonly string[]
```
-## SpatialAudioConfig — interface
+## SpatialAudioConfig — interface @experimental
```
maxDistance: number
model: AttenuationModel
@@ -6749,22 +6749,22 @@ refDistance: number
rolloff: number
```
-## SpawnOverride — type
+## SpawnOverride — type @experimental
```
Omit<PrefabOverride, 'prefabEntityId'> & { prefabEntityId?: string }
```
-## Spine — const
+## Spine — const @experimental
```
ResourceDef<SpineManager>
```
-## SpineAnimation — const
+## SpineAnimation — const @experimental
```
BuiltinComponentDef<SpineAnimationData>
```
-## SpineAnimationData — interface
+## SpineAnimationData — interface @experimental
```
animation: string
atlasPath: string
@@ -6782,23 +6782,23 @@ skin: string
timeScale: number
```
-## SpineAnimationDriver — interface
+## SpineAnimationDriver — interface @experimental
```
setAnimation: (entity: Entity, animation: string, loop: boolean) => void
```
-## SpineEvents — const
+## SpineEvents — const @experimental
```
ResourceDef<SpineEventsData>
```
-## SpineLoadResult — interface
+## SpineLoadResult — interface @experimental
```
error: string | undefined
success: boolean
```
-## SpinePlugin — class
+## SpinePlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -6810,7 +6810,7 @@ static new (manager?: SpineManager): SpinePlugin
static prototype: SpinePlugin
```
-## SpineTrack — interface
+## SpineTrack — interface @experimental
```
blendIn: number
childPath: string
@@ -6819,12 +6819,12 @@ name: string
type: "spine"
```
-## Sprite — const
+## Sprite — const @experimental
```
BuiltinComponentDef<SpriteData>
```
-## SpriteAnimClip — interface
+## SpriteAnimClip — interface @experimental
```
events: SpriteAnimEvent[] | undefined
fps: number
@@ -6834,19 +6834,19 @@ loop: boolean
name: string
```
-## SpriteAnimEvent — interface
+## SpriteAnimEvent — interface @experimental
```
data: unknown
frame: number
name: string
```
-## SpriteAnimEventHandler — type
+## SpriteAnimEventHandler — type @experimental
```
(event: SpriteAnimEvent, entity: Entity) => void
```
-## SpriteAnimFrame — interface
+## SpriteAnimFrame — interface @experimental
```
duration: number | undefined
pivot: { x: number; y: number; } | undefined
@@ -6855,7 +6855,7 @@ uvOffset: { x: number; y: number; } | undefined
uvScale: { x: number; y: number; } | undefined
```
-## SpriteAnimTrack — interface
+## SpriteAnimTrack — interface @experimental
```
childPath: string
clip: string
@@ -6864,12 +6864,12 @@ startTime: number
type: "spriteAnim"
```
-## SpriteAnimation — const
+## SpriteAnimation — const @experimental
```
ResourceDef<SpriteAnimationAPI>
```
-## SpriteAnimationAPI — class
+## SpriteAnimationAPI — class @experimental
```
aliasClip: (name: string, clip: SpriteAnimClip) => void
clearClips: () => void
@@ -6886,12 +6886,12 @@ static new (): SpriteAnimationAPI
static prototype: SpriteAnimationAPI
```
-## SpriteAnimator — const
+## SpriteAnimator — const @experimental
```
ComponentDef<SpriteAnimatorData>
```
-## SpriteAnimatorData — interface
+## SpriteAnimatorData — interface @experimental
```
clip: string
currentFrame: number
@@ -6903,7 +6903,7 @@ playing: boolean
speed: number
```
-## SpriteData — interface
+## SpriteData — interface @experimental
```
color: Color
enabled: boolean
@@ -6922,12 +6922,12 @@ uvOffset: Vec2
uvScale: Vec2
```
-## SpriteFilter — const
+## SpriteFilter — const @experimental
```
{ createOutline(options?: OutlineFilterOptions): MaterialHandle; createGlow(options?: OutlineFilterOptions): MaterialHandle; createDropShadow(options?: DropShadowFilterOptions): MaterialHandle; setOutlineColor(material: MaterialHandle, color: { r: number; g: number; b: number; a: number; }): void; setOutlineWidth(material: MaterialHandle, width: number): void; setShadowOffset(material: MaterialHandle, x: number, y: number): void; setShadowBlur(material: MaterialHandle, blur: number): void; }
```
-## StaleOverride — interface
+## StaleOverride — interface @experimental
```
nestedAt: string | undefined
override: PrefabOverride
@@ -6935,18 +6935,18 @@ reason: string
site: "variant" | "nested" | "instance"
```
-## StateMachineAgent — const
+## StateMachineAgent — const @experimental
```
ComponentDef<StateMachineAgentData>
```
-## StateMachineAgentData — interface
+## StateMachineAgentData — interface @experimental
```
current: string
fsm: string
```
-## StateMachines — class
+## StateMachines — class @experimental
```
blackboard: (entity: Entity) => Blackboard
fire: (entity: Entity, trigger: string) => void
@@ -6955,12 +6955,12 @@ static new (states: Map<Entity, AgentState>): StateMachines
static prototype: StateMachines
```
-## Stats — const
+## Stats — const @experimental
```
ResourceDef<FrameStats>
```
-## StatsCollector — class
+## StatsCollector — class @experimental
```
getFps: () => number
getFrameTimeMs: () => number
@@ -6970,7 +6970,7 @@ static new (): StatsCollector
static prototype: StatsCollector
```
-## StatsOverlay — class
+## StatsOverlay — class @experimental
```
dispose: () => void
hide: () => void
@@ -6980,7 +6980,7 @@ static new (container: HTMLElement, position?: StatsPosition): StatsOverlay
static prototype: StatsOverlay
```
-## StatsPlugin — class
+## StatsPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -6989,36 +6989,36 @@ static new (options?: StatsPluginOptions): StatsPlugin
static prototype: StatsPlugin
```
-## StatsPluginOptions — interface
+## StatsPluginOptions — interface @experimental
```
container: HTMLElement | undefined
overlay: boolean | undefined
position: StatsPosition | undefined
```
-## StatsPosition — type
+## StatsPosition — type @experimental
```
'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'
```
-## Status — enum
+## Status — enum @experimental
```
Failure = "failure"
Running = "running"
Success = "success"
```
-## Stick — const
+## Stick — const @experimental
```
(stick: "left" | "right", pad?: number) => Binding
```
-## Storage — const
+## Storage — const @experimental
```
{ getString(key: string, defaultValue?: string): string | undefined; setString(key: string, value: string): void; getNumber(key: string, defaultValue?: number): number | undefined; setNumber(key: string, value: number): void; getBoolean(key: string, defaultValue?: boolean): boolean | undefined; setBoolean(key: string, value: boolean): void; getJSON<T>(key: string, defaultValue?: T): T | undefined; setJSON<T>(key: string, value: T): void; remove(key: string): void; has(key: string): boolean; clear(): void; }
```
-## StreamCell — interface
+## StreamCell — interface @experimental
```
radius: number
scene: string
@@ -7026,34 +7026,34 @@ x: number
y: number
```
-## StreamDecision — interface
+## StreamDecision — interface @experimental
```
toActivate: string[]
toDeactivate: string[]
```
-## StreamPolicy — type
+## StreamPolicy — type @experimental
```
'unload' | 'sleep'
```
-## SubEmitterTrigger — enum
+## SubEmitterTrigger — enum @experimental
```
Birth = 1
Death = 0
```
-## SubmitSkipFlags — const
+## SubmitSkipFlags — const @experimental
```
{ readonly None: 0; readonly Spine: 1; readonly Particles: 2; }
```
-## SubsystemActivity — type
+## SubsystemActivity — type @experimental
```
'stepping' | 'idle' | 'inactive'
```
-## SubsystemEvent — interface
+## SubsystemEvent — interface @experimental
```
atMs: number
detail: string | undefined
@@ -7062,12 +7062,12 @@ phase: SubsystemPhase
seq: number
```
-## SubsystemPhase — type
+## SubsystemPhase — type @experimental
```
'registered' | 'initializing' | 'ready' | 'error'
```
-## SubsystemRegistry — class
+## SubsystemRegistry — class @experimental
```
getStatuses: () => SubsystemStatus[]
markError: (id: string, reason?: string) => void
@@ -7081,7 +7081,7 @@ static new (): SubsystemRegistry
static prototype: SubsystemRegistry
```
-## SubsystemStatus — interface
+## SubsystemStatus — interface @experimental
```
activity: SubsystemActivity
dependsOn: readonly string[]
@@ -7093,17 +7093,17 @@ phase: SubsystemPhase
phaseAgeMs: number
```
-## SwipeDirection — type
+## SwipeDirection — type @experimental
```
'left' | 'right' | 'up' | 'down'
```
-## SyncPrefabResolver — type
+## SyncPrefabResolver — type @experimental
```
(path: string) => PrefabData | null
```
-## SystemDef — interface
+## SystemDef — interface @experimental
```
_fn: (...args: never[]) => void | Promise<void>
_id: symbol
@@ -7113,14 +7113,14 @@ _runAfter: readonly string[] | undefined
_runBefore: readonly string[] | undefined
```
-## SystemOptions — interface
+## SystemOptions — interface @experimental
```
name: string | undefined
runAfter: string[] | undefined
runBefore: string[] | undefined
```
-## SystemParam — type
+## SystemParam — type @experimental
```
| QueryDescriptor<readonly QueryArg[]>
| ResDescriptor<unknown>
@@ -7132,7 +7132,7 @@ runBefore: string[] | undefined
| GetWorldDescriptor
```
-## SystemRunner — class
+## SystemRunner — class @experimental
```
clearTimings: () => void
evict: (systemId: symbol) => void
@@ -7144,7 +7144,7 @@ static new (world: World, resources: ResourceStorage, eventRegistry?: EventRegis
static prototype: SystemRunner
```
-## SystemSet — interface
+## SystemSet — interface @experimental
```
_kind: "set"
_name: string
@@ -7154,7 +7154,7 @@ _runIf: RunCondition | undefined
_systems: readonly SystemDef[]
```
-## SystemSetOptions — interface
+## SystemSetOptions — interface @experimental
```
runAfter: string[] | undefined
runBefore: string[] | undefined
@@ -7162,92 +7162,92 @@ runIf: RunCondition | undefined
systems: SystemDef[]
```
-## TB_E — const
+## TB_E — const @experimental
```
2
```
-## TB_N — const
+## TB_N — const @experimental
```
1
```
-## TB_NE — const
+## TB_NE — const @experimental
```
16
```
-## TB_NW — const
+## TB_NW — const @experimental
```
128
```
-## TB_S — const
+## TB_S — const @experimental
```
4
```
-## TB_SE — const
+## TB_SE — const @experimental
```
32
```
-## TB_SW — const
+## TB_SW — const @experimental
```
64
```
-## TB_W — const
+## TB_W — const @experimental
```
8
```
-## TERRAIN_NEIGHBORS — const
+## TERRAIN_NEIGHBORS — const @experimental
```
readonly { dx: number; dy: number; bit: number; }[]
```
-## THEME_COLOR_ROLES — const
+## THEME_COLOR_ROLES — const @experimental
```
readonly (keyof ThemeColors)[]
```
-## TILESET_FORMAT_VERSION — const
+## TILESET_FORMAT_VERSION — const @experimental
```
"1"
```
-## TILE_FLAGS_MASK — const
+## TILE_FLAGS_MASK — const @experimental
```
number
```
-## TILE_FLIP_D — const
+## TILE_FLIP_D — const @experimental
```
32768
```
-## TILE_FLIP_H — const
+## TILE_FLIP_H — const @experimental
```
8192
```
-## TILE_FLIP_V — const
+## TILE_FLIP_V — const @experimental
```
16384
```
-## TILE_ID_MASK — const
+## TILE_ID_MASK — const @experimental
```
8191
```
-## TParams — type
+## TParams — type @experimental
```
Record<string, string | number>
```
-## Takeover — interface
+## Takeover — interface @experimental
```
active: boolean
around: <T>(show: () => Promise<T>) => Promise<T>
@@ -7255,7 +7255,7 @@ begin: () => void
end: () => void
```
-## TakeoverHost — interface
+## TakeoverHost — interface @experimental
```
isPaused: () => boolean
resumeAudio: () => void
@@ -7263,40 +7263,40 @@ setPaused: (paused: boolean) => void
suspendAudio: () => void
```
-## TerrainColor — interface
+## TerrainColor — interface @experimental
```
color: string
name: string
```
-## TerrainIndex — interface
+## TerrainIndex — interface @experimental
```
byMask: Map<number, number>
mode: TerrainMode
```
-## TerrainIndices — interface
+## TerrainIndices — interface @experimental
```
sets: Map<number, TerrainIndex>
tileTerrain: Map<number, number>
```
-## TerrainMode — type
+## TerrainMode — type @experimental
```
'edge' | 'corner' | 'wang'
```
-## Text — const
+## Text — const @experimental
```
ComponentDef<TextData>
```
-## TextAlign — type
+## TextAlign — type @experimental
```
(typeof TextAlign)[keyof typeof TextAlign]
```
-## TextData — interface
+## TextData — interface @experimental
```
align: TextAlign
bold: boolean
@@ -7323,7 +7323,7 @@ verticalAlign: TextVerticalAlign
wordWrap: boolean
```
-## TextInit — interface
+## TextInit — interface @experimental
```
align: TextAlign | undefined
bold: boolean | undefined
@@ -7350,12 +7350,12 @@ verticalAlign: TextVerticalAlign | undefined
wordWrap: boolean | undefined
```
-## TextInput — const
+## TextInput — const @experimental
```
ComponentDef<TextInputData>
```
-## TextInputData — interface
+## TextInputData — interface @experimental
```
backgroundColor: Color
color: Color
@@ -7377,7 +7377,7 @@ textAlign: TextAlign
value: string
```
-## TextInputHandle — interface
+## TextInputHandle — interface @experimental
```
dispose: () => void
entity: number
@@ -7385,7 +7385,7 @@ getValue: () => string
setValue: (value: string) => void
```
-## TextInputOptions — interface
+## TextInputOptions — interface @experimental
```
backgroundColor: Color | undefined
color: Color | undefined
@@ -7410,7 +7410,7 @@ value: string | undefined
world: World
```
-## TextInputPlugin — class
+## TextInputPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -7420,19 +7420,19 @@ static new (): TextInputPlugin
static prototype: TextInputPlugin
```
-## TextMetrics — interface
+## TextMetrics — interface @experimental
```
height: number
lineCount: number
width: number
```
-## TextOverflow — type
+## TextOverflow — type @experimental
```
(typeof TextOverflow)[keyof typeof TextOverflow]
```
-## TextPlugin — class
+## TextPlugin — class @experimental
```
build: (app: App) => void
name: string
@@ -7440,12 +7440,12 @@ static new (): TextPlugin
static prototype: TextPlugin
```
-## TextRenderMode — type
+## TextRenderMode — type @experimental
```
(typeof TextRenderMode)[keyof typeof TextRenderMode]
```
-## TextSegment — interface
+## TextSegment — interface @experimental
```
bold: boolean
color: Color | null
@@ -7455,46 +7455,46 @@ text: string
type: "text"
```
-## TextVerticalAlign — type
+## TextVerticalAlign — type @experimental
```
(typeof TextVerticalAlign)[keyof typeof TextVerticalAlign]
```
-## TextureDimensions — interface
+## TextureDimensions — interface @experimental
```
height: number
width: number
```
-## TextureFilter — type
+## TextureFilter — type @experimental
```
(typeof TextureFilter)[keyof typeof TextureFilter]
```
-## TextureHandle — type
+## TextureHandle — type @experimental
```
number
```
-## TextureInfo — interface
+## TextureInfo — interface @experimental
```
handle: number
height: number
width: number
```
-## TextureRef — interface
+## TextureRef — interface @experimental
```
slot: number | undefined
textureId: number
```
-## TextureWrap — type
+## TextureWrap — type @experimental
```
(typeof TextureWrap)[keyof typeof TextureWrap]
```
-## ThemeColors — interface
+## ThemeColors — interface @experimental
```
backdrop: Color
control: Color
@@ -7511,18 +7511,18 @@ text: Color
track: Color
```
-## ThemeOverrides — interface
+## ThemeOverrides — interface @experimental
```
colors: Partial<ThemeColors> | undefined
type: Partial<ThemeType> | undefined
```
-## ThemeStyle — const
+## ThemeStyle — const @experimental
```
ComponentDef<ThemeStyleData>
```
-## ThemeStyleData — interface
+## ThemeStyleData — interface @experimental
```
input: { background?: ColorRole; text?: ColorRole; placeholder?: ColorRole; } | undefined
states: Record<string, keyof ThemeColors> | undefined
@@ -7530,20 +7530,20 @@ text: keyof ThemeColors | undefined
visual: keyof ThemeColors | undefined
```
-## ThemeTokens — interface
+## ThemeTokens — interface @experimental
```
colors: ThemeColors
type: ThemeType
```
-## ThemeType — interface
+## ThemeType — interface @experimental
```
body: number
label: number
title: number
```
-## TileCollisionPiece — interface
+## TileCollisionPiece — interface @experimental
```
center: Vec2
circles: { c: Vec2; r: number; }[]
@@ -7552,21 +7552,21 @@ polylines: Vec2[][]
sensor: boolean
```
-## TileCollisionShape — type
+## TileCollisionShape — type @experimental
```
| { type: 'box' }
| { type: 'polygon'; points: [number, number][] }
| { type: 'circle'; cx: number; cy: number; r: number }
```
-## TileFlags — interface
+## TileFlags — interface @experimental
```
flipD: boolean
flipH: boolean
flipV: boolean
```
-## TileGridParams — interface
+## TileGridParams — interface @experimental
```
hexSideLength: number | undefined
orientation: number
@@ -7576,7 +7576,7 @@ tileHeight: number
tileWidth: number
```
-## TileOrientation — enum
+## TileOrientation — enum @experimental
```
Hexagonal = 3
Isometric = 1
@@ -7584,14 +7584,14 @@ Orthogonal = 0
Staggered = 2
```
-## TileStamp — interface
+## TileStamp — interface @experimental
```
cells: number[]
h: number
w: number
```
-## TiledLayerData — interface
+## TiledLayerData — interface @experimental
```
chunks: TiledChunkData[]
height: number
@@ -7606,7 +7606,7 @@ visible: boolean
width: number
```
-## TiledMapData — interface
+## TiledMapData — interface @experimental
```
collisionTileIds: number[]
height: number
@@ -7625,7 +7625,7 @@ tilesets: TiledTilesetData[]
width: number
```
-## TiledTilesetData — interface
+## TiledTilesetData — interface @experimental
```
collectionTiles: TiledCollectionTile[] | undefined
columns: number
@@ -7639,27 +7639,27 @@ tileHeight: number
tileWidth: number
```
-## Tilemap — const
+## Tilemap — const @experimental
```
ComponentDef<TilemapData>
```
-## TilemapAPI — const
+## TilemapAPI — const @experimental
```
{ initLayer(entity: number, width: number, height: number, tileWidth: number, tileHeight: number): void; destroyLayer(entity: number): void; setTile(entity: number, x: number, y: number, tileId: number): void; getTile(entity: number, x: number, y: number): number; fillRect(entity: number, x: number, y: number, w: number, h: number, tileId: number): void; setTiles(entity: number, tiles: Uint16Array): void; setTilesets(entity: number, slots: { firstId: number; textureHandle: number; columns: number; margin?: number; spacing?: number; }[]): void; hasLayer(entity: number): boolean; setRenderProps(entity: number, textureHandle: number, tilesetColumns: number, uvTileW: number, uvTileH: number, sortLayer: number, depth: number, parallaxX: number, parallaxY: number): void; setTint(entity: number, r: number, g: number, b: number, a: number, opacity: number): void; setVisible(entity: number, visible: boolean): void; setOriginEntity(layerKey: number, originEntity: number): void; setTileAnimation(entity: number, tileId: number, frames: { tileId: number; duration: number; }[]): void; clearTileAnimations(entity: number): void; advanceAnimations(entity: number, dtMs: number): void; setTileProperty(entity: number, tileId: number, key: string, value: string): void; getTileProperty(entity: number, x: number, y: number, key: string): string; flipTile(entity: number, x: number, y: number, flipH: boolean, flipV: boolean, flipD: boolean): void; rotateTile(entity: number, x: number, y: number, degrees: number): void; initInfiniteLayer(entity: number, tileWidth: number, tileHeight: number): void; setChunkTiles(entity: number, chunkX: number, chunkY: number, tiles: Uint16Array, width: number, height: number): void; setGridType(entity: number, type: number): void; setHexParams(entity: number, sideLength: number, staggerAxisX: boolean, staggerIndexEven: boolean): void; tileToWorld(entity: number, tx: number, ty: number, originX: number, originY: number): { x: number; y: number; }; worldToTile(entity: number, wx: number, wy: number, originX: number, originY: number): { x: number; y: number; }; exportChunks(entity: number): string; importChunks(entity: number, encoded: string): boolean; }
```
-## TilemapData — interface
+## TilemapData — interface @experimental
```
source: string
```
-## TilemapLayer — const
+## TilemapLayer — const @experimental
```
BuiltinComponentDef<TilemapLayerData>
```
-## TilemapLayerData — interface
+## TilemapLayerData — interface @experimental
```
cellSize: Vec2
hexSideLength: number
@@ -7677,12 +7677,12 @@ tintColor: Color
visible: boolean
```
-## TilemapLiveSync — const
+## TilemapLiveSync — const @experimental
```
{ _bind(fn: ApplyTilesetRefs | null): void; setLayerTilesets(entity: number, refs: readonly string[]): void; }
```
-## TilemapPlugin — class
+## TilemapPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -7692,18 +7692,18 @@ static new (): TilemapPlugin
static prototype: TilemapPlugin
```
-## Tilemaps — const
+## Tilemaps — const @experimental
```
ResourceDef<{ initLayer(entity: number, width: number, height: number, tileWidth: number, tileHeight: number): void; destroyLayer(entity: number): void; setTile(entity: number, x: number, y: number, tileId: number): void; getTile(entity: number, x: number, y: number): number; fillRect(entity: number, x: number, y: number, w: number, h: number, tileId: number): void; setTiles(entity: number, tiles: Uint16Array): void; setTilesets(entity: number, slots: { firstId: number; textureHandle: number; columns: number; margin?: number; spacing?: number; }[]): void; hasLayer(entity: number): boolean; setRenderProps(entity: number, textureHandle: number, tilesetColumns: number, uvTileW: number, uvTileH: number, sortLayer: number, depth: number, parallaxX: number, parallaxY: number): void; setTint(entity: number, r: number, g: number, b: number, a: number, opacity: number): void; setVisible(entity: number, visible: boolean): void; setOriginEntity(layerKey: number, originEntity: number): void; setTileAnimation(entity: number, tileId: number, frames: { tileId: number; duration: number; }[]): void; clearTileAnimations(entity: number): void; advanceAnimations(entity: number, dtMs: number): void; setTileProperty(entity: number, tileId: number, key: string, value: string): void; getTileProperty(entity: number, x: number, y: number, key: string): string; flipTile(entity: number, x: number, y: number, flipH: boolean, flipV: boolean, flipD: boolean): void; rotateTile(entity: number, x: number, y: number, degrees: number): void; initInfiniteLayer(entity: number, tileWidth: number, tileHeight: number): void; setChunkTiles(entity: number, chunkX: number, chunkY: number, tiles: Uint16Array, width: number, height: number): void; setGridType(entity: number, type: number): void; setHexParams(entity: number, sideLength: number, staggerAxisX: boolean, staggerIndexEven: boolean): void; tileToWorld(entity: number, tx: number, ty: number, originX: number, originY: number): { x: number; y: number; }; worldToTile(entity: number, wx: number, wy: number, originX: number, originY: number): { x: number; y: number; }; exportChunks(entity: number): string; importChunks(entity: number, encoded: string): boolean; }>
```
-## TilesetAnimFrame — interface
+## TilesetAnimFrame — interface @experimental
```
durationMs: number
tile: number
```
-## TilesetAsset — interface
+## TilesetAsset — interface @experimental
```
columns: number
margin: number
@@ -7717,7 +7717,7 @@ tiles: Record<number, TilesetTile>
version: string
```
-## TilesetCollision — type
+## TilesetCollision — type @experimental
```
TileCollisionShape & {
/** One-way (jump-through) platform: contacts from behind this normal pass through. */
@@ -7731,7 +7731,7 @@ TileCollisionShape & {
}
```
-## TilesetModel — interface
+## TilesetModel — interface @experimental
```
animations: Map<number, { tileId: number; duration: number; }[]>
collidableTileIds: number[]
@@ -7739,7 +7739,7 @@ slots: TilesetModelSlot[]
tileShapes: Map<number, ResolvedTileCollision>
```
-## TilesetTerrain — interface
+## TilesetTerrain — interface @experimental
```
color: string | undefined
colors: TerrainColor[] | undefined
@@ -7747,7 +7747,7 @@ mode: TerrainMode
name: string
```
-## TilesetTile — interface
+## TilesetTile — interface @experimental
```
animation: TilesetAnimFrame[] | undefined
collision: TilesetCollision | undefined
@@ -7756,19 +7756,19 @@ properties: Record<string, string> | undefined
terrain: TilesetTileTerrain | undefined
```
-## TilesetTileTerrain — interface
+## TilesetTileTerrain — interface @experimental
```
corners: number[] | undefined
mask: number | undefined
set: number
```
-## Time — const
+## Time — const @experimental
```
ResourceDef<TimeData>
```
-## TimeData — interface
+## TimeData — interface @experimental
```
delta: number
elapsed: number
@@ -7780,12 +7780,12 @@ scale: number
unscaledDelta: number
```
-## Timeline — const
+## Timeline — const @experimental
```
ResourceDef<TimelineAPI>
```
-## TimelineAPI — class
+## TimelineAPI — class @experimental
```
clearStates: () => void
ensureState: (entity: Entity, wrapMode: WrapMode, speed: number) => TimelineState
@@ -7801,7 +7801,7 @@ static new (flags_?: PlayerFlagChannel | null): TimelineAPI
static prototype: TimelineAPI
```
-## TimelineAsset — interface
+## TimelineAsset — interface @experimental
```
duration: number
tracks: Track[]
@@ -7810,12 +7810,12 @@ version: string
wrapMode: WrapMode
```
-## TimelinePlayer — const
+## TimelinePlayer — const @experimental
```
ComponentDef<TimelinePlayerData>
```
-## TimelinePlayerData — interface
+## TimelinePlayerData — interface @experimental
```
finished: boolean
playing: boolean
@@ -7824,7 +7824,7 @@ timeline: string
wrapMode: string
```
-## TimelinePlugin — class
+## TimelinePlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -7838,7 +7838,7 @@ static new (): TimelinePlugin
static prototype: TimelinePlugin
```
-## TimerHandle — class
+## TimerHandle — class @experimental
```
cancel: () => void
elapsed: number
@@ -7852,7 +7852,7 @@ static new (manager: TimerManager, id: number): TimerHandle
static prototype: TimerHandle
```
-## TimerManager — class
+## TimerManager — class @experimental
```
activeCount: number
cancel: (id: number) => void
@@ -7871,12 +7871,12 @@ static new (): TimerManager
static prototype: TimerManager
```
-## TimerRes — const
+## TimerRes — const @experimental
```
ResourceDef<TimerManager>
```
-## ToggleHandle — interface
+## ToggleHandle — interface @experimental
```
dispose: () => void
entity: number
@@ -7885,7 +7885,7 @@ setDisabled: (disabled: boolean) => void
setValue: (value: boolean) => void
```
-## ToggleOptions — interface
+## ToggleOptions — interface @experimental
```
background: UIVisualInit | undefined
check: { node?: UINodeInit; color?: Color; sprite?: number; } | undefined
@@ -7901,29 +7901,29 @@ tabIndex: number | undefined
world: World
```
-## TouchPoint — interface
+## TouchPoint — interface @experimental
```
id: number
x: number
y: number
```
-## Track — type
+## Track — type @experimental
```
PropertyTrack | SpineTrack | SpriteAnimTrack | AudioTrack | ActivationTrack | MarkerTrack | CustomEventTrack | AnimFramesTrack
```
-## TrackType — type
+## TrackType — type @experimental
```
(typeof TrackType)[keyof typeof TrackType]
```
-## Trail — const
+## Trail — const @experimental
```
ResourceDef<TrailAPI>
```
-## TrailAPI — class
+## TrailAPI — class @experimental
```
clear: (entity: Entity) => void
update: (dt: number) => void
@@ -7931,7 +7931,7 @@ static new (module: NonNullable<EngineApi>, registry: CppRegistry): TrailAPI
static prototype: TrailAPI
```
-## TrailPlugin — class
+## TrailPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -7940,12 +7940,12 @@ static new (): TrailPlugin
static prototype: TrailPlugin
```
-## TrailRenderer — const
+## TrailRenderer — const @experimental
```
BuiltinComponentDef<TrailRendererData>
```
-## TrailRendererData — interface
+## TrailRendererData — interface @experimental
```
blendMode: number
emitting: boolean
@@ -7961,7 +7961,7 @@ texture: number
time: number
```
-## Transaction — class
+## Transaction — class @experimental
```
add: (op: TransactionOp) => void
addDeferred: (op: TransactionOp) => void
@@ -7975,7 +7975,7 @@ static new (label: string, id?: string): Transaction
static prototype: Transaction
```
-## TransactionManager — class
+## TransactionManager — class @experimental
```
begin: (label: string) => Transaction
canRedo: () => boolean
@@ -7991,23 +7991,23 @@ static new (options?: TransactionManagerOptions): TransactionManager
static prototype: TransactionManager
```
-## TransactionManagerOptions — interface
+## TransactionManagerOptions — interface @experimental
```
historyLimit: number | undefined
```
-## TransactionOp — interface
+## TransactionOp — interface @experimental
```
forward: () => void
reverse: () => void
```
-## Transform — const
+## Transform — const @experimental
```
BuiltinComponentDef<TransformData>
```
-## TransformData — interface
+## TransformData — interface @experimental
```
position: Vec3
rotation: Quat
@@ -8017,14 +8017,14 @@ worldRotation: Quat
worldScale: Vec3
```
-## TransitionConfig — interface
+## TransitionConfig — interface @experimental
```
color: Color | undefined
duration: number
type: "fade"
```
-## TransitionOptions — interface
+## TransitionOptions — interface @experimental
```
color: Color | undefined
duration: number | undefined
@@ -8034,12 +8034,12 @@ onStart: (() => void) | undefined
transition: "fade" | "none" | undefined
```
-## Tween — const
+## Tween — const @experimental
```
ResourceDef<TweenAPI>
```
-## TweenAPI — class
+## TweenAPI — class @experimental
```
activeCompositionCount: number
cancel: (tweenHandle: TweenHandle) => void
@@ -8055,12 +8055,12 @@ static new (module: AnimCore, registry: CppRegistry): TweenAPI
static prototype: TweenAPI
```
-## TweenFactory — type
+## TweenFactory — type @experimental
```
() => Completable
```
-## TweenGroup — class
+## TweenGroup — class @experimental
```
cancel: () => void
checkComplete: () => boolean
@@ -8072,7 +8072,7 @@ static new (tweens: Completable[]): TweenGroup
static prototype: TweenGroup
```
-## TweenHandle — class
+## TweenHandle — class @experimental
```
bezier: (p1x: number, p1y: number, p2x: number, p2y: number) => TweenHandle
cancel: () => void
@@ -8085,7 +8085,7 @@ static new (module: AnimCore, registry: CppRegistry, valueManager: ValueTweenMan
static prototype: TweenHandle
```
-## TweenOptions — interface
+## TweenOptions — interface @experimental
```
delay: number | undefined
easing: EasingType | undefined
@@ -8093,7 +8093,7 @@ loop: LoopMode | undefined
loopCount: number | undefined
```
-## TweenSequence — class
+## TweenSequence — class @experimental
```
cancel: () => void
checkComplete: () => boolean
@@ -8105,17 +8105,17 @@ static new (factories: TweenFactory[]): TweenSequence
static prototype: TweenSequence
```
-## TweenState — type
+## TweenState — type @experimental
```
(typeof TweenState)[keyof typeof TweenState]
```
-## TweenTarget — type
+## TweenTarget — type @experimental
```
(typeof TweenTarget)[keyof typeof TweenTarget]
```
-## UICameraData — interface
+## UICameraData — interface @experimental
```
screenH: number
screenW: number
@@ -8133,44 +8133,44 @@ worldRight: number
worldTop: number
```
-## UICameraInfo — const
+## UICameraInfo — const @experimental
```
ResourceDef<UICameraData>
```
-## UIController — const
+## UIController — const @experimental
```
ComponentDef<UIControllerData>
```
-## UIControllerData — interface
+## UIControllerData — interface @experimental
```
controllers: ControllerState[]
```
-## UIDialog — const
+## UIDialog — const @experimental
```
ComponentDef<UIDialogData>
```
-## UIDialogData — interface
+## UIDialogData — interface @experimental
```
closeOnBackdrop: boolean
closeOnEscape: boolean
```
-## UIDisplay — enum
+## UIDisplay — enum @experimental
```
Flex = 0
None = 1
```
-## UIDropdown — const
+## UIDropdown — const @experimental
```
ComponentDef<UIDropdownData>
```
-## UIDropdownData — interface
+## UIDropdownData — interface @experimental
```
label: number
optionHeight: number
@@ -8178,7 +8178,7 @@ options: string[]
selectedIndex: number
```
-## UIEntityInit — interface
+## UIEntityInit — interface @experimental
```
node: UINodeInit | undefined
parent: number | undefined
@@ -8187,7 +8187,7 @@ visual: UIVisualInit | undefined
world: World
```
-## UIEvent — interface
+## UIEvent — interface @experimental
```
currentTarget: number
data: TData
@@ -8199,12 +8199,12 @@ target: number
type: string
```
-## UIEventHandler — type
+## UIEventHandler — type @experimental
```
(event: EntityEvent<TData>) => void
```
-## UIEventQueue — class
+## UIEventQueue — class @experimental
```
clear: () => void
drain: () => readonly EntityEvent[]
@@ -8218,32 +8218,32 @@ static new (): EntityEventQueue
static prototype: EntityEventQueue
```
-## UIEventType — type
+## UIEventType — type @experimental
```
typeof UIEventType[keyof typeof UIEventType]
```
-## UIEvents — const
+## UIEvents — const @experimental
```
ResourceDef<EntityEventQueue>
```
-## UIGear — const
+## UIGear — const @experimental
```
ComponentDef<UIGearData>
```
-## UIGearData — interface
+## UIGearData — interface @experimental
```
bindings: GearBinding[]
```
-## UIInteraction — const
+## UIInteraction — const @experimental
```
BuiltinComponentDef<UIInteractionData>
```
-## UIInteractionData — interface
+## UIInteractionData — interface @experimental
```
hovered: boolean
justPressed: boolean
@@ -8251,7 +8251,7 @@ justReleased: boolean
pressed: boolean
```
-## UIInteractionPlugin — class
+## UIInteractionPlugin — class @experimental
```
build: (app: App) => void
dependencies: "uiLayout"[]
@@ -8260,17 +8260,17 @@ static new (): UIInteractionPlugin
static prototype: UIInteractionPlugin
```
-## UILayoutGeneration — const
+## UILayoutGeneration — const @experimental
```
ResourceDef<UILayoutGenerationData>
```
-## UILayoutGenerationData — interface
+## UILayoutGenerationData — interface @experimental
```
generation: number
```
-## UILayoutPlugin — class
+## UILayoutPlugin — class @experimental
```
build: (app: App) => void
name: string
@@ -8278,19 +8278,19 @@ static new (): UILayoutPlugin
static prototype: UILayoutPlugin
```
-## UIMask — const
+## UIMask — const @experimental
```
BuiltinComponentDef<UIMaskData>
```
-## UIMaskData — interface
+## UIMaskData — interface @experimental
```
alphaCutoff: number
enabled: boolean
mode: MaskMode
```
-## UIMaskPlugin — class
+## UIMaskPlugin — class @experimental
```
build: (app: App) => void
name: "uiMask"
@@ -8298,12 +8298,12 @@ static new (): UIMaskPlugin
static prototype: UIMaskPlugin
```
-## UINode — const
+## UINode — const @experimental
```
BuiltinComponentDef<UINodeData>
```
-## UINodeInit — interface
+## UINodeInit — interface @experimental
```
fill: boolean | undefined
flexGrow: number | undefined
@@ -8323,7 +8323,7 @@ position: number | undefined
width: Dimension | undefined
```
-## UIPlugin — class
+## UIPlugin — class @experimental
```
attachScrollContainer: (entity: Entity, container: ScrollContainer) => void
build: (app: App) => void
@@ -8337,19 +8337,19 @@ static new (): UIPlugin
static prototype: UIPlugin
```
-## UIPointerEvents — enum
+## UIPointerEvents — enum @experimental
```
Auto = 0
None = 1
```
-## UIPositionType — enum
+## UIPositionType — enum @experimental
```
Absolute = 1
Relative = 0
```
-## UIRenderOrderPlugin — class
+## UIRenderOrderPlugin — class @experimental
```
after: ("text" | "uiInteraction" | "uiMask")[]
build: (app: App) => void
@@ -8359,12 +8359,12 @@ static new (): UIRenderOrderPlugin
static prototype: UIRenderOrderPlugin
```
-## UISlider — const
+## UISlider — const @experimental
```
ComponentDef<UISliderData>
```
-## UISliderData — interface
+## UISliderData — interface @experimental
```
fill: number
handle: number
@@ -8374,18 +8374,18 @@ step: number
value: number
```
-## UIToggle — const
+## UIToggle — const @experimental
```
ComponentDef<UIToggleData>
```
-## UIToggleData — interface
+## UIToggleData — interface @experimental
```
check: number
isOn: boolean
```
-## UIVisibilityPlugin — class
+## UIVisibilityPlugin — class @experimental
```
build: (app: App) => void
dependencies: "uiInteraction"[]
@@ -8394,12 +8394,12 @@ static new (): UIVisibilityPlugin
static prototype: UIVisibilityPlugin
```
-## UIVisual — const
+## UIVisual — const @experimental
```
BuiltinComponentDef<UIVisualData>
```
-## UIVisualData — interface
+## UIVisualData — interface @experimental
```
color: Color
enabled: boolean
@@ -8416,7 +8416,7 @@ uvScale: Vec2
visualType: UIVisualType
```
-## UIVisualInit — interface
+## UIVisualInit — interface @experimental
```
color: { r: number; g: number; b: number; a: number; } | undefined
enabled: boolean | undefined
@@ -8433,7 +8433,7 @@ uvScale: Vec2 | undefined
visualType: UIVisualType | undefined
```
-## UIVisualType — enum
+## UIVisualType — enum @experimental
```
Filled = 5
Image = 2
@@ -8443,23 +8443,23 @@ SolidColor = 1
Tiled = 4
```
-## UniformValue — type
+## UniformValue — type @experimental
```
number | Vec2 | Vec3 | Vec4 | number[] | TextureRef
```
-## Unsubscribe — type
+## Unsubscribe — type @experimental
```
() => void
```
-## ValidatePrefabOptions — interface
+## ValidatePrefabOptions — interface @experimental
```
instanceOverrides: readonly PrefabOverride[] | undefined
loadPrefab: ((path: string) => PrefabData | null) | undefined
```
-## ValidateResult — interface
+## ValidateResult — interface @experimental
```
duplicateIds: string[]
invalidIds: string[]
@@ -8467,7 +8467,7 @@ orphanedChildren: string[]
stale: StaleOverride[]
```
-## ValueTweenHandle — class
+## ValueTweenHandle — class @experimental
```
bezier: (p1x: number, p1y: number, p2x: number, p2y: number) => ValueTweenHandle
cancel: () => void
@@ -8481,26 +8481,26 @@ static new (manager: ValueTweenManager, id: number): ValueTweenHandle
static prototype: ValueTweenHandle
```
-## Vec2 — interface
+## Vec2 — interface @experimental
```
x: number
y: number
```
-## Vec2Like — interface
+## Vec2Like — interface @experimental
```
x: number
y: number
```
-## Vec3 — interface
+## Vec3 — interface @experimental
```
x: number
y: number
z: number
```
-## Vec4 — interface
+## Vec4 — interface @experimental
```
w: number
x: number
@@ -8508,29 +8508,29 @@ y: number
z: number
```
-## Velocity — const
+## Velocity — const @experimental
```
BuiltinComponentDef<VelocityData>
```
-## VelocityData — interface
+## VelocityData — interface @experimental
```
angular: Vec3
linear: Vec3
```
-## VertexAttributeDescriptor — interface
+## VertexAttributeDescriptor — interface @experimental
```
name: string
type: DataType
```
-## Video — const
+## Video — const @experimental
```
ComponentDef<VideoData>
```
-## VideoAPI — class
+## VideoAPI — class @experimental
```
backendName: string
baseUrl: string
@@ -8544,7 +8544,7 @@ static new (backend: PlatformVideoBackend): VideoAPI
static prototype: VideoAPI
```
-## VideoData — interface
+## VideoData — interface @experimental
```
autoplay: boolean
enabled: boolean
@@ -8556,22 +8556,22 @@ source: string
volume: number
```
-## VideoHandle — type
+## VideoHandle — type @experimental
```
VideoStreamHandle
```
-## VideoPlayOptions — type
+## VideoPlayOptions — type @experimental
```
VideoStreamOptions
```
-## VideoPlayer — const
+## VideoPlayer — const @experimental
```
ResourceDef<VideoAPI>
```
-## VideoPlugin — class
+## VideoPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -8581,7 +8581,7 @@ static new (): VideoPlugin
static prototype: VideoPlugin
```
-## VideoStreamHandle — interface
+## VideoStreamHandle — interface @experimental
```
bytes: number | undefined
currentTime: number
@@ -8606,7 +8606,7 @@ textureHandle: number
width: number
```
-## VideoStreamOptions — interface
+## VideoStreamOptions — interface @experimental
```
audioTrackUrl: string | undefined
autoplay: boolean | undefined
@@ -8616,7 +8616,7 @@ playbackRate: number | undefined
volume: number | undefined
```
-## Viewport — interface
+## Viewport — interface @experimental
```
h: number
w: number
@@ -8624,28 +8624,28 @@ x: number
y: number
```
-## Virtual — const
+## Virtual — const @experimental
```
(id: string) => Binding
```
-## WangIndex — interface
+## WangIndex — interface @experimental
```
byKey: Map<number, number>
```
-## WangIndices — interface
+## WangIndices — interface @experimental
```
sets: Map<number, WangIndex>
tileTerrain: Map<number, number>
```
-## WeChatSideModuleFactories — type
+## WeChatSideModuleFactories — type @experimental
```
Partial<Record<SideModuleId, EmscriptenFactory>>
```
-## WeChatSocket — class
+## WeChatSocket — class @experimental
```
close: (code?: number, reason?: string) => void
connect: () => void
@@ -8656,7 +8656,7 @@ static new (options: GameSocketOptions): WeChatSocket
static prototype: WeChatSocket
```
-## WebAppOptions — interface
+## WebAppOptions — interface @experimental
```
colorSpace: "gamma" | "linear" | undefined
depthLayers: number | undefined
@@ -8669,34 +8669,34 @@ sideModules: SideModuleHost | undefined
ySortLayers: number | undefined
```
-## WeldJoint — const
+## WeldJoint — const @experimental
```
ComponentDef<WeldJointData>
```
-## WheelJoint — const
+## WheelJoint — const @experimental
```
ComponentDef<WheelJointData>
```
-## WidgetInteractionInit — interface
+## WidgetInteractionInit — interface @experimental
```
disabled: boolean | undefined
focusable: boolean | undefined
tabIndex: number | undefined
```
-## With — function
+## With — function @experimental
```
(component: AnyComponentDef): FilterExpr
```
-## Without — function
+## Without — function @experimental
```
(component: AnyComponentDef): FilterExpr
```
-## World — class
+## World — class @experimental
```
advanceTick: () => void
anyChangedSince: (component: AnyComponentDef, sinceTick: number) => boolean
@@ -8751,7 +8751,7 @@ static new (): World
static prototype: World
```
-## WorldRect — interface
+## WorldRect — interface @experimental
```
bottom: number
left: number
@@ -8759,62 +8759,62 @@ right: number
top: number
```
-## WorldTransform — const
+## WorldTransform — const @experimental
```
BuiltinComponentDef<TransformData>
```
-## WorldTransformData — type
+## WorldTransformData — type @experimental
```
TransformData
```
-## WrapMode — type
+## WrapMode — type @experimental
```
(typeof WrapMode)[keyof typeof WrapMode]
```
-## actionRefArg — function
+## actionRefArg — function @experimental
```
(ref: FsmActionRef | undefined): string | undefined
```
-## actionRefName — function
+## actionRefName — function @experimental
```
(ref: FsmActionRef | undefined): string
```
-## actionRefParams — function
+## actionRefParams — function @experimental
```
(ref: FsmActionRef | undefined): Record<string, AiParamValue> | undefined
```
-## activeRemoteRoot — function
+## activeRemoteRoot — function @experimental
```
(config: AssetGroupsConfig | null | undefined): string | undefined
```
-## addAnimatorParam — function
+## addAnimatorParam — function @experimental
```
(def: AnimatorControllerDef, name: string, type: AnimatorParamType): AnimatorControllerDef
```
-## addAnimatorState — function
+## addAnimatorState — function @experimental
```
(def: AnimatorControllerDef, name: string, x?: number, y?: number): AnimatorControllerDef
```
-## addAnimatorTransition — function
+## addAnimatorTransition — function @experimental
```
(def: AnimatorControllerDef, from: string, to: string): AnimatorControllerDef
```
-## addBtChild — function
+## addBtChild — function @experimental
```
(def: BtDefinition, parentId: string, type: BtNodeType, x?: number, y?: number): BtDefinition
```
-## addBtOrphan — function
+## addBtOrphan — function @experimental
```
(def: BtDefinition, type: BtNodeType, x?: number, y?: number): BtDefinition
```
@@ -8824,397 +8824,397 @@ TransformData
(g: MaterialGraph, type: GraphNodeType, x: number, y: number): { graph: MaterialGraph; id: string; }
```
-## addStartupSystem — function
+## addStartupSystem — function @experimental
```
(system: SystemDef): void
```
-## addState — function
+## addState — function @experimental
```
(def: FsmDefinition, name: string, x?: number, y?: number): FsmDefinition
```
-## addSystem — function
+## addSystem — function @experimental
```
(system: SystemDef): void
```
-## addSystemSetToSchedule — function
+## addSystemSetToSchedule — function @experimental
```
(schedule: Schedule, set: SystemSet): void
```
-## addSystemToSchedule — function
+## addSystemToSchedule — function @experimental
```
(schedule: Schedule, system: SystemDef): void
```
-## addTransition — function
+## addTransition — function @experimental
```
(def: FsmDefinition, from: string, to: string): FsmDefinition
```
-## agentBlackboard — function
+## agentBlackboard — function @experimental
```
(states: Map<Entity, AgentState>, entity: Entity): Blackboard
```
-## agentBtBlackboard — function
+## agentBtBlackboard — function @experimental
```
(states: Map<Entity, BtAgentState>, entity: Entity): Blackboard
```
-## aiRegistry — const
+## aiRegistry — const @experimental
```
AiRegistry<AiContext>
```
-## analyzeCensusSeries — function
+## analyzeCensusSeries — function @experimental
```
(samples: readonly Census[], opts?: CensusSeriesOptions): CensusReport
```
-## anchorPresetFields — function
+## anchorPresetFields — function @experimental
```
(preset: AnchorPreset): AnchorFields
```
-## animClipCellRect — function
+## animClipCellRect — function @experimental
```
(sheet: AnimClipSheetData, cell: number): { x: number; y: number; width: number; height: number; }
```
-## animClipCellUv — function
+## animClipCellUv — function @experimental
```
(sheet: AnimClipSheetData, cell: number): { uvOffset: { x: number; y: number; }; uvScale: { x: number; y: number; }; }
```
-## animClipDrivesPivot — function
+## animClipDrivesPivot — function @experimental
```
(data: AnimClipAssetData): boolean
```
-## animClipFramePivot — function
+## animClipFramePivot — function @experimental
```
(data: AnimClipAssetData, frame: AnimClipFrameData): AnimClipPivotData | null
```
-## animClipSheetCols — function
+## animClipSheetCols — function @experimental
```
(sheet: AnimClipSheetData): number
```
-## animClipSheetRows — function
+## animClipSheetRows — function @experimental
```
(sheet: AnimClipSheetData): number
```
-## animationPlugin — const
+## animationPlugin — const @experimental
```
AnimationPlugin
```
-## animatorEdges — function
+## animatorEdges — function @experimental
```
(def: AnimatorControllerDef): AnimatorEdge[]
```
-## applyAssetRefResolvers — function
+## applyAssetRefResolvers — function @experimental
```
(app: App, resolveRef: (ref: string) => string): void
```
-## applyAudioProjectConfig — function
+## applyAudioProjectConfig — function @experimental
```
(audio: AudioAPI, config: AudioProjectConfig | undefined): void
```
-## applyBuildRuntimeConfig — function
+## applyBuildRuntimeConfig — function @experimental
```
(app: { setMaxDeltaTime(v: number): void; setMaxFixedSteps(v: number): void; }, config: RuntimeBuildConfig): void
```
-## applyDeltaToSource — function
+## applyDeltaToSource — function @experimental
```
(source: PrefabData, delta: SourceDelta): PrefabData
```
-## applyOverrides — function
+## applyOverrides — function @experimental
```
(entity: OverrideTarget, overrides: readonly PrefabOverride[] | undefined): void
```
-## applyOverridesToSource — function
+## applyOverridesToSource — function @experimental
```
(source: PrefabData, overrides: readonly PrefabOverride[]): PrefabData
```
-## applyRuntimeConfig — function
+## applyRuntimeConfig — function @experimental
```
(components: { Text?: { _default: Record<string, unknown>; }; TextInput?: { _default: Record<string, unknown>; }; Canvas?: { _default: Record<string, unknown>; }; }): void
```
-## applyThemeToWorld — function
+## applyThemeToWorld — function @experimental
```
(world: World): void
```
-## applyWrapMode — function
+## applyWrapMode — function @experimental
```
(time: number, duration: number, mode: WrapMode): { time: number; stopped: boolean; }
```
-## arrayDataSource — function
+## arrayDataSource — function @experimental
```
<T>(items: readonly T[]): ArrayDataSource<T>
```
-## assetPlugin — const
+## assetPlugin — const @experimental
```
AssetPlugin
```
-## atlasCatalogFields — function
+## atlasCatalogFields — function @experimental
```
(atlas: CookedAtlasInfo, pagePath: string): Pick<CatalogEntry, "atlas" | "frame" | "uv">
```
-## audioPlugin — const
+## audioPlugin — const @experimental
```
AudioPlugin
```
-## auto — const
+## auto — const @experimental
```
() => Dimension
```
-## bind — function
+## bind — function @experimental
```
<C extends object, K extends keyof C>(world: World, entity: Entity, component: ComponentDef<C>, field: K, source: ReadonlySignal<C[K]>): () => void
```
-## bindControllerPage — function
+## bindControllerPage — function @experimental
```
(world: World, entity: Entity, controller: string, source: ReadonlySignal<string>): () => void
```
-## bindWidgetValue — function
+## bindWidgetValue — function @experimental
```
<C extends object, K extends keyof C>(world: World, events: UIEventQueue, entity: Entity, component: ComponentDef<C>, field: K, signal: Signal<C[K]>, payloadKey?: string): () => void
```
-## btEdges — function
+## btEdges — function @experimental
```
(def: BtDefinition): BtEdge[]
```
-## btNodes — function
+## btNodes — function @experimental
```
(def: BtDefinition): BtNode[]
```
-## btPlugin — const
+## btPlugin — const @experimental
```
BtPlugin
```
-## bucketOverridesByEntity — function
+## bucketOverridesByEntity — function @experimental
```
(overrides: readonly PrefabOverride[]): Map<PrefabEntityId, PrefabOverride[]>
```
-## buildCollisionPaletteModel — function
+## buildCollisionPaletteModel — function @experimental
```
(material?: CollisionMaterial): TilesetModel
```
-## buildTerrainIndices — function
+## buildTerrainIndices — function @experimental
```
(asset: TilesetAsset): TerrainIndices
```
-## buildText — function
+## buildText — function @experimental
```
(init?: TextInit): TextData
```
-## buildUINode — function
+## buildUINode — function @experimental
```
(init?: UINodeInit): UINodeData
```
-## buildUIVisual — function
+## buildUIVisual — function @experimental
```
(init?: UIVisualInit): UIVisualData
```
-## buildVariant — function
+## buildVariant — function @experimental
```
(base: PrefabData, baseRef: string, name: string, delta: { overrides: readonly PrefabOverride[]; added: readonly AddedEntity[]; }): PrefabData
```
-## buildWangIndices — function
+## buildWangIndices — function @experimental
```
(asset: TilesetAsset): WangIndices
```
-## builtinShaderTemplate — function
+## builtinShaderTemplate — function @experimental
```
(id: string): BuiltinShaderTemplate | undefined
```
-## calculateAttenuation — function
+## calculateAttenuation — function @experimental
```
(distance: number, config?: SpatialAudioConfig): number
```
-## calculatePanning — function
+## calculatePanning — function @experimental
```
(sourceX: number, sourceY: number, listenerX: number, listenerY: number, maxDistance: number): number
```
-## canHaveChildren — function
+## canHaveChildren — function @experimental
```
(type: BtNodeType): boolean
```
-## canonicalMask — function
+## canonicalMask — function @experimental
```
(mode: TerrainMode, mask: number): number
```
-## catalogFromManifest — function
+## catalogFromManifest — function @experimental
```
(manifest: AddressableManifest): Catalog | undefined
```
-## censusProbeIds — function
+## censusProbeIds — function @experimental
```
(): string[]
```
-## clearAllCaches — function
+## clearAllCaches — function @experimental
```
(): void
```
-## clearAnimatorControllerStore — function
+## clearAnimatorControllerStore — function @experimental
```
(): void
```
-## clearBtStore — function
+## clearBtStore — function @experimental
```
(): void
```
-## clearDrawCallbacks — function
+## clearDrawCallbacks — function @experimental
```
(): void
```
-## clearFsmStore — function
+## clearFsmStore — function @experimental
```
(): void
```
-## clearProjectSideModules — function
+## clearProjectSideModules — function @experimental
```
(): void
```
-## clearTilemapSourceCache — function
+## clearTilemapSourceCache — function @experimental
```
(): void
```
-## clearUserComponents — function
+## clearUserComponents — function @experimental
```
(): void
```
-## cloneComponentData — function
+## cloneComponentData — function @experimental
```
(data: Record<string, unknown>): Record<string, unknown>
```
-## cloneComponents — function
+## cloneComponents — function @experimental
```
(components: ComponentData[]): ComponentData[]
```
-## cloneMetadata — function
+## cloneMetadata — function @experimental
```
(metadata: Record<string, unknown>): Record<string, unknown>
```
-## closeDialog — function
+## closeDialog — function @experimental
```
(world: World, events: UIEventQueue, root: Entity): void
```
-## closeDropdown — function
+## closeDropdown — function @experimental
```
(world: World, e: Entity): void
```
-## col — const
+## col — const @experimental
```
{ readonly create: (r?: number, g?: number, b?: number, a?: number) => Color; readonly rgb: (r: number, g: number, b: number) => Color; readonly from255: (r: number, g: number, b: number, a?: number) => Color; readonly clone: (c: Color) => Color; readonly lerp: (a: Color, b: Color, t: number) => Color; readonly withAlpha: (c: Color, a: number) => Color; readonly multiply: (a: Color, b: Color) => Color; readonly scaleRgb: (c: Color, s: number) => Color; readonly fromHex: (hex: string) => Color; readonly toHex: (c: Color, withAlpha?: boolean) => string; readonly equals: (a: Color, b: Color, epsilon?: number) => boolean; }
```
-## collapseEntry — function
+## collapseEntry — function @experimental
```
(prefab: PrefabData, prefabRef: string, expanded: readonly ProcessedEntity[], rootId: number, sceneParent: number | null, loadPrefab?: SyncPrefabResolver): PrefabInstanceEntry
```
-## collapseInstance — function
+## collapseInstance — function @experimental
```
(prefab: PrefabData, prefabRef: string, expanded: readonly ProcessedEntity[], loadPrefab?: SyncPrefabResolver): PrefabInstanceDelta
```
-## collectExternalEntityRefs — function
+## collectExternalEntityRefs — function @experimental
```
(entities: readonly ExtractEntity[]): ExternalEntityRef[]
```
-## collectGarbage — function
+## collectGarbage — function @experimental
```
(): boolean
```
-## collectNestedPrefabPaths — function
+## collectNestedPrefabPaths — function @experimental
```
(prefab: PrefabData, loadPrefab: (path: string) => PrefabData | null, visited?: Set<string>): string[]
```
-## collidableTileIds — function
+## collidableTileIds — function @experimental
```
(asset: TilesetAsset): number[]
```
-## colliderShapeOutline — function
+## colliderShapeOutline — function @experimental
```
(shape: ColliderShape, center: Vec2, angle: number, ppu: number): ColliderOutline
```
-## collisionRefWithMaterial — function
+## collisionRefWithMaterial — function @experimental
```
(material: CollisionMaterial): string
```
-## color — const
+## color — const @experimental
```
(r?: number, g?: number, b?: number, a?: number) => Color
```
-## compareDrawRank — function
+## compareDrawRank — function @experimental
```
(a: DrawRank, b: DrawRank): number
```
-## compileFsm — function
+## compileFsm — function @experimental
```
(def: FsmDefinition): CompiledFsm
```
@@ -9224,12 +9224,12 @@ BtPlugin
(graph: MaterialGraph): string
```
-## computeEffectiveOrthoSize — function
+## computeEffectiveOrthoSize — function @experimental
```
(baseOrthoSize: number, designAspect: number, actualAspect: number, scaleMode: number, matchWidthOrHeight: number): number
```
-## computeStreaming — function
+## computeStreaming — function @experimental
```
(cells: readonly StreamCell[], focusX: number, focusY: number, loadRadius: number, unloadRadius: number, active: ReadonlySet<string>): StreamDecision
```
@@ -9239,62 +9239,62 @@ BtPlugin
(g: MaterialGraph, fromId: string, toId: string, toSlot: string): MaterialGraph
```
-## contentHashHex — function
+## contentHashHex — function @experimental
```
(data: Uint8Array): string
```
-## contentHashOf — function
+## contentHashOf — function @experimental
```
(data: Uint8Array | string): string
```
-## controllerState — function
+## controllerState — function @experimental
```
(name: string, pages: string[], current?: string): ControllerState
```
-## corePlugin — const
+## corePlugin — const @experimental
```
Plugin
```
-## createAnimClip — function
+## createAnimClip — function @experimental
```
(texture: string, cellWidth: number, cellHeight: number, pageWidth: number, pageHeight: number): AnimClipAssetData
```
-## createBtRunState — function
+## createBtRunState — function @experimental
```
(): BtRunState
```
-## createButton — function
+## createButton — function @experimental
```
(opts: ButtonOptions): ButtonHandle
```
-## createDialog — function
+## createDialog — function @experimental
```
(opts: DialogOptions): DialogHandle
```
-## createDropdown — function
+## createDropdown — function @experimental
```
<T>(opts: DropdownOptions<T>): DropdownHandle<T>
```
-## createEmbeddedSideModuleHost — function
+## createEmbeddedSideModuleHost — function @experimental
```
(registry: EmbeddedSideModuleRegistry): SideModuleHost
```
-## createFetchSideModuleHost — function
+## createFetchSideModuleHost — function @experimental
```
(baseUrl: string): SideModuleHost
```
-## createFsmRunState — function
+## createFsmRunState — function @experimental
```
(fsm: CompiledFsm): FsmRunState
```
@@ -9304,187 +9304,187 @@ Plugin
(module: ESEngineModule, options?: HeadlessAppOptions): App
```
-## createListView — function
+## createListView — function @experimental
```
<T>(opts: CreateListViewOptions<T>): ListViewHandle<T>
```
-## createLocalAchievements — function
+## createLocalAchievements — function @experimental
```
(): AchievementProvider
```
-## createLocalLeaderboard — function
+## createLocalLeaderboard — function @experimental
```
(options?: LocalLeaderboardOptions): LeaderboardProvider
```
-## createMemoryTransportPair — function
+## createMemoryTransportPair — function @experimental
```
(options?: MemoryTransportOptions): [MemoryTransport, MemoryTransport]
```
-## createMockAdProvider — function
+## createMockAdProvider — function @experimental
```
(options?: MockAdProviderOptions): AdProvider
```
-## createPackagedAssetSource — function
+## createPackagedAssetSource — function @experimental
```
(index: PackagedAssetIndex, options?: PackagedAssetSourceOptions): RuntimeAssetSource
```
-## createProgress — function
+## createProgress — function @experimental
```
(opts: ProgressOptions): ProgressHandle
```
-## createRuntimeSceneConfig — function
+## createRuntimeSceneConfig — function @experimental
```
(name: string, sceneData: SceneData | undefined, options: Omit<LoadRuntimeSceneOptions, "sceneData" | "sceneName">, scenePath?: string): SceneConfig
```
-## createScrollView — function
+## createScrollView — function @experimental
```
(opts: ScrollViewOptions): ScrollViewHandle
```
-## createSlider — function
+## createSlider — function @experimental
```
(opts: SliderOptions): SliderHandle
```
-## createSocket — function
+## createSocket — function @experimental
```
(options: GameSocketOptions): PlatformSocket
```
-## createTakeover — function
+## createTakeover — function @experimental
```
(host: TakeoverHost): Takeover
```
-## createTextInput — function
+## createTextInput — function @experimental
```
(opts: TextInputOptions): TextInputHandle
```
-## createTileset — function
+## createTileset — function @experimental
```
(texture: string, tileWidth?: number, tileHeight?: number, columns?: number): TilesetAsset
```
-## createToggle — function
+## createToggle — function @experimental
```
(opts: ToggleOptions): ToggleHandle
```
-## createWeChatSideModuleHost — function
+## createWeChatSideModuleHost — function @experimental
```
(factories: MiniGameSideModuleFactories): SideModuleHost
```
-## createWebApp — function
+## createWebApp — function @experimental
```
(module: ESEngineModule, options?: CreateWebAppOptions): App
```
-## debug — function
+## debug — function @experimental
```
(category: string, message: string, data?: unknown): void
```
-## decodeImageBitmap — function
+## decodeImageBitmap — function @experimental
```
(src: ImageBitmapSource | PlatformImage, flip: boolean): Promise<ImageBitmap>
```
-## decodeImagePixels — function
+## decodeImagePixels — function @experimental
```
(src: ImageBitmapSource): Promise<DecodedPixels>
```
-## decodeTilemapChunks — function
+## decodeTilemapChunks — function @experimental
```
(blob: string): DecodedChunk[]
```
-## defaultFrameStats — function
+## defaultFrameStats — function @experimental
```
(): FrameStats
```
-## defaultPluralSelector — const
+## defaultPluralSelector — const @experimental
```
PluralSelector
```
-## defineBehavior — function
+## defineBehavior — function @experimental
```
<S extends object>(name: string, def: BehaviorDef<S>): ComponentDef<S>
```
-## defineComponent — function
+## defineComponent — function @experimental
```
<T extends object>(name: string, defaults: T, metadata?: ComponentMetadata): ComponentDef<T>
```
-## defineEvent — function
+## defineEvent — function @experimental
```
<T>(name: string): EventDef<T>
```
-## defineInputMap — function
+## defineInputMap — function @experimental
```
(actions: Record<string, ActionDef>): InputMap
```
-## defineResource — function
+## defineResource — function @experimental
```
<T>(defaultValue: T, name?: string): ResourceDef<T>
```
-## defineSystem — function
+## defineSystem — function @experimental
```
<P extends readonly SystemParam[]>(params: [...P], fn: (...args: InferParams<P>) => void | Promise<void>, options?: SystemOptions): SystemDef
```
-## defineSystemSet — function
+## defineSystemSet — function @experimental
```
(name: string, options: SystemSetOptions): SystemSet
```
-## defineTag — function
+## defineTag — function @experimental
```
(name: string): ComponentDef<{}>
```
-## derived — function
+## derived — function @experimental
```
<T>(sources: ReadonlySignal<unknown>[], compute: () => T): ReadonlySignal<T>
```
-## detectAnchor — function
+## detectAnchor — function @experimental
```
(node: UINodeData): AnchorPreset | null
```
-## detectAnchorAxes — function
+## detectAnchorAxes — function @experimental
```
(node: UINodeData): { h: AnchorAxis | null; v: AnchorAxis | null; }
```
-## diagnosticsPlugin — const
+## diagnosticsPlugin — const @experimental
```
DiagnosticsPlugin
```
-## diffAgainstSource — function
+## diffAgainstSource — function @experimental
```
(source: PrefabData, instance: readonly ProcessedEntity[], options?: DiffOptions): { overrides: PrefabOverride[]; untracked: ProcessedEntity[]; orphanedSourceIds: PrefabEntityId[]; }
```
-## diffCensus — function
+## diffCensus — function @experimental
```
(before: Census, after: Census): CensusDelta[]
```
@@ -9494,787 +9494,787 @@ DiagnosticsPlugin
(g: MaterialGraph, toId: string, toSlot: string): MaterialGraph
```
-## discoverSceneAssets — function
+## discoverSceneAssets — function @experimental
```
(sceneData: SceneData, refResolver?: RefResolver): SceneAssetRefs
```
-## dragPlugin — const
+## dragPlugin — const @experimental
```
DragPlugin
```
-## dragonBonesPlugin — const
+## dragonBonesPlugin — const @experimental
```
() => DragonBonesPlugin
```
-## editorViewHalfExtent — function
+## editorViewHalfExtent — function @experimental
```
(view: EditorViewData, aspect: number): { halfW: number; halfH: number; }
```
-## editorViewHalfHeight — function
+## editorViewHalfHeight — function @experimental
```
(view: EditorViewData): number
```
-## emptyAnimatorController — function
+## emptyAnimatorController — function @experimental
```
(): AnimatorControllerDef
```
-## emptyBt — function
+## emptyBt — function @experimental
```
(): BtDefinition
```
-## emptyFsm — function
+## emptyFsm — function @experimental
```
(): FsmDefinition
```
-## encodeTile — function
+## encodeTile — function @experimental
```
(id: number, flags?: TileFlags): number
```
-## ensureBtIds — function
+## ensureBtIds — function @experimental
```
(def: BtDefinition): BtDefinition
```
-## enterStatePath — function
+## enterStatePath — function @experimental
```
(scope: AnimatorScope, name: string): string[]
```
-## enumOptions — function
+## enumOptions — function @experimental
```
(obj: Record<string, unknown>, only?: readonly string[]): ReadonlyArray<{ label: string; value: number; }>
```
-## error — function
+## error — function @experimental
```
(category: string, message: string, data?: unknown): void
```
-## evalGuard — function
+## evalGuard — function @experimental
```
(bb: Blackboard, guard: BlackboardGuard): boolean
```
-## evalGuards — function
+## evalGuards — function @experimental
```
(bb: Blackboard, guards: BlackboardGuard | BlackboardGuard[]): boolean
```
-## evaluateAnimatorPath — function
+## evaluateAnimatorPath — function @experimental
```
(def: AnimatorControllerDef, currentPath: string, params: AnimatorParamValues, triggers: ReadonlySet<string>, clipFinished?: boolean): AnimatorPathEvalResult
```
-## evaluateAnimatorTransitions — function
+## evaluateAnimatorTransitions — function @experimental
```
(def: AnimatorControllerDef, currentState: string, params: AnimatorParamValues, triggers: ReadonlySet<string>, clipFinished?: boolean): AnimatorEvalResult
```
-## evaluateChannel — function
+## evaluateChannel — function @experimental
```
(channel: PropertyChannel, time: number): number
```
-## eventBindingPlugin — const
+## eventBindingPlugin — const @experimental
```
EventBindingPlugin
```
-## evictTextureDimensions — function
+## evictTextureDimensions — function @experimental
```
(handle: number): void
```
-## expandEntry — function
+## expandEntry — function @experimental
```
(prefab: PrefabData, entry: PrefabInstanceEntry, allocateId: () => number, loadPrefab?: SyncPrefabResolver): { entities: ProcessedEntity[]; rootId: number; }
```
-## expandInstance — function
+## expandInstance — function @experimental
```
(prefab: PrefabData, delta: PrefabInstanceDelta, allocateId: () => number, loadPrefab?: SyncPrefabResolver): { entities: ProcessedEntity[]; rootId: number; }
```
-## extractAnimClipTexturePaths — function
+## extractAnimClipTexturePaths — function @experimental
```
(data: AnimClipAssetData): string[]
```
-## extractPrefab — function
+## extractPrefab — function @experimental
```
(entities: readonly ExtractEntity[], rootId: number, name: string, makeId?: (sourceId: number) => PrefabEntityId): PrefabData
```
-## facingFromQuat — function
+## facingFromQuat — function @experimental
```
(z: number, w: number): number
```
-## fetchDecodePixels — function
+## fetchDecodePixels — function @experimental
```
(url: string): Promise<DecodedPixels>
```
-## findControllerOwner — function
+## findControllerOwner — function @experimental
```
(world: World, entity: Entity, name: string): Entity | null
```
-## findEntityByName — function
+## findEntityByName — function @experimental
```
(world: World, name: string): Entity | null
```
-## findPath — function
+## findPath — function @experimental
```
(grid: NavGrid, start: Cell, goal: Cell, opts?: PathfindOptions): Cell[] | null
```
-## fingerprint — function
+## fingerprint — function @experimental
```
(report: DiagnosticReport): string
```
-## finishDeviceRecovery — function
+## finishDeviceRecovery — function @experimental
```
(): void
```
-## flattenPrefab — function
+## flattenPrefab — function @experimental
```
(prefab: PrefabData, overrides: PrefabOverride[], ctx: FlattenContext): FlattenResult
```
-## flipFlagsH — function
+## flipFlagsH — function @experimental
```
(flags: TileFlags): TileFlags
```
-## flipFlagsV — function
+## flipFlagsV — function @experimental
```
(flags: TileFlags): TileFlags
```
-## flipStampH — function
+## flipStampH — function @experimental
```
(s: TileStamp): TileStamp
```
-## flipStampV — function
+## flipStampV — function @experimental
```
(s: TileStamp): TileStamp
```
-## flushPendingSystems — function
+## flushPendingSystems — function @experimental
```
(app: App): void
```
-## focusPlugin — const
+## focusPlugin — const @experimental
```
FocusPlugin
```
-## folderAlwaysInclude — function
+## folderAlwaysInclude — function @experimental
```
(config: AssetGroupsConfig | null | undefined, folder: string): boolean
```
-## folderGroupMode — function
+## folderGroupMode — function @experimental
```
(config: AssetGroupsConfig | null | undefined, folder: string): AssetGroupMode
```
-## formatActionArg — function
+## formatActionArg — function @experimental
```
(params: Readonly<Record<string, AiParamValue>> | undefined, defs: readonly AiParamDef[], separator?: string): string | undefined
```
-## formatCensusDiff — function
+## formatCensusDiff — function @experimental
```
(before: Census, after: Census, all?: boolean): string
```
-## formatCensusReport — function
+## formatCensusReport — function @experimental
```
(report: CensusReport): string
```
-## fsmEdges — function
+## fsmEdges — function @experimental
```
(def: FsmDefinition): FsmEdge[]
```
-## fsmPlugin — const
+## fsmPlugin — const @experimental
```
FsmPlugin
```
-## fxPreviewOrPlayMode — function
+## fxPreviewOrPlayMode — function @experimental
```
(): boolean
```
-## gearBinding — function
+## gearBinding — function @experimental
```
(controller: string, component: string, property: string, pages: Record<string, GearValue>, tween?: GearTween): GearBinding
```
-## getAddressableType — function
+## getAddressableType — function @experimental
```
(path: string): AddressableAssetType | null
```
-## getAddressableTypeByEditorType — function
+## getAddressableTypeByEditorType — function @experimental
```
(editorType: string): AddressableAssetType | null
```
-## getAllAssetExtensions — function
+## getAllAssetExtensions — function @experimental
```
(): Set<string>
```
-## getAllEffectDefs — function
+## getAllEffectDefs — function @experimental
```
(): EffectDef[]
```
-## getAssetBuildTransform — function
+## getAssetBuildTransform — function @experimental
```
(extensionOrPath: string): AssetBuildTransform | undefined
```
-## getAssetMimeType — function
+## getAssetMimeType — function @experimental
```
(ext: string): string | undefined
```
-## getAssetTypeEntry — function
+## getAssetTypeEntry — function @experimental
```
(extensionOrPath: string): AssetTypeEntry | undefined
```
-## getBt — function
+## getBt — function @experimental
```
(key: string): BtDefinition | undefined
```
-## getCacheForEntity — function
+## getCacheForEntity — function @experimental
```
(entityId: number): BitmapCache | undefined
```
-## getComponent — function
+## getComponent — function @experimental
```
(name: string): AnyComponentDef | undefined
```
-## getComponentAssetFieldDescriptors — function
+## getComponentAssetFieldDescriptors — function @experimental
```
(componentType: string): readonly { field: string; type: AssetFieldType; }[]
```
-## getComponentAssetFields — function
+## getComponentAssetFields — function @experimental
```
(componentType: string): string[]
```
-## getComponentDefaults — function
+## getComponentDefaults — function @experimental
```
(typeName: string): Record<string, unknown> | null
```
-## getComponentFieldMeta — function
+## getComponentFieldMeta — function @experimental
```
(name: string): Readonly<Record<string, FieldMeta>>
```
-## getComponentRegistry — function
+## getComponentRegistry — function @experimental
```
(): Map<string, AnyComponentDef>
```
-## getComponentSkeletalFieldDescriptor — function
+## getComponentSkeletalFieldDescriptor — function @experimental
```
(componentType: string): { skeletonField: string; atlasField: string; runtime: string; } | null
```
-## getContextLossGuardInfo — function
+## getContextLossGuardInfo — function @experimental
```
(): { target: string; lostEventsSeen: number; }
```
-## getControllerPage — function
+## getControllerPage — function @experimental
```
(world: World, entity: Entity, name: string): string | null
```
-## getCustomExtensions — function
+## getCustomExtensions — function @experimental
```
(): string[]
```
-## getDefaultContext — function
+## getDefaultContext — function @experimental
```
(): AppContext
```
-## getDeviceIdentity — function
+## getDeviceIdentity — function @experimental
```
(): DeviceIdentity | null
```
-## getDeviceLostReport — function
+## getDeviceLostReport — function @experimental
```
(): string
```
-## getDeviceStatus — function
+## getDeviceStatus — function @experimental
```
(): number
```
-## getEditorType — function
+## getEditorType — function @experimental
```
(path: string): EditorAssetType
```
-## getEffectDef — function
+## getEffectDef — function @experimental
```
(type: string): EffectDef | undefined
```
-## getEffectTypes — function
+## getEffectTypes — function @experimental
```
(): string[]
```
-## getFsm — function
+## getFsm — function @experimental
```
(key: string): CompiledFsm | undefined
```
-## getLogger — function
+## getLogger — function @experimental
```
(): Logger
```
-## getPlatform — function
+## getPlatform — function @experimental
```
(): PlatformAdapter
```
-## getPlatformType — function
+## getPlatformType — function @experimental
```
(): PlatformAdapter["name"] | null
```
-## getRegisteredAnimatorController — function
+## getRegisteredAnimatorController — function @experimental
```
(key: string): AnimatorControllerDef | undefined
```
-## getReplicatedFields — function
+## getReplicatedFields — function @experimental
```
(name: string): readonly string[]
```
-## getResourceManager — function
+## getResourceManager — function @experimental
```
(): CppResourceManager | null
```
-## getResourceStats — function
+## getResourceStats — function @experimental
```
(): ResourceStats | null
```
-## getTextureDimensions — function
+## getTextureDimensions — function @experimental
```
(handle: number): TextureDimensions | null
```
-## getTheme — function
+## getTheme — function @experimental
```
(): ThemeTokens
```
-## getTilemapSource — function
+## getTilemapSource — function @experimental
```
(path: string): LoadedTilemapSource | undefined
```
-## getUserComponent — function
+## getUserComponent — function @experimental
```
(name: string): ComponentDef<any> | undefined
```
-## getUserComponentFingerprint — function
+## getUserComponentFingerprint — function @experimental
```
(): string
```
-## getUserComponents — function
+## getUserComponents — function @experimental
```
(): Map<string, AnyComponentDef>
```
-## getWeChatPackOptions — function
+## getWeChatPackOptions — function @experimental
```
(): Array<{ type: string; value: string; }>
```
-## hasPlayableCta — function
+## hasPlayableCta — function @experimental
```
(): boolean
```
-## hasVisibility — function
+## hasVisibility — function @experimental
```
(world: World, entity: Entity): boolean
```
-## headlessBasePlugins — const
+## headlessBasePlugins — const @experimental
```
() => Plugin[]
```
-## imageBitmapOptions — function
+## imageBitmapOptions — function @experimental
```
(flip: boolean): ImageBitmapOptions
```
-## indexPackagedManifest — function
+## indexPackagedManifest — function @experimental
```
(manifest: AddressableManifest): PackagedAssetIndex
```
-## info — function
+## info — function @experimental
```
(category: string, message: string, data?: unknown): void
```
-## initPlayRealmRuntime — function
+## initPlayRealmRuntime — function @experimental
```
(config: PlayRealmRuntimeConfig): Promise<void>
```
-## initPlayableRuntime — function
+## initPlayableRuntime — function @experimental
```
(config: PlayableRuntimeConfig): Promise<void>
```
-## initRuntime — function
+## initRuntime — function @experimental
```
(config: RuntimeInitConfig): Promise<void>
```
-## inputEventCallbacks — function
+## inputEventCallbacks — function @experimental
```
(state: InputState): InputEventCallbacks
```
-## inputPlugin — const
+## inputPlugin — const @experimental
```
InputPlugin
```
-## inputRouter — const
+## inputRouter — const @experimental
```
InputRouter
```
-## installEditorGrid — function
+## installEditorGrid — function @experimental
```
(app: App): void
```
-## instantiatePrefab — function
+## instantiatePrefab — function @experimental
```
(world: World, prefab: PrefabData, options?: InstantiatePrefabOptions): Promise<InstantiatePrefabResult>
```
-## interactionController — function
+## interactionController — function @experimental
```
(pages?: string[]): ControllerState
```
-## interpolate — function
+## interpolate — function @experimental
```
(template: string, params?: TParams): string
```
-## intersectRects — function
+## intersectRects — function @experimental
```
(a: ScreenRect, b: ScreenRect): ScreenRect
```
-## invertMatrix4 — function
+## invertMatrix4 — function @experimental
```
(m: Float32Array, result?: Float32Array): Float32Array
```
-## invokeAction — function
+## invokeAction — function @experimental
```
<Ctx>(registry: AiRegistry<Ctx>, name: string, ctx: Ctx, bb: Blackboard, input?: AiActionInput): void | Status
```
-## isAuto — const
+## isAuto — const @experimental
```
(d: Dimension) => boolean
```
-## isBuiltinComponent — function
+## isBuiltinComponent — function @experimental
```
(comp: AnyComponentDef): comp is BuiltinComponentDef<any>
```
-## isCollisionPaletteRef — function
+## isCollisionPaletteRef — function @experimental
```
(refs: readonly string[]): boolean
```
-## isCustomExtension — function
+## isCustomExtension — function @experimental
```
(path: string): boolean
```
-## isDialogOpen — function
+## isDialogOpen — function @experimental
```
(world: World, root: Entity): boolean
```
-## isDropdownOpen — function
+## isDropdownOpen — function @experimental
```
(world: World, e: Entity): boolean
```
-## isEditor — function
+## isEditor — function @experimental
```
(): boolean
```
-## isEmptyStamp — function
+## isEmptyStamp — function @experimental
```
(s: TileStamp): boolean
```
-## isEntityActive — function
+## isEntityActive — function @experimental
```
(world: World, entity: Entity): boolean
```
-## isEntityVisible — function
+## isEntityVisible — function @experimental
```
(world: World, entity: Entity): boolean
```
-## isFxEditPreview — function
+## isFxEditPreview — function @experimental
```
(): boolean
```
-## isHexOrientation — function
+## isHexOrientation — function @experimental
```
(orientation: number): boolean
```
-## isKnownAssetExtension — function
+## isKnownAssetExtension — function @experimental
```
(ext: string): boolean
```
-## isNative — function
+## isNative — function @experimental
```
(): boolean
```
-## isNonOrthogonal — function
+## isNonOrthogonal — function @experimental
```
(orientation: number): boolean
```
-## isPlatformInitialized — function
+## isPlatformInitialized — function @experimental
```
(): boolean
```
-## isPlayMode — function
+## isPlayMode — function @experimental
```
(): boolean
```
-## isRuntime — function
+## isRuntime — function @experimental
```
(): boolean
```
-## isTextureRef — function
+## isTextureRef — function @experimental
```
(v: UniformValue): v is TextureRef
```
-## isWeChat — function
+## isWeChat — function @experimental
```
(): boolean
```
-## isWeb — function
+## isWeb — function @experimental
```
(): boolean
```
-## layerFrontness — function
+## layerFrontness — function @experimental
```
(order: LayerOrder, worldY: number, worldZ: number): number
```
-## layerOrderOf — function
+## layerOrderOf — function @experimental
```
(layer: number, ySortMask: number, depthMask: number): LayerOrder
```
-## leafStateOf — function
+## leafStateOf — function @experimental
```
(def: AnimatorControllerDef, path: string): AnimatorState | null
```
-## lifecyclePlugin — const
+## lifecyclePlugin — const @experimental
```
LifecyclePlugin
```
-## loadComponent — function
+## loadComponent — function @experimental
```
(world: World, entity: Entity, compData: SceneComponentData, entityName?: string): void
```
-## loadInputMapAsset — function
+## loadInputMapAsset — function @experimental
```
(asset: InputMapAsset): InputMap
```
-## loadPackagedAssetIndex — function
+## loadPackagedAssetIndex — function @experimental
```
(manifestPath?: string): Promise<PackagedAssetIndex>
```
-## loadPhysicsModule — function
+## loadPhysicsModule — function @experimental
```
(wasmUrl: string, factory?: PhysicsModuleFactory): Promise<PhysicsWasmModule>
```
-## loadRuntimeScene — function
+## loadRuntimeScene — function @experimental
```
(options: LoadRuntimeSceneOptions): Promise<void>
```
-## loadSceneData — function
+## loadSceneData — function @experimental
```
(world: World, sceneData: SceneData): Map<number, Entity>
```
-## loadSceneWithAssets — function
+## loadSceneWithAssets — function @experimental
```
(world: World, sceneData: SceneData, options?: SceneLoadOptions): Promise<Map<number, Entity>>
```
-## loadTiledMap — function
+## loadTiledMap — function @experimental
```
(world: World, mapData: TiledMapData, textureHandles: Map<string, number>, options?: TilemapLoadOptions): Entity[]
```
-## localizationPlugin — const
+## localizationPlugin — const @experimental
```
LocalizationPlugin
```
-## log — const
+## log — const @experimental
```
Logger
```
-## looksLikeAssetPath — function
+## looksLikeAssetPath — function @experimental
```
(value: unknown): value is string
```
-## makeLosCheck — function
+## makeLosCheck — function @experimental
```
(physics: PhysicsAPI): LosCheck
```
-## makeWidgetInteractable — function
+## makeWidgetInteractable — function @experimental
```
(world: World, entity: Entity, init?: WidgetInteractionInit): void
```
-## markThemed — function
+## markThemed — function @experimental
```
(world: World, entity: Entity, style: ThemeStyleData): void
```
-## matchLocale — function
+## matchLocale — function @experimental
```
(tag: string, available: readonly string[]): string | null
```
-## maxChildren — function
+## maxChildren — function @experimental
```
(type: BtNodeType): number
```
-## measureText — function
+## measureText — function @experimental
```
(text: string, opts: MeasureTextOptions): TextMetrics
```
-## mesh2dPlugin — const
+## mesh2dPlugin — const @experimental
```
Mesh2DPlugin
```
-## messageOf — function
+## messageOf — function @experimental
```
(error: unknown): string
```
-## migratePrefabData — function
+## migratePrefabData — function @experimental
```
(raw: unknown): MigrationResult
```
-## migrateSaveData — function
+## migrateSaveData — function @experimental
```
(version: number, data: unknown, currentVersion: number, migrations: Record<number, SaveMigration>): unknown
```
-## migrateSceneData — function
+## migrateSceneData — function @experimental
```
(raw: SceneData): SceneMigrationResult
```
-## modeToDelivery — function
+## modeToDelivery — function @experimental
```
(mode: AssetGroupMode): BundleMode
```
-## moveAnimatorState — function
+## moveAnimatorState — function @experimental
```
(def: AnimatorControllerDef, name: string, x: number, y: number): AnimatorControllerDef
```
-## moveBtNode — function
+## moveBtNode — function @experimental
```
(def: BtDefinition, id: string, x: number, y: number): BtDefinition
```
@@ -10284,22 +10284,22 @@ Mesh2DPlugin
(g: MaterialGraph, id: string, x: number, y: number): MaterialGraph
```
-## moveState — function
+## moveState — function @experimental
```
(def: FsmDefinition, name: string, x: number, y: number): FsmDefinition
```
-## navGridFromTilemapLayer — function
+## navGridFromTilemapLayer — function @experimental
```
(entity: Entity, opts: BuildNavGridOptions): NavGrid
```
-## navGridFromTiles — function
+## navGridFromTiles — function @experimental
```
(getTile: (x: number, y: number) => number, opts: BuildNavGridOptions): NavGrid
```
-## navPlugin — const
+## navPlugin — const @experimental
```
NavPlugin
```
@@ -10309,382 +10309,382 @@ NavPlugin
(): MaterialGraph
```
-## normalizeAngle — function
+## normalizeAngle — function @experimental
```
(a: number): number
```
-## normalizeBundleMode — function
+## normalizeBundleMode — function @experimental
```
(mode: string | undefined | null): BundleMode
```
-## normalizeCornerMask — function
+## normalizeCornerMask — function @experimental
```
(mask: number): number
```
-## openDialog — function
+## openDialog — function @experimental
```
(world: World, events: UIEventQueue, root: Entity): void
```
-## openDropdown — function
+## openDropdown — function @experimental
```
(world: World, events: UIEventQueue, e: Entity): void
```
-## orientationPerm — function
+## orientationPerm — function @experimental
```
(flags: TileFlags): Perm
```
-## packCorners — function
+## packCorners — function @experimental
```
(tl: number, tr: number, br: number, bl: number): number
```
-## packagedAppOptions — function
+## packagedAppOptions — function @experimental
```
(config: Pick<PackagedGameConfig, "ySortLayers" | "depthLayers" | "colorSpace" | "screenFit">): { ySortLayers?: number; depthLayers?: number; colorSpace?: "gamma" | "linear"; screenFit?: PackagedGameConfig["screenFit"]; }
```
-## packagedRuntimeInit — function
+## packagedRuntimeInit — function @experimental
```
(config: Pick<PackagedGameConfig, "physicsEnabled" | "physicsConfig" | "audioConfig" | "uiTheme" | "uiThemeColors" | "achievements" | "steamAppId" | "screenFit">): { physicsEnabled?: boolean; physicsConfig?: PhysicsPluginConfig; audioConfig?: AudioProjectConfig; uiTheme?: "light"; uiThemeOverrides?: ThemeOverrides; achievements?: string[]; steamAppId?: number; screenFit?: PackagedGameConfig["screenFit"]; }
```
-## paramDefaultValue — function
+## paramDefaultValue — function @experimental
```
(param: ShaderParam): unknown
```
-## parseActionArg — function
+## parseActionArg — function @experimental
```
(arg: string | undefined, params: readonly AiParamDef[], separator?: string): Record<string, AiParamValue>
```
-## parseAnimClipAsset — function
+## parseAnimClipAsset — function @experimental
```
(rawJson: unknown): AnimClipAssetData
```
-## parseAnimClipData — function
+## parseAnimClipData — function @experimental
```
(clipPath: string, data: AnimClipAssetData, textureHandles: Map<string, number>): SpriteAnimClip
```
-## parseAnimationClip — function
+## parseAnimationClip — function @experimental
```
(rawJson: unknown): TimelineAsset
```
-## parseAudioProjectConfig — function
+## parseAudioProjectConfig — function @experimental
```
(raw: unknown): AudioProjectConfig
```
-## parseBusEffects — function
+## parseBusEffects — function @experimental
```
(raw: unknown): BusEffectDef[]
```
-## parseCollisionMaterial — function
+## parseCollisionMaterial — function @experimental
```
(refs: readonly string[]): CollisionMaterial
```
-## parseLocaleTable — function
+## parseLocaleTable — function @experimental
```
(text: string, path: string): LocaleTableAsset
```
-## parseRichText — function
+## parseRichText — function @experimental
```
(input: string): RichTextRun[]
```
-## parseThemeOverrides — function
+## parseThemeOverrides — function @experimental
```
(colors?: Record<string, string>): ThemeOverrides | undefined
```
-## parseTileset — function
+## parseTileset — function @experimental
```
(rawJson: unknown): TilesetAsset
```
-## parseTimelineAsset — function
+## parseTimelineAsset — function @experimental
```
(rawJson: unknown): TimelineAsset
```
-## parseTmjJson — function
+## parseTmjJson — function @experimental
```
(json: Record<string, unknown>): TiledMapData | null
```
-## parseTmjWithExternals — function
+## parseTmjWithExternals — function @experimental
```
(json: Record<string, unknown>, resolveExternal: (source: string) => Promise<string>): Promise<TiledMapData | null>
```
-## particlePlugin — const
+## particlePlugin — const @experimental
```
ParticlePlugin
```
-## pathToWorld — function
+## pathToWorld — function @experimental
```
(grid: NavGrid, path: Cell[]): Vec2[]
```
-## percent — const
+## percent — const @experimental
```
(n: number) => Dimension
```
-## perceptionPlugin — const
+## perceptionPlugin — const @experimental
```
PerceptionPlugin
```
-## platformFetch — function
+## platformFetch — function @experimental
```
(url: string, options?: PlatformRequestOptions): Promise<PlatformResponse>
```
-## platformFileExists — function
+## platformFileExists — function @experimental
```
(path: string): Promise<boolean>
```
-## platformInstantiateWasm — function
+## platformInstantiateWasm — function @experimental
```
(pathOrBuffer: string | ArrayBuffer, imports: WebAssembly.Imports): Promise<WasmInstantiateResult>
```
-## platformReadFile — function
+## platformReadFile — function @experimental
```
(path: string): Promise<ArrayBuffer>
```
-## platformReadTextFile — function
+## platformReadTextFile — function @experimental
```
(path: string): Promise<string>
```
-## playModeOnly — function
+## playModeOnly — function @experimental
```
(): boolean
```
-## playableCta — function
+## playableCta — function @experimental
```
(): void
```
-## pointInHitArea — function
+## pointInHitArea — function @experimental
```
(px: number, py: number, area: HitAreaShape): boolean
```
-## pointInOBB — function
+## pointInOBB — function @experimental
```
(px: number, py: number, worldX: number, worldY: number, worldW: number, worldH: number, pivotX: number, pivotY: number, rotationZ: number, rotationW: number): boolean
```
-## pointInWorldRect — function
+## pointInWorldRect — function @experimental
```
(px: number, py: number, worldX: number, worldY: number, worldW: number, worldH: number, pivotX: number, pivotY: number): boolean
```
-## postProcessPlugin — const
+## postProcessPlugin — const @experimental
```
PostProcessPlugin
```
-## prefabsPlugin — const
+## prefabsPlugin — const @experimental
```
PrefabsPlugin
```
-## preloadNestedPrefabs — function
+## preloadNestedPrefabs — function @experimental
```
(prefab: PrefabData, loadPrefab: (path: string) => Promise<PrefabData>, cache: Map<string, PrefabData>, visited?: Set<string>, depth?: number): Promise<void>
```
-## previewPlugin — function
+## previewPlugin — function @experimental
```
(sceneUrl: string, baseUrl?: string): PreviewPlugin
```
-## probeRegistrations — function
+## probeRegistrations — function @experimental
```
(register: () => Promise<void>): Promise<ProbedRegistrations>
```
-## projectSideModuleIds — function
+## projectSideModuleIds — function @experimental
```
(): string[]
```
-## px — const
+## px — const @experimental
```
(n: number) => Dimension
```
-## quat — const
+## quat — const @experimental
```
(w?: number, x?: number, y?: number, z?: number) => Quat
```
-## quaternionToAngle2D — function
+## quaternionToAngle2D — function @experimental
```
(rz: number, rw: number): number
```
-## radiusInterest — function
+## radiusInterest — function @experimental
```
(radius: number, options?: RadiusInterestOptions): InterestPolicy
```
-## readColliderShapes — function
+## readColliderShapes — function @experimental
```
(world: World, entity: number): ColliderInstance[]
```
-## readFieldPath — function
+## readFieldPath — function @experimental
```
(data: Record<string, unknown>, path: string): unknown
```
-## readPtrField — function
+## readPtrField — function @experimental
```
(f32: Float32Array, u32: Uint32Array, u8: Uint8Array, ptr: number, field: PtrFieldDesc): unknown
```
-## rebuildChildren — function
+## rebuildChildren — function @experimental
```
(entities: ProcessedEntity[]): void
```
-## recoverDevice — function
+## recoverDevice — function @experimental
```
(): boolean
```
-## reflectEsshader — function
+## reflectEsshader — function @experimental
```
(source: string): ShaderReflection
```
-## registerAction — function
+## registerAction — function @experimental
```
(name: string, fn: AiAction<AiContext>): void
```
-## registerAnimatorController — function
+## registerAnimatorController — function @experimental
```
(key: string, def: AnimatorControllerDef): void
```
-## registerAssetBuildTransform — function
+## registerAssetBuildTransform — function @experimental
```
(editorType: EditorAssetType, transform: AssetBuildTransform): void
```
-## registerBt — function
+## registerBt — function @experimental
```
(key: string, def: BtDefinition): BtDefinition
```
-## registerCensusProbe — function
+## registerCensusProbe — function @experimental
```
(probe: CensusProbe): () => void
```
-## registerComponent — function
+## registerComponent — function @experimental
```
(name: string, def: AnyComponentDef): void
```
-## registerCondition — function
+## registerCondition — function @experimental
```
(name: string, fn: AiCondition<AiContext>): void
```
-## registerDrawCallback — function
+## registerDrawCallback — function @experimental
```
(id: string, fn: DrawCallback, scene?: string): void
```
-## registerFsm — function
+## registerFsm — function @experimental
```
(key: string, def: FsmDefinition): CompiledFsm
```
-## registerPackagedSideModules — function
+## registerPackagedSideModules — function @experimental
```
(config: Pick<PackagedGameConfig, "sideModules">): void
```
-## registerPreSceneDrawCallback — function
+## registerPreSceneDrawCallback — function @experimental
```
(id: string, fn: PreSceneDrawCallback): void
```
-## registerSceneComponentCodec — function
+## registerSceneComponentCodec — function @experimental
```
(type: string, codec: SceneComponentCodec): void
```
-## registerSideModule — function
+## registerSideModule — function @experimental
```
(id: string, descriptor: SideModuleDescriptor): void
```
-## registerTilemapSource — function
+## registerTilemapSource — function @experimental
```
(path: string, data: LoadedTilemapSource): void
```
-## registerTimelineAsset — function
+## registerTimelineAsset — function @experimental
```
(path: string, asset: TimelineAsset): void
```
-## remapComponentEntityRefs — function
+## remapComponentEntityRefs — function @experimental
```
(components: ComponentData[], idMapping: Map<PrefabEntityId, number>): void
```
-## remapEntityFields — function
+## remapEntityFields — function @experimental
```
(compData: SceneComponentData, entityMap: Map<number, Entity>): void
```
-## removeAnimatorParam — function
+## removeAnimatorParam — function @experimental
```
(def: AnimatorControllerDef, name: string): AnimatorControllerDef
```
-## removeAnimatorState — function
+## removeAnimatorState — function @experimental
```
(def: AnimatorControllerDef, name: string): AnimatorControllerDef
```
-## removeAnimatorTransition — function
+## removeAnimatorTransition — function @experimental
```
(def: AnimatorControllerDef, from: string, index: number): AnimatorControllerDef
```
-## removeBtNode — function
+## removeBtNode — function @experimental
```
(def: BtDefinition, id: string): BtDefinition
```
-## removeCacheForEntity — function
+## removeCacheForEntity — function @experimental
```
(entityId: number): BitmapCache | undefined
```
@@ -10694,107 +10694,107 @@ PrefabsPlugin
(g: MaterialGraph, id: string): MaterialGraph
```
-## removeState — function
+## removeState — function @experimental
```
(def: FsmDefinition, name: string): FsmDefinition
```
-## removeTransition — function
+## removeTransition — function @experimental
```
(def: FsmDefinition, from: string, index: number): FsmDefinition
```
-## renameAnimatorState — function
+## renameAnimatorState — function @experimental
```
(def: AnimatorControllerDef, oldName: string, newName: string): AnimatorControllerDef
```
-## renameState — function
+## renameState — function @experimental
```
(def: FsmDefinition, oldName: string, newName: string): FsmDefinition
```
-## reparentBtNode — function
+## reparentBtNode — function @experimental
```
(def: BtDefinition, id: string, newParentId: string): BtDefinition
```
-## replicationPlugin — const
+## replicationPlugin — const @experimental
```
ReplicationPlugin
```
-## reportDeviceLost — function
+## reportDeviceLost — function @experimental
```
(reason: number, message: string): void
```
-## requireResourceManager — function
+## requireResourceManager — function @experimental
```
(): CppResourceManager
```
-## resetWorldTo — function
+## resetWorldTo — function @experimental
```
(world: World, sceneData: SceneData): Map<number, Entity>
```
-## resolveAssetGroup — function
+## resolveAssetGroup — function @experimental
```
(projectRelPath: string, config: AssetGroupsConfig | null | undefined): ResolvedAssetGroup
```
-## resolveAtlas — function
+## resolveAtlas — function @experimental
```
(projectRelPath: string, config: AssetGroupsConfig | null | undefined): ResolvedAtlas | null
```
-## resolveAutotile — function
+## resolveAutotile — function @experimental
```
(index: TerrainIndex, neighbors: readonly boolean[]): number
```
-## resolveBindingTarget — function
+## resolveBindingTarget — function @experimental
```
(world: World, from: Entity, name: string): Entity | null
```
-## resolveChildEntity — function
+## resolveChildEntity — function @experimental
```
(world: Pick<World, "tryGet">, rootEntity: Entity, childPath: string): Entity | null
```
-## resolveParams — function
+## resolveParams — function @experimental
```
(def: AnimatorControllerDef, overrides: ReadonlyMap<string, number | boolean>): Record<string, number | boolean>
```
-## resolveRelativePath — function
+## resolveRelativePath — function @experimental
```
(basePath: string, relativePath: string): string
```
-## resolveThemeTokens — function
+## resolveThemeTokens — function @experimental
```
(base: "dark" | "light", overrides?: ThemeOverrides): ThemeTokens
```
-## resolveTilesetModel — function
+## resolveTilesetModel — function @experimental
```
(tilesets: ResolvedTileset[]): TilesetModel
```
-## resolveWang — function
+## resolveWang — function @experimental
```
(index: WangIndex, corners: readonly number[]): number
```
-## rotateFlagsCW — function
+## rotateFlagsCW — function @experimental
```
(flags: TileFlags): TileFlags
```
-## rotateStampCW — function
+## rotateStampCW — function @experimental
```
(s: TileStamp): TileStamp
```
@@ -10804,617 +10804,617 @@ ReplicationPlugin
(app: App, options?: { fps?: number; }): () => void
```
-## safeAreaPlugin — const
+## safeAreaPlugin — const @experimental
```
SafeAreaPlugin
```
-## sampleTimeline — function
+## sampleTimeline — function @experimental
```
(asset: TimelineAsset, time: number, rootEntity: Entity, deps: SampleDeps, opts?: SampleOptions): void
```
-## sampleTimelineInWorld — function
+## sampleTimelineInWorld — function @experimental
```
(asset: TimelineAsset, time: number, world: SampleWorld & Pick<World, "tryGet">, rootEntity: Entity, opts?: SampleOptions): void
```
-## scalar — const
+## scalar — const @experimental
```
{ readonly clamp: (x: number, min: number, max: number) => number; readonly clamp01: (x: number) => number; readonly lerp: (a: number, b: number, t: number) => number; readonly inverseLerp: (a: number, b: number, value: number) => number; readonly remap: (value: number, inMin: number, inMax: number, outMin: number, outMax: number) => number; readonly deg2rad: (deg: number) => number; readonly rad2deg: (rad: number) => number; readonly approximately: (a: number, b: number, epsilon?: number) => boolean; readonly smoothstep: (edge0: number, edge1: number, x: number) => number; readonly mod: (x: number, n: number) => number; readonly sign: (x: number) => number; }
```
-## sceneManagerPlugin — const
+## sceneManagerPlugin — const @experimental
```
Plugin
```
-## sceneUsesI18n — function
+## sceneUsesI18n — function @experimental
```
(sceneData: SceneData): boolean
```
-## screenToUiWorld — function
+## screenToUiWorld — function @experimental
```
(camera: UICameraData, screenGLX: number, screenGLY: number): { x: number; y: number; }
```
-## screenToWorld — function
+## screenToWorld — function @experimental
```
(screenX: number, screenY: number, inverseVP: Float32Array, vpX: number, vpY: number, vpW: number, vpH: number, planeZ?: number): { x: number; y: number; }
```
-## selectBlendClip — function
+## selectBlendClip — function @experimental
```
(blend: AnimatorBlend1D, value: number): AnimatorBlendThreshold
```
-## selectPluralForm — function
+## selectPluralForm — function @experimental
```
(forms: PluralForms, count: number, selector: PluralSelector): string
```
-## senseTarget — function
+## senseTarget — function @experimental
```
(ox: number, oy: number, facing: number, tx: number, ty: number, range: number, halfFov: number, isBlocked?: (ox: number, oy: number, tx: number, ty: number) => boolean): SenseResult
```
-## serializeAnimClip — function
+## serializeAnimClip — function @experimental
```
(asset: AnimClipAssetData): Record<string, unknown>
```
-## serializeScene — function
+## serializeScene — function @experimental
```
(world: World, sceneName?: string): SceneData
```
-## serializeTileset — function
+## serializeTileset — function @experimental
```
(asset: TilesetAsset): Record<string, unknown>
```
-## serializeTimelineAsset — function
+## serializeTimelineAsset — function @experimental
```
(asset: TimelineAsset): Record<string, unknown>
```
-## serializeTimelineToJson — function
+## serializeTimelineToJson — function @experimental
```
(asset: TimelineAsset, indent?: number): string
```
-## servicesPlugin — const
+## servicesPlugin — const @experimental
```
ServicesPlugin
```
-## setAnimatorConditions — function
+## setAnimatorConditions — function @experimental
```
(def: AnimatorControllerDef, from: string, index: number, conditions: AnimatorCondition[]): AnimatorControllerDef
```
-## setAnimatorInitial — function
+## setAnimatorInitial — function @experimental
```
(def: AnimatorControllerDef, name: string): AnimatorControllerDef
```
-## setAnimatorStateClip — function
+## setAnimatorStateClip — function @experimental
```
(def: AnimatorControllerDef, name: string, clip: string): AnimatorControllerDef
```
-## setAnimatorStateProps — function
+## setAnimatorStateProps — function @experimental
```
(def: AnimatorControllerDef, name: string, patch: { speed?: number; loop?: boolean; }): AnimatorControllerDef
```
-## setBtNodeField — function
+## setBtNodeField — function @experimental
```
(def: BtDefinition, id: string, patch: Partial<BtNode>): BtDefinition
```
-## setButtonState — function
+## setButtonState — function @experimental
```
(world: World, entity: Entity, state: string): void
```
-## setCacheForEntity — function
+## setCacheForEntity — function @experimental
```
(entityId: number, cache: BitmapCache): void
```
-## setControllerPage — function
+## setControllerPage — function @experimental
```
(world: World, entity: Entity, name: string, page: string): boolean
```
-## setDefaultContext — function
+## setDefaultContext — function @experimental
```
(ctx: AppContext): void
```
-## setEditorMode — function
+## setEditorMode — function @experimental
```
(active: boolean): void
```
-## setEditorViewHalfHeight — function
+## setEditorViewHalfHeight — function @experimental
```
(view: EditorViewData, halfH: number): void
```
-## setEntityActive — function
+## setEntityActive — function @experimental
```
(world: World, entity: Entity, active: boolean): void
```
-## setEntityVisible — function
+## setEntityVisible — function @experimental
```
(world: World, entity: Entity, visible: boolean): void
```
-## setFxEditPreview — function
+## setFxEditPreview — function @experimental
```
(enabled: boolean): void
```
-## setInitial — function
+## setInitial — function @experimental
```
(def: FsmDefinition, name: string): FsmDefinition
```
-## setLogLevel — function
+## setLogLevel — function @experimental
```
(level: LogLevel): void
```
-## setNavDestination — function
+## setNavDestination — function @experimental
```
(world: World, entity: Entity, target: Vec2): void
```
-## setPlayMode — function
+## setPlayMode — function @experimental
```
(active: boolean): void
```
-## setStateHook — function
+## setStateHook — function @experimental
```
(def: FsmDefinition, name: string, hook: "onEnter" | "onUpdate" | "onExit", action: string, arg?: string, params?: Record<string, AiParamValue>): FsmDefinition
```
-## setTextureBudget — function
+## setTextureBudget — function @experimental
```
(bytes: number): void
```
-## setTextureFilter — function
+## setTextureFilter — function @experimental
```
(textureId: number, filter: TextureFilter): void
```
-## setTextureParams — function
+## setTextureParams — function @experimental
```
(textureId: number, minFilter: TextureFilter, magFilter: TextureFilter, wrapS: TextureWrap, wrapT: TextureWrap): void
```
-## setTextureSliceBorder — function
+## setTextureSliceBorder — function @experimental
```
(textureId: number, left: number, right: number, top: number, bottom: number): void
```
-## setTextureWrap — function
+## setTextureWrap — function @experimental
```
(textureId: number, wrap: TextureWrap): void
```
-## setTheme — function
+## setTheme — function @experimental
```
(tokens: ThemeTokens): void
```
-## setUIVisible — function
+## setUIVisible — function @experimental
```
(world: World, entity: Entity, visible: boolean): void
```
-## setViewTarget — function
+## setViewTarget — function @experimental
```
(host: CameraDirectorHost, entity: number, opts?: { time?: number; curve?: number; }): void
```
-## setWasmErrorHandler — function
+## setWasmErrorHandler — function @experimental
```
(handler: WasmErrorHandler | null): void
```
-## shakeCamera — function
+## shakeCamera — function @experimental
```
(host: CameraDirectorHost, opts?: { amplitude?: number; rotation?: number; frequency?: number; duration?: number; }): void
```
-## shapeCenter — function
+## shapeCenter — function @experimental
```
(shape: ColliderShape, worldPos: Vec2, angle: number, ppu: number): Vec2
```
-## shapeOffset — function
+## shapeOffset — function @experimental
```
(shape: ColliderShape): Vec2
```
-## shutdownDrawAPI — function
+## shutdownDrawAPI — function @experimental
```
(): void
```
-## shutdownGLDebugAPI — function
+## shutdownGLDebugAPI — function @experimental
```
(): void
```
-## shutdownGeometryAPI — function
+## shutdownGeometryAPI — function @experimental
```
(): void
```
-## shutdownMaterialAPI — function
+## shutdownMaterialAPI — function @experimental
```
(): void
```
-## shutdownRendererAPI — function
+## shutdownRendererAPI — function @experimental
```
(): void
```
-## shutdownResourceManager — function
+## shutdownResourceManager — function @experimental
```
(): void
```
-## sideModuleDescriptor — function
+## sideModuleDescriptor — function @experimental
```
(id: SideModuleId): SideModuleDescriptor | undefined
```
-## signal — function
+## signal — function @experimental
```
<T>(initial: T): Signal<T>
```
-## singleStamp — function
+## singleStamp — function @experimental
```
(raw: number): TileStamp
```
-## spawnUIEntity — function
+## spawnUIEntity — function @experimental
```
(init: UIEntityInit): Entity
```
-## spineModuleId — function
+## spineModuleId — function @experimental
```
(version: SpineVersion): SideModuleId
```
-## stackOf — function
+## stackOf — function @experimental
```
(error: unknown): string | undefined
```
-## statsPlugin — const
+## statsPlugin — const @experimental
```
StatsPlugin
```
-## stepFsm — function
+## stepFsm — function @experimental
```
<Ctx>(fsm: CompiledFsm, run: FsmRunState, ctx: Ctx, bb: Blackboard, registry: AiRegistry<Ctx>): boolean
```
-## stepPerception — function
+## stepPerception — function @experimental
```
(world: PerceptionWorldView, isBlocked?: LosCheck): void
```
-## stopNavAgent — function
+## stopNavAgent — function @experimental
```
(world: World, entity: Entity): void
```
-## switchTheme — function
+## switchTheme — function @experimental
```
(world: World, tokens: ThemeTokens): void
```
-## takeCensus — function
+## takeCensus — function @experimental
```
(ctx?: CensusContext): Census
```
-## textInputPlugin — const
+## textInputPlugin — const @experimental
```
TextInputPlugin
```
-## textPlugin — const
+## textPlugin — const @experimental
```
TextPlugin
```
-## textureImportSettingsFrom — function
+## textureImportSettingsFrom — function @experimental
```
(importer: Record<string, unknown> | undefined | null): ParsedTextureImportSettings | undefined
```
-## themeButtonStates — function
+## themeButtonStates — function @experimental
```
(): Record<string, ButtonStateVisual>
```
-## themeColors — function
+## themeColors — function @experimental
```
(): ThemeColors
```
-## themeType — function
+## themeType — function @experimental
```
(): ThemeType
```
-## tickBt — function
+## tickBt — function @experimental
```
<Ctx>(def: BtDefinition, ctx: Ctx, bb: Blackboard, registry: AiRegistry<Ctx>, rs: BtRunState, dt: number): Status
```
-## tileCellCenter — function
+## tileCellCenter — function @experimental
```
(p: TileGridParams, tx: number, ty: number): Vec2Like
```
-## tileCellOutline — function
+## tileCellOutline — function @experimental
```
(p: TileGridParams): Vec2Like[]
```
-## tileCollisionOutlines — function
+## tileCollisionOutlines — function @experimental
```
(chunks: DecodedChunk[], model: TilesetModel, tileW: number, tileH: number, originX: number, originY: number): TileCollisionPiece[]
```
-## tileFlagsOf — function
+## tileFlagsOf — function @experimental
```
(raw: number): TileFlags
```
-## tileIdOf — function
+## tileIdOf — function @experimental
```
(raw: number): number
```
-## tilemapPlugin — const
+## tilemapPlugin — const @experimental
```
TilemapPlugin
```
-## timelinePlugin — const
+## timelinePlugin — const @experimental
```
TimelinePlugin
```
-## timerPlugin — const
+## timerPlugin — const @experimental
```
Plugin
```
-## toBuildPath — function
+## toBuildPath — function @experimental
```
(path: string): string
```
-## trailPlugin — const
+## trailPlugin — const @experimental
```
TrailPlugin
```
-## transitionTo — function
+## transitionTo — function @experimental
```
(host: App | SceneManagerState, targetScene: string, config: TransitionConfig): Promise<void>
```
-## trimTextureCache — function
+## trimTextureCache — function @experimental
```
(): number
```
-## uiHitTestWorld — function
+## uiHitTestWorld — function @experimental
```
(engine: EngineApi | null, registry: CppRegistry, worldX: number, worldY: number, mouseDown?: boolean, mousePressed?: boolean, mouseReleased?: boolean): Entity | null
```
-## uiInteractionPlugin — const
+## uiInteractionPlugin — const @experimental
```
UIInteractionPlugin
```
-## uiLayoutPlugin — const
+## uiLayoutPlugin — const @experimental
```
UILayoutPlugin
```
-## uiLayoutRect — function
+## uiLayoutRect — function @experimental
```
(cam: CameraExtents, fit: CanvasScale | null, width: number, height: number, previewAspect?: number): WorldRect
```
-## uiMaskPlugin — const
+## uiMaskPlugin — const @experimental
```
UIMaskPlugin
```
-## uiPickAllWorld — function
+## uiPickAllWorld — function @experimental
```
(engine: EngineApi | null, registry: CppRegistry, worldX: number, worldY: number): Entity[]
```
-## uiPickWorld — function
+## uiPickWorld — function @experimental
```
(engine: EngineApi | null, registry: CppRegistry, worldX: number, worldY: number): Entity | null
```
-## uiPlugin — const
+## uiPlugin — const @experimental
```
UIPlugin
```
-## uiPlugins — const
+## uiPlugins — const @experimental
```
Plugin[]
```
-## uiRenderOrderPlugin — const
+## uiRenderOrderPlugin — const @experimental
```
UIRenderOrderPlugin
```
-## uiVisibilityPlugin — const
+## uiVisibilityPlugin — const @experimental
```
UIVisibilityPlugin
```
-## uiWorldToScreen — function
+## uiWorldToScreen — function @experimental
```
(camera: UICameraData, worldX: number, worldY: number): { x: number; y: number; }
```
-## unregisterComponent — function
+## unregisterComponent — function @experimental
```
(name: string): void
```
-## unregisterDrawCallback — function
+## unregisterDrawCallback — function @experimental
```
(id: string): void
```
-## unregisterPreSceneDrawCallback — function
+## unregisterPreSceneDrawCallback — function @experimental
```
(id: string): void
```
-## updateAnimatorParam — function
+## updateAnimatorParam — function @experimental
```
(def: AnimatorControllerDef, name: string, patch: Partial<AnimatorParam>): AnimatorControllerDef
```
-## updateAnimatorTransition — function
+## updateAnimatorTransition — function @experimental
```
(def: AnimatorControllerDef, from: string, index: number, patch: Partial<AnimatorTransition>): AnimatorControllerDef
```
-## updateCameraAspectRatio — function
+## updateCameraAspectRatio — function @experimental
```
(world: World, aspectRatio: number): void
```
-## updateTransition — function
+## updateTransition — function @experimental
```
(def: FsmDefinition, from: string, index: number, patch: Partial<FsmTransition>): FsmDefinition
```
-## usesStagger — function
+## usesStagger — function @experimental
```
(orientation: number): boolean
```
-## v2 — const
+## v2 — const @experimental
```
{ readonly create: (x?: number, y?: number) => Vec2; readonly clone: (a: Vec2) => Vec2; readonly add: (a: Vec2, b: Vec2) => Vec2; readonly sub: (a: Vec2, b: Vec2) => Vec2; readonly scale: (a: Vec2, s: number) => Vec2; readonly mul: (a: Vec2, b: Vec2) => Vec2; readonly neg: (a: Vec2) => Vec2; readonly dot: (a: Vec2, b: Vec2) => number; readonly cross: (a: Vec2, b: Vec2) => number; readonly len: (a: Vec2) => number; readonly len2: (a: Vec2) => number; readonly dist: (a: Vec2, b: Vec2) => number; readonly dist2: (a: Vec2, b: Vec2) => number; readonly normalize: (a: Vec2) => Vec2; readonly lerp: (a: Vec2, b: Vec2, t: number) => Vec2; readonly angle: (a: Vec2) => number; readonly fromAngle: (radians: number, length?: number) => Vec2; readonly rotate: (a: Vec2, radians: number) => Vec2; readonly perp: (a: Vec2) => Vec2; readonly equals: (a: Vec2, b: Vec2, epsilon?: number) => boolean; }
```
-## v3 — const
+## v3 — const @experimental
```
{ readonly create: (x?: number, y?: number, z?: number) => Vec3; readonly clone: (a: Vec3) => Vec3; readonly add: (a: Vec3, b: Vec3) => Vec3; readonly sub: (a: Vec3, b: Vec3) => Vec3; readonly scale: (a: Vec3, s: number) => Vec3; readonly mul: (a: Vec3, b: Vec3) => Vec3; readonly neg: (a: Vec3) => Vec3; readonly dot: (a: Vec3, b: Vec3) => number; readonly cross: (a: Vec3, b: Vec3) => Vec3; readonly len: (a: Vec3) => number; readonly len2: (a: Vec3) => number; readonly dist: (a: Vec3, b: Vec3) => number; readonly normalize: (a: Vec3) => Vec3; readonly lerp: (a: Vec3, b: Vec3, t: number) => Vec3; readonly equals: (a: Vec3, b: Vec3, epsilon?: number) => boolean; }
```
-## validateOverrides — function
+## validateOverrides — function @experimental
```
(prefab: PrefabData, options?: { instanceOverrides?: readonly PrefabOverride[]; loadPrefab?: (path: string) => PrefabData | null; }): ValidateResult
```
-## validatePrefab — function
+## validatePrefab — function @experimental
```
(prefab: PrefabData, options?: ValidatePrefabOptions): PrefabDiagnostic[]
```
-## vec2 — const
+## vec2 — const @experimental
```
(x?: number, y?: number) => Vec2
```
-## vec3 — const
+## vec3 — const @experimental
```
(x?: number, y?: number, z?: number) => Vec3
```
-## vec4 — const
+## vec4 — const @experimental
```
(x?: number, y?: number, z?: number, w?: number) => Vec4
```
-## velocityPlugin — const
+## velocityPlugin — const @experimental
```
Plugin
```
-## velocitySystem — const
+## velocitySystem — const @experimental
```
SystemDef
```
-## videoPlugin — const
+## videoPlugin — const @experimental
```
VideoPlugin
```
-## warn — function
+## warn — function @experimental
```
(category: string, message: string, data?: unknown): void
```
-## widgetToPrefab — function
+## widgetToPrefab — function @experimental
```
(build: (world: World) => Entity, name: string): PrefabData
```
-## withActiveRemoteRoot — function
+## withActiveRemoteRoot — function @experimental
```
(config: AssetGroupsConfig | null | undefined, remoteRoot: string): AssetGroupsConfig
```
-## withFolderAlwaysInclude — function
+## withFolderAlwaysInclude — function @experimental
```
(config: AssetGroupsConfig | null | undefined, folder: string, on: boolean): AssetGroupsConfig
```
-## withFolderGroup — function
+## withFolderGroup — function @experimental
```
(config: AssetGroupsConfig | null | undefined, folder: string, mode: AssetGroupMode): AssetGroupsConfig
```
-## wrapSceneSystem — function
+## wrapSceneSystem — function @experimental
```
(app: App, sceneName: string, system: SystemDef): SystemDef
```
-## writeFieldPath — function
+## writeFieldPath — function @experimental
```
(data: Record<string, unknown>, path: string, value: unknown): boolean
```
-## writePtrField — function
+## writePtrField — function @experimental
```
(f32: Float32Array, u32: Uint32Array, u8: Uint8Array, ptr: number, field: PtrFieldDesc, value: PtrFieldValue | unknown): void
```
diff --git a/sdk/etc/index.native.api.md b/sdk/etc/index.native.api.md
index e7d1bf98d..abd2086e2 100644
--- a/sdk/etc/index.native.api.md
+++ b/sdk/etc/index.native.api.md
@@ -1,29 +1,29 @@
# API surface — esengine/index.native
<!-- Generated by tools/api-surface.mjs — do not edit. Run --update to accept changes. -->
-Symbols: 1506 stable · 22 beta · 1 deprecated
+Symbols: 0 public · 22 beta · 1507 experimental · 1 deprecated
-## ABI_LAYOUT_HASH — const
+## ABI_LAYOUT_HASH — const @experimental
```
"7b8797b9ae911eeb"
```
-## ANCHOR_AXES — const
+## ANCHOR_AXES — const @experimental
```
readonly AnchorAxis[]
```
-## ANIM_CLIP_FORMAT_VERSION — const
+## ANIM_CLIP_FORMAT_VERSION — const @experimental
```
"1.4"
```
-## ASSET_GROUP_MODES — const
+## ASSET_GROUP_MODES — const @experimental
```
readonly ["local", "subpackage", "remote"]
```
-## AchievementProvider — interface
+## AchievementProvider — interface @experimental
```
getStat: (name: string) => number
platformBacked: boolean
@@ -34,12 +34,12 @@ unlock: (id: string) => Promise<void>
unlocked: (id: string) => boolean
```
-## Achievements — const
+## Achievements — const @experimental
```
ResourceDef<AchievementsAPI>
```
-## AchievementsAPI — class
+## AchievementsAPI — class @experimental
```
available: boolean
getStat: (name: string) => number
@@ -54,18 +54,18 @@ static new (): AchievementsAPI
static prototype: AchievementsAPI
```
-## ActionDef — interface
+## ActionDef — interface @experimental
```
bindings: Binding[]
type: ActionType
```
-## ActionType — type
+## ActionType — type @experimental
```
'button' | 'axis' | 'axis2d'
```
-## ActivationTrack — interface
+## ActivationTrack — interface @experimental
```
childPath: string
name: string
@@ -73,18 +73,18 @@ ranges: ActivationRange[]
type: "activation"
```
-## AdProvider — interface
+## AdProvider — interface @experimental
```
createInterstitialAd: (adUnitId: string) => PlatformInterstitialAd
createRewardedAd: (adUnitId: string) => PlatformRewardedAd
```
-## Added — function
+## Added — function @experimental
```
<T extends AnyComponentDef>(component: T): AddedWrapper<T>
```
-## AddedEntity — interface
+## AddedEntity — interface @experimental
```
components: ComponentData[]
name: string
@@ -93,26 +93,26 @@ prefabEntityId: string
visible: boolean
```
-## AddedWrapper — interface
+## AddedWrapper — interface @experimental
```
_component: T
_filterType: "added"
```
-## AddressableAssetType — type
+## AddressableAssetType — type @experimental
```
| 'texture' | 'material' | 'spine' | 'bitmap-font' | 'font'
| 'prefab' | 'json' | 'text' | 'binary' | 'audio'
```
-## AddressableManifest — interface
+## AddressableManifest — interface @experimental
```
groups: Record<string, AddressableManifestGroup>
revision: string | undefined
version: "2.0"
```
-## AddressableManifestAsset — interface
+## AddressableManifestAsset — interface @experimental
```
address: string | undefined
compressedFormats: string[] | undefined
@@ -125,19 +125,19 @@ textureImport: ParsedTextureImportSettings | undefined
type: AddressableAssetType
```
-## AddressableManifestGroup — interface
+## AddressableManifestGroup — interface @experimental
```
assets: Record<string, AddressableManifestAsset>
bundleMode: string
labels: string[]
```
-## Ads — const
+## Ads — const @experimental
```
ResourceDef<AdsAPI>
```
-## AdsAPI — class
+## AdsAPI — class @experimental
```
available: boolean
preloadRewarded: (adUnitId: string) => Promise<void>
@@ -149,7 +149,7 @@ static new (takeover: Takeover): AdsAPI
static prototype: AdsAPI
```
-## AiAction — type
+## AiAction — type @experimental
```
(
ctx: Ctx,
@@ -159,30 +159,30 @@ static prototype: AdsAPI
) => void | Status
```
-## AiActionInput — interface
+## AiActionInput — interface @experimental
```
arg: string | undefined
params: Readonly<Record<string, AiParamValue>> | undefined
```
-## AiActionSpec — interface
+## AiActionSpec — interface @experimental
```
params: readonly AiParamDef[] | undefined
run: AiAction<Ctx>
separator: string | undefined
```
-## AiBt — const
+## AiBt — const @experimental
```
ResourceDef<BehaviorTrees>
```
-## AiCondition — type
+## AiCondition — type @experimental
```
(ctx: Ctx, bb: Blackboard) => boolean
```
-## AiContext — interface
+## AiContext — interface @experimental
```
blackboard: Blackboard
commands: CommandsInstance
@@ -194,12 +194,12 @@ set: <C extends AnyComponentDef>(component: C, data: ComponentData<C>) => void
world: World
```
-## AiFsm — const
+## AiFsm — const @experimental
```
ResourceDef<StateMachines>
```
-## AiParamDef — interface
+## AiParamDef — interface @experimental
```
label: string | undefined
max: number | undefined
@@ -212,17 +212,17 @@ tooltip: string | undefined
type: "string" | "number" | "bool" | "enum"
```
-## AiParamValue — type
+## AiParamValue — type @experimental
```
string | number | boolean
```
-## AiParams — type
+## AiParams — type @experimental
```
Readonly<Record<string, AiParamValue>>
```
-## AiRegistry — class
+## AiRegistry — class @experimental
```
actionNames: () => string[]
clear: () => void
@@ -239,17 +239,17 @@ static new <Ctx = unknown>(): AiRegistry<Ctx>
static prototype: AiRegistry<any>
```
-## AlignContent — type
+## AlignContent — type @experimental
```
(typeof AlignContent)[keyof typeof AlignContent]
```
-## AlignItems — type
+## AlignItems — type @experimental
```
(typeof AlignItems)[keyof typeof AlignItems]
```
-## AlignSelf — enum
+## AlignSelf — enum @experimental
```
Auto = 0
Center = 2
@@ -258,7 +258,7 @@ Start = 1
Stretch = 4
```
-## AnchorAxis — enum
+## AnchorAxis — enum @experimental
```
Center = 1
End = 2
@@ -266,7 +266,7 @@ Start = 0
Stretch = 3
```
-## AnchorFields — interface
+## AnchorFields — interface @experimental
```
height: Dimension | undefined
insetBottom: Dimension
@@ -281,18 +281,18 @@ position: number
width: Dimension | undefined
```
-## AnchorPreset — interface
+## AnchorPreset — interface @experimental
```
h: AnchorAxis
v: AnchorAxis
```
-## And — function
+## And — function @experimental
```
(...filters: FilterExpr[]): FilterExpr
```
-## AnimClipAssetData — interface
+## AnimClipAssetData — interface @experimental
```
events: AnimClipEventData[] | undefined
fps: number | undefined
@@ -304,14 +304,14 @@ type: "animation-clip"
version: string
```
-## AnimClipEventData — interface
+## AnimClipEventData — interface @experimental
```
data: unknown
frame: number
name: string
```
-## AnimClipFrameData — interface
+## AnimClipFrameData — interface @experimental
```
atlasFrame: { x: number; y: number; width: number; height: number; pageWidth: number; pageHeight: number; } | undefined
cell: number | undefined
@@ -320,13 +320,13 @@ pivot: AnimClipPivotData | undefined
texture: string | undefined
```
-## AnimClipPivotData — interface
+## AnimClipPivotData — interface @experimental
```
x: number
y: number
```
-## AnimClipSheetData — interface
+## AnimClipSheetData — interface @experimental
```
cellHeight: number
cellWidth: number
@@ -337,7 +337,7 @@ spacing: number
texture: string
```
-## AnimFramesTrack — interface
+## AnimFramesTrack — interface @experimental
```
childPath: string
frames: AnimFrame[]
@@ -345,7 +345,7 @@ name: string
type: "animFrames"
```
-## AnimationPlugin — class
+## AnimationPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -354,18 +354,18 @@ static new (): AnimationPlugin
static prototype: AnimationPlugin
```
-## Animator — const
+## Animator — const @experimental
```
ComponentDef<AnimatorData>
```
-## AnimatorBlend1D — interface
+## AnimatorBlend1D — interface @experimental
```
parameter: string
thresholds: AnimatorBlendThreshold[]
```
-## AnimatorBlendThreshold — interface
+## AnimatorBlendThreshold — interface @experimental
```
clip: string
loop: boolean | undefined
@@ -373,18 +373,18 @@ speed: number | undefined
value: number
```
-## AnimatorCondition — type
+## AnimatorCondition — type @experimental
```
| { param: string; op: 'gt' | 'lt' | 'eq' | 'neq'; value: number }
| { param: string; op: 'true' | 'false' | 'trigger' }
```
-## AnimatorController — const
+## AnimatorController — const @experimental
```
ResourceDef<AnimatorControllerAPI>
```
-## AnimatorControllerAPI — class
+## AnimatorControllerAPI — class @experimental
```
clearControllers: () => void
getBool: (entity: Entity, name: string) => boolean
@@ -403,7 +403,7 @@ static new (): AnimatorControllerAPI
static prototype: AnimatorControllerAPI
```
-## AnimatorControllerDef — interface
+## AnimatorControllerDef — interface @experimental
```
anyStateTransitions: AnimatorTransition[] | undefined
initialState: string
@@ -411,59 +411,59 @@ parameters: AnimatorParam[]
states: AnimatorState[]
```
-## AnimatorData — interface
+## AnimatorData — interface @experimental
```
controller: string
currentState: string
enabled: boolean
```
-## AnimatorEdge — type
+## AnimatorEdge — type @experimental
```
GraphEdge<AnimatorTransition>
```
-## AnimatorEvalResult — interface
+## AnimatorEvalResult — interface @experimental
```
consumedTriggers: string[]
next: string | null
```
-## AnimatorParam — interface
+## AnimatorParam — interface @experimental
```
default: number | boolean | undefined
name: string
type: AnimatorParamType
```
-## AnimatorParamType — type
+## AnimatorParamType — type @experimental
```
'float' | 'bool' | 'trigger'
```
-## AnimatorParamValues — type
+## AnimatorParamValues — type @experimental
```
Readonly<Record<string, number | boolean>>
```
-## AnimatorPathEvalResult — interface
+## AnimatorPathEvalResult — interface @experimental
```
consumedTriggers: string[]
nextPath: string | null
```
-## AnimatorScope — type
+## AnimatorScope — type @experimental
```
Pick<AnimatorControllerDef, 'states' | 'initialState' | 'anyStateTransitions'>
```
-## AnimatorSpineMotion — interface
+## AnimatorSpineMotion — interface @experimental
```
animation: string
loop: boolean | undefined
```
-## AnimatorState — interface
+## AnimatorState — interface @experimental
```
blend: AnimatorBlend1D | undefined
clip: string | undefined
@@ -477,26 +477,26 @@ x: number | undefined
y: number | undefined
```
-## AnimatorSubMachine — interface
+## AnimatorSubMachine — interface @experimental
```
anyStateTransitions: AnimatorTransition[] | undefined
initialState: string
states: AnimatorState[]
```
-## AnimatorTransition — interface
+## AnimatorTransition — interface @experimental
```
conditions: AnimatorCondition[]
hasExitTime: boolean | undefined
to: string
```
-## AnyComponentDef — type
+## AnyComponentDef — type @experimental
```
ComponentDef<any> | BuiltinComponentDef<any>
```
-## App — class
+## App — class @experimental
```
addBundleSystems: (entries: ReadonlyArray<{ schedule: number; system: SystemDef | SystemSet; }>) => App
addEvent: <T>(event: EventDef<T>) => App
@@ -558,7 +558,7 @@ static new: () => App
static prototype: App
```
-## AppContext — class
+## AppContext — class @experimental
```
componentRegistry: Map<string, any>
drainPendingSystems: () => PendingSystemEntry[]
@@ -572,12 +572,12 @@ static new (): AppContext
static prototype: AppContext
```
-## ApplyTilesetRefs — type
+## ApplyTilesetRefs — type @experimental
```
(entity: number, refs: readonly string[]) => void
```
-## ArrayDataSource — class
+## ArrayDataSource — class @experimental
```
append: (items: readonly T[]) => void
getCount: () => number
@@ -591,34 +591,34 @@ static new <T>(items?: readonly T[]): ArrayDataSource<T>
static prototype: ArrayDataSource<any>
```
-## AssetBuildTransform — type
+## AssetBuildTransform — type @experimental
```
(content: string, context: unknown) => string
```
-## AssetContentType — type
+## AssetContentType — type @experimental
```
'json' | 'text' | 'binary' | 'image' | 'audio'
```
-## AssetFieldType — type
+## AssetFieldType — type @experimental
```
'texture' | 'material' | 'font' | 'anim-clip' | 'audio' | 'video' | 'tilemap' | 'tileset' | 'timeline' | 'statemachine' | 'behaviortree' | 'animatorcontroller'
```
-## AssetGroupDef — interface
+## AssetGroupDef — interface @experimental
```
alwaysInclude: boolean | undefined
folder: string
mode: "local" | "subpackage" | "remote"
```
-## AssetGroupMode — type
+## AssetGroupMode — type @experimental
```
typeof ASSET_GROUP_MODES[number]
```
-## AssetGroupsConfig — interface
+## AssetGroupsConfig — interface @experimental
```
activeProfile: string | undefined
atlases: Record<string, AtlasDef> | undefined
@@ -627,7 +627,7 @@ profiles: Record<string, BuildProfile> | undefined
version: string
```
-## AssetPlugin — class
+## AssetPlugin — class @experimental
```
build: (app: App) => void
name: string
@@ -635,7 +635,7 @@ static new (): AssetPlugin
static prototype: AssetPlugin
```
-## AssetRefCounter — class
+## AssetRefCounter — class @experimental
```
addFontRef: (path: string, entity: number) => void
addMaterialRef: (path: string, entity: number) => void
@@ -660,14 +660,14 @@ static new (): AssetRefCounter
static prototype: AssetRefCounter
```
-## AssetRefInfo — interface
+## AssetRefInfo — interface @experimental
```
assetPath: string
entities: number[]
refCount: number
```
-## AssetTypeEntry — interface
+## AssetTypeEntry — interface @experimental
```
addressableType: AddressableAssetType | null
buildTransform: AssetBuildTransform | undefined
@@ -679,17 +679,17 @@ suffixes: string[] | undefined
wechatPackInclude: boolean
```
-## Assets — const
+## Assets — const @experimental
```
ResourceDef<AssetsClass>
```
-## AssetsData — type
+## AssetsData — type @experimental
```
AssetsClass
```
-## AsyncCache — class
+## AsyncCache — class @experimental
```
clear: () => void
clearAll: () => void
@@ -706,24 +706,24 @@ static new <T>(dispose_?: ((value: T) => void) | undefined): AsyncCache<T>
static prototype: AsyncCache<any>
```
-## AtlasDef — interface
+## AtlasDef — interface @experimental
```
folder: string
```
-## AttenuationModel — enum
+## AttenuationModel — enum @experimental
```
Exponential = 2
Inverse = 1
Linear = 0
```
-## Audio — const
+## Audio — const @experimental
```
ResourceDef<AudioAPI>
```
-## AudioAPI — class
+## AudioAPI — class @experimental
```
baseUrl: string
bufferBudget: number
@@ -771,20 +771,20 @@ static new (backend: PlatformAudioBackend, mixer?: AudioMixer | null): AudioAPI
static prototype: AudioAPI
```
-## AudioBackendInitOptions — interface
+## AudioBackendInitOptions — interface @experimental
```
initialPoolSize: number | undefined
mixerConfig: AudioMixerConfig | undefined
```
-## AudioBufferHandle — interface
+## AudioBufferHandle — interface @experimental
```
bytes: number | undefined
duration: number
id: number
```
-## AudioBufferStats — interface
+## AudioBufferStats — interface @experimental
```
bufferBudget: number
bufferBytes: number
@@ -792,7 +792,7 @@ bufferCount: number
evictableCount: number
```
-## AudioBus — class
+## AudioBus — class @experimental
```
addChild: (child: AudioBus) => void
connect: (destination: AudioBus | AudioNode) => void
@@ -808,7 +808,7 @@ static new (context: AudioContext, config: AudioBusConfig): AudioBus
static prototype: AudioBus
```
-## AudioBusConfig — interface
+## AudioBusConfig — interface @experimental
```
muted: boolean | undefined
name: string
@@ -816,7 +816,7 @@ parent: string | undefined
volume: number | undefined
```
-## AudioBusDecl — interface
+## AudioBusDecl — interface @experimental
```
duck: BusDuckRule | undefined
effects: BusEffectDef[] | undefined
@@ -826,7 +826,7 @@ parent: string | undefined
volume: number | undefined
```
-## AudioHandle — interface
+## AudioHandle — interface @experimental
```
currentTime: number
duration: number
@@ -842,17 +842,17 @@ setVolume: (volume: number) => void
stop: () => void
```
-## AudioListener — const
+## AudioListener — const @experimental
```
ComponentDef<AudioListenerData>
```
-## AudioListenerData — interface
+## AudioListenerData — interface @experimental
```
enabled: boolean
```
-## AudioMixer — class
+## AudioMixer — class @experimental
```
busNames: () => string[]
createBus: (config: AudioBusConfig) => AudioBus
@@ -869,7 +869,7 @@ static new (context: AudioContext, config?: AudioMixerConfig): AudioMixer
static prototype: AudioMixer
```
-## AudioMixerConfig — interface
+## AudioMixerConfig — interface @experimental
```
masterVolume: number | undefined
musicVolume: number | undefined
@@ -878,7 +878,7 @@ uiVolume: number | undefined
voiceVolume: number | undefined
```
-## AudioPlugin — class
+## AudioPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -888,7 +888,7 @@ static new (config?: AudioPluginConfig): AudioPlugin
static prototype: AudioPlugin
```
-## AudioPluginConfig — interface
+## AudioPluginConfig — interface @experimental
```
initialPoolSize: number | undefined
masterVolume: number | undefined
@@ -896,7 +896,7 @@ musicVolume: number | undefined
sfxVolume: number | undefined
```
-## AudioPool — class
+## AudioPool — class @experimental
```
acquire: () => PooledAudioNode
activeCount: number
@@ -906,17 +906,17 @@ static new (context: AudioContext, initialSize?: number): AudioPool
static prototype: AudioPool
```
-## AudioProjectConfig — interface
+## AudioProjectConfig — interface @experimental
```
buses: AudioBusDecl[] | undefined
```
-## AudioSource — const
+## AudioSource — const @experimental
```
ComponentDef<AudioSourceData>
```
-## AudioSourceData — interface
+## AudioSourceData — interface @experimental
```
attenuationModel: number
bus: string
@@ -933,7 +933,7 @@ spatial: boolean
volume: number
```
-## AudioTrack — interface
+## AudioTrack — interface @experimental
```
childPath: string
events: AudioEvent[]
@@ -941,37 +941,37 @@ name: string
type: "audio"
```
-## Axis1D — const
+## Axis1D — const @experimental
```
(...bindings: Binding[]) => ActionDef
```
-## Axis2D — const
+## Axis2D — const @experimental
```
(...bindings: Binding[]) => ActionDef
```
-## BUILTIN_SHADER_TEMPLATES — const
+## BUILTIN_SHADER_TEMPLATES — const @experimental
```
readonly BuiltinShaderTemplate[]
```
-## BUILTIN_UI_PREFABS — const
+## BUILTIN_UI_PREFABS — const @experimental
```
Record<string, PrefabData>
```
-## BUILTIN_UI_WIDGET_NAMES — const
+## BUILTIN_UI_WIDGET_NAMES — const @experimental
```
readonly ["Button", "Toggle", "Slider", "Dialog", "TextInput", "Progress", "Dropdown", "ListView", "ScrollView"]
```
-## BUNDLE_MODES — const
+## BUNDLE_MODES — const @experimental
```
readonly BundleMode[]
```
-## Backend — interface
+## Backend — interface @experimental
```
fetchBinary: (path: string) => Promise<ArrayBuffer>
fetchText: (path: string) => Promise<string>
@@ -979,7 +979,7 @@ resolveUrl: (path: string) => string
setBaseUrl: ((url: string) => void) | undefined
```
-## BehaviorContext — interface
+## BehaviorContext — interface @experimental
```
commands: CommandsInstance
entity: number
@@ -992,7 +992,7 @@ time: TimeData
world: World
```
-## BehaviorDef — interface
+## BehaviorDef — interface @experimental
```
destroy: ((ctx: BehaviorContext<S>) => void) | undefined
metadata: ComponentMetadata | undefined
@@ -1002,18 +1002,18 @@ state: S | undefined
update: ((ctx: BehaviorContext<S>, dt: number) => void) | undefined
```
-## BehaviorTreeAgent — const
+## BehaviorTreeAgent — const @experimental
```
ComponentDef<BehaviorTreeAgentData>
```
-## BehaviorTreeAgentData — interface
+## BehaviorTreeAgentData — interface @experimental
```
bt: string
status: string
```
-## BehaviorTrees — class
+## BehaviorTrees — class @experimental
```
blackboard: (entity: Entity) => Blackboard
status: (entity: Entity) => string | null
@@ -1021,7 +1021,7 @@ static new (states: Map<Entity, BtAgentState>): BehaviorTrees
static prototype: BehaviorTrees
```
-## BezierPoints — interface
+## BezierPoints — interface @experimental
```
p1x: number
p1y: number
@@ -1029,12 +1029,12 @@ p2x: number
p2y: number
```
-## BinaryHandler — type
+## BinaryHandler — type @experimental
```
(payload: Uint8Array) => void
```
-## Binding — type
+## Binding — type @experimental
```
| { kind: 'key'; code: string }
| { kind: 'mouse'; button: number }
@@ -1046,7 +1046,7 @@ p2y: number
| { kind: 'virtual'; id: string }
```
-## BitmapCache — interface
+## BitmapCache — interface @experimental
```
_rt: RenderTextureHandle | null
height: number
@@ -1055,12 +1055,12 @@ valid: boolean
width: number
```
-## BitmapText — const
+## BitmapText — const @experimental
```
BuiltinComponentDef<BitmapTextData>
```
-## BitmapTextData — interface
+## BitmapTextData — interface @experimental
```
align: number
color: Color
@@ -1073,7 +1073,7 @@ spacing: number
text: string
```
-## Blackboard — class
+## Blackboard — class @experimental
```
clearTriggers: () => void
consume: (trigger: string) => void
@@ -1087,19 +1087,19 @@ static new (): Blackboard
static prototype: Blackboard
```
-## BlackboardGuard — interface
+## BlackboardGuard — interface @experimental
```
key: string
op: CompareOp
value: string | number | boolean | undefined
```
-## BlendCurve — type
+## BlendCurve — type @experimental
```
(typeof BlendCurve)[keyof typeof BlendCurve]
```
-## BlendMode — enum
+## BlendMode — enum @experimental
```
Additive = 1
Darken = 7
@@ -1113,19 +1113,19 @@ PremultipliedAlpha = 4
Screen = 3
```
-## BodyType — enum
+## BodyType — enum @experimental
```
Dynamic = 2
Kinematic = 1
Static = 0
```
-## BoxCollider — const
+## BoxCollider — const @experimental
```
BuiltinComponentDef<BoxColliderData>
```
-## BoxColliderData — interface
+## BoxColliderData — interface @experimental
```
categoryBits: number
density: number
@@ -1139,20 +1139,20 @@ radius: number
restitution: number
```
-## BtDefinition — interface
+## BtDefinition — interface @experimental
```
orphans: BtNode[] | undefined
root: BtNode
```
-## BtEdge — interface
+## BtEdge — interface @experimental
```
from: string
id: string
to: string
```
-## BtNode — interface
+## BtNode — interface @experimental
```
arg: string | undefined
children: BtNode[] | undefined
@@ -1167,7 +1167,7 @@ x: number | undefined
y: number | undefined
```
-## BtNodeType — type
+## BtNodeType — type @experimental
```
| 'sequence' | 'selector' | 'parallel'
// decorators (one child)
@@ -1176,7 +1176,7 @@ y: number | undefined
| 'action' | 'condition'
```
-## BtPlugin — class
+## BtPlugin — class @experimental
```
build: (app: App) => void
name: string
@@ -1184,12 +1184,12 @@ static new (): BtPlugin
static prototype: BtPlugin
```
-## BtRunState — type
+## BtRunState — type @experimental
```
Map<string, NodeState>
```
-## BuildNavGridOptions — interface
+## BuildNavGridOptions — interface @experimental
```
blockedTileIds: Iterable<number> | undefined
cellSize: number
@@ -1199,12 +1199,12 @@ origin: Vec2 | undefined
width: number
```
-## BuildProfile — interface
+## BuildProfile — interface @experimental
```
remoteRoot: string | undefined
```
-## BuiltinBridge — class
+## BuiltinBridge — class @experimental
```
connect: (cppRegistry: CppRegistry, module?: ESEngineModule, options?: BridgeConnectOptions) => void
deleteFromEntitySets: (entity: Entity) => string[]
@@ -1229,7 +1229,7 @@ static new (): BuiltinBridge
static prototype: BuiltinBridge
```
-## BuiltinComponentDef — interface
+## BuiltinComponentDef — interface @experimental
```
_builtin: true
_cppName: string
@@ -1249,7 +1249,7 @@ skeletalFields: SkeletalFieldMeta | undefined
transient: boolean
```
-## BuiltinShaderTemplate — interface
+## BuiltinShaderTemplate — interface @experimental
```
defaults: Record<string, unknown>
description: string
@@ -1258,17 +1258,17 @@ label: string
source: string
```
-## BuiltinSideModuleId — type
+## BuiltinSideModuleId — type @experimental
```
'physics' | 'basis' | 'videodec' | 'dragonbones' | `spine:${SpineVersion}`
```
-## BundleMode — type
+## BundleMode — type @experimental
```
'local' | 'lazy' | 'remote'
```
-## BusDuckRule — interface
+## BusDuckRule — interface @experimental
```
amount: number
attack: number | undefined
@@ -1277,24 +1277,24 @@ threshold: number | undefined
trigger: string
```
-## BusEffectDef — type
+## BusEffectDef — type @experimental
```
FilterEffectDef | ReverbEffectDef | CompressorEffectDef
```
-## Button — const
+## Button — const @experimental
```
(...bindings: Binding[]) => ActionDef
```
-## ButtonHandle — interface
+## ButtonHandle — interface @experimental
```
dispose: () => void
entity: number
setDisabled: (disabled: boolean) => void
```
-## ButtonOptions — interface
+## ButtonOptions — interface @experimental
```
background: UIVisualInit | undefined
disabled: boolean | undefined
@@ -1310,39 +1310,39 @@ text: string | TextInit | undefined
world: World
```
-## ButtonStateVisual — interface
+## ButtonStateVisual — interface @experimental
```
color: Color | undefined
scale: number | undefined
sprite: number | undefined
```
-## CAPSULE_ARC_SEGMENTS — const
+## CAPSULE_ARC_SEGMENTS — const @experimental
```
16
```
-## CHUNK_SIZE — const
+## CHUNK_SIZE — const @experimental
```
16
```
-## COLLISION_BRUSHES — const
+## COLLISION_BRUSHES — const @experimental
```
CollisionBrush[]
```
-## COLLISION_PALETTE_REF — const
+## COLLISION_PALETTE_REF — const @experimental
```
"builtin:collision"
```
-## CacheAsBitmap — const
+## CacheAsBitmap — const @experimental
```
ComponentDef<CacheAsBitmapData>
```
-## CacheAsBitmapData — interface
+## CacheAsBitmapData — interface @experimental
```
dirty: boolean
enabled: boolean
@@ -1350,22 +1350,22 @@ height: number
width: number
```
-## CacheBitmap — const
+## CacheBitmap — const @experimental
```
{ create(width: number, height: number): BitmapCache; release(cache: BitmapCache): void; beginDraw(cache: BitmapCache, viewProjection: Float32Array): void; endDraw(): void; resize(cache: BitmapCache, width: number, height: number): void; }
```
-## Camera — const
+## Camera — const @experimental
```
BuiltinComponentDef<CameraData>
```
-## CameraBounds — const
+## CameraBounds — const @experimental
```
ComponentDef<CameraBoundsData>
```
-## CameraBoundsData — interface
+## CameraBoundsData — interface @experimental
```
maxX: number
maxY: number
@@ -1373,7 +1373,7 @@ minX: number
minY: number
```
-## CameraData — interface
+## CameraData — interface @experimental
```
aspectRatio: number
clearFlags: number
@@ -1390,12 +1390,12 @@ showFrustum: boolean
viewport: Vec4
```
-## CameraDirector — const
+## CameraDirector — const @experimental
```
ResourceDef<CameraDirectorState>
```
-## CameraDirectorState — interface
+## CameraDirectorState — interface @experimental
```
blending: boolean
currentMain: CameraPOV | null
@@ -1412,7 +1412,7 @@ startTime: number
target: number
```
-## CameraExtents — interface
+## CameraExtents — interface @experimental
```
cameraX: number
cameraY: number
@@ -1421,7 +1421,7 @@ halfH: number
halfW: number
```
-## CameraPOV — interface
+## CameraPOV — interface @experimental
```
clearFlags: number
cullingMask: number
@@ -1441,7 +1441,7 @@ y: number
z: number
```
-## CameraRenderParams — interface
+## CameraRenderParams — interface @experimental
```
cameraEntity: number | undefined
clearColor: { x: number; y: number; z: number; w: number; } | undefined
@@ -1453,12 +1453,12 @@ viewProjection: Float32Array<ArrayBufferLike>
viewportPixels: Viewport
```
-## CameraView — const
+## CameraView — const @experimental
```
ResourceDef<CameraViewAPI>
```
-## CameraViewAPI — class
+## CameraViewAPI — class @experimental
```
getWorldBounds: () => { left: number; right: number; bottom: number; top: number; } | null
getWorldMousePosition: () => { x: number; y: number; } | null
@@ -1468,12 +1468,12 @@ static new (app_: App): CameraViewAPI
static prototype: CameraViewAPI
```
-## Canvas — const
+## Canvas — const @experimental
```
BuiltinComponentDef<CanvasData>
```
-## CanvasData — interface
+## CanvasData — interface @experimental
```
backgroundColor: Color
designResolution: Vec2
@@ -1483,19 +1483,19 @@ pixelsPerUnit: number
scaleMode: number
```
-## CanvasScale — interface
+## CanvasScale — interface @experimental
```
designResolution: { x: number; y: number; }
matchWidthOrHeight: number
scaleMode: number
```
-## CapsuleCollider — const
+## CapsuleCollider — const @experimental
```
BuiltinComponentDef<CapsuleColliderData>
```
-## CapsuleColliderData — interface
+## CapsuleColliderData — interface @experimental
```
categoryBits: number
density: number
@@ -1509,7 +1509,7 @@ radius: number
restitution: number
```
-## Catalog — class
+## Catalog — class @experimental
```
getAllLabels: () => string[]
getAtlasFrame: (path: string) => AtlasFrameInfo | null
@@ -1527,7 +1527,7 @@ static new (entries: Map<string, CatalogEntry>, addresses: Map<string, string>,
static prototype: Catalog
```
-## CatalogData — interface
+## CatalogData — interface @experimental
```
addresses: Record<string, string> | undefined
entries: Record<string, CatalogEntry>
@@ -1535,7 +1535,7 @@ labels: Record<string, string[]> | undefined
version: number
```
-## CatalogEntry — interface
+## CatalogEntry — interface @experimental
```
atlas: string | undefined
buildPath: string | undefined
@@ -1546,27 +1546,27 @@ type: string
uv: { offset: [number, number]; scale: [number, number]; } | undefined
```
-## Cell — interface
+## Cell — interface @experimental
```
x: number
y: number
```
-## Census — interface
+## Census — interface @experimental
```
atMs: number
entries: ReadonlyMap<string, CensusEntry>
failedProbes: readonly string[]
```
-## CensusContext — interface
+## CensusContext — interface @experimental
```
app: App | undefined
module: ESEngineModule | null | undefined
world: World | undefined
```
-## CensusDelta — interface
+## CensusDelta — interface @experimental
```
after: number
before: number
@@ -1576,7 +1576,7 @@ tier: CensusTier
unit: "count" | "bytes"
```
-## CensusEntry — interface
+## CensusEntry — interface @experimental
```
key: string
tier: CensusTier
@@ -1584,13 +1584,13 @@ unit: "count" | "bytes"
value: number
```
-## CensusProbe — interface
+## CensusProbe — interface @experimental
```
id: string
read: (ctx: CensusContext) => readonly CensusEntry[] | undefined
```
-## CensusReport — interface
+## CensusReport — interface @experimental
```
cycles: number
failedProbes: readonly string[]
@@ -1600,7 +1600,7 @@ projectCycles: number
verdicts: readonly CensusVerdict[]
```
-## CensusSeriesOptions — interface
+## CensusSeriesOptions — interface @experimental
```
boundedSlopeTolerance: number | undefined
projectCycles: number | undefined
@@ -1608,12 +1608,12 @@ trendByteBudgetPerCycle: number | undefined
warmupCycles: number | undefined
```
-## CensusTier — type
+## CensusTier — type @experimental
```
'conserved' | 'bounded' | 'trend' | 'info'
```
-## CensusVerdict — interface
+## CensusVerdict — interface @experimental
```
confidentSlopePerCycle: number
first: number
@@ -1628,28 +1628,28 @@ tier: CensusTier
unit: "count" | "bytes"
```
-## ChainCollider — const
+## ChainCollider — const @experimental
```
ComponentDef<ChainColliderData>
```
-## Changed — function
+## Changed — function @experimental
```
<T extends AnyComponentDef>(component: T): ChangedWrapper<T>
```
-## ChangedWrapper — interface
+## ChangedWrapper — interface @experimental
```
_component: T
_filterType: "changed"
```
-## CharacterController — const
+## CharacterController — const @experimental
```
ComponentDef<CharacterControllerData>
```
-## CharacterControllerData — interface
+## CharacterControllerData — interface @experimental
```
floorMaxAngle: number
floorNormal: Vec2
@@ -1666,22 +1666,22 @@ up: Vec2
velocity: Vec2
```
-## Children — const
+## Children — const @experimental
```
BuiltinComponentDef<ChildrenData>
```
-## ChildrenData — interface
+## ChildrenData — interface @experimental
```
entities: number[]
```
-## CircleCollider — const
+## CircleCollider — const @experimental
```
BuiltinComponentDef<CircleColliderData>
```
-## CircleColliderData — interface
+## CircleColliderData — interface @experimental
```
categoryBits: number
density: number
@@ -1694,7 +1694,7 @@ radius: number
restitution: number
```
-## ClearFlags — enum
+## ClearFlags — enum @experimental
```
Color = 1
ColorAndDepth = 3
@@ -1702,20 +1702,20 @@ Depth = 2
Nothing = 0
```
-## ColliderInstance — interface
+## ColliderInstance — interface @experimental
```
enabled: boolean
isSensor: boolean
shape: ColliderShape
```
-## ColliderOutline — interface
+## ColliderOutline — interface @experimental
```
circles: { c: Vec2; r: number; }[]
polylines: Vec2[][]
```
-## ColliderShape — type
+## ColliderShape — type @experimental
```
| { kind: 'box'; halfExtents: Vec2; offset: Vec2 }
| { kind: 'circle'; radius: number; offset: Vec2 }
@@ -1725,14 +1725,14 @@ polylines: Vec2[][]
| { kind: 'chain'; points: Vec2[]; isLoop: boolean }
```
-## CollisionBrush — interface
+## CollisionBrush — interface @experimental
```
collision: ResolvedTileCollision
id: number
key: string
```
-## CollisionEnterEvent — interface
+## CollisionEnterEvent — interface @experimental
```
contactX: number
contactY: number
@@ -1742,7 +1742,7 @@ normalX: number
normalY: number
```
-## CollisionHitEvent — interface
+## CollisionHitEvent — interface @experimental
```
approachSpeed: number
entityA: number
@@ -1753,14 +1753,14 @@ pointX: number
pointY: number
```
-## CollisionMaterial — interface
+## CollisionMaterial — interface @experimental
```
density: number | undefined
friction: number | undefined
restitution: number | undefined
```
-## Color — interface
+## Color — interface @experimental
```
a: number
b: number
@@ -1768,22 +1768,22 @@ g: number
r: number
```
-## ColorRole — type
+## ColorRole — type @experimental
```
keyof ThemeColors
```
-## Commands — function
+## Commands — function @experimental
```
(): CommandsDescriptor
```
-## CommandsDescriptor — interface
+## CommandsDescriptor — interface @experimental
```
_type: "commands"
```
-## CommandsInstance — class
+## CommandsInstance — class @experimental
```
despawn: (entity: Entity) => CommandsInstance
entity: (entity: Entity) => EntityCommands
@@ -1797,18 +1797,18 @@ static new (world: World, resources: ResourceStorage): CommandsInstance
static prototype: CommandsInstance
```
-## CompareOp — type
+## CompareOp — type @experimental
```
'==' | '!=' | '<' | '<=' | '>' | '>=' | 'truthy' | 'falsy'
```
-## CompiledFsm — interface
+## CompiledFsm — interface @experimental
```
initial: string
states: Map<string, FsmState>
```
-## Completable — interface
+## Completable — interface @experimental
```
cancel: () => void
pause: () => void
@@ -1816,14 +1816,14 @@ resume: () => void
state: TweenState
```
-## ComponentData — type
+## ComponentData — type @experimental
```
C extends BuiltinComponentDef<infer T> ? T :
C extends ComponentDef<infer T> ? T :
never
```
-## ComponentDef — interface
+## ComponentDef — interface @experimental
```
_builtin: false
_default: T
@@ -1843,7 +1843,7 @@ skeletalFields: SkeletalFieldMeta | undefined
transient: boolean
```
-## ComponentHeap — interface
+## ComponentHeap — interface @experimental
```
f32: Float32Array<ArrayBufferLike>
ptr: number
@@ -1851,7 +1851,7 @@ u32: Uint32Array<ArrayBufferLike>
u8: Uint8Array<ArrayBufferLike>
```
-## ComponentMetadata — interface
+## ComponentMetadata — interface @experimental
```
animatableFields: string[] | undefined
assetFields: AssetFieldMeta[] | undefined
@@ -1865,7 +1865,7 @@ skeletalFields: SkeletalFieldMeta | undefined
transient: boolean | undefined
```
-## CompressorEffectDef — interface
+## CompressorEffectDef — interface @experimental
```
attack: number | undefined
kneeDb: number | undefined
@@ -1875,14 +1875,14 @@ thresholdDb: number | undefined
type: "compressor"
```
-## ControllerState — interface
+## ControllerState — interface @experimental
```
current: string
name: string
pages: string[]
```
-## CookedAtlasInfo — interface
+## CookedAtlasInfo — interface @experimental
```
frame: { x: number; y: number; width: number; height: number; }
page: number | undefined
@@ -1890,7 +1890,7 @@ pageHeight: number
pageWidth: number
```
-## CppRegistry — interface
+## CppRegistry — interface @experimental
```
addBitmapText: (entity: Entity, component: BitmapText) => void
addBoxCollider: (entity: Entity, component: BoxCollider) => void
@@ -2020,7 +2020,7 @@ setParent: (child: Entity, parent: Entity) => void
valid: (entity: Entity) => boolean
```
-## CppResourceManager — interface
+## CppResourceManager — interface @experimental
```
acquireTextureByPath: (path: string) => number
createLabelAtlasFont: (textureHandle: number, texWidth: number, texHeight: number, chars: string, charWidth: number, charHeight: number) => number
@@ -2052,7 +2052,7 @@ updateTextureSubregion: (handle: number, x: number, y: number, width: number, he
updateTextureSubregionFromBytes: ((handle: number, x: number, y: number, width: number, height: number, pixels: Uint8Array) => void) | undefined
```
-## CreateListViewOptions — interface
+## CreateListViewOptions — interface @experimental
```
background: UIVisualInit | undefined
data: DataSource<T> | readonly T[]
@@ -2071,7 +2071,7 @@ wheelSpeed: number | undefined
world: World
```
-## CreateWebAppOptions — interface
+## CreateWebAppOptions — interface @experimental
```
colorSpace: "gamma" | "linear" | undefined
depthLayers: number | undefined
@@ -2085,109 +2085,109 @@ wasmBaseUrl: string | undefined
ySortLayers: number | undefined
```
-## CullMode — enum
+## CullMode — enum @experimental
```
Back = 1
Front = 2
None = 0
```
-## DARK_TOKENS — const
+## DARK_TOKENS — const @experimental
```
ThemeTokens
```
-## DEFAULT_ANIM_CLIP_PIVOT — const
+## DEFAULT_ANIM_CLIP_PIVOT — const @experimental
```
AnimClipPivotData
```
-## DEFAULT_DESIGN_HEIGHT — const
+## DEFAULT_DESIGN_HEIGHT — const @experimental
```
number
```
-## DEFAULT_DESIGN_WIDTH — const
+## DEFAULT_DESIGN_WIDTH — const @experimental
```
number
```
-## DEFAULT_EDITOR_GRID — const
+## DEFAULT_EDITOR_GRID — const @experimental
```
EditorGridData
```
-## DEFAULT_EDITOR_VIEW — const
+## DEFAULT_EDITOR_VIEW — const @experimental
```
EditorViewData
```
-## DEFAULT_FALLBACK_DT — const
+## DEFAULT_FALLBACK_DT — const @experimental
```
number
```
-## DEFAULT_FIXED_TIMESTEP — const
+## DEFAULT_FIXED_TIMESTEP — const @experimental
```
number
```
-## DEFAULT_FONT_FAMILY — const
+## DEFAULT_FONT_FAMILY — const @experimental
```
"Arial"
```
-## DEFAULT_FONT_SIZE — const
+## DEFAULT_FONT_SIZE — const @experimental
```
24
```
-## DEFAULT_GRAVITY — const
+## DEFAULT_GRAVITY — const @experimental
```
{ x: number; y: number; }
```
-## DEFAULT_LINE_HEIGHT — const
+## DEFAULT_LINE_HEIGHT — const @experimental
```
1.2
```
-## DEFAULT_MAX_DELTA_TIME — const
+## DEFAULT_MAX_DELTA_TIME — const @experimental
```
0.5
```
-## DEFAULT_PIXELS_PER_UNIT — const
+## DEFAULT_PIXELS_PER_UNIT — const @experimental
```
number
```
-## DEFAULT_SCREEN_SCALING — const
+## DEFAULT_SCREEN_SCALING — const @experimental
```
ScreenScalingData
```
-## DEFAULT_SPINE_SKIN — const
+## DEFAULT_SPINE_SKIN — const @experimental
```
"default"
```
-## DEFAULT_SPRITE_SIZE — const
+## DEFAULT_SPRITE_SIZE — const @experimental
```
{ x: number; y: number; }
```
-## DEFAULT_TEXT_CANVAS_SIZE — const
+## DEFAULT_TEXT_CANVAS_SIZE — const @experimental
```
512
```
-## DEFAULT_UI_CAMERA_INFO — const
+## DEFAULT_UI_CAMERA_INFO — const @experimental
```
{ readonly viewProjection: Float32Array<ArrayBuffer>; readonly vpX: 0; readonly vpY: 0; readonly vpW: 0; readonly vpH: 0; readonly screenW: 0; readonly screenH: 0; readonly worldLeft: 0; readonly worldBottom: 0; readonly worldRight: 0; readonly worldTop: 0; readonly worldMouseX: 0; readonly worldMouseY: 0; readonly valid: false; }
```
-## DataSource — interface
+## DataSource — interface @experimental
```
getCount: () => number
getItem: (index: number) => T
@@ -2196,7 +2196,7 @@ getItemType: ((index: number) => string) | undefined
subscribe: ((listener: (change: DataSourceChange) => void) => Unsubscribe) | undefined
```
-## DataSourceChange — type
+## DataSourceChange — type @experimental
```
| { type: 'insert'; index: number; count: number }
| { type: 'remove'; index: number; count: number }
@@ -2204,7 +2204,7 @@ subscribe: ((listener: (change: DataSourceChange) => void) => Unsubscribe) | und
| { type: 'reset' }
```
-## DataType — enum
+## DataType — enum @experimental
```
Float = 1
Float2 = 2
@@ -2216,21 +2216,21 @@ Int3 = 7
Int4 = 8
```
-## DecodedChunk — interface
+## DecodedChunk — interface @experimental
```
tiles: Uint16Array<ArrayBufferLike>
x: number
y: number
```
-## DecodedPixels — interface
+## DecodedPixels — interface @experimental
```
height: number
pixels: Uint8Array<ArrayBufferLike>
width: number
```
-## DeviceIdentity — interface
+## DeviceIdentity — interface @experimental
```
backend: string
renderer: string
@@ -2238,17 +2238,17 @@ vendor: string
version: string
```
-## DeviceLostReason — const
+## DeviceLostReason — const @experimental
```
{ readonly Unknown: 0; readonly ContextLost: 1; readonly OutOfMemory: 2; readonly Reset: 3; readonly Removed: 4; readonly Destroyed: 5; readonly Validation: 6; readonly Internal: 7; }
```
-## DeviceStatus — const
+## DeviceStatus — const @experimental
```
{ readonly Live: 0; readonly Lost: 1; readonly Recovering: 2; readonly Dead: 3; }
```
-## DiagnosticEvent — interface
+## DiagnosticEvent — interface @experimental
```
context: Record<string, unknown> | undefined
count: number
@@ -2261,7 +2261,7 @@ source: string | undefined
stack: string | undefined
```
-## DiagnosticKind — type
+## DiagnosticKind — type @experimental
```
| 'engine'
/** Reached the host with nobody catching it: `window.onerror`,
@@ -2280,7 +2280,7 @@ stack: string | undefined
| 'game'
```
-## DiagnosticReport — interface
+## DiagnosticReport — interface @experimental
```
context: Record<string, unknown> | undefined
error: unknown
@@ -2289,12 +2289,12 @@ message: string
source: string | undefined
```
-## Diagnostics — const
+## Diagnostics — const @experimental
```
ResourceDef<DiagnosticsAPI>
```
-## DiagnosticsAPI — class
+## DiagnosticsAPI — class @experimental
```
clear: () => void
dropped: number
@@ -2308,13 +2308,13 @@ static new (options?: DiagnosticsOptions): DiagnosticsAPI
static prototype: DiagnosticsAPI
```
-## DiagnosticsOptions — interface
+## DiagnosticsOptions — interface @experimental
```
flushIntervalSec: number | undefined
maxDistinct: number | undefined
```
-## DiagnosticsPlugin — class
+## DiagnosticsPlugin — class @experimental
```
build: (app: App) => void
cleanup: (app: App) => void
@@ -2323,19 +2323,19 @@ static new (options_?: DiagnosticsPluginOptions): DiagnosticsPlugin
static prototype: DiagnosticsPlugin
```
-## DiagnosticsPluginOptions — interface
+## DiagnosticsPluginOptions — interface @experimental
```
captureLevel: LogLevel | undefined
flushIntervalSec: number | undefined
maxDistinct: number | undefined
```
-## DiagnosticsSink — type
+## DiagnosticsSink — type @experimental
```
(events: readonly DiagnosticEvent[]) => void
```
-## DialogHandle — interface
+## DialogHandle — interface @experimental
```
close: () => void
dispose: () => void
@@ -2345,7 +2345,7 @@ open: () => void
panelEntity: number
```
-## DialogOptions — interface
+## DialogOptions — interface @experimental
```
backdropNode: UINodeInit | undefined
backdropVisual: UIVisualInit | undefined
@@ -2360,35 +2360,35 @@ startHidden: boolean | undefined
world: World
```
-## DiffOptions — interface
+## DiffOptions — interface @experimental
```
floatEpsilon: number | undefined
ignoreEntityNames: readonly string[] | undefined
ignoreMetadataKeys: readonly string[] | undefined
```
-## Dimension — interface
+## Dimension — interface @experimental
```
unit: number
value: number
```
-## DimensionUnit — type
+## DimensionUnit — type @experimental
```
(typeof DimensionUnit)[keyof typeof DimensionUnit]
```
-## Disabled — const
+## Disabled — const @experimental
```
ComponentDef<{}>
```
-## DistanceJoint — const
+## DistanceJoint — const @experimental
```
ComponentDef<DistanceJointData>
```
-## DragPlugin — class
+## DragPlugin — class @experimental
```
build: (app: App) => void
dependencies: "uiInteraction"[]
@@ -2397,12 +2397,12 @@ static new (): DragPlugin
static prototype: DragPlugin
```
-## DragState — const
+## DragState — const @experimental
```
ComponentDef<DragStateData>
```
-## DragStateData — interface
+## DragStateData — interface @experimental
```
currentWorldPos: { x: number; y: number; }
deltaWorld: { x: number; y: number; }
@@ -2412,12 +2412,12 @@ startWorldPos: { x: number; y: number; }
totalDeltaWorld: { x: number; y: number; }
```
-## Draggable — const
+## Draggable — const @experimental
```
ComponentDef<DraggableData>
```
-## DraggableData — interface
+## DraggableData — interface @experimental
```
constraintMax: { x: number; y: number; } | null
constraintMin: { x: number; y: number; } | null
@@ -2427,17 +2427,17 @@ lockX: boolean
lockY: boolean
```
-## DragonBones — const
+## DragonBones — const @experimental
```
ResourceDef<DragonBonesManager | null>
```
-## DragonBonesAnimation — const
+## DragonBonesAnimation — const @experimental
```
BuiltinComponentDef<DragonBonesAnimationData>
```
-## DragonBonesAnimationData — interface
+## DragonBonesAnimationData — interface @experimental
```
animation: string
armature: string
@@ -2456,7 +2456,7 @@ skeletonScale: number
timeScale: number
```
-## DragonBonesPlugin — class
+## DragonBonesPlugin — class @experimental
```
acquire: () => Promise<DragonBonesManager | null>
build: (app: App) => void
@@ -2467,12 +2467,12 @@ static new (manager?: DragonBonesManager): DragonBonesPlugin
static prototype: DragonBonesPlugin
```
-## Draw — const
+## Draw — const @experimental
```
DrawAPI
```
-## DrawAPI — interface
+## DrawAPI — interface @experimental
```
begin: (viewProjection: Float32Array) => void
circle: (center: Vec2, radius: number, color: Color, filled?: boolean, segments?: number) => void
@@ -2493,7 +2493,7 @@ texture: (position: Vec2, size: Vec2, textureHandle: number, tint?: Color) => vo
textureRotated: (position: Vec2, size: Vec2, rotation: number, textureHandle: number, tint?: Color) => void
```
-## DrawCallInfo — interface
+## DrawCallInfo — interface @experimental
```
blendMode: number
cameraIndex: number
@@ -2521,12 +2521,12 @@ type: RenderType
vertexCount: number
```
-## DrawCallback — type
+## DrawCallback — type @experimental
```
(elapsed: number) => void
```
-## DrawRank — interface
+## DrawRank — interface @experimental
```
layer: number
order: LayerOrder
@@ -2534,7 +2534,7 @@ worldY: number
worldZ: number
```
-## DropShadowFilterOptions — interface
+## DropShadowFilterOptions — interface @experimental
```
blur: number | undefined
color: { r: number; g: number; b: number; a: number; } | undefined
@@ -2543,7 +2543,7 @@ offsetY: number | undefined
texelSize: { x: number; y: number; } | undefined
```
-## DropdownHandle — interface
+## DropdownHandle — interface @experimental
```
close: () => void
dispose: () => void
@@ -2556,7 +2556,7 @@ open: () => void
setSelectedIndex: (index: number) => void
```
-## DropdownOptions — interface
+## DropdownOptions — interface @experimental
```
buttonStates: { normal?: Color; hover?: Color; pressed?: Color; } | undefined
disabled: boolean | undefined
@@ -2573,17 +2573,17 @@ tabIndex: number | undefined
world: World
```
-## EDITOR_UI_ANCHOR — const
+## EDITOR_UI_ANCHOR — const @experimental
```
{ readonly x: 0; readonly y: 0; }
```
-## EDITOR_VIEW_ENTITY — const
+## EDITOR_VIEW_ENTITY — const @experimental
```
-1
```
-## ESEngineModule — interface
+## ESEngineModule — interface @experimental
```
EstellaContext: new () => CppEngineContext
FS: EmscriptenFS
@@ -2805,12 +2805,12 @@ ui_getCullBit: ((registry: CppRegistry, entity: number) => number) | undefined
ui_getRenderOrder: ((registry: CppRegistry, entity: number) => number) | undefined
```
-## EasingType — type
+## EasingType — type @experimental
```
(typeof EasingType)[keyof typeof EasingType]
```
-## EditorAssetType — type
+## EditorAssetType — type @experimental
```
| 'texture' | 'material' | 'shader' | 'spine-atlas' | 'spine-skeleton'
| 'dragonbones-atlas' | 'dragonbones-skeleton'
@@ -2819,7 +2819,7 @@ ui_getRenderOrder: ((registry: CppRegistry, entity: number) => number) | undefin
| 'unknown'
```
-## EditorBridge — interface
+## EditorBridge — interface @experimental
```
onComponentAdded: ((entity: number, component: string) => void) | undefined
onComponentChanged: ((entity: number, component: string) => void) | undefined
@@ -2830,12 +2830,12 @@ onParentChanged: ((child: number, parent: number | null) => void) | undefined
registerComponent: (name: string, defaults: Record<string, unknown>, isTag: boolean) => void
```
-## EditorGrid — const
+## EditorGrid — const @experimental
```
ResourceDef<EditorGridData>
```
-## EditorGridData — interface
+## EditorGridData — interface @experimental
```
axisX: GridColor
axisY: GridColor
@@ -2846,12 +2846,12 @@ majorEvery: number
spacing: number
```
-## EditorView — const
+## EditorView — const @experimental
```
ResourceDef<EditorViewData>
```
-## EditorViewData — interface
+## EditorViewData — interface @experimental
```
active: boolean
distance: number
@@ -2863,7 +2863,7 @@ x: number
y: number
```
-## EffectDef — interface
+## EffectDef — interface @experimental
```
factory: () => ShaderHandle
label: string
@@ -2873,7 +2873,7 @@ type: string
uniforms: EffectUniformDef[]
```
-## EffectUniformDef — interface
+## EffectUniformDef — interface @experimental
```
defaultValue: number
label: string
@@ -2884,18 +2884,18 @@ neutralValue: number | undefined
step: number
```
-## EmbeddedSideModuleEntry — interface
+## EmbeddedSideModuleEntry — interface @experimental
```
glueBase64: string
wasmBase64: string
```
-## EmbeddedSideModuleRegistry — type
+## EmbeddedSideModuleRegistry — type @experimental
```
Partial<Record<SideModuleId, EmbeddedSideModuleEntry>>
```
-## EmitterShape — enum
+## EmitterShape — enum @experimental
```
Circle = 1
Cone = 3
@@ -2903,17 +2903,17 @@ Point = 0
Rectangle = 2
```
-## EngineApi — type
+## EngineApi — type @experimental
```
NativeEngineApi & Partial<NativeHeap>
```
-## Entity — type
+## Entity — type @experimental
```
number
```
-## EntityCommands — class
+## EntityCommands — class @experimental
```
finalize: () => void
id: () => Entity
@@ -2923,7 +2923,7 @@ static new (commands: CommandsInstance, entity: Entity | null, name?: string): E
static prototype: EntityCommands
```
-## EntityEvent — interface
+## EntityEvent — interface @experimental
```
currentTarget: number
data: TData
@@ -2935,12 +2935,12 @@ target: number
type: string
```
-## EntityEventHandler — type
+## EntityEventHandler — type @experimental
```
(event: EntityEvent<TData>) => void
```
-## EntityEventQueue — class
+## EntityEventQueue — class @experimental
```
clear: () => void
drain: () => readonly EntityEvent[]
@@ -2954,22 +2954,22 @@ static new (): EntityEventQueue
static prototype: EntityEventQueue
```
-## EntityEvents — const
+## EntityEvents — const @experimental
```
ResourceDef<EntityEventQueue>
```
-## EventBinding — const
+## EventBinding — const @experimental
```
ComponentDef<EventBindingData>
```
-## EventBindingData — interface
+## EventBindingData — interface @experimental
```
rows: EventBindingRow[]
```
-## EventBindingPlugin — class
+## EventBindingPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -2978,7 +2978,7 @@ static new (): EventBindingPlugin
static prototype: EventBindingPlugin
```
-## EventBindingRow — interface
+## EventBindingRow — interface @experimental
```
action: string
arg: string | undefined
@@ -2990,25 +2990,25 @@ params: Record<string, AiParamValue> | undefined
target: string | undefined
```
-## EventDef — interface
+## EventDef — interface @experimental
```
_id: symbol
_name: string
_phantom: T | undefined
```
-## EventReader — function
+## EventReader — function @experimental
```
<T>(event: EventDef<T>): EventReaderDescriptor<T>
```
-## EventReaderDescriptor — interface
+## EventReaderDescriptor — interface @experimental
```
_event: EventDef<T>
_type: "event_reader"
```
-## EventReaderInstance — class
+## EventReaderInstance — class @experimental
```
isEmpty: () => boolean
toArray: () => T[]
@@ -3016,7 +3016,7 @@ static new <T>(bus: EventBus<T>): EventReaderInstance<T>
static prototype: EventReaderInstance<any>
```
-## EventRegistry — class
+## EventRegistry — class @experimental
```
getBus: <T>(event: EventDef<T>) => EventBus<T>
register: <T>(event: EventDef<T>) => void
@@ -3025,25 +3025,25 @@ static new (): EventRegistry
static prototype: EventRegistry
```
-## EventWriter — function
+## EventWriter — function @experimental
```
<T>(event: EventDef<T>): EventWriterDescriptor<T>
```
-## EventWriterDescriptor — interface
+## EventWriterDescriptor — interface @experimental
```
_event: EventDef<T>
_type: "event_writer"
```
-## EventWriterInstance — class
+## EventWriterInstance — class @experimental
```
send: (event: T) => void
static new <T>(bus: EventBus<T>): EventWriterInstance<T>
static prototype: EventWriterInstance<any>
```
-## ExternalEntityRef — interface
+## ExternalEntityRef — interface @experimental
```
componentType: string
entityId: number
@@ -3051,7 +3051,7 @@ field: string
target: number
```
-## ExtractEntity — interface
+## ExtractEntity — interface @experimental
```
children: number[]
components: ComponentData[]
@@ -3061,12 +3061,12 @@ parent: number | null
visible: boolean | undefined
```
-## FILL_AXIS — const
+## FILL_AXIS — const @experimental
```
Record<LinearFillDirection, readonly [FillMethod, FillOrigin]>
```
-## FieldMeta — interface
+## FieldMeta — interface @experimental
```
advanced: boolean | undefined
bitmask: { bits?: number; source?: string; } | undefined
@@ -3086,7 +3086,7 @@ tooltip: string | undefined
unit: string | undefined
```
-## FillMethod — enum
+## FillMethod — enum @experimental
```
Horizontal = 0
Radial180 = 4
@@ -3095,7 +3095,7 @@ Radial90 = 3
Vertical = 1
```
-## FillOrigin — enum
+## FillOrigin — enum @experimental
```
Bottom = 2
Left = 0
@@ -3103,7 +3103,7 @@ Right = 1
Top = 3
```
-## FilterEffectDef — interface
+## FilterEffectDef — interface @experimental
```
filter: "lowpass" | "highpass" | "bandpass" | "lowshelf" | "highshelf" | "peaking" | "notch"
frequency: number
@@ -3112,7 +3112,7 @@ q: number | undefined
type: "filter"
```
-## FilterExpr — type
+## FilterExpr — type @experimental
```
| { readonly kind: 'with'; readonly component: AnyComponentDef }
| { readonly kind: 'without'; readonly component: AnyComponentDef }
@@ -3121,12 +3121,12 @@ type: "filter"
| { readonly kind: 'not'; readonly filter: FilterExpr }
```
-## Filters — const
+## Filters — const @experimental
```
{ identityMatrix(): number[]; grayscaleMatrix(): number[]; sepiaMatrix(): number[]; brightnessMatrix(value: number): number[]; contrastMatrix(value: number): number[]; saturationMatrix(value: number): number[]; invertMatrix(): number[]; getColorMatrixShader: () => ShaderHandle; colorMatrixUniforms(matrix: number[]): Record<string, number[]>; }
```
-## FlattenContext — interface
+## FlattenContext — interface @experimental
```
allocateId: () => number
depth: number | undefined
@@ -3134,18 +3134,18 @@ loadPrefab: (path: string) => PrefabData | null
visited: Set<string> | undefined
```
-## FlattenResult — interface
+## FlattenResult — interface @experimental
```
entities: ProcessedEntity[]
rootId: number
```
-## FlexContainer — const
+## FlexContainer — const @experimental
```
BuiltinComponentDef<FlexContainerData>
```
-## FlexContainerData — interface
+## FlexContainerData — interface @experimental
```
alignContent: AlignContent
alignItems: AlignItems
@@ -3156,17 +3156,17 @@ padding: Padding
wrap: FlexWrap
```
-## FlexDirection — type
+## FlexDirection — type @experimental
```
(typeof FlexDirection)[keyof typeof FlexDirection]
```
-## FlexWrap — type
+## FlexWrap — type @experimental
```
(typeof FlexWrap)[keyof typeof FlexWrap]
```
-## FlushReason — enum
+## FlushReason — enum @experimental
```
BatchFull = 0
BlendModeChange = 5
@@ -3179,12 +3179,12 @@ TextureSlotsFull = 1
TypeChange = 7
```
-## FocusManager — const
+## FocusManager — const @experimental
```
ResourceDef<FocusManagerState>
```
-## FocusManagerState — class
+## FocusManagerState — class @experimental
```
blur: () => Entity | null
focus: (entity: Entity, visible?: boolean) => Entity | null
@@ -3195,7 +3195,7 @@ static new (): FocusManagerState
static prototype: FocusManagerState
```
-## FocusPlugin — class
+## FocusPlugin — class @experimental
```
build: (app: App) => void
dependencies: "uiInteraction"[]
@@ -3204,23 +3204,23 @@ static new (): FocusPlugin
static prototype: FocusPlugin
```
-## Focusable — const
+## Focusable — const @experimental
```
ComponentDef<FocusableData>
```
-## FocusableData — interface
+## FocusableData — interface @experimental
```
isFocused: boolean
tabIndex: number
```
-## FollowTarget — const
+## FollowTarget — const @experimental
```
ComponentDef<FollowTargetData>
```
-## FollowTargetData — interface
+## FollowTargetData — interface @experimental
```
damping: number
deadzone: number
@@ -3229,12 +3229,12 @@ offsetY: number
target: number
```
-## FontHandle — type
+## FontHandle — type @experimental
```
number
```
-## ForceFieldType — enum
+## ForceFieldType — enum @experimental
```
Directional = 0
Drag = 3
@@ -3242,13 +3242,13 @@ Point = 1
Vortex = 2
```
-## FrameCaptureData — interface
+## FrameCaptureData — interface @experimental
```
cameraCount: number
drawCalls: DrawCallInfo[]
```
-## FrameHistory — class
+## FrameHistory — class @experimental
```
count: number
getAll: () => FrameSnapshot[]
@@ -3259,14 +3259,14 @@ static new (capacity?: number): FrameHistory
static prototype: FrameHistory
```
-## FrameSnapshot — interface
+## FrameSnapshot — interface @experimental
```
frameTimeMs: number
phaseTimings: Map<string, number>
systemTimings: Map<string, number>
```
-## FrameStats — interface
+## FrameStats — interface @experimental
```
culled: number
drawCalls: number
@@ -3282,23 +3282,23 @@ text: number
triangles: number
```
-## FsmActionRef — type
+## FsmActionRef — type @experimental
```
string | { name: string; arg?: string; params?: Record<string, AiParamValue> }
```
-## FsmDefinition — interface
+## FsmDefinition — interface @experimental
```
initial: string
states: FsmState[]
```
-## FsmEdge — type
+## FsmEdge — type @experimental
```
GraphEdge<FsmTransition>
```
-## FsmPlugin — class
+## FsmPlugin — class @experimental
```
build: (app: App) => void
name: string
@@ -3306,14 +3306,14 @@ static new (): FsmPlugin
static prototype: FsmPlugin
```
-## FsmRunState — interface
+## FsmRunState — interface @experimental
```
current: string
entered: boolean
previous: string | null
```
-## FsmState — interface
+## FsmState — interface @experimental
```
name: string
onEnter: FsmActionRef | undefined
@@ -3324,7 +3324,7 @@ x: number | undefined
y: number | undefined
```
-## FsmTransition — interface
+## FsmTransition — interface @experimental
```
condition: string | undefined
guard: BlackboardGuard | BlackboardGuard[] | undefined
@@ -3332,12 +3332,12 @@ to: string
trigger: string | undefined
```
-## GLDebug — const
+## GLDebug — const @experimental
```
{ enable(): void; disable(): void; check(context: string): number; diagnose(): void; }
```
-## GameSocket — class
+## GameSocket — class @experimental
```
close: (code?: number, reason?: string) => void
connect: () => void
@@ -3348,12 +3348,12 @@ static new (options: GameSocketOptions): GameSocket
static prototype: GameSocket
```
-## GameSocketOptions — type
+## GameSocketOptions — type @experimental
```
PlatformSocketOptions
```
-## GamepadAxis — enum
+## GamepadAxis — enum @experimental
```
LeftX = 0
LeftY = 1
@@ -3361,7 +3361,7 @@ RightX = 2
RightY = 3
```
-## GamepadButton — enum
+## GamepadButton — enum @experimental
```
Back = 8
DpadDown = 13
@@ -3382,7 +3382,7 @@ Start = 9
West = 2
```
-## GamepadSnapshot — interface
+## GamepadSnapshot — interface @experimental
```
axes: number[]
buttons: number[]
@@ -3391,7 +3391,7 @@ index: number
mapping: string
```
-## GearBinding — interface
+## GearBinding — interface @experimental
```
component: string
controller: string
@@ -3400,28 +3400,28 @@ property: string
tween: GearTween | undefined
```
-## GearTween — interface
+## GearTween — interface @experimental
```
duration: number
easing: EasingType
```
-## GearValue — type
+## GearValue — type @experimental
```
number | boolean | string | Color | Vec2 | Vec3
```
-## Geometry — const
+## Geometry — const @experimental
```
{ create(options: GeometryOptions): GeometryHandle; updateVertices(handle: GeometryHandle, vertices: Float32Array, offset?: number): void; release(handle: GeometryHandle): void; isValid(handle: GeometryHandle): boolean; createQuad(width?: number, height?: number): GeometryHandle; createCircle(radius?: number, segments?: number): GeometryHandle; createPolygon(points: Array<{ x: number; y: number; }>): GeometryHandle; }
```
-## GeometryHandle — type
+## GeometryHandle — type @experimental
```
number
```
-## GeometryOptions — interface
+## GeometryOptions — interface @experimental
```
dynamic: boolean | undefined
indices: Uint16Array<ArrayBufferLike> | Uint32Array<ArrayBufferLike> | undefined
@@ -3429,7 +3429,7 @@ layout: VertexAttributeDescriptor[]
vertices: Float32Array<ArrayBufferLike>
```
-## GestureDetector — class
+## GestureDetector — class @experimental
```
onLongPress: ((x: number, y: number) => void) | null
onPinch: ((scale: number, centerX: number, centerY: number) => void) | null
@@ -3441,22 +3441,22 @@ static new (input: InputState): GestureDetector
static prototype: GestureDetector
```
-## GetWorld — function
+## GetWorld — function @experimental
```
(): GetWorldDescriptor
```
-## GetWorldDescriptor — interface
+## GetWorldDescriptor — interface @experimental
```
_type: "get_world"
```
-## GpAxis — const
+## GpAxis — const @experimental
```
(axis: number, pad?: number, scale?: number) => Binding
```
-## GpButton — const
+## GpButton — const @experimental
```
(button: number, pad?: number) => Binding
```
@@ -3487,7 +3487,7 @@ _type: "get_world"
'float' | 'vec2' | 'vec3' | 'vec4'
```
-## Graphics — class
+## Graphics — class @experimental
```
arc: (cx: number, cy: number, radius: number, startAngle: number, endAngle: number, anticlockwise?: boolean, segments?: number) => void
beginFill: (color: Color) => void
@@ -3511,12 +3511,12 @@ static new (): Graphics
static prototype: Graphics
```
-## GridColor — type
+## GridColor — type @experimental
```
[number, number, number, number]
```
-## GridLayoutProvider — class
+## GridLayoutProvider — class @experimental
```
getContentSize: (count: number) => Vec2
getItemRect: (index: number) => Rect
@@ -3525,20 +3525,20 @@ static new (opts: GridLayoutOptions): GridLayoutProvider
static prototype: GridLayoutProvider
```
-## HeadlessAppOptions — interface
+## HeadlessAppOptions — interface @experimental
```
plugins: Plugin[] | undefined
sideModules: SideModuleHost | undefined
```
-## HitAreaShape — type
+## HitAreaShape — type @experimental
```
| { type: 'rect'; x: number; y: number; width: number; height: number }
| { type: 'circle'; cx: number; cy: number; radius: number }
| { type: 'polygon'; points: number[] }
```
-## HttpBackend — class
+## HttpBackend — class @experimental
```
fetchBinary: (path: string) => Promise<ArrayBuffer>
fetchText: (path: string) => Promise<string>
@@ -3548,42 +3548,42 @@ static new (options: HttpBackendOptions): HttpBackend
static prototype: HttpBackend
```
-## INTERACTION_CONTROLLER — const
+## INTERACTION_CONTROLLER — const @experimental
```
"$interaction"
```
-## INTERACTION_PAGES — const
+## INTERACTION_PAGES — const @experimental
```
readonly ["normal", "hover", "pressed", "disabled", "focused"]
```
-## INVALID_ENTITY — const
+## INVALID_ENTITY — const @experimental
```
number
```
-## INVALID_FONT — const
+## INVALID_FONT — const @experimental
```
number
```
-## INVALID_MATERIAL — const
+## INVALID_MATERIAL — const @experimental
```
0
```
-## INVALID_TEXTURE — const
+## INVALID_TEXTURE — const @experimental
```
number
```
-## Identity — const
+## Identity — const @experimental
```
ResourceDef<IdentityAPI>
```
-## IdentityAPI — class
+## IdentityAPI — class @experimental
```
available: boolean
login: () => Promise<LoginResult>
@@ -3592,7 +3592,7 @@ static new (): IdentityAPI
static prototype: IdentityAPI
```
-## ImageSegment — interface
+## ImageSegment — interface @experimental
```
height: number
offsetX: number
@@ -3605,7 +3605,7 @@ valign: ImageValign
width: number
```
-## InferParam — type
+## InferParam — type @experimental
```
P extends QueryDescriptor<infer C> ? QueryInstance<C> :
P extends ResDescriptor<infer T> ? T :
@@ -3618,19 +3618,19 @@ P extends QueryDescriptor<infer C> ? QueryInstance<C> :
never
```
-## InferParams — type
+## InferParams — type @experimental
```
{
[K in keyof P]: InferParam<P[K]>;
}
```
-## Input — const
+## Input — const @experimental
```
ResourceDef<InputState>
```
-## InputHandler — interface
+## InputHandler — interface @experimental
```
onKeyDown: ((code: string, mods: Modifiers) => boolean | void) | undefined
onKeyUp: ((code: string, mods: Modifiers) => boolean | void) | undefined
@@ -3644,7 +3644,7 @@ onTouchStart: ((id: number, x: number, y: number) => boolean | void) | undefined
onWheel: ((deltaX: number, deltaY: number, mods: Modifiers) => boolean | void) | undefined
```
-## InputMap — class
+## InputMap — class @experimental
```
actions: () => string[]
axis2d: (name: string) => Vec2
@@ -3668,13 +3668,13 @@ static new (actions: Record<string, ActionDef>): InputMap
static prototype: InputMap
```
-## InputMapAsset — interface
+## InputMapAsset — interface @experimental
```
actions: Record<string, ActionDef>
version: number
```
-## InputPlugin — class
+## InputPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -3683,7 +3683,7 @@ static new (target?: unknown): InputPlugin
static prototype: InputPlugin
```
-## InputRouter — class
+## InputRouter — class @experimental
```
currentMods: Modifiers
dispatchKeyDown: (code: string) => boolean
@@ -3702,7 +3702,7 @@ static new (): InputRouter
static prototype: InputRouter
```
-## InputState — class
+## InputState — class @experimental
```
beginFixedStep: () => void
clearFrameState: () => void
@@ -3761,7 +3761,7 @@ static new (): InputState
static prototype: InputState
```
-## InstantiatePrefabOptions — interface
+## InstantiatePrefabOptions — interface @experimental
```
assetBaseUrl: string | undefined
assets: Assets | undefined
@@ -3769,57 +3769,57 @@ overrides: PrefabOverride[] | undefined
parent: number | undefined
```
-## InstantiatePrefabResult — interface
+## InstantiatePrefabResult — interface @experimental
```
entities: Map<number, number>
root: number
```
-## Interactable — const
+## Interactable — const @experimental
```
BuiltinComponentDef<InteractableData>
```
-## InteractableData — interface
+## InteractableData — interface @experimental
```
blockRaycast: boolean
enabled: boolean
raycastTarget: boolean
```
-## InterestPolicy — type
+## InterestPolicy — type @experimental
```
(view: InterestView) => ReadonlySet<Entity> | 'all'
```
-## InterestView — interface
+## InterestView — interface @experimental
```
candidates: readonly number[]
connectionId: number
world: World
```
-## InterpType — type
+## InterpType — type @experimental
```
(typeof InterpType)[keyof typeof InterpType]
```
-## JsonResult — interface
+## JsonResult — interface @experimental
```
data: T
```
-## JustifyContent — type
+## JustifyContent — type @experimental
```
(typeof JustifyContent)[keyof typeof JustifyContent]
```
-## Key — const
+## Key — const @experimental
```
(code: string) => Binding
```
-## Keyframe — interface
+## Keyframe — interface @experimental
```
inTangent: number
interpolation: InterpType | undefined
@@ -3828,17 +3828,17 @@ time: number
value: number
```
-## Keys1D — const
+## Keys1D — const @experimental
```
(neg: string, pos: string) => Binding
```
-## Keys2D — const
+## Keys2D — const @experimental
```
(up: string, down: string, left: string, right: string) => Binding
```
-## KineticScroll — class
+## KineticScroll — class @experimental
```
beginDrag: () => void
endDrag: () => void
@@ -3853,31 +3853,31 @@ static new (opts?: KineticScrollOptions): KineticScroll
static prototype: KineticScroll
```
-## LIGHT_TOKENS — const
+## LIGHT_TOKENS — const @experimental
```
ThemeTokens
```
-## LayerOrder — enum
+## LayerOrder — enum @experimental
```
Depth = 2
Painter = 0
YSort = 1
```
-## LayoutProvider — interface
+## LayoutProvider — interface @experimental
```
getContentSize: (count: number) => Vec2
getItemRect: (index: number) => Rect
getVisibleRange: (viewport: Rect, count: number) => [start: number, end: number]
```
-## Leaderboard — const
+## Leaderboard — const @experimental
```
ResourceDef<LeaderboardAPI>
```
-## LeaderboardAPI — class
+## LeaderboardAPI — class @experimental
```
available: boolean
dispose: () => void
@@ -3892,7 +3892,7 @@ static new (module_: () => ESEngineModule | null): LeaderboardAPI
static prototype: LeaderboardAPI
```
-## LeaderboardOptions — interface
+## LeaderboardOptions — interface @experimental
```
key: string | undefined
limit: number | undefined
@@ -3901,18 +3901,18 @@ scope: LeaderboardScope | undefined
style: LeaderboardStyle | undefined
```
-## LeaderboardProvider — interface
+## LeaderboardProvider — interface @experimental
```
canvas: () => PlatformCanvas | null
post: (message: Record<string, unknown>) => void
```
-## LeaderboardScope — type
+## LeaderboardScope — type @experimental
```
'friends' | 'group'
```
-## LeaderboardStyle — interface
+## LeaderboardStyle — interface @experimental
```
avatars: boolean | undefined
background: string | undefined
@@ -3924,22 +3924,22 @@ rowHeight: number | undefined
selfColor: string | undefined
```
-## Lifecycle — const
+## Lifecycle — const @experimental
```
ResourceDef<LifecycleManager>
```
-## LifecycleEvent — type
+## LifecycleEvent — type @experimental
```
'show' | 'hide' | 'pause' | 'resume'
```
-## LifecycleListener — type
+## LifecycleListener — type @experimental
```
(event: LifecycleEvent) => void
```
-## LifecycleManager — class
+## LifecycleManager — class @experimental
```
autoPause: boolean
emit_: (event: LifecycleEvent) => void
@@ -3954,7 +3954,7 @@ static new (autoPause?: boolean): LifecycleManager
static prototype: LifecycleManager
```
-## LifecyclePlugin — class
+## LifecyclePlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -3963,17 +3963,17 @@ static new (options_?: LifecyclePluginOptions | undefined): LifecyclePlugin
static prototype: LifecyclePlugin
```
-## LifecyclePluginOptions — interface
+## LifecyclePluginOptions — interface @experimental
```
autoPause: boolean | undefined
```
-## Light2D — const
+## Light2D — const @experimental
```
BuiltinComponentDef<Light2DData>
```
-## Light2DData — interface
+## Light2DData — interface @experimental
```
color: Color
direction: Vec2
@@ -3987,7 +3987,7 @@ shadowSoftness: number
type: number
```
-## Light2DType — enum
+## Light2DType — enum @experimental
```
Ambient = 2
Directional = 1
@@ -3995,12 +3995,12 @@ Point = 0
Spot = 3
```
-## LinearFillDirection — type
+## LinearFillDirection — type @experimental
```
'right' | 'left' | 'up' | 'down'
```
-## LinearLayoutProvider — class
+## LinearLayoutProvider — class @experimental
```
getContentSize: (count: number) => Vec2
getItemRect: (index: number) => Rect
@@ -4009,20 +4009,20 @@ static new (opts: LinearLayoutOptions): LinearLayoutProvider
static prototype: LinearLayoutProvider
```
-## ListItemTemplate — interface
+## ListItemTemplate — interface @experimental
```
bind: (entity: Entity, data: T, index: number) => void
create: (world: World, parent: Entity) => Entity
```
-## ListLayoutSpec — type
+## ListLayoutSpec — type @experimental
```
| { itemHeight: number | ((index: number) => number); spacing?: number; direction?: 'column' }
| { itemWidth: number; spacing?: number; direction: 'row' }
| { columns: number; itemSize: Vec2; spacing?: Vec2 }
```
-## ListView — class
+## ListView — class @experimental
```
dispose: () => void
getContentSize: () => Vec2
@@ -4037,7 +4037,7 @@ static new <T = unknown>(opts: ListViewOptions<T>): ListView<T>
static prototype: ListView<any>
```
-## ListViewHandle — interface
+## ListViewHandle — interface @experimental
```
content: number
data: DataSource<T>
@@ -4050,7 +4050,7 @@ scrollToIndex: (index: number) => void
view: ListView<T>
```
-## ListViewHost — interface
+## ListViewHost — interface @experimental
```
attachScrollContainer: (entity: Entity, container: ScrollContainer) => void
detachScrollContainer: (entity: Entity) => void
@@ -4058,7 +4058,7 @@ registerListView: (list: ListView<unknown>) => void
unregisterListView: (list: ListView<unknown>) => void
```
-## ListViewOptions — interface
+## ListViewOptions — interface @experimental
```
dataSource: DataSource<T>
layout: LayoutProvider
@@ -4072,14 +4072,14 @@ viewportSize: Vec2
world: World
```
-## ListenOptions — interface
+## ListenOptions — interface @experimental
```
gamepad: boolean | undefined
keyboard: boolean | undefined
mouse: boolean | undefined
```
-## LoadRuntimeSceneOptions — interface
+## LoadRuntimeSceneOptions — interface @experimental
```
app: App
module: ESEngineModule | null
@@ -4095,7 +4095,7 @@ uiTheme: "dark" | "light" | undefined
uiThemeOverrides: ThemeOverrides | undefined
```
-## LoadedTilemapLayer — interface
+## LoadedTilemapLayer — interface @experimental
```
chunks: LoadedTilemapChunk[]
height: number
@@ -4105,7 +4105,7 @@ tiles: Uint16Array<ArrayBufferLike>
width: number
```
-## LoadedTilemapSource — interface
+## LoadedTilemapSource — interface @experimental
```
collisionTileIds: number[] | undefined
hexSideLength: number | undefined
@@ -4122,7 +4122,7 @@ tileWidth: number
tilesets: LoadedTilemapTileset[]
```
-## LoadedTilemapTileset — interface
+## LoadedTilemapTileset — interface @experimental
```
columns: number
firstId: number
@@ -4132,52 +4132,52 @@ spacing: number
textureHandle: number
```
-## LocalLeaderboardOptions — interface
+## LocalLeaderboardOptions — interface @experimental
```
friends: readonly CloudPlayer[] | undefined
height: number | undefined
width: number | undefined
```
-## LocalTransform — const
+## LocalTransform — const @experimental
```
BuiltinComponentDef<TransformData>
```
-## LocalTransformData — type
+## LocalTransformData — type @experimental
```
TransformData
```
-## LocaleCatalog — type
+## LocaleCatalog — type @experimental
```
Record<string, LocaleEntry>
```
-## LocaleEntry — type
+## LocaleEntry — type @experimental
```
string | PluralForms
```
-## LocaleResult — interface
+## LocaleResult — interface @experimental
```
keyCount: number
locale: string
```
-## LocaleTableAsset — interface
+## LocaleTableAsset — interface @experimental
```
entries: LocaleCatalog
locale: string
version: number
```
-## Localization — const
+## Localization — const @experimental
```
ResourceDef<LocalizationAPI>
```
-## LocalizationAPI — class
+## LocalizationAPI — class @experimental
```
addCatalog: (locale: string, entries: LocaleCatalog) => void
availableLocales: () => string[]
@@ -4192,7 +4192,7 @@ static new (locale?: string, fallback?: string): LocalizationAPI
static prototype: LocalizationAPI
```
-## LocalizationOptions — interface
+## LocalizationOptions — interface @experimental
```
catalogs: Record<string, LocaleCatalog> | undefined
fallback: string | undefined
@@ -4200,7 +4200,7 @@ locale: string | undefined
tables: string[] | undefined
```
-## LocalizationPlugin — class
+## LocalizationPlugin — class @experimental
```
build: (app: App) => void
name: string
@@ -4208,7 +4208,7 @@ static new (opts?: LocalizationOptions): LocalizationPlugin
static prototype: LocalizationPlugin
```
-## LogEntry — interface
+## LogEntry — interface @experimental
```
category: string
data: unknown
@@ -4217,12 +4217,12 @@ message: string
timestamp: number
```
-## LogHandler — interface
+## LogHandler — interface @experimental
```
handle: (entry: LogEntry) => void
```
-## LogLevel — enum
+## LogLevel — enum @experimental
```
Debug = 0
Error = 3
@@ -4230,7 +4230,7 @@ Info = 1
Warn = 2
```
-## Logger — class
+## Logger — class @experimental
```
addHandler: (handler: LogHandler) => void
clearHandlers: () => void
@@ -4244,17 +4244,17 @@ static new (): Logger
static prototype: Logger
```
-## LoginResult — interface
+## LoginResult — interface @experimental
```
code: string
```
-## LoopMode — type
+## LoopMode — type @experimental
```
(typeof LoopMode)[keyof typeof LoopMode]
```
-## ManifestModel — class
+## ManifestModel — class @experimental
```
allAssets: () => AddressableManifestAsset[]
assetByKey: (key: string) => AddressableManifestAsset | null
@@ -4278,28 +4278,28 @@ static new (manifest: AddressableManifest): ManifestModel
static prototype: ManifestModel
```
-## Marker — const
+## Marker — const @experimental
```
ComponentDef<MarkerData>
```
-## MarkerData — interface
+## MarkerData — interface @experimental
```
properties: Record<string, string>
type: string
```
-## MaskMode — type
+## MaskMode — type @experimental
```
(typeof MaskMode)[keyof typeof MaskMode]
```
-## Material — const
+## Material — const @experimental
```
{ createShader(vertexSrc: string, fragmentSrc: string): ShaderHandle; releaseShader(shader: ShaderHandle): void; create(options: MaterialOptions): MaterialHandle; compileShader(esshaderSource: string, features?: string[]): ShaderHandle; getSwitch(material: MaterialHandle, name: string): boolean; setSwitch(material: MaterialHandle, name: string, on: boolean): void; get(material: MaterialHandle): MaterialData | undefined; setUniform(material: MaterialHandle, name: string, value: UniformValue): void; getUniform(material: MaterialHandle, name: string): UniformValue | undefined; setBlendMode(material: MaterialHandle, mode: BlendMode): void; getBlendMode(material: MaterialHandle): BlendMode; setDepthTest(material: MaterialHandle, enabled: boolean): void; setDepthWrite(material: MaterialHandle, enabled: boolean): void; setCull(material: MaterialHandle, cull: CullMode): void; getShader(material: MaterialHandle): ShaderHandle; release(material: MaterialHandle): void; isValid(material: MaterialHandle): boolean; renderPreview(material: MaterialHandle, w: number, h: number): Promise<ImageData | null>; releaseAll(): void; createFromAsset(data: MaterialAssetData, shaderHandle: ShaderHandle, parentHandle?: MaterialHandle): MaterialHandle; createInstance(source: MaterialHandle): MaterialHandle; toAssetData(material: MaterialHandle, shaderPath: string, parentPath?: string): MaterialAssetData | null; getUniforms(material: MaterialHandle): Map<string, UniformValue>; tex(textureId: number, slot?: number): TextureRef; }
```
-## MaterialAssetData — interface
+## MaterialAssetData — interface @experimental
```
blendMode: number | undefined
cull: number | undefined
@@ -4313,7 +4313,7 @@ type: "material"
version: string
```
-## MaterialData — interface
+## MaterialData — interface @experimental
```
blendMode: BlendMode
cachedBuffer_: Float32Array<ArrayBufferLike> | null
@@ -4347,12 +4347,12 @@ x: number | undefined
y: number | undefined
```
-## MaterialHandle — type
+## MaterialHandle — type @experimental
```
number
```
-## MaterialOptions — interface
+## MaterialOptions — interface @experimental
```
blendMode: BlendMode | undefined
cull: CullMode | undefined
@@ -4363,7 +4363,7 @@ switches: Record<string, boolean> | undefined
uniforms: Record<string, UniformValue> | undefined
```
-## MeasureTextOptions — interface
+## MeasureTextOptions — interface @experimental
```
bold: boolean | undefined
fontFamily: string | undefined
@@ -4374,7 +4374,7 @@ lineHeight: number | undefined
maxWidth: number | undefined
```
-## MeasuredLinearLayoutProvider — class
+## MeasuredLinearLayoutProvider — class @experimental
```
getContentSize: (count: number) => Vec2
getItemRect: (index: number) => Rect
@@ -4384,12 +4384,12 @@ static new (opts: MeasuredLinearLayoutOptions): MeasuredLinearLayoutProvider
static prototype: MeasuredLinearLayoutProvider
```
-## MemoryProvider — interface
+## MemoryProvider — interface @experimental
```
resolveComponentHeap: (cppName: string) => ComponentHeapResolver | null
```
-## MemoryTransport — class
+## MemoryTransport — class @experimental
```
dropPending: () => void
flush: (limit?: number) => void
@@ -4401,12 +4401,12 @@ static pair: (options?: MemoryTransportOptions) => [MemoryTransport, MemoryTrans
static prototype: MemoryTransport
```
-## Mesh2D — const
+## Mesh2D — const @experimental
```
BuiltinComponentDef<Mesh2DData>
```
-## Mesh2DAPI — class
+## Mesh2DAPI — class @experimental
```
clearGeometry: (entity: Entity) => void
getGeometry: (entity: Entity) => Mesh2DGeometry | undefined
@@ -4415,7 +4415,7 @@ static new (module_: NonNullable<EngineApi>, registry_: CppRegistry): Mesh2DAPI
static prototype: Mesh2DAPI
```
-## Mesh2DData — interface
+## Mesh2DData — interface @experimental
```
color: Color
enabled: boolean
@@ -4427,7 +4427,7 @@ parallax: Vec2
texture: number
```
-## Mesh2DGeometry — interface
+## Mesh2DGeometry — interface @experimental
```
colors: number[] | undefined
indices: number[]
@@ -4435,7 +4435,7 @@ positions: number[]
uvs: number[] | undefined
```
-## Mesh2DPlugin — class
+## Mesh2DPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -4444,24 +4444,24 @@ static new (): Mesh2DPlugin
static prototype: Mesh2DPlugin
```
-## Meshes2D — const
+## Meshes2D — const @experimental
```
ResourceDef<Mesh2DAPI>
```
-## MessageHandler — type
+## MessageHandler — type @experimental
```
(payload: T) => void
```
-## MessagePortLike — interface
+## MessagePortLike — interface @experimental
```
close: (() => void) | undefined
onmessage: ((event: { data: unknown; }) => void) | null
postMessage: (data: unknown) => void
```
-## MessagePortTransport — class
+## MessagePortTransport — class @experimental
```
close: () => void
on: (event: "message", handler: (data: string | ArrayBuffer) => void) => () => void
@@ -4470,7 +4470,7 @@ static new (port: MessagePortLike | MessagePort): MessagePortTransport
static prototype: MessagePortTransport
```
-## MigrationResult — interface
+## MigrationResult — interface @experimental
```
data: PrefabData
fromVersion: string
@@ -4478,7 +4478,7 @@ migrated: boolean
toVersion: string
```
-## MiniGameSocket — class
+## MiniGameSocket — class @experimental
```
close: (code?: number, reason?: string) => void
connect: () => void
@@ -4489,25 +4489,25 @@ static new (options: GameSocketOptions, global: MiniGameGlobal): MiniGameSocket
static prototype: MiniGameSocket
```
-## MissingAssetCallback — type
+## MissingAssetCallback — type @experimental
```
(missing: MissingAsset[]) => void
```
-## MissingAssetsError — class
+## MissingAssetsError — class @experimental
```
missing: MissingAsset[]
static new (missing: MissingAsset[]): MissingAssetsError
static prototype: MissingAssetsError
```
-## MockAdProviderOptions — interface
+## MockAdProviderOptions — interface @experimental
```
completed: boolean | undefined
durationMs: number | undefined
```
-## Modifiers — interface
+## Modifiers — interface @experimental
```
alt: boolean
ctrl: boolean
@@ -4515,22 +4515,22 @@ meta: boolean
shift: boolean
```
-## MotorJoint — const
+## MotorJoint — const @experimental
```
ComponentDef<MotorJointData>
```
-## MouseButton — const
+## MouseButton — const @experimental
```
(button: number) => Binding
```
-## Mut — function
+## Mut — function @experimental
```
<T extends AnyComponentDef>(component: T): MutWrapper<T>
```
-## MutWrapper — interface
+## MutWrapper — interface @experimental
```
_component: T
_type: "mut"
@@ -4541,12 +4541,12 @@ _type: "mut"
Record<GraphNodeType, NodeSpec>
```
-## Name — const
+## Name — const @experimental
```
ComponentDef<NameData>
```
-## NameData — interface
+## NameData — interface @experimental
```
value: string
```
@@ -4580,7 +4580,7 @@ textEditor: NativeTextEditorBridge | undefined
writeCacheFile: ((key: string, bytes: ArrayBuffer) => Promise<void>) | undefined
```
-## NativeComponentBufferFn — type
+## NativeComponentBufferFn — type @experimental
```
(entity: number) => ArrayBuffer | null | undefined
```
@@ -4595,13 +4595,13 @@ statusText: string | undefined
text: string | undefined
```
-## NativeGame — interface
+## NativeGame — interface @experimental
```
app: App
config: PackagedGameConfig
```
-## NativeGameOptions — interface
+## NativeGameOptions — interface @experimental
```
bridge: NativeBridge
configPath: string | undefined
@@ -4610,7 +4610,7 @@ scope: Record<string, unknown> | undefined
width: number
```
-## NativeHostBindings — interface
+## NativeHostBindings — interface @experimental
```
es_audioLoad: ((bytes: ArrayBuffer) => { id: number; duration: number; bytes: number; } | null) | undefined
es_audioPause: ((voiceId: number) => void) | undefined
@@ -4669,7 +4669,7 @@ onTouchStart: (id: number, x: number, y: number) => void
onWheel: (deltaX: number, deltaY: number) => void
```
-## NativeMemoryProvider — class
+## NativeMemoryProvider — class @experimental
```
resolveComponentHeap: (cppName: string) => ComponentHeapResolver | null
static new (scope?: Record<string, unknown>): NativeMemoryProvider
@@ -4716,17 +4716,17 @@ static new (bridge_: NativeBridge): NativePlatformAdapter
static prototype: NativePlatformAdapter
```
-## Nav — const
+## Nav — const @experimental
```
ResourceDef<Navigation>
```
-## NavAgent — const
+## NavAgent — const @experimental
```
ComponentDef<NavAgentData>
```
-## NavAgentData — interface
+## NavAgentData — interface @experimental
```
arriveRadius: number
arrived: boolean
@@ -4738,7 +4738,7 @@ targetX: number
targetY: number
```
-## NavGrid — class
+## NavGrid — class @experimental
```
cellSize: number
cellToWorld: (gx: number, gy: number) => Vec2
@@ -4758,7 +4758,7 @@ static new (opts: NavGridOptions): NavGrid
static prototype: NavGrid
```
-## NavGridOptions — interface
+## NavGridOptions — interface @experimental
```
cellSize: number
height: number
@@ -4767,7 +4767,7 @@ walkable: ArrayLike<number> | undefined
width: number
```
-## NavPlugin — class
+## NavPlugin — class @experimental
```
build: (app: App) => void
name: string
@@ -4775,7 +4775,7 @@ static new (): NavPlugin
static prototype: NavPlugin
```
-## Navigation — class
+## Navigation — class @experimental
```
findWorldPath: (from: Vec2, to: Vec2, opts?: PathfindOptions & { radius?: number; }) => Vec2[] | null
grid: NavGrid | null
@@ -4785,18 +4785,18 @@ static new (): Navigation
static prototype: Navigation
```
-## NestedPrefabRef — interface
+## NestedPrefabRef — interface @experimental
```
overrides: PrefabOverride[]
prefabPath: string
```
-## Net — const
+## Net — const @experimental
```
ResourceDef<NetSession>
```
-## NetChannel — class
+## NetChannel — class @experimental
```
dispose: (reason?: string) => void
handle: <Req = unknown, Res = unknown>(type: string, handler: RequestHandler<Req, Res>) => () => void
@@ -4809,22 +4809,22 @@ static new (transport: NetTransport, opts?: NetChannelOptions): NetChannel
static prototype: NetChannel
```
-## NetChannelOptions — interface
+## NetChannelOptions — interface @experimental
```
requestTimeoutMs: number | undefined
```
-## NetGhost — const
+## NetGhost — const @experimental
```
ComponentDef<{}>
```
-## NetRoleKind — type
+## NetRoleKind — type @experimental
```
'offline' | 'server' | 'client'
```
-## NetSession — class
+## NetSession — class @experimental
```
client: ReplicationClient | null
connect: (transport: NetTransport, options?: ReplicationClientOptions) => Promise<ReplicationClient>
@@ -4836,7 +4836,7 @@ static new (app_: App): NetSession
static prototype: NetSession
```
-## NetTransport — interface
+## NetTransport — interface @experimental
```
on: (event: "message", handler: (data: string | ArrayBuffer) => void) => () => void
send: (data: string | ArrayBuffer) => void
@@ -4864,44 +4864,44 @@ output: GraphType | null
params: NodeParamSpec[]
```
-## Not — function
+## Not — function @experimental
```
(filter: FilterExpr): FilterExpr
```
-## OneWayPlatform — const
+## OneWayPlatform — const @experimental
```
ComponentDef<OneWayPlatformData>
```
-## Or — function
+## Or — function @experimental
```
(...filters: FilterExpr[]): FilterExpr
```
-## OutlineFilterOptions — interface
+## OutlineFilterOptions — interface @experimental
```
color: { r: number; g: number; b: number; a: number; } | undefined
texelSize: { x: number; y: number; } | undefined
width: number | undefined
```
-## PLATFORM_BINDINGS — const
+## PLATFORM_BINDINGS — const @experimental
```
{ readonly readAsset: "es_readAsset"; readonly loadImagePixels: "es_loadImagePixels"; readonly utf8Decode: "es_utf8Decode"; }
```
-## PREFAB_FORMAT_VERSION — const
+## PREFAB_FORMAT_VERSION — const @experimental
```
"2"
```
-## PTR_LAYOUTS — const
+## PTR_LAYOUTS — const @experimental
```
Record<string, PtrLayout>
```
-## PackagedAssetIndex — interface
+## PackagedAssetIndex — interface @experimental
```
addressOf: (ref: string) => string | null
assetPaths: () => string[]
@@ -4912,13 +4912,13 @@ resolvePath: (ref: string) => string
textureImport: (ref: string) => ParsedTextureImportSettings | undefined
```
-## PackagedAssetSourceOptions — interface
+## PackagedAssetSourceOptions — interface @experimental
```
backend: Backend | undefined
decodePixels: ((path: string, flip: boolean) => Promise<{ width: number; height: number; pixels: Uint8Array; }>) | undefined
```
-## PackagedGameConfig — interface
+## PackagedGameConfig — interface @experimental
```
achievements: string[] | undefined
audioConfig: AudioProjectConfig | undefined
@@ -4937,17 +4937,17 @@ uiThemeColors: Record<string, string> | undefined
ySortLayers: number | undefined
```
-## Parent — const
+## Parent — const @experimental
```
BuiltinComponentDef<ParentData>
```
-## ParentData — interface
+## ParentData — interface @experimental
```
entity: number
```
-## ParsedTextureImportSettings — interface
+## ParsedTextureImportSettings — interface @experimental
```
filter: "linear" | "nearest" | undefined
sliceBorder: { left: number; right: number; top: number; bottom: number; } | undefined
@@ -4955,12 +4955,12 @@ srgb: boolean | undefined
wrap: "repeat" | "clamp" | "mirror" | undefined
```
-## Particle — const
+## Particle — const @experimental
```
ResourceDef<ParticleAPI>
```
-## ParticleAPI — class
+## ParticleAPI — class @experimental
```
getAliveCount: (entity: Entity) => number
play: (entity: Entity) => void
@@ -4973,7 +4973,7 @@ static new (module: NonNullable<EngineApi>, registry: CppRegistry): ParticleAPI
static prototype: ParticleAPI
```
-## ParticleEasing — enum
+## ParticleEasing — enum @experimental
```
EaseIn = 1
EaseInOut = 3
@@ -4981,12 +4981,12 @@ EaseOut = 2
Linear = 0
```
-## ParticleEmitter — const
+## ParticleEmitter — const @experimental
```
BuiltinComponentDef<ParticleEmitterData>
```
-## ParticleEmitterData — interface
+## ParticleEmitterData — interface @experimental
```
angleSpreadMax: number
angleSpreadMin: number
@@ -5050,12 +5050,12 @@ trailPoints: number
trailWidth: number
```
-## ParticleForceField — const
+## ParticleForceField — const @experimental
```
BuiltinComponentDef<ParticleForceFieldData>
```
-## ParticleForceFieldData — interface
+## ParticleForceFieldData — interface @experimental
```
direction: Vec2
enabled: boolean
@@ -5065,7 +5065,7 @@ strength: number
type: number
```
-## ParticlePlugin — class
+## ParticlePlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -5074,19 +5074,19 @@ static new (): ParticlePlugin
static prototype: ParticlePlugin
```
-## PathfindOptions — interface
+## PathfindOptions — interface @experimental
```
clearance: number | undefined
diagonal: boolean | undefined
snapRadius: number | undefined
```
-## Payment — const
+## Payment — const @experimental
```
ResourceDef<PaymentAPI>
```
-## PaymentAPI — class
+## PaymentAPI — class @experimental
```
available: boolean
request: (request: PaymentRequest) => Promise<void>
@@ -5094,33 +5094,33 @@ static new (): PaymentAPI
static prototype: PaymentAPI
```
-## PaymentFailure — interface
+## PaymentFailure — interface @experimental
```
code: number | undefined
```
-## PaymentRequest — type
+## PaymentRequest — type @experimental
```
PlatformPaymentRequest
```
-## Perceiver — const
+## Perceiver — const @experimental
```
ComponentDef<PerceiverData>
```
-## PerceiverData — interface
+## PerceiverData — interface @experimental
```
fovDegrees: number
range: number
```
-## Perception — const
+## Perception — const @experimental
```
ComponentDef<PerceptionData>
```
-## PerceptionData — interface
+## PerceptionData — interface @experimental
```
dirX: number
dirY: number
@@ -5130,7 +5130,7 @@ targetY: number
visible: boolean
```
-## PerceptionPlugin — class
+## PerceptionPlugin — class @experimental
```
build: (app: App) => void
name: string
@@ -5138,34 +5138,34 @@ static new (): PerceptionPlugin
static prototype: PerceptionPlugin
```
-## PerceptionTarget — const
+## PerceptionTarget — const @experimental
```
ComponentDef<{}>
```
-## Physics — const
+## Physics — const @experimental
```
ResourceDef<PhysicsAPI>
```
-## PhysicsContactEventData — interface
+## PhysicsContactEventData — interface @experimental
```
approachSpeed: number | undefined
isSensor: boolean | undefined
other: number
```
-## PhysicsEventType — type
+## PhysicsEventType — type @experimental
```
typeof PhysicsEventType[keyof typeof PhysicsEventType]
```
-## PhysicsEvents — const
+## PhysicsEvents — const @experimental
```
ResourceDef<PhysicsEventsData>
```
-## PhysicsEventsData — interface
+## PhysicsEventsData — interface @experimental
```
collisionEnters: CollisionEnterEvent[]
collisionExits: { entityA: Entity; entityB: Entity; }[]
@@ -5174,12 +5174,12 @@ sensorEnters: SensorEvent[]
sensorExits: SensorEvent[]
```
-## PhysicsModuleFactory — type
+## PhysicsModuleFactory — type @experimental
```
(config?: Record<string, unknown>) => Promise<PhysicsWasmModule>
```
-## PhysicsPlugin — class
+## PhysicsPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -5188,7 +5188,7 @@ static new (wasmUrl: string, config?: PhysicsPluginConfig, factory?: PhysicsModu
static prototype: PhysicsPlugin
```
-## PhysicsPluginConfig — interface
+## PhysicsPluginConfig — interface @experimental
```
collisionLayerMasks: number[] | undefined
contactDampingRatio: number | undefined
@@ -5203,7 +5203,7 @@ restitutionThreshold: number | undefined
subStepCount: number | undefined
```
-## PhysicsWasmModule — interface
+## PhysicsWasmModule — interface @experimental
```
HEAPF32: Float32Array<ArrayBufferLike>
HEAPU32: Uint32Array<ArrayBufferLike>
@@ -5326,7 +5326,7 @@ _physics_step: (dt: number) => void
_physics_updateBodyProperties: (entityId: number, bodyType: number, gravityScale: number, linearDamping: number, angularDamping: number, fixedRotation: number, bullet: number) => void
```
-## PlatformAdapter — interface
+## PlatformAdapter — interface @experimental
```
bindInputEvents: (callbacks: InputEventCallbacks, target?: unknown) => void
canPay: (() => boolean) | undefined
@@ -5381,7 +5381,7 @@ unbindInputEvents: (() => void) | undefined
writeCacheFile: ((key: string, bytes: ArrayBuffer) => Promise<void>) | undefined
```
-## PlatformAudioBackend — interface
+## PlatformAudioBackend — interface @experimental
```
dispose: () => void
ensureResumed: () => Promise<void>
@@ -5398,14 +5398,14 @@ suspend: () => void
unloadBuffer: (handle: AudioBufferHandle) => void
```
-## PlatformCanvas — interface
+## PlatformCanvas — interface @experimental
```
getContext: (contextId: "2d", options?: PlatformCanvasContextAttributes) => PlatformCanvas2DContext | null
height: number
width: number
```
-## PlatformCanvas2DContext — interface
+## PlatformCanvas2DContext — interface @experimental
```
clearRect: (x: number, y: number, w: number, h: number) => void
drawImage: (image: PlatformImageSource, dx: number, dy: number) => void
@@ -5418,7 +5418,7 @@ textAlign: string
textBaseline: string
```
-## PlatformImage — interface
+## PlatformImage — interface @experimental
```
crossOrigin: string | null | undefined
height: number
@@ -5428,7 +5428,7 @@ src: string
width: number
```
-## PlatformRequestOptions — interface
+## PlatformRequestOptions — interface @experimental
```
body: string | ArrayBuffer | undefined
headers: Record<string, string> | undefined
@@ -5437,7 +5437,7 @@ responseType: "json" | "text" | "arraybuffer" | undefined
timeout: number | undefined
```
-## PlatformResponse — interface
+## PlatformResponse — interface @experimental
```
arrayBuffer: () => Promise<ArrayBuffer>
headers: Record<string, string>
@@ -5448,7 +5448,7 @@ statusText: string
text: () => Promise<string>
```
-## PlatformSocket — interface
+## PlatformSocket — interface @experimental
```
close: (code?: number, reason?: string) => void
connect: () => void
@@ -5457,7 +5457,7 @@ readyState: PlatformSocketReadyState
send: (data: string | ArrayBuffer) => void
```
-## PlatformSocketEvents — interface
+## PlatformSocketEvents — interface @experimental
```
close: [code: number, reason: string]
error: [error: unknown]
@@ -5465,30 +5465,30 @@ message: [data: string | ArrayBuffer]
open: []
```
-## PlatformSocketOptions — interface
+## PlatformSocketOptions — interface @experimental
```
protocols: string | string[] | undefined
url: string
```
-## PlatformSocketReadyState — type
+## PlatformSocketReadyState — type @experimental
```
'connecting' | 'open' | 'closing' | 'closed'
```
-## PlatformType — type @deprecated
+## PlatformType — type @experimental @deprecated
```
PlatformName
```
-## PlatformVideoBackend — interface
+## PlatformVideoBackend — interface @experimental
```
createStream: (url: string, options: VideoStreamOptions) => VideoStreamHandle
dispose: () => void
name: string
```
-## PlayConfig — interface
+## PlayConfig — interface @experimental
```
bus: string | undefined
loop: boolean | undefined
@@ -5499,7 +5499,7 @@ startOffset: number | undefined
volume: number | undefined
```
-## PlayRealmRuntimeConfig — interface
+## PlayRealmRuntimeConfig — interface @experimental
```
achievements: string[] | undefined
app: App
@@ -5524,12 +5524,12 @@ uiThemeOverrides: ThemeOverrides | undefined
wasmBaseUrl: string | undefined
```
-## PlayableAdBridge — interface
+## PlayableAdBridge — interface @experimental
```
cta: (() => void) | undefined
```
-## PlayableRuntimeConfig — interface
+## PlayableRuntimeConfig — interface @experimental
```
app: App
assetPathMap: Record<string, string> | undefined
@@ -5548,7 +5548,7 @@ uiThemeOverrides: ThemeOverrides | undefined
ySortLayers: number | undefined
```
-## Plugin — interface
+## Plugin — interface @experimental
```
after: string[] | undefined
before: string[] | undefined
@@ -5559,17 +5559,17 @@ finish: ((app: App) => void) | undefined
name: string | undefined
```
-## PluginDependency — type
+## PluginDependency — type @experimental
```
string | ResourceDef<any>
```
-## PluralCategory — type
+## PluralCategory — type @experimental
```
'zero' | 'one' | 'two' | 'few' | 'many' | 'other'
```
-## PluralForms — interface
+## PluralForms — interface @experimental
```
few: string | undefined
many: string | undefined
@@ -5579,17 +5579,17 @@ two: string | undefined
zero: string | undefined
```
-## PluralSelector — type
+## PluralSelector — type @experimental
```
(count: number) => PluralCategory
```
-## PolygonCollider — const
+## PolygonCollider — const @experimental
```
ComponentDef<PolygonColliderData>
```
-## PooledAudioNode — interface
+## PooledAudioNode — interface @experimental
```
gain: GainNode
inUse: boolean
@@ -5598,12 +5598,12 @@ source: AudioBufferSourceNode | null
startTime: number
```
-## PostProcess — const
+## PostProcess — const @experimental
```
ResourceDef<PostProcessAPI>
```
-## PostProcessAPI — class
+## PostProcessAPI — class @experimental
```
_applyForCamera: (camera: Entity) => void
_applyScreenStack: () => void
@@ -5632,7 +5632,7 @@ static new (): PostProcessAPI
static prototype: PostProcessAPI
```
-## PostProcessPlugin — class
+## PostProcessPlugin — class @experimental
```
build: (app: App) => void
cleanup: (app?: App) => void
@@ -5641,7 +5641,7 @@ static new (): PostProcessPlugin
static prototype: PostProcessPlugin
```
-## PostProcessStack — class
+## PostProcessStack — class @experimental
```
addPass: (name: string, shader: ShaderHandle) => PostProcessStack
clearDirty: () => void
@@ -5663,12 +5663,12 @@ static new (state: PostProcessState): PostProcessStack
static prototype: PostProcessStack
```
-## PostProcessVolume — const
+## PostProcessVolume — const @experimental
```
ComponentDef<PostProcessVolumeData>
```
-## PostProcessVolumeData — interface
+## PostProcessVolumeData — interface @experimental
```
blendDistance: number
effects: { type: string; enabled: boolean; uniforms: Record<string, number>; textures?: Record<string, string>; }[]
@@ -5679,38 +5679,38 @@ size: { x: number; y: number; }
weight: number
```
-## PreSceneDrawCallback — type
+## PreSceneDrawCallback — type @experimental
```
(info: PreSceneDrawInfo) => void
```
-## PreSceneDrawInfo — interface
+## PreSceneDrawInfo — interface @experimental
```
elapsed: number
height: number
width: number
```
-## PredictionOptions — interface
+## PredictionOptions — interface @experimental
```
apply: (world: World, entity: Entity, actions: Record<string, unknown>, dt: number) => void
maxPendingInputs: number | undefined
smoothing: PredictionSmoothing | undefined
```
-## PredictionSmoothing — interface
+## PredictionSmoothing — interface @experimental
```
halfLife: number
maxError: number | undefined
```
-## PrefabComponentData — interface
+## PrefabComponentData — interface @experimental
```
data: Record<string, unknown>
type: string
```
-## PrefabData — interface
+## PrefabData — interface @experimental
```
basePrefab: string | undefined
entities: PrefabEntityData[]
@@ -5720,7 +5720,7 @@ rootEntityId: string
version: string
```
-## PrefabDiagnostic — interface
+## PrefabDiagnostic — interface @experimental
```
code: string
entityId: string | undefined
@@ -5729,12 +5729,12 @@ message: string
severity: PrefabDiagnosticSeverity
```
-## PrefabDiagnosticSeverity — type
+## PrefabDiagnosticSeverity — type @experimental
```
'error' | 'warning'
```
-## PrefabEntityData — interface
+## PrefabEntityData — interface @experimental
```
children: string[]
components: ComponentData[]
@@ -5746,12 +5746,12 @@ prefabEntityId: string
visible: boolean
```
-## PrefabEntityId — type
+## PrefabEntityId — type @experimental
```
string
```
-## PrefabInstanceDelta — interface
+## PrefabInstanceDelta — interface @experimental
```
added: AddedEntity[]
overrides: PrefabOverride[]
@@ -5759,7 +5759,7 @@ prefab: string
removed: string[]
```
-## PrefabInstanceEntry — interface
+## PrefabInstanceEntry — interface @experimental
```
added: AddedEntity[]
id: number
@@ -5769,7 +5769,7 @@ prefab: string
removed: string[]
```
-## PrefabOverride — interface
+## PrefabOverride — interface @experimental
```
componentData: ComponentData | undefined
componentType: string | undefined
@@ -5780,19 +5780,19 @@ type: "property" | "component_added" | "component_replaced" | "component_removed
value: unknown
```
-## PrefabServer — class
+## PrefabServer — class @experimental
```
instantiate: (pathOrAddress: string, options?: { baseUrl?: string; parent?: Entity; overrides?: SpawnOverride[]; scene?: boolean; }) => Promise<InstantiatePrefabResult>
static new (world: World, getAssets: () => AssetsClass, getScenes?: () => SceneManagerState | null): PrefabServer
static prototype: PrefabServer
```
-## Prefabs — const
+## Prefabs — const @experimental
```
ResourceDef<PrefabServer>
```
-## PrefabsPlugin — class
+## PrefabsPlugin — class @experimental
```
build: (app: App) => void
dependencies: ResourceDef<AssetsClass>[]
@@ -5801,7 +5801,7 @@ static new (): PrefabsPlugin
static prototype: PrefabsPlugin
```
-## PreviewPlugin — class
+## PreviewPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -5811,18 +5811,18 @@ static new (sceneUrl: string, baseUrl?: string): PreviewPlugin
static prototype: PreviewPlugin
```
-## PrismaticJoint — const
+## PrismaticJoint — const @experimental
```
ComponentDef<PrismaticJointData>
```
-## ProbedRegistrations — interface
+## ProbedRegistrations — interface @experimental
```
fingerprint: string
pending: PendingSystemEntry[]
```
-## ProcessedEntity — interface
+## ProcessedEntity — interface @experimental
```
children: number[]
components: ComponentData[]
@@ -5834,7 +5834,7 @@ prefabEntityId: string
visible: boolean
```
-## ProgressHandle — interface
+## ProgressHandle — interface @experimental
```
dispose: () => void
entity: number
@@ -5843,7 +5843,7 @@ getValue: () => number
setValue: (v: number) => void
```
-## ProgressOptions — interface
+## ProgressOptions — interface @experimental
```
background: UIVisualInit | undefined
direction: LinearFillDirection | undefined
@@ -5855,19 +5855,19 @@ value: number | undefined
world: World
```
-## ProjectionType — enum
+## ProjectionType — enum @experimental
```
Orthographic = 1
Perspective = 0
```
-## PropertyChannel — interface
+## PropertyChannel — interface @experimental
```
keyframes: Keyframe[]
property: string
```
-## PropertyTrack — interface
+## PropertyTrack — interface @experimental
```
channels: PropertyChannel[]
childPath: string
@@ -5876,13 +5876,13 @@ name: string
type: "property"
```
-## PtrLayout — interface
+## PtrLayout — interface @experimental
```
fields: readonly PtrFieldDesc[]
ptrFn: string
```
-## Quat — interface
+## Quat — interface @experimental
```
w: number
x: number
@@ -5890,12 +5890,12 @@ y: number
z: number
```
-## Query — function
+## Query — function @experimental
```
<C extends QueryArg[]>(...components: C): QueryBuilder<C>
```
-## QueryBuilder — interface
+## QueryBuilder — interface @experimental
```
_addedFilters: { index: number; component: AnyComponentDef; }[]
_changedFilters: { index: number; component: AnyComponentDef; }[]
@@ -5910,7 +5910,7 @@ with: (...components: AnyComponentDef[]) => QueryBuilder<C>
without: (...components: AnyComponentDef[]) => QueryBuilder<C>
```
-## QueryDescriptor — interface
+## QueryDescriptor — interface @experimental
```
_addedFilters: { index: number; component: AnyComponentDef; }[]
_changedFilters: { index: number; component: AnyComponentDef; }[]
@@ -5922,7 +5922,7 @@ _with: AnyComponentDef[]
_without: AnyComponentDef[]
```
-## QueryInstance — class
+## QueryInstance — class @experimental
```
count: () => number
forEach: (callback: (entity: Entity, ...components: ComponentsData<C>) => void) => void
@@ -5934,7 +5934,7 @@ static new <C extends readonly QueryArg[]>(world: World, descriptor: QueryDescri
static prototype: QueryInstance<any>
```
-## QueryResult — type
+## QueryResult — type @experimental
```
[
Entity,
@@ -5942,54 +5942,54 @@ static prototype: QueryInstance<any>
]
```
-## REGISTRY_BINDINGS — const
+## REGISTRY_BINDINGS — const @experimental
```
{ readonly createEntity: "es_createEntity"; readonly destroyEntity: "es_destroyEntity"; readonly setParent: "es_setParent"; readonly hasParent: "es_hasParent"; readonly getParent: "es_getParent"; readonly removeParent: "es_removeParent"; readonly hasChildren: "es_hasChildren"; readonly getChildren: "es_getChildren"; }
```
-## REPLICATION_CHANNEL — const
+## REPLICATION_CHANNEL — const @experimental
```
1
```
-## REPLICATION_PROTOCOL_VERSION — const
+## REPLICATION_PROTOCOL_VERSION — const @experimental
```
2
```
-## RESOURCE_BINDINGS — const
+## RESOURCE_BINDINGS — const @experimental
```
{ readonly createTexture: "es_rm_createTextureEx"; readonly createTextureKTX2: "es_createTextureKTX2"; readonly releaseTexture: "es_rm_releaseTexture"; readonly registerTextureWithPath: "es_rm_registerTextureWithPath"; readonly getTextureDimensions: "es_getTextureDimensions"; }
```
-## RETIRED_COMPONENT_TYPES — const
+## RETIRED_COMPONENT_TYPES — const @experimental
```
ReadonlySet<string>
```
-## RadiusInterestOptions — interface
+## RadiusInterestOptions — interface @experimental
```
position: ((world: World, entity: Entity) => { x: number; y: number; } | null) | undefined
```
-## ReadonlySignal — interface
+## ReadonlySignal — interface @experimental
```
get: () => T
subscribe: (fn: (value: T) => void) => () => void
```
-## Removed — function
+## Removed — function @experimental
```
<T extends AnyComponentDef>(component: T): RemovedQueryDescriptor<T>
```
-## RemovedQueryDescriptor — interface
+## RemovedQueryDescriptor — interface @experimental
```
_component: T
_type: "removed"
```
-## RemovedQueryInstance — class
+## RemovedQueryInstance — class @experimental
```
isEmpty: () => boolean
resetTick: (tick: number) => void
@@ -5998,7 +5998,7 @@ static new <T extends AnyComponentDef>(world: World, component: T, lastRunTick:
static prototype: RemovedQueryInstance<any>
```
-## RenderParams — interface
+## RenderParams — interface @experimental
```
clearColor: { x: number; y: number; z: number; w: number; } | undefined
elapsed: number
@@ -6008,7 +6008,7 @@ viewProjection: Float32Array<ArrayBufferLike>
width: number
```
-## RenderPipeline — class
+## RenderPipeline — class @experimental
```
addPreFlushCallback: (cb: (registry: { _cpp: CppRegistry; }) => void) => void
beginFrame: (elapsedSec?: number) => void
@@ -6024,7 +6024,7 @@ static new (): RenderPipeline
static prototype: RenderPipeline
```
-## RenderStage — enum
+## RenderStage — enum @experimental
```
Background = 0
Opaque = 1
@@ -6032,7 +6032,7 @@ Overlay = 3
Transparent = 2
```
-## RenderStats — interface
+## RenderStats — interface @experimental
```
culled: number
drawCalls: number
@@ -6043,24 +6043,24 @@ text: number
triangles: number
```
-## RenderSurfaceSource — type
+## RenderSurfaceSource — type @experimental
```
| { readonly kind: 'gl-context'; readonly handle: number }
| { readonly kind: 'webgpu'; readonly canvasSelector?: string }
| { readonly kind: 'default' }
```
-## RenderTargetHandle — type
+## RenderTargetHandle — type @experimental
```
number
```
-## RenderTexture — const
+## RenderTexture — const @experimental
```
{ create(options: RenderTextureOptions): RenderTextureHandle; release(rt: RenderTextureHandle): void; resize(rt: RenderTextureHandle, width: number, height: number): RenderTextureHandle; begin(rt: RenderTextureHandle, viewProjection: Float32Array): void; end(): void; getDepthTexture(rt: RenderTextureHandle): number; }
```
-## RenderTextureHandle — interface
+## RenderTextureHandle — interface @experimental
```
_depth: boolean
_filter: "linear" | "nearest"
@@ -6071,7 +6071,7 @@ textureId: number
width: number
```
-## RenderTextureOptions — interface
+## RenderTextureOptions — interface @experimental
```
depth: boolean | undefined
filter: "linear" | "nearest" | undefined
@@ -6079,7 +6079,7 @@ height: number
width: number
```
-## RenderType — enum
+## RenderType — enum @experimental
```
ExternalMesh = 3
Mesh = 2
@@ -6091,23 +6091,23 @@ Text = 4
UIElement = 7
```
-## Renderer — const
+## Renderer — const @experimental
```
{ init(width: number, height: number): void; resize(width: number, height: number): void; beginFrame(elapsedSec?: number): void; updateTransforms(registry: { _cpp: CppRegistry; }): void; begin(viewProjection: Float32Array, target?: RenderTargetHandle, clearFlags?: number, clearColor?: { x: number; y: number; z: number; w: number; }, clearRect?: { x: number; y: number; w: number; h: number; }): void; flush(): void; end(): void; submitAll(registry: { _cpp: CppRegistry; }, skipFlags: number, vpX: number, vpY: number, vpW: number, vpH: number): void; setStage(stage: RenderStage): void; createRenderTarget(width: number, height: number, flags?: number): RenderTargetHandle; releaseRenderTarget(handle: RenderTargetHandle): void; getTargetTexture(handle: RenderTargetHandle): number; getTargetDepthTexture(handle: RenderTargetHandle): number; setClearColor(r: number, g: number, b: number, a: number): void; setViewport(x: number, y: number, w: number, h: number): void; setYSortLayers(mask: number): void; setDepthLayers(mask: number): void; setCullingMask(mask: number): void; setTextureParams(textureId: number, minFilter: number, magFilter: number, wrapS: number, wrapT: number): void; measureBitmapText(fontHandle: number, text: string, fontSize: number, spacing: number): { width: number; height: number; }; getStats(): RenderStats; captureNextFrame(): void; getCapturedData(): FrameCaptureData | null; hasCapturedData(): boolean; replayToDrawCall(drawCallIndex: number): void; getSnapshotImageData(): Promise<ImageData | null>; }
```
-## Replicated — const
+## Replicated — const @experimental
```
ComponentDef<ReplicatedData>
```
-## ReplicatedData — interface
+## ReplicatedData — interface @experimental
```
netId: number
owner: number
```
-## ReplicationClient — class
+## ReplicationClient — class @experimental
```
applyPending: () => void
connect: (transport: NetTransport) => Promise<void>
@@ -6127,7 +6127,7 @@ static new (world: World, options?: ReplicationClientOptions): ReplicationClient
static prototype: ReplicationClient
```
-## ReplicationPlugin — class
+## ReplicationPlugin — class @experimental
```
build: (app: App) => void
name: string
@@ -6135,7 +6135,7 @@ static new (): ReplicationPlugin
static prototype: ReplicationPlugin
```
-## ReplicationServer — class
+## ReplicationServer — class @experimental
```
attachConnection: (transport: NetTransport) => number
beginTick: (fixedDelta: number) => void
@@ -6152,34 +6152,34 @@ static new (world: World): ReplicationServer
static prototype: ReplicationServer
```
-## RequestHandler — type
+## RequestHandler — type @experimental
```
(payload: Req) => Res | Promise<Res>
```
-## Res — function
+## Res — function @experimental
```
<T>(resource: ResourceDef<T>): ResDescriptor<T>
```
-## ResDescriptor — interface
+## ResDescriptor — interface @experimental
```
_resource: ResourceDef<T>
_type: "res"
```
-## ResMut — function
+## ResMut — function @experimental
```
<T>(resource: ResourceDef<T>): ResMutDescriptor<T>
```
-## ResMutDescriptor — interface
+## ResMutDescriptor — interface @experimental
```
_resource: ResourceDef<T>
_type: "res_mut"
```
-## ResMutInstance — class
+## ResMutInstance — class @experimental
```
get: () => T
modify: (fn: (value: T) => void) => void
@@ -6189,20 +6189,20 @@ static new <T>(value: T, setter: (v: T) => void): ResMutInstance<T>
static prototype: ResMutInstance<any>
```
-## ResolvedAssetGroup — interface
+## ResolvedAssetGroup — interface @experimental
```
alwaysInclude: boolean
delivery: BundleMode
name: string
```
-## ResolvedAtlas — interface
+## ResolvedAtlas — interface @experimental
```
folder: string
name: string
```
-## ResolvedTileCollision — interface
+## ResolvedTileCollision — interface @experimental
```
density: number | undefined
friction: number | undefined
@@ -6212,7 +6212,7 @@ sensor: boolean | undefined
shape: { type: "box"; } | { type: "polygon"; points: [number, number][]; } | { type: "circle"; cx: number; cy: number; r: number; }
```
-## ResolvedTileset — interface
+## ResolvedTileset — interface @experimental
```
asset: TilesetAsset
textureHandle: number
@@ -6220,14 +6220,14 @@ textureHeight: number | undefined
textureWidth: number | undefined
```
-## ResourceDef — interface
+## ResourceDef — interface @experimental
```
_default: T
_id: symbol
_name: string
```
-## ResourceStats — interface
+## ResourceStats — interface @experimental
```
cacheHits: number
cacheMisses: number
@@ -6240,7 +6240,7 @@ textureEvictableCount: number
vertexBufferCount: number
```
-## ReverbEffectDef — interface
+## ReverbEffectDef — interface @experimental
```
decay: number | undefined
seconds: number | undefined
@@ -6248,22 +6248,22 @@ type: "reverb"
wet: number | undefined
```
-## RevoluteJoint — const
+## RevoluteJoint — const @experimental
```
ComponentDef<RevoluteJointData>
```
-## RichTextRun — type
+## RichTextRun — type @experimental
```
TextSegment | ImageSegment
```
-## RigidBody — const
+## RigidBody — const @experimental
```
BuiltinComponentDef<RigidBodyData>
```
-## RigidBodyData — interface
+## RigidBodyData — interface @experimental
```
angularDamping: number
bodyType: number
@@ -6274,12 +6274,12 @@ gravityScale: number
linearDamping: number
```
-## RunCondition — type
+## RunCondition — type @experimental
```
() => boolean
```
-## RuntimeAssetSource — interface
+## RuntimeAssetSource — interface @experimental
```
backend: Backend
decodePixels: (path: string, flip: boolean) => Promise<{ width: number; height: number; pixels: Uint8Array; }>
@@ -6289,7 +6289,7 @@ resolveRef: ((ref: string) => string) | undefined
textureImportSettings: ((ref: string) => ParsedTextureImportSettings | undefined) | undefined
```
-## RuntimeBuildConfig — interface
+## RuntimeBuildConfig — interface @experimental
```
assetFailureCooldown: number | undefined
assetLoadTimeout: number | undefined
@@ -6305,12 +6305,12 @@ textCanvasSize: number | undefined
textureCacheBudget: number | undefined
```
-## RuntimeConfig — const
+## RuntimeConfig — const @experimental
```
{ sceneTransitionDuration: number; sceneTransitionColor: { r: number; g: number; b: number; a: number; }; defaultFontFamily: string; canvasScaleMode: number; canvasMatchWidthOrHeight: number; maxDeltaTime: number; maxFixedSteps: number; textCanvasSize: number; assetLoadTimeout: number; assetFailureCooldown: number; textureCacheBudget: number; audioCacheBudget: number; }
```
-## RuntimeInitConfig — interface
+## RuntimeInitConfig — interface @experimental
```
achievements: string[] | undefined
app: App
@@ -6335,42 +6335,42 @@ uiTheme: "dark" | "light" | undefined
uiThemeOverrides: ThemeOverrides | undefined
```
-## RuntimeOnly — const
+## RuntimeOnly — const @experimental
```
ComponentDef<{}>
```
-## SCENE_FORMAT_VERSION — const
+## SCENE_FORMAT_VERSION — const @experimental
```
1
```
-## SCREEN_FIT_OFF — const
+## SCREEN_FIT_OFF — const @experimental
```
-1
```
-## SIDE_MODULES — const
+## SIDE_MODULES — const @experimental
```
Record<BuiltinSideModuleId, SideModuleDescriptor>
```
-## SPINE_VERSIONS — const
+## SPINE_VERSIONS — const @experimental
```
readonly SpineVersion[]
```
-## STATE_PATH_SEP — const
+## STATE_PATH_SEP — const @experimental
```
"/"
```
-## SafeArea — const
+## SafeArea — const @experimental
```
ComponentDef<SafeAreaData>
```
-## SafeAreaData — interface
+## SafeAreaData — interface @experimental
```
applyBottom: boolean
applyLeft: boolean
@@ -6378,7 +6378,7 @@ applyRight: boolean
applyTop: boolean
```
-## SafeAreaPlugin — class
+## SafeAreaPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -6388,33 +6388,33 @@ static new (): SafeAreaPlugin
static prototype: SafeAreaPlugin
```
-## SampleDeps — interface
+## SampleDeps — interface @experimental
```
getComponent: (name: string) => AnyComponentDef | undefined
resolveChild: (root: Entity, childPath: string) => Entity | null
world: SampleWorld
```
-## SampleOptions — interface
+## SampleOptions — interface @experimental
```
skipChannel: ((childPath: string, component: string, property: string) => boolean) | undefined
```
-## SampleWorld — interface
+## SampleWorld — interface @experimental
```
get: (entity: Entity, def: AnyComponentDef) => Record<string, unknown>
has: (entity: Entity, def: AnyComponentDef) => boolean
set: (entity: Entity, def: AnyComponentDef, data: Record<string, unknown>) => void
```
-## SaveEnvelope — interface
+## SaveEnvelope — interface @experimental
```
data: T
savedAt: number
version: number
```
-## SaveManager — class
+## SaveManager — class @experimental
```
has: (slot: string) => boolean
load: <T>(slot: string) => T | null
@@ -6425,7 +6425,7 @@ static new (opts: SaveManagerOptions): SaveManager
static prototype: SaveManager
```
-## SaveManagerOptions — interface
+## SaveManagerOptions — interface @experimental
```
keyPrefix: string | undefined
migrations: Record<number, SaveMigration> | undefined
@@ -6434,12 +6434,12 @@ storage: SaveStorage | undefined
version: number
```
-## SaveMigration — type
+## SaveMigration — type @experimental
```
(data: unknown) => unknown
```
-## SaveStorage — interface
+## SaveStorage — interface @experimental
```
getJSON: <T>(key: string, defaultValue?: T) => T | undefined
has: (key: string) => boolean
@@ -6447,12 +6447,12 @@ remove: (key: string) => void
setJSON: <T>(key: string, value: T) => void
```
-## ScaleMode — type
+## ScaleMode — type @experimental
```
(typeof ScaleMode)[keyof typeof ScaleMode]
```
-## SceneAssetRefs — interface
+## SceneAssetRefs — interface @experimental
```
byType: Map<string, Set<string>>
dragonBones: SpineAssetRef[]
@@ -6462,20 +6462,20 @@ spines: SpineAssetRef[]
unresolved: string[]
```
-## SceneComponentCodec — interface
+## SceneComponentCodec — interface @experimental
```
exportData: ((entity: number, data: Record<string, unknown>) => void) | undefined
importData: ((entity: number, outOfBand: Record<string, unknown>) => void) | undefined
outOfBandFields: readonly string[] | undefined
```
-## SceneComponentData — interface
+## SceneComponentData — interface @experimental
```
data: Record<string, unknown>
type: string
```
-## SceneConfig — interface
+## SceneConfig — interface @experimental
```
cleanup: ((ctx: SceneContext) => void) | undefined
data: SceneData | undefined
@@ -6485,7 +6485,7 @@ setup: ((ctx: SceneContext) => void | Promise<void>) | undefined
systems: { schedule: Schedule; system: SystemDef; }[] | undefined
```
-## SceneContext — interface
+## SceneContext — interface @experimental
```
adopt: (entity: Entity) => void
bindPostProcess: (camera: Entity, stack: PostProcessStack) => void
@@ -6499,7 +6499,7 @@ trackAssets: (byType: ReadonlyMap<string, ReadonlySet<string>>) => void
unbindPostProcess: (camera: Entity) => void
```
-## SceneData — interface
+## SceneData — interface @experimental
```
entities: SceneEntityData[]
generator: string | undefined
@@ -6508,7 +6508,7 @@ textureMetadata: Record<string, TextureMetadata> | undefined
version: string | number
```
-## SceneEntityData — interface
+## SceneEntityData — interface @experimental
```
children: number[]
components: SceneComponentData[]
@@ -6518,13 +6518,13 @@ parent: number | null
visible: boolean | undefined
```
-## SceneLoadCancelled — class
+## SceneLoadCancelled — class @experimental
```
static new (name: string): SceneLoadCancelled
static prototype: SceneLoadCancelled
```
-## SceneLoadOptions — interface
+## SceneLoadOptions — interface @experimental
```
abortOnMissingAssets: boolean | undefined
assetBaseUrl: string | undefined
@@ -6534,17 +6534,17 @@ onMissingAssets: MissingAssetCallback | undefined
onProgress: SceneLoadProgressCallback | undefined
```
-## SceneLoadProgressCallback — type
+## SceneLoadProgressCallback — type @experimental
```
(loaded: number, total: number) => void
```
-## SceneManager — const
+## SceneManager — const @experimental
```
ResourceDef<SceneManagerState>
```
-## SceneManagerState — class
+## SceneManagerState — class @experimental
```
bringToTop: (name: string) => void
getActive: () => string | null
@@ -6576,7 +6576,7 @@ static new (app: App): SceneManagerState
static prototype: SceneManagerState
```
-## SceneMigrationResult — interface
+## SceneMigrationResult — interface @experimental
```
data: SceneData
fromVersion: number
@@ -6584,23 +6584,23 @@ migrated: boolean
toVersion: number
```
-## SceneOwner — const
+## SceneOwner — const @experimental
```
ComponentDef<SceneOwnerData>
```
-## SceneOwnerData — interface
+## SceneOwnerData — interface @experimental
```
persistent: boolean
scene: string
```
-## SceneStatus — type
+## SceneStatus — type @experimental
```
'loading' | 'running' | 'paused' | 'sleeping' | 'unloading'
```
-## SceneStreamHost — interface
+## SceneStreamHost — interface @experimental
```
isLoaded: (name: string) => boolean
isSleeping: (name: string) => boolean
@@ -6610,19 +6610,19 @@ unload: (name: string) => Promise<void>
wake: (name: string) => void
```
-## SceneStreaming — const
+## SceneStreaming — const @experimental
```
ResourceDef<SceneStreamingController>
```
-## SceneStreamingConfig — interface
+## SceneStreamingConfig — interface @experimental
```
loadRadius: number
policy: StreamPolicy | undefined
unloadRadius: number
```
-## SceneStreamingController — class
+## SceneStreamingController — class @experimental
```
clear: () => void
configure: (config: SceneStreamingConfig) => void
@@ -6637,7 +6637,7 @@ static new (host: SceneStreamHost, config?: SceneStreamingConfig): SceneStreamin
static prototype: SceneStreamingController
```
-## Schedule — enum
+## Schedule — enum @experimental
```
First = 1
FixedPostUpdate = 12
@@ -6650,7 +6650,7 @@ Startup = 0
Update = 3
```
-## ScreenInfo — class
+## ScreenInfo — class @experimental
```
dpr: number
height: number
@@ -6662,19 +6662,19 @@ static new (): ScreenInfo
static prototype: ScreenInfo
```
-## ScreenInfoEvents — interface
+## ScreenInfoEvents — interface @experimental
```
orientationchange: [orientation: ScreenOrientation]
resize: [width: number, height: number]
```
-## ScreenOrientation — enum
+## ScreenOrientation — enum @experimental
```
Landscape = "landscape"
Portrait = "portrait"
```
-## ScreenRect — interface
+## ScreenRect — interface @experimental
```
h: number
w: number
@@ -6682,12 +6682,12 @@ x: number
y: number
```
-## ScreenScaling — const
+## ScreenScaling — const @experimental
```
ResourceDef<ScreenScalingData>
```
-## ScreenScalingData — interface
+## ScreenScalingData — interface @experimental
```
designHeight: number
designWidth: number
@@ -6695,7 +6695,7 @@ matchWidthOrHeight: number
scaleMode: number
```
-## ScrollContainer — class
+## ScrollContainer — class @experimental
```
dispose: () => void
getContentSize: () => Vec2
@@ -6715,7 +6715,7 @@ static new (opts: ScrollContainerOptions): ScrollContainer
static prototype: ScrollContainer
```
-## ScrollViewHandle — interface
+## ScrollViewHandle — interface @experimental
```
content: number
dispose: () => void
@@ -6725,7 +6725,7 @@ scrollTo: (offset: Vec2) => void
setContentSize: (size: Vec2) => void
```
-## ScrollViewOptions — interface
+## ScrollViewOptions — interface @experimental
```
background: UIVisualInit | undefined
contentSize: Vec2
@@ -6741,12 +6741,12 @@ wheelSpeed: number | undefined
world: World
```
-## SegmentCollider — const
+## SegmentCollider — const @experimental
```
BuiltinComponentDef<SegmentColliderData>
```
-## SenseResult — interface
+## SenseResult — interface @experimental
```
dirX: number
dirY: number
@@ -6754,13 +6754,13 @@ distance: number
visible: boolean
```
-## SensorEvent — interface
+## SensorEvent — interface @experimental
```
sensorEntity: number
visitorEntity: number
```
-## ServicesPlugin — class
+## ServicesPlugin — class @experimental
```
build: (app: App) => void
name: string
@@ -6768,12 +6768,12 @@ static new (): ServicesPlugin
static prototype: ServicesPlugin
```
-## ShaderHandle — type
+## ShaderHandle — type @experimental
```
number
```
-## ShaderParam — interface
+## ShaderParam — interface @experimental
```
default: number[]
defaultTexture: string | undefined
@@ -6784,39 +6784,39 @@ type: ShaderParamType
ui: string | undefined
```
-## ShaderParamType — type
+## ShaderParamType — type @experimental
```
'float' | 'vec2' | 'vec3' | 'vec4' | 'color' | 'int' | 'texture'
```
-## ShaderReflection — interface
+## ShaderReflection — interface @experimental
```
domain: string
params: ShaderParam[]
```
-## ShaderSources — const
+## ShaderSources — const @experimental
```
{ SPRITE_VERTEX: string; SPRITE_FRAGMENT: string; COLOR_VERTEX: string; COLOR_FRAGMENT: string; }
```
-## ShadowCaster2D — const
+## ShadowCaster2D — const @experimental
```
BuiltinComponentDef<ShadowCaster2DData>
```
-## ShadowCaster2DData — interface
+## ShadowCaster2DData — interface @experimental
```
enabled: boolean
size: Vec2
```
-## ShapeRenderer — const
+## ShapeRenderer — const @experimental
```
BuiltinComponentDef<ShapeRendererData>
```
-## ShapeRendererData — interface
+## ShapeRendererData — interface @experimental
```
color: Color
cornerRadius: number
@@ -6827,19 +6827,19 @@ shapeType: number
size: Vec2
```
-## ShapeType — enum
+## ShapeType — enum @experimental
```
Capsule = 1
Circle = 0
RoundedRect = 2
```
-## Share — const
+## Share — const @experimental
```
ResourceDef<ShareAPI>
```
-## ShareAPI — class
+## ShareAPI — class @experimental
```
available: boolean
setShareCard: (card: ShareCard | (() => ShareCard)) => void
@@ -6848,28 +6848,28 @@ static new (): ShareAPI
static prototype: ShareAPI
```
-## ShareCard — type
+## ShareCard — type @experimental
```
PlatformShareOptions
```
-## SideModuleDescriptor — interface
+## SideModuleDescriptor — interface @experimental
```
file: string
globalName: string | undefined
```
-## SideModuleHost — interface
+## SideModuleHost — interface @experimental
```
acquire: (id: SideModuleId) => Promise<SideModule | null>
```
-## SideModuleId — type
+## SideModuleId — type @experimental
```
BuiltinSideModuleId | (string & {})
```
-## Signal — interface
+## Signal — interface @experimental
```
get: () => T
set: (value: T) => void
@@ -6877,13 +6877,13 @@ subscribe: (fn: (value: T) => void) => () => void
update: (fn: (prev: T) => T) => void
```
-## SimulationSpace — enum
+## SimulationSpace — enum @experimental
```
Local = 1
World = 0
```
-## SliceBorder — interface
+## SliceBorder — interface @experimental
```
bottom: number
left: number
@@ -6891,7 +6891,7 @@ right: number
top: number
```
-## SliderHandle — interface
+## SliderHandle — interface @experimental
```
dispose: () => void
entity: number
@@ -6902,7 +6902,7 @@ setValue: (value: number) => void
trackEntity: number
```
-## SliderOptions — interface
+## SliderOptions — interface @experimental
```
disabled: boolean | undefined
events: UIEventQueue
@@ -6922,19 +6922,19 @@ value: number | undefined
world: World
```
-## SocketReadyState — type
+## SocketReadyState — type @experimental
```
PlatformSocketReadyState
```
-## SourceDelta — interface
+## SourceDelta — interface @experimental
```
added: readonly AddedEntity[]
overrides: readonly PrefabOverride[]
removed: readonly string[]
```
-## SpatialAudioConfig — interface
+## SpatialAudioConfig — interface @experimental
```
maxDistance: number
model: AttenuationModel
@@ -6942,22 +6942,22 @@ refDistance: number
rolloff: number
```
-## SpawnOverride — type
+## SpawnOverride — type @experimental
```
Omit<PrefabOverride, 'prefabEntityId'> & { prefabEntityId?: string }
```
-## Spine — const
+## Spine — const @experimental
```
ResourceDef<SpineManager>
```
-## SpineAnimation — const
+## SpineAnimation — const @experimental
```
BuiltinComponentDef<SpineAnimationData>
```
-## SpineAnimationData — interface
+## SpineAnimationData — interface @experimental
```
animation: string
atlasPath: string
@@ -6975,23 +6975,23 @@ skin: string
timeScale: number
```
-## SpineAnimationDriver — interface
+## SpineAnimationDriver — interface @experimental
```
setAnimation: (entity: Entity, animation: string, loop: boolean) => void
```
-## SpineEvents — const
+## SpineEvents — const @experimental
```
ResourceDef<SpineEventsData>
```
-## SpineLoadResult — interface
+## SpineLoadResult — interface @experimental
```
error: string | undefined
success: boolean
```
-## SpinePlugin — class
+## SpinePlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -7003,7 +7003,7 @@ static new (manager?: SpineManager): SpinePlugin
static prototype: SpinePlugin
```
-## SpineTrack — interface
+## SpineTrack — interface @experimental
```
blendIn: number
childPath: string
@@ -7012,12 +7012,12 @@ name: string
type: "spine"
```
-## Sprite — const
+## Sprite — const @experimental
```
BuiltinComponentDef<SpriteData>
```
-## SpriteAnimClip — interface
+## SpriteAnimClip — interface @experimental
```
events: SpriteAnimEvent[] | undefined
fps: number
@@ -7027,19 +7027,19 @@ loop: boolean
name: string
```
-## SpriteAnimEvent — interface
+## SpriteAnimEvent — interface @experimental
```
data: unknown
frame: number
name: string
```
-## SpriteAnimEventHandler — type
+## SpriteAnimEventHandler — type @experimental
```
(event: SpriteAnimEvent, entity: Entity) => void
```
-## SpriteAnimFrame — interface
+## SpriteAnimFrame — interface @experimental
```
duration: number | undefined
pivot: { x: number; y: number; } | undefined
@@ -7048,7 +7048,7 @@ uvOffset: { x: number; y: number; } | undefined
uvScale: { x: number; y: number; } | undefined
```
-## SpriteAnimTrack — interface
+## SpriteAnimTrack — interface @experimental
```
childPath: string
clip: string
@@ -7057,12 +7057,12 @@ startTime: number
type: "spriteAnim"
```
-## SpriteAnimation — const
+## SpriteAnimation — const @experimental
```
ResourceDef<SpriteAnimationAPI>
```
-## SpriteAnimationAPI — class
+## SpriteAnimationAPI — class @experimental
```
aliasClip: (name: string, clip: SpriteAnimClip) => void
clearClips: () => void
@@ -7079,12 +7079,12 @@ static new (): SpriteAnimationAPI
static prototype: SpriteAnimationAPI
```
-## SpriteAnimator — const
+## SpriteAnimator — const @experimental
```
ComponentDef<SpriteAnimatorData>
```
-## SpriteAnimatorData — interface
+## SpriteAnimatorData — interface @experimental
```
clip: string
currentFrame: number
@@ -7096,7 +7096,7 @@ playing: boolean
speed: number
```
-## SpriteData — interface
+## SpriteData — interface @experimental
```
color: Color
enabled: boolean
@@ -7115,12 +7115,12 @@ uvOffset: Vec2
uvScale: Vec2
```
-## SpriteFilter — const
+## SpriteFilter — const @experimental
```
{ createOutline(options?: OutlineFilterOptions): MaterialHandle; createGlow(options?: OutlineFilterOptions): MaterialHandle; createDropShadow(options?: DropShadowFilterOptions): MaterialHandle; setOutlineColor(material: MaterialHandle, color: { r: number; g: number; b: number; a: number; }): void; setOutlineWidth(material: MaterialHandle, width: number): void; setShadowOffset(material: MaterialHandle, x: number, y: number): void; setShadowBlur(material: MaterialHandle, blur: number): void; }
```
-## StaleOverride — interface
+## StaleOverride — interface @experimental
```
nestedAt: string | undefined
override: PrefabOverride
@@ -7128,18 +7128,18 @@ reason: string
site: "variant" | "nested" | "instance"
```
-## StateMachineAgent — const
+## StateMachineAgent — const @experimental
```
ComponentDef<StateMachineAgentData>
```
-## StateMachineAgentData — interface
+## StateMachineAgentData — interface @experimental
```
current: string
fsm: string
```
-## StateMachines — class
+## StateMachines — class @experimental
```
blackboard: (entity: Entity) => Blackboard
fire: (entity: Entity, trigger: string) => void
@@ -7148,12 +7148,12 @@ static new (states: Map<Entity, AgentState>): StateMachines
static prototype: StateMachines
```
-## Stats — const
+## Stats — const @experimental
```
ResourceDef<FrameStats>
```
-## StatsCollector — class
+## StatsCollector — class @experimental
```
getFps: () => number
getFrameTimeMs: () => number
@@ -7163,7 +7163,7 @@ static new (): StatsCollector
static prototype: StatsCollector
```
-## StatsOverlay — class
+## StatsOverlay — class @experimental
```
dispose: () => void
hide: () => void
@@ -7173,7 +7173,7 @@ static new (container: HTMLElement, position?: StatsPosition): StatsOverlay
static prototype: StatsOverlay
```
-## StatsPlugin — class
+## StatsPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -7182,36 +7182,36 @@ static new (options?: StatsPluginOptions): StatsPlugin
static prototype: StatsPlugin
```
-## StatsPluginOptions — interface
+## StatsPluginOptions — interface @experimental
```
container: HTMLElement | undefined
overlay: boolean | undefined
position: StatsPosition | undefined
```
-## StatsPosition — type
+## StatsPosition — type @experimental
```
'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'
```
-## Status — enum
+## Status — enum @experimental
```
Failure = "failure"
Running = "running"
Success = "success"
```
-## Stick — const
+## Stick — const @experimental
```
(stick: "left" | "right", pad?: number) => Binding
```
-## Storage — const
+## Storage — const @experimental
```
{ getString(key: string, defaultValue?: string): string | undefined; setString(key: string, value: string): void; getNumber(key: string, defaultValue?: number): number | undefined; setNumber(key: string, value: number): void; getBoolean(key: string, defaultValue?: boolean): boolean | undefined; setBoolean(key: string, value: boolean): void; getJSON<T>(key: string, defaultValue?: T): T | undefined; setJSON<T>(key: string, value: T): void; remove(key: string): void; has(key: string): boolean; clear(): void; }
```
-## StreamCell — interface
+## StreamCell — interface @experimental
```
radius: number
scene: string
@@ -7219,34 +7219,34 @@ x: number
y: number
```
-## StreamDecision — interface
+## StreamDecision — interface @experimental
```
toActivate: string[]
toDeactivate: string[]
```
-## StreamPolicy — type
+## StreamPolicy — type @experimental
```
'unload' | 'sleep'
```
-## SubEmitterTrigger — enum
+## SubEmitterTrigger — enum @experimental
```
Birth = 1
Death = 0
```
-## SubmitSkipFlags — const
+## SubmitSkipFlags — const @experimental
```
{ readonly None: 0; readonly Spine: 1; readonly Particles: 2; }
```
-## SubsystemActivity — type
+## SubsystemActivity — type @experimental
```
'stepping' | 'idle' | 'inactive'
```
-## SubsystemEvent — interface
+## SubsystemEvent — interface @experimental
```
atMs: number
detail: string | undefined
@@ -7255,12 +7255,12 @@ phase: SubsystemPhase
seq: number
```
-## SubsystemPhase — type
+## SubsystemPhase — type @experimental
```
'registered' | 'initializing' | 'ready' | 'error'
```
-## SubsystemRegistry — class
+## SubsystemRegistry — class @experimental
```
getStatuses: () => SubsystemStatus[]
markError: (id: string, reason?: string) => void
@@ -7274,7 +7274,7 @@ static new (): SubsystemRegistry
static prototype: SubsystemRegistry
```
-## SubsystemStatus — interface
+## SubsystemStatus — interface @experimental
```
activity: SubsystemActivity
dependsOn: readonly string[]
@@ -7286,17 +7286,17 @@ phase: SubsystemPhase
phaseAgeMs: number
```
-## SwipeDirection — type
+## SwipeDirection — type @experimental
```
'left' | 'right' | 'up' | 'down'
```
-## SyncPrefabResolver — type
+## SyncPrefabResolver — type @experimental
```
(path: string) => PrefabData | null
```
-## SystemDef — interface
+## SystemDef — interface @experimental
```
_fn: (...args: never[]) => void | Promise<void>
_id: symbol
@@ -7306,14 +7306,14 @@ _runAfter: readonly string[] | undefined
_runBefore: readonly string[] | undefined
```
-## SystemOptions — interface
+## SystemOptions — interface @experimental
```
name: string | undefined
runAfter: string[] | undefined
runBefore: string[] | undefined
```
-## SystemParam — type
+## SystemParam — type @experimental
```
| QueryDescriptor<readonly QueryArg[]>
| ResDescriptor<unknown>
@@ -7325,7 +7325,7 @@ runBefore: string[] | undefined
| GetWorldDescriptor
```
-## SystemRunner — class
+## SystemRunner — class @experimental
```
clearTimings: () => void
evict: (systemId: symbol) => void
@@ -7337,7 +7337,7 @@ static new (world: World, resources: ResourceStorage, eventRegistry?: EventRegis
static prototype: SystemRunner
```
-## SystemSet — interface
+## SystemSet — interface @experimental
```
_kind: "set"
_name: string
@@ -7347,7 +7347,7 @@ _runIf: RunCondition | undefined
_systems: readonly SystemDef[]
```
-## SystemSetOptions — interface
+## SystemSetOptions — interface @experimental
```
runAfter: string[] | undefined
runBefore: string[] | undefined
@@ -7355,92 +7355,92 @@ runIf: RunCondition | undefined
systems: SystemDef[]
```
-## TB_E — const
+## TB_E — const @experimental
```
2
```
-## TB_N — const
+## TB_N — const @experimental
```
1
```
-## TB_NE — const
+## TB_NE — const @experimental
```
16
```
-## TB_NW — const
+## TB_NW — const @experimental
```
128
```
-## TB_S — const
+## TB_S — const @experimental
```
4
```
-## TB_SE — const
+## TB_SE — const @experimental
```
32
```
-## TB_SW — const
+## TB_SW — const @experimental
```
64
```
-## TB_W — const
+## TB_W — const @experimental
```
8
```
-## TERRAIN_NEIGHBORS — const
+## TERRAIN_NEIGHBORS — const @experimental
```
readonly { dx: number; dy: number; bit: number; }[]
```
-## THEME_COLOR_ROLES — const
+## THEME_COLOR_ROLES — const @experimental
```
readonly (keyof ThemeColors)[]
```
-## TILESET_FORMAT_VERSION — const
+## TILESET_FORMAT_VERSION — const @experimental
```
"1"
```
-## TILE_FLAGS_MASK — const
+## TILE_FLAGS_MASK — const @experimental
```
number
```
-## TILE_FLIP_D — const
+## TILE_FLIP_D — const @experimental
```
32768
```
-## TILE_FLIP_H — const
+## TILE_FLIP_H — const @experimental
```
8192
```
-## TILE_FLIP_V — const
+## TILE_FLIP_V — const @experimental
```
16384
```
-## TILE_ID_MASK — const
+## TILE_ID_MASK — const @experimental
```
8191
```
-## TParams — type
+## TParams — type @experimental
```
Record<string, string | number>
```
-## Takeover — interface
+## Takeover — interface @experimental
```
active: boolean
around: <T>(show: () => Promise<T>) => Promise<T>
@@ -7448,7 +7448,7 @@ begin: () => void
end: () => void
```
-## TakeoverHost — interface
+## TakeoverHost — interface @experimental
```
isPaused: () => boolean
resumeAudio: () => void
@@ -7456,40 +7456,40 @@ setPaused: (paused: boolean) => void
suspendAudio: () => void
```
-## TerrainColor — interface
+## TerrainColor — interface @experimental
```
color: string
name: string
```
-## TerrainIndex — interface
+## TerrainIndex — interface @experimental
```
byMask: Map<number, number>
mode: TerrainMode
```
-## TerrainIndices — interface
+## TerrainIndices — interface @experimental
```
sets: Map<number, TerrainIndex>
tileTerrain: Map<number, number>
```
-## TerrainMode — type
+## TerrainMode — type @experimental
```
'edge' | 'corner' | 'wang'
```
-## Text — const
+## Text — const @experimental
```
ComponentDef<TextData>
```
-## TextAlign — type
+## TextAlign — type @experimental
```
(typeof TextAlign)[keyof typeof TextAlign]
```
-## TextData — interface
+## TextData — interface @experimental
```
align: TextAlign
bold: boolean
@@ -7516,7 +7516,7 @@ verticalAlign: TextVerticalAlign
wordWrap: boolean
```
-## TextInit — interface
+## TextInit — interface @experimental
```
align: TextAlign | undefined
bold: boolean | undefined
@@ -7543,12 +7543,12 @@ verticalAlign: TextVerticalAlign | undefined
wordWrap: boolean | undefined
```
-## TextInput — const
+## TextInput — const @experimental
```
ComponentDef<TextInputData>
```
-## TextInputData — interface
+## TextInputData — interface @experimental
```
backgroundColor: Color
color: Color
@@ -7570,7 +7570,7 @@ textAlign: TextAlign
value: string
```
-## TextInputHandle — interface
+## TextInputHandle — interface @experimental
```
dispose: () => void
entity: number
@@ -7578,7 +7578,7 @@ getValue: () => string
setValue: (value: string) => void
```
-## TextInputOptions — interface
+## TextInputOptions — interface @experimental
```
backgroundColor: Color | undefined
color: Color | undefined
@@ -7603,7 +7603,7 @@ value: string | undefined
world: World
```
-## TextInputPlugin — class
+## TextInputPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -7613,19 +7613,19 @@ static new (): TextInputPlugin
static prototype: TextInputPlugin
```
-## TextMetrics — interface
+## TextMetrics — interface @experimental
```
height: number
lineCount: number
width: number
```
-## TextOverflow — type
+## TextOverflow — type @experimental
```
(typeof TextOverflow)[keyof typeof TextOverflow]
```
-## TextPlugin — class
+## TextPlugin — class @experimental
```
build: (app: App) => void
name: string
@@ -7633,12 +7633,12 @@ static new (): TextPlugin
static prototype: TextPlugin
```
-## TextRenderMode — type
+## TextRenderMode — type @experimental
```
(typeof TextRenderMode)[keyof typeof TextRenderMode]
```
-## TextSegment — interface
+## TextSegment — interface @experimental
```
bold: boolean
color: Color | null
@@ -7648,46 +7648,46 @@ text: string
type: "text"
```
-## TextVerticalAlign — type
+## TextVerticalAlign — type @experimental
```
(typeof TextVerticalAlign)[keyof typeof TextVerticalAlign]
```
-## TextureDimensions — interface
+## TextureDimensions — interface @experimental
```
height: number
width: number
```
-## TextureFilter — type
+## TextureFilter — type @experimental
```
(typeof TextureFilter)[keyof typeof TextureFilter]
```
-## TextureHandle — type
+## TextureHandle — type @experimental
```
number
```
-## TextureInfo — interface
+## TextureInfo — interface @experimental
```
handle: number
height: number
width: number
```
-## TextureRef — interface
+## TextureRef — interface @experimental
```
slot: number | undefined
textureId: number
```
-## TextureWrap — type
+## TextureWrap — type @experimental
```
(typeof TextureWrap)[keyof typeof TextureWrap]
```
-## ThemeColors — interface
+## ThemeColors — interface @experimental
```
backdrop: Color
control: Color
@@ -7704,18 +7704,18 @@ text: Color
track: Color
```
-## ThemeOverrides — interface
+## ThemeOverrides — interface @experimental
```
colors: Partial<ThemeColors> | undefined
type: Partial<ThemeType> | undefined
```
-## ThemeStyle — const
+## ThemeStyle — const @experimental
```
ComponentDef<ThemeStyleData>
```
-## ThemeStyleData — interface
+## ThemeStyleData — interface @experimental
```
input: { background?: ColorRole; text?: ColorRole; placeholder?: ColorRole; } | undefined
states: Record<string, keyof ThemeColors> | undefined
@@ -7723,20 +7723,20 @@ text: keyof ThemeColors | undefined
visual: keyof ThemeColors | undefined
```
-## ThemeTokens — interface
+## ThemeTokens — interface @experimental
```
colors: ThemeColors
type: ThemeType
```
-## ThemeType — interface
+## ThemeType — interface @experimental
```
body: number
label: number
title: number
```
-## TileCollisionPiece — interface
+## TileCollisionPiece — interface @experimental
```
center: Vec2
circles: { c: Vec2; r: number; }[]
@@ -7745,21 +7745,21 @@ polylines: Vec2[][]
sensor: boolean
```
-## TileCollisionShape — type
+## TileCollisionShape — type @experimental
```
| { type: 'box' }
| { type: 'polygon'; points: [number, number][] }
| { type: 'circle'; cx: number; cy: number; r: number }
```
-## TileFlags — interface
+## TileFlags — interface @experimental
```
flipD: boolean
flipH: boolean
flipV: boolean
```
-## TileGridParams — interface
+## TileGridParams — interface @experimental
```
hexSideLength: number | undefined
orientation: number
@@ -7769,7 +7769,7 @@ tileHeight: number
tileWidth: number
```
-## TileOrientation — enum
+## TileOrientation — enum @experimental
```
Hexagonal = 3
Isometric = 1
@@ -7777,14 +7777,14 @@ Orthogonal = 0
Staggered = 2
```
-## TileStamp — interface
+## TileStamp — interface @experimental
```
cells: number[]
h: number
w: number
```
-## TiledLayerData — interface
+## TiledLayerData — interface @experimental
```
chunks: TiledChunkData[]
height: number
@@ -7799,7 +7799,7 @@ visible: boolean
width: number
```
-## TiledMapData — interface
+## TiledMapData — interface @experimental
```
collisionTileIds: number[]
height: number
@@ -7818,7 +7818,7 @@ tilesets: TiledTilesetData[]
width: number
```
-## TiledTilesetData — interface
+## TiledTilesetData — interface @experimental
```
collectionTiles: TiledCollectionTile[] | undefined
columns: number
@@ -7832,27 +7832,27 @@ tileHeight: number
tileWidth: number
```
-## Tilemap — const
+## Tilemap — const @experimental
```
ComponentDef<TilemapData>
```
-## TilemapAPI — const
+## TilemapAPI — const @experimental
```
{ initLayer(entity: number, width: number, height: number, tileWidth: number, tileHeight: number): void; destroyLayer(entity: number): void; setTile(entity: number, x: number, y: number, tileId: number): void; getTile(entity: number, x: number, y: number): number; fillRect(entity: number, x: number, y: number, w: number, h: number, tileId: number): void; setTiles(entity: number, tiles: Uint16Array): void; setTilesets(entity: number, slots: { firstId: number; textureHandle: number; columns: number; margin?: number; spacing?: number; }[]): void; hasLayer(entity: number): boolean; setRenderProps(entity: number, textureHandle: number, tilesetColumns: number, uvTileW: number, uvTileH: number, sortLayer: number, depth: number, parallaxX: number, parallaxY: number): void; setTint(entity: number, r: number, g: number, b: number, a: number, opacity: number): void; setVisible(entity: number, visible: boolean): void; setOriginEntity(layerKey: number, originEntity: number): void; setTileAnimation(entity: number, tileId: number, frames: { tileId: number; duration: number; }[]): void; clearTileAnimations(entity: number): void; advanceAnimations(entity: number, dtMs: number): void; setTileProperty(entity: number, tileId: number, key: string, value: string): void; getTileProperty(entity: number, x: number, y: number, key: string): string; flipTile(entity: number, x: number, y: number, flipH: boolean, flipV: boolean, flipD: boolean): void; rotateTile(entity: number, x: number, y: number, degrees: number): void; initInfiniteLayer(entity: number, tileWidth: number, tileHeight: number): void; setChunkTiles(entity: number, chunkX: number, chunkY: number, tiles: Uint16Array, width: number, height: number): void; setGridType(entity: number, type: number): void; setHexParams(entity: number, sideLength: number, staggerAxisX: boolean, staggerIndexEven: boolean): void; tileToWorld(entity: number, tx: number, ty: number, originX: number, originY: number): { x: number; y: number; }; worldToTile(entity: number, wx: number, wy: number, originX: number, originY: number): { x: number; y: number; }; exportChunks(entity: number): string; importChunks(entity: number, encoded: string): boolean; }
```
-## TilemapData — interface
+## TilemapData — interface @experimental
```
source: string
```
-## TilemapLayer — const
+## TilemapLayer — const @experimental
```
BuiltinComponentDef<TilemapLayerData>
```
-## TilemapLayerData — interface
+## TilemapLayerData — interface @experimental
```
cellSize: Vec2
hexSideLength: number
@@ -7870,12 +7870,12 @@ tintColor: Color
visible: boolean
```
-## TilemapLiveSync — const
+## TilemapLiveSync — const @experimental
```
{ _bind(fn: ApplyTilesetRefs | null): void; setLayerTilesets(entity: number, refs: readonly string[]): void; }
```
-## TilemapPlugin — class
+## TilemapPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -7885,18 +7885,18 @@ static new (): TilemapPlugin
static prototype: TilemapPlugin
```
-## Tilemaps — const
+## Tilemaps — const @experimental
```
ResourceDef<{ initLayer(entity: number, width: number, height: number, tileWidth: number, tileHeight: number): void; destroyLayer(entity: number): void; setTile(entity: number, x: number, y: number, tileId: number): void; getTile(entity: number, x: number, y: number): number; fillRect(entity: number, x: number, y: number, w: number, h: number, tileId: number): void; setTiles(entity: number, tiles: Uint16Array): void; setTilesets(entity: number, slots: { firstId: number; textureHandle: number; columns: number; margin?: number; spacing?: number; }[]): void; hasLayer(entity: number): boolean; setRenderProps(entity: number, textureHandle: number, tilesetColumns: number, uvTileW: number, uvTileH: number, sortLayer: number, depth: number, parallaxX: number, parallaxY: number): void; setTint(entity: number, r: number, g: number, b: number, a: number, opacity: number): void; setVisible(entity: number, visible: boolean): void; setOriginEntity(layerKey: number, originEntity: number): void; setTileAnimation(entity: number, tileId: number, frames: { tileId: number; duration: number; }[]): void; clearTileAnimations(entity: number): void; advanceAnimations(entity: number, dtMs: number): void; setTileProperty(entity: number, tileId: number, key: string, value: string): void; getTileProperty(entity: number, x: number, y: number, key: string): string; flipTile(entity: number, x: number, y: number, flipH: boolean, flipV: boolean, flipD: boolean): void; rotateTile(entity: number, x: number, y: number, degrees: number): void; initInfiniteLayer(entity: number, tileWidth: number, tileHeight: number): void; setChunkTiles(entity: number, chunkX: number, chunkY: number, tiles: Uint16Array, width: number, height: number): void; setGridType(entity: number, type: number): void; setHexParams(entity: number, sideLength: number, staggerAxisX: boolean, staggerIndexEven: boolean): void; tileToWorld(entity: number, tx: number, ty: number, originX: number, originY: number): { x: number; y: number; }; worldToTile(entity: number, wx: number, wy: number, originX: number, originY: number): { x: number; y: number; }; exportChunks(entity: number): string; importChunks(entity: number, encoded: string): boolean; }>
```
-## TilesetAnimFrame — interface
+## TilesetAnimFrame — interface @experimental
```
durationMs: number
tile: number
```
-## TilesetAsset — interface
+## TilesetAsset — interface @experimental
```
columns: number
margin: number
@@ -7910,7 +7910,7 @@ tiles: Record<number, TilesetTile>
version: string
```
-## TilesetCollision — type
+## TilesetCollision — type @experimental
```
TileCollisionShape & {
/** One-way (jump-through) platform: contacts from behind this normal pass through. */
@@ -7924,7 +7924,7 @@ TileCollisionShape & {
}
```
-## TilesetModel — interface
+## TilesetModel — interface @experimental
```
animations: Map<number, { tileId: number; duration: number; }[]>
collidableTileIds: number[]
@@ -7932,7 +7932,7 @@ slots: TilesetModelSlot[]
tileShapes: Map<number, ResolvedTileCollision>
```
-## TilesetTerrain — interface
+## TilesetTerrain — interface @experimental
```
color: string | undefined
colors: TerrainColor[] | undefined
@@ -7940,7 +7940,7 @@ mode: TerrainMode
name: string
```
-## TilesetTile — interface
+## TilesetTile — interface @experimental
```
animation: TilesetAnimFrame[] | undefined
collision: TilesetCollision | undefined
@@ -7949,19 +7949,19 @@ properties: Record<string, string> | undefined
terrain: TilesetTileTerrain | undefined
```
-## TilesetTileTerrain — interface
+## TilesetTileTerrain — interface @experimental
```
corners: number[] | undefined
mask: number | undefined
set: number
```
-## Time — const
+## Time — const @experimental
```
ResourceDef<TimeData>
```
-## TimeData — interface
+## TimeData — interface @experimental
```
delta: number
elapsed: number
@@ -7973,12 +7973,12 @@ scale: number
unscaledDelta: number
```
-## Timeline — const
+## Timeline — const @experimental
```
ResourceDef<TimelineAPI>
```
-## TimelineAPI — class
+## TimelineAPI — class @experimental
```
clearStates: () => void
ensureState: (entity: Entity, wrapMode: WrapMode, speed: number) => TimelineState
@@ -7994,7 +7994,7 @@ static new (flags_?: PlayerFlagChannel | null): TimelineAPI
static prototype: TimelineAPI
```
-## TimelineAsset — interface
+## TimelineAsset — interface @experimental
```
duration: number
tracks: Track[]
@@ -8003,12 +8003,12 @@ version: string
wrapMode: WrapMode
```
-## TimelinePlayer — const
+## TimelinePlayer — const @experimental
```
ComponentDef<TimelinePlayerData>
```
-## TimelinePlayerData — interface
+## TimelinePlayerData — interface @experimental
```
finished: boolean
playing: boolean
@@ -8017,7 +8017,7 @@ timeline: string
wrapMode: string
```
-## TimelinePlugin — class
+## TimelinePlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -8031,7 +8031,7 @@ static new (): TimelinePlugin
static prototype: TimelinePlugin
```
-## TimerHandle — class
+## TimerHandle — class @experimental
```
cancel: () => void
elapsed: number
@@ -8045,7 +8045,7 @@ static new (manager: TimerManager, id: number): TimerHandle
static prototype: TimerHandle
```
-## TimerManager — class
+## TimerManager — class @experimental
```
activeCount: number
cancel: (id: number) => void
@@ -8064,12 +8064,12 @@ static new (): TimerManager
static prototype: TimerManager
```
-## TimerRes — const
+## TimerRes — const @experimental
```
ResourceDef<TimerManager>
```
-## ToggleHandle — interface
+## ToggleHandle — interface @experimental
```
dispose: () => void
entity: number
@@ -8078,7 +8078,7 @@ setDisabled: (disabled: boolean) => void
setValue: (value: boolean) => void
```
-## ToggleOptions — interface
+## ToggleOptions — interface @experimental
```
background: UIVisualInit | undefined
check: { node?: UINodeInit; color?: Color; sprite?: number; } | undefined
@@ -8094,29 +8094,29 @@ tabIndex: number | undefined
world: World
```
-## TouchPoint — interface
+## TouchPoint — interface @experimental
```
id: number
x: number
y: number
```
-## Track — type
+## Track — type @experimental
```
PropertyTrack | SpineTrack | SpriteAnimTrack | AudioTrack | ActivationTrack | MarkerTrack | CustomEventTrack | AnimFramesTrack
```
-## TrackType — type
+## TrackType — type @experimental
```
(typeof TrackType)[keyof typeof TrackType]
```
-## Trail — const
+## Trail — const @experimental
```
ResourceDef<TrailAPI>
```
-## TrailAPI — class
+## TrailAPI — class @experimental
```
clear: (entity: Entity) => void
update: (dt: number) => void
@@ -8124,7 +8124,7 @@ static new (module: NonNullable<EngineApi>, registry: CppRegistry): TrailAPI
static prototype: TrailAPI
```
-## TrailPlugin — class
+## TrailPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -8133,12 +8133,12 @@ static new (): TrailPlugin
static prototype: TrailPlugin
```
-## TrailRenderer — const
+## TrailRenderer — const @experimental
```
BuiltinComponentDef<TrailRendererData>
```
-## TrailRendererData — interface
+## TrailRendererData — interface @experimental
```
blendMode: number
emitting: boolean
@@ -8154,7 +8154,7 @@ texture: number
time: number
```
-## Transaction — class
+## Transaction — class @experimental
```
add: (op: TransactionOp) => void
addDeferred: (op: TransactionOp) => void
@@ -8168,7 +8168,7 @@ static new (label: string, id?: string): Transaction
static prototype: Transaction
```
-## TransactionManager — class
+## TransactionManager — class @experimental
```
begin: (label: string) => Transaction
canRedo: () => boolean
@@ -8184,23 +8184,23 @@ static new (options?: TransactionManagerOptions): TransactionManager
static prototype: TransactionManager
```
-## TransactionManagerOptions — interface
+## TransactionManagerOptions — interface @experimental
```
historyLimit: number | undefined
```
-## TransactionOp — interface
+## TransactionOp — interface @experimental
```
forward: () => void
reverse: () => void
```
-## Transform — const
+## Transform — const @experimental
```
BuiltinComponentDef<TransformData>
```
-## TransformData — interface
+## TransformData — interface @experimental
```
position: Vec3
rotation: Quat
@@ -8210,14 +8210,14 @@ worldRotation: Quat
worldScale: Vec3
```
-## TransitionConfig — interface
+## TransitionConfig — interface @experimental
```
color: Color | undefined
duration: number
type: "fade"
```
-## TransitionOptions — interface
+## TransitionOptions — interface @experimental
```
color: Color | undefined
duration: number | undefined
@@ -8227,12 +8227,12 @@ onStart: (() => void) | undefined
transition: "fade" | "none" | undefined
```
-## Tween — const
+## Tween — const @experimental
```
ResourceDef<TweenAPI>
```
-## TweenAPI — class
+## TweenAPI — class @experimental
```
activeCompositionCount: number
cancel: (tweenHandle: TweenHandle) => void
@@ -8248,12 +8248,12 @@ static new (module: AnimCore, registry: CppRegistry): TweenAPI
static prototype: TweenAPI
```
-## TweenFactory — type
+## TweenFactory — type @experimental
```
() => Completable
```
-## TweenGroup — class
+## TweenGroup — class @experimental
```
cancel: () => void
checkComplete: () => boolean
@@ -8265,7 +8265,7 @@ static new (tweens: Completable[]): TweenGroup
static prototype: TweenGroup
```
-## TweenHandle — class
+## TweenHandle — class @experimental
```
bezier: (p1x: number, p1y: number, p2x: number, p2y: number) => TweenHandle
cancel: () => void
@@ -8278,7 +8278,7 @@ static new (module: AnimCore, registry: CppRegistry, valueManager: ValueTweenMan
static prototype: TweenHandle
```
-## TweenOptions — interface
+## TweenOptions — interface @experimental
```
delay: number | undefined
easing: EasingType | undefined
@@ -8286,7 +8286,7 @@ loop: LoopMode | undefined
loopCount: number | undefined
```
-## TweenSequence — class
+## TweenSequence — class @experimental
```
cancel: () => void
checkComplete: () => boolean
@@ -8298,17 +8298,17 @@ static new (factories: TweenFactory[]): TweenSequence
static prototype: TweenSequence
```
-## TweenState — type
+## TweenState — type @experimental
```
(typeof TweenState)[keyof typeof TweenState]
```
-## TweenTarget — type
+## TweenTarget — type @experimental
```
(typeof TweenTarget)[keyof typeof TweenTarget]
```
-## UICameraData — interface
+## UICameraData — interface @experimental
```
screenH: number
screenW: number
@@ -8326,44 +8326,44 @@ worldRight: number
worldTop: number
```
-## UICameraInfo — const
+## UICameraInfo — const @experimental
```
ResourceDef<UICameraData>
```
-## UIController — const
+## UIController — const @experimental
```
ComponentDef<UIControllerData>
```
-## UIControllerData — interface
+## UIControllerData — interface @experimental
```
controllers: ControllerState[]
```
-## UIDialog — const
+## UIDialog — const @experimental
```
ComponentDef<UIDialogData>
```
-## UIDialogData — interface
+## UIDialogData — interface @experimental
```
closeOnBackdrop: boolean
closeOnEscape: boolean
```
-## UIDisplay — enum
+## UIDisplay — enum @experimental
```
Flex = 0
None = 1
```
-## UIDropdown — const
+## UIDropdown — const @experimental
```
ComponentDef<UIDropdownData>
```
-## UIDropdownData — interface
+## UIDropdownData — interface @experimental
```
label: number
optionHeight: number
@@ -8371,7 +8371,7 @@ options: string[]
selectedIndex: number
```
-## UIEntityInit — interface
+## UIEntityInit — interface @experimental
```
node: UINodeInit | undefined
parent: number | undefined
@@ -8380,7 +8380,7 @@ visual: UIVisualInit | undefined
world: World
```
-## UIEvent — interface
+## UIEvent — interface @experimental
```
currentTarget: number
data: TData
@@ -8392,12 +8392,12 @@ target: number
type: string
```
-## UIEventHandler — type
+## UIEventHandler — type @experimental
```
(event: EntityEvent<TData>) => void
```
-## UIEventQueue — class
+## UIEventQueue — class @experimental
```
clear: () => void
drain: () => readonly EntityEvent[]
@@ -8411,32 +8411,32 @@ static new (): EntityEventQueue
static prototype: EntityEventQueue
```
-## UIEventType — type
+## UIEventType — type @experimental
```
typeof UIEventType[keyof typeof UIEventType]
```
-## UIEvents — const
+## UIEvents — const @experimental
```
ResourceDef<EntityEventQueue>
```
-## UIGear — const
+## UIGear — const @experimental
```
ComponentDef<UIGearData>
```
-## UIGearData — interface
+## UIGearData — interface @experimental
```
bindings: GearBinding[]
```
-## UIInteraction — const
+## UIInteraction — const @experimental
```
BuiltinComponentDef<UIInteractionData>
```
-## UIInteractionData — interface
+## UIInteractionData — interface @experimental
```
hovered: boolean
justPressed: boolean
@@ -8444,7 +8444,7 @@ justReleased: boolean
pressed: boolean
```
-## UIInteractionPlugin — class
+## UIInteractionPlugin — class @experimental
```
build: (app: App) => void
dependencies: "uiLayout"[]
@@ -8453,17 +8453,17 @@ static new (): UIInteractionPlugin
static prototype: UIInteractionPlugin
```
-## UILayoutGeneration — const
+## UILayoutGeneration — const @experimental
```
ResourceDef<UILayoutGenerationData>
```
-## UILayoutGenerationData — interface
+## UILayoutGenerationData — interface @experimental
```
generation: number
```
-## UILayoutPlugin — class
+## UILayoutPlugin — class @experimental
```
build: (app: App) => void
name: string
@@ -8471,19 +8471,19 @@ static new (): UILayoutPlugin
static prototype: UILayoutPlugin
```
-## UIMask — const
+## UIMask — const @experimental
```
BuiltinComponentDef<UIMaskData>
```
-## UIMaskData — interface
+## UIMaskData — interface @experimental
```
alphaCutoff: number
enabled: boolean
mode: MaskMode
```
-## UIMaskPlugin — class
+## UIMaskPlugin — class @experimental
```
build: (app: App) => void
name: "uiMask"
@@ -8491,12 +8491,12 @@ static new (): UIMaskPlugin
static prototype: UIMaskPlugin
```
-## UINode — const
+## UINode — const @experimental
```
BuiltinComponentDef<UINodeData>
```
-## UINodeInit — interface
+## UINodeInit — interface @experimental
```
fill: boolean | undefined
flexGrow: number | undefined
@@ -8516,7 +8516,7 @@ position: number | undefined
width: Dimension | undefined
```
-## UIPlugin — class
+## UIPlugin — class @experimental
```
attachScrollContainer: (entity: Entity, container: ScrollContainer) => void
build: (app: App) => void
@@ -8530,19 +8530,19 @@ static new (): UIPlugin
static prototype: UIPlugin
```
-## UIPointerEvents — enum
+## UIPointerEvents — enum @experimental
```
Auto = 0
None = 1
```
-## UIPositionType — enum
+## UIPositionType — enum @experimental
```
Absolute = 1
Relative = 0
```
-## UIRenderOrderPlugin — class
+## UIRenderOrderPlugin — class @experimental
```
after: ("text" | "uiInteraction" | "uiMask")[]
build: (app: App) => void
@@ -8552,12 +8552,12 @@ static new (): UIRenderOrderPlugin
static prototype: UIRenderOrderPlugin
```
-## UISlider — const
+## UISlider — const @experimental
```
ComponentDef<UISliderData>
```
-## UISliderData — interface
+## UISliderData — interface @experimental
```
fill: number
handle: number
@@ -8567,18 +8567,18 @@ step: number
value: number
```
-## UIToggle — const
+## UIToggle — const @experimental
```
ComponentDef<UIToggleData>
```
-## UIToggleData — interface
+## UIToggleData — interface @experimental
```
check: number
isOn: boolean
```
-## UIVisibilityPlugin — class
+## UIVisibilityPlugin — class @experimental
```
build: (app: App) => void
dependencies: "uiInteraction"[]
@@ -8587,12 +8587,12 @@ static new (): UIVisibilityPlugin
static prototype: UIVisibilityPlugin
```
-## UIVisual — const
+## UIVisual — const @experimental
```
BuiltinComponentDef<UIVisualData>
```
-## UIVisualData — interface
+## UIVisualData — interface @experimental
```
color: Color
enabled: boolean
@@ -8609,7 +8609,7 @@ uvScale: Vec2
visualType: UIVisualType
```
-## UIVisualInit — interface
+## UIVisualInit — interface @experimental
```
color: { r: number; g: number; b: number; a: number; } | undefined
enabled: boolean | undefined
@@ -8626,7 +8626,7 @@ uvScale: Vec2 | undefined
visualType: UIVisualType | undefined
```
-## UIVisualType — enum
+## UIVisualType — enum @experimental
```
Filled = 5
Image = 2
@@ -8636,23 +8636,23 @@ SolidColor = 1
Tiled = 4
```
-## UniformValue — type
+## UniformValue — type @experimental
```
number | Vec2 | Vec3 | Vec4 | number[] | TextureRef
```
-## Unsubscribe — type
+## Unsubscribe — type @experimental
```
() => void
```
-## ValidatePrefabOptions — interface
+## ValidatePrefabOptions — interface @experimental
```
instanceOverrides: readonly PrefabOverride[] | undefined
loadPrefab: ((path: string) => PrefabData | null) | undefined
```
-## ValidateResult — interface
+## ValidateResult — interface @experimental
```
duplicateIds: string[]
invalidIds: string[]
@@ -8660,7 +8660,7 @@ orphanedChildren: string[]
stale: StaleOverride[]
```
-## ValueTweenHandle — class
+## ValueTweenHandle — class @experimental
```
bezier: (p1x: number, p1y: number, p2x: number, p2y: number) => ValueTweenHandle
cancel: () => void
@@ -8674,26 +8674,26 @@ static new (manager: ValueTweenManager, id: number): ValueTweenHandle
static prototype: ValueTweenHandle
```
-## Vec2 — interface
+## Vec2 — interface @experimental
```
x: number
y: number
```
-## Vec2Like — interface
+## Vec2Like — interface @experimental
```
x: number
y: number
```
-## Vec3 — interface
+## Vec3 — interface @experimental
```
x: number
y: number
z: number
```
-## Vec4 — interface
+## Vec4 — interface @experimental
```
w: number
x: number
@@ -8701,29 +8701,29 @@ y: number
z: number
```
-## Velocity — const
+## Velocity — const @experimental
```
BuiltinComponentDef<VelocityData>
```
-## VelocityData — interface
+## VelocityData — interface @experimental
```
angular: Vec3
linear: Vec3
```
-## VertexAttributeDescriptor — interface
+## VertexAttributeDescriptor — interface @experimental
```
name: string
type: DataType
```
-## Video — const
+## Video — const @experimental
```
ComponentDef<VideoData>
```
-## VideoAPI — class
+## VideoAPI — class @experimental
```
backendName: string
baseUrl: string
@@ -8737,7 +8737,7 @@ static new (backend: PlatformVideoBackend): VideoAPI
static prototype: VideoAPI
```
-## VideoData — interface
+## VideoData — interface @experimental
```
autoplay: boolean
enabled: boolean
@@ -8749,22 +8749,22 @@ source: string
volume: number
```
-## VideoHandle — type
+## VideoHandle — type @experimental
```
VideoStreamHandle
```
-## VideoPlayOptions — type
+## VideoPlayOptions — type @experimental
```
VideoStreamOptions
```
-## VideoPlayer — const
+## VideoPlayer — const @experimental
```
ResourceDef<VideoAPI>
```
-## VideoPlugin — class
+## VideoPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -8774,7 +8774,7 @@ static new (): VideoPlugin
static prototype: VideoPlugin
```
-## VideoStreamHandle — interface
+## VideoStreamHandle — interface @experimental
```
bytes: number | undefined
currentTime: number
@@ -8799,7 +8799,7 @@ textureHandle: number
width: number
```
-## VideoStreamOptions — interface
+## VideoStreamOptions — interface @experimental
```
audioTrackUrl: string | undefined
autoplay: boolean | undefined
@@ -8809,7 +8809,7 @@ playbackRate: number | undefined
volume: number | undefined
```
-## Viewport — interface
+## Viewport — interface @experimental
```
h: number
w: number
@@ -8817,28 +8817,28 @@ x: number
y: number
```
-## Virtual — const
+## Virtual — const @experimental
```
(id: string) => Binding
```
-## WangIndex — interface
+## WangIndex — interface @experimental
```
byKey: Map<number, number>
```
-## WangIndices — interface
+## WangIndices — interface @experimental
```
sets: Map<number, WangIndex>
tileTerrain: Map<number, number>
```
-## WeChatSideModuleFactories — type
+## WeChatSideModuleFactories — type @experimental
```
Partial<Record<SideModuleId, EmscriptenFactory>>
```
-## WeChatSocket — class
+## WeChatSocket — class @experimental
```
close: (code?: number, reason?: string) => void
connect: () => void
@@ -8849,7 +8849,7 @@ static new (options: GameSocketOptions): WeChatSocket
static prototype: WeChatSocket
```
-## WebAppOptions — interface
+## WebAppOptions — interface @experimental
```
colorSpace: "gamma" | "linear" | undefined
depthLayers: number | undefined
@@ -8862,34 +8862,34 @@ sideModules: SideModuleHost | undefined
ySortLayers: number | undefined
```
-## WeldJoint — const
+## WeldJoint — const @experimental
```
ComponentDef<WeldJointData>
```
-## WheelJoint — const
+## WheelJoint — const @experimental
```
ComponentDef<WheelJointData>
```
-## WidgetInteractionInit — interface
+## WidgetInteractionInit — interface @experimental
```
disabled: boolean | undefined
focusable: boolean | undefined
tabIndex: number | undefined
```
-## With — function
+## With — function @experimental
```
(component: AnyComponentDef): FilterExpr
```
-## Without — function
+## Without — function @experimental
```
(component: AnyComponentDef): FilterExpr
```
-## World — class
+## World — class @experimental
```
advanceTick: () => void
anyChangedSince: (component: AnyComponentDef, sinceTick: number) => boolean
@@ -8944,7 +8944,7 @@ static new (): World
static prototype: World
```
-## WorldRect — interface
+## WorldRect — interface @experimental
```
bottom: number
left: number
@@ -8952,62 +8952,62 @@ right: number
top: number
```
-## WorldTransform — const
+## WorldTransform — const @experimental
```
BuiltinComponentDef<TransformData>
```
-## WorldTransformData — type
+## WorldTransformData — type @experimental
```
TransformData
```
-## WrapMode — type
+## WrapMode — type @experimental
```
(typeof WrapMode)[keyof typeof WrapMode]
```
-## actionRefArg — function
+## actionRefArg — function @experimental
```
(ref: FsmActionRef | undefined): string | undefined
```
-## actionRefName — function
+## actionRefName — function @experimental
```
(ref: FsmActionRef | undefined): string
```
-## actionRefParams — function
+## actionRefParams — function @experimental
```
(ref: FsmActionRef | undefined): Record<string, AiParamValue> | undefined
```
-## activeRemoteRoot — function
+## activeRemoteRoot — function @experimental
```
(config: AssetGroupsConfig | null | undefined): string | undefined
```
-## addAnimatorParam — function
+## addAnimatorParam — function @experimental
```
(def: AnimatorControllerDef, name: string, type: AnimatorParamType): AnimatorControllerDef
```
-## addAnimatorState — function
+## addAnimatorState — function @experimental
```
(def: AnimatorControllerDef, name: string, x?: number, y?: number): AnimatorControllerDef
```
-## addAnimatorTransition — function
+## addAnimatorTransition — function @experimental
```
(def: AnimatorControllerDef, from: string, to: string): AnimatorControllerDef
```
-## addBtChild — function
+## addBtChild — function @experimental
```
(def: BtDefinition, parentId: string, type: BtNodeType, x?: number, y?: number): BtDefinition
```
-## addBtOrphan — function
+## addBtOrphan — function @experimental
```
(def: BtDefinition, type: BtNodeType, x?: number, y?: number): BtDefinition
```
@@ -9017,412 +9017,412 @@ TransformData
(g: MaterialGraph, type: GraphNodeType, x: number, y: number): { graph: MaterialGraph; id: string; }
```
-## addStartupSystem — function
+## addStartupSystem — function @experimental
```
(system: SystemDef): void
```
-## addState — function
+## addState — function @experimental
```
(def: FsmDefinition, name: string, x?: number, y?: number): FsmDefinition
```
-## addSystem — function
+## addSystem — function @experimental
```
(system: SystemDef): void
```
-## addSystemSetToSchedule — function
+## addSystemSetToSchedule — function @experimental
```
(schedule: Schedule, set: SystemSet): void
```
-## addSystemToSchedule — function
+## addSystemToSchedule — function @experimental
```
(schedule: Schedule, system: SystemDef): void
```
-## addTransition — function
+## addTransition — function @experimental
```
(def: FsmDefinition, from: string, to: string): FsmDefinition
```
-## agentBlackboard — function
+## agentBlackboard — function @experimental
```
(states: Map<Entity, AgentState>, entity: Entity): Blackboard
```
-## agentBtBlackboard — function
+## agentBtBlackboard — function @experimental
```
(states: Map<Entity, BtAgentState>, entity: Entity): Blackboard
```
-## aiRegistry — const
+## aiRegistry — const @experimental
```
AiRegistry<AiContext>
```
-## analyzeCensusSeries — function
+## analyzeCensusSeries — function @experimental
```
(samples: readonly Census[], opts?: CensusSeriesOptions): CensusReport
```
-## anchorPresetFields — function
+## anchorPresetFields — function @experimental
```
(preset: AnchorPreset): AnchorFields
```
-## animClipCellRect — function
+## animClipCellRect — function @experimental
```
(sheet: AnimClipSheetData, cell: number): { x: number; y: number; width: number; height: number; }
```
-## animClipCellUv — function
+## animClipCellUv — function @experimental
```
(sheet: AnimClipSheetData, cell: number): { uvOffset: { x: number; y: number; }; uvScale: { x: number; y: number; }; }
```
-## animClipDrivesPivot — function
+## animClipDrivesPivot — function @experimental
```
(data: AnimClipAssetData): boolean
```
-## animClipFramePivot — function
+## animClipFramePivot — function @experimental
```
(data: AnimClipAssetData, frame: AnimClipFrameData): AnimClipPivotData | null
```
-## animClipSheetCols — function
+## animClipSheetCols — function @experimental
```
(sheet: AnimClipSheetData): number
```
-## animClipSheetRows — function
+## animClipSheetRows — function @experimental
```
(sheet: AnimClipSheetData): number
```
-## animationPlugin — const
+## animationPlugin — const @experimental
```
AnimationPlugin
```
-## animatorEdges — function
+## animatorEdges — function @experimental
```
(def: AnimatorControllerDef): AnimatorEdge[]
```
-## applyAssetRefResolvers — function
+## applyAssetRefResolvers — function @experimental
```
(app: App, resolveRef: (ref: string) => string): void
```
-## applyAudioProjectConfig — function
+## applyAudioProjectConfig — function @experimental
```
(audio: AudioAPI, config: AudioProjectConfig | undefined): void
```
-## applyBuildRuntimeConfig — function
+## applyBuildRuntimeConfig — function @experimental
```
(app: { setMaxDeltaTime(v: number): void; setMaxFixedSteps(v: number): void; }, config: RuntimeBuildConfig): void
```
-## applyDeltaToSource — function
+## applyDeltaToSource — function @experimental
```
(source: PrefabData, delta: SourceDelta): PrefabData
```
-## applyOverrides — function
+## applyOverrides — function @experimental
```
(entity: OverrideTarget, overrides: readonly PrefabOverride[] | undefined): void
```
-## applyOverridesToSource — function
+## applyOverridesToSource — function @experimental
```
(source: PrefabData, overrides: readonly PrefabOverride[]): PrefabData
```
-## applyRuntimeConfig — function
+## applyRuntimeConfig — function @experimental
```
(components: { Text?: { _default: Record<string, unknown>; }; TextInput?: { _default: Record<string, unknown>; }; Canvas?: { _default: Record<string, unknown>; }; }): void
```
-## applyThemeToWorld — function
+## applyThemeToWorld — function @experimental
```
(world: World): void
```
-## applyWrapMode — function
+## applyWrapMode — function @experimental
```
(time: number, duration: number, mode: WrapMode): { time: number; stopped: boolean; }
```
-## arrayDataSource — function
+## arrayDataSource — function @experimental
```
<T>(items: readonly T[]): ArrayDataSource<T>
```
-## assertHostEnvironment — function
+## assertHostEnvironment — function @experimental
```
(scope?: Record<string, unknown>): void
```
-## assertNativeBindings — function
+## assertNativeBindings — function @experimental
```
(scope?: Record<string, unknown>): void
```
-## assertNativeHost — function
+## assertNativeHost — function @experimental
```
(scope?: Record<string, unknown>): void
```
-## assetPlugin — const
+## assetPlugin — const @experimental
```
AssetPlugin
```
-## atlasCatalogFields — function
+## atlasCatalogFields — function @experimental
```
(atlas: CookedAtlasInfo, pagePath: string): Pick<CatalogEntry, "atlas" | "frame" | "uv">
```
-## audioPlugin — const
+## audioPlugin — const @experimental
```
AudioPlugin
```
-## auto — const
+## auto — const @experimental
```
() => Dimension
```
-## bind — function
+## bind — function @experimental
```
<C extends object, K extends keyof C>(world: World, entity: Entity, component: ComponentDef<C>, field: K, source: ReadonlySignal<C[K]>): () => void
```
-## bindControllerPage — function
+## bindControllerPage — function @experimental
```
(world: World, entity: Entity, controller: string, source: ReadonlySignal<string>): () => void
```
-## bindWidgetValue — function
+## bindWidgetValue — function @experimental
```
<C extends object, K extends keyof C>(world: World, events: UIEventQueue, entity: Entity, component: ComponentDef<C>, field: K, signal: Signal<C[K]>, payloadKey?: string): () => void
```
-## btEdges — function
+## btEdges — function @experimental
```
(def: BtDefinition): BtEdge[]
```
-## btNodes — function
+## btNodes — function @experimental
```
(def: BtDefinition): BtNode[]
```
-## btPlugin — const
+## btPlugin — const @experimental
```
BtPlugin
```
-## bucketOverridesByEntity — function
+## bucketOverridesByEntity — function @experimental
```
(overrides: readonly PrefabOverride[]): Map<PrefabEntityId, PrefabOverride[]>
```
-## buildCollisionPaletteModel — function
+## buildCollisionPaletteModel — function @experimental
```
(material?: CollisionMaterial): TilesetModel
```
-## buildTerrainIndices — function
+## buildTerrainIndices — function @experimental
```
(asset: TilesetAsset): TerrainIndices
```
-## buildText — function
+## buildText — function @experimental
```
(init?: TextInit): TextData
```
-## buildUINode — function
+## buildUINode — function @experimental
```
(init?: UINodeInit): UINodeData
```
-## buildUIVisual — function
+## buildUIVisual — function @experimental
```
(init?: UIVisualInit): UIVisualData
```
-## buildVariant — function
+## buildVariant — function @experimental
```
(base: PrefabData, baseRef: string, name: string, delta: { overrides: readonly PrefabOverride[]; added: readonly AddedEntity[]; }): PrefabData
```
-## buildWangIndices — function
+## buildWangIndices — function @experimental
```
(asset: TilesetAsset): WangIndices
```
-## builtinShaderTemplate — function
+## builtinShaderTemplate — function @experimental
```
(id: string): BuiltinShaderTemplate | undefined
```
-## calculateAttenuation — function
+## calculateAttenuation — function @experimental
```
(distance: number, config?: SpatialAudioConfig): number
```
-## calculatePanning — function
+## calculatePanning — function @experimental
```
(sourceX: number, sourceY: number, listenerX: number, listenerY: number, maxDistance: number): number
```
-## canHaveChildren — function
+## canHaveChildren — function @experimental
```
(type: BtNodeType): boolean
```
-## canonicalMask — function
+## canonicalMask — function @experimental
```
(mode: TerrainMode, mask: number): number
```
-## catalogFromManifest — function
+## catalogFromManifest — function @experimental
```
(manifest: AddressableManifest): Catalog | undefined
```
-## censusProbeIds — function
+## censusProbeIds — function @experimental
```
(): string[]
```
-## clearAllCaches — function
+## clearAllCaches — function @experimental
```
(): void
```
-## clearAnimatorControllerStore — function
+## clearAnimatorControllerStore — function @experimental
```
(): void
```
-## clearBtStore — function
+## clearBtStore — function @experimental
```
(): void
```
-## clearDrawCallbacks — function
+## clearDrawCallbacks — function @experimental
```
(): void
```
-## clearFsmStore — function
+## clearFsmStore — function @experimental
```
(): void
```
-## clearProjectSideModules — function
+## clearProjectSideModules — function @experimental
```
(): void
```
-## clearTilemapSourceCache — function
+## clearTilemapSourceCache — function @experimental
```
(): void
```
-## clearUserComponents — function
+## clearUserComponents — function @experimental
```
(): void
```
-## cloneComponentData — function
+## cloneComponentData — function @experimental
```
(data: Record<string, unknown>): Record<string, unknown>
```
-## cloneComponents — function
+## cloneComponents — function @experimental
```
(components: ComponentData[]): ComponentData[]
```
-## cloneMetadata — function
+## cloneMetadata — function @experimental
```
(metadata: Record<string, unknown>): Record<string, unknown>
```
-## closeDialog — function
+## closeDialog — function @experimental
```
(world: World, events: UIEventQueue, root: Entity): void
```
-## closeDropdown — function
+## closeDropdown — function @experimental
```
(world: World, e: Entity): void
```
-## col — const
+## col — const @experimental
```
{ readonly create: (r?: number, g?: number, b?: number, a?: number) => Color; readonly rgb: (r: number, g: number, b: number) => Color; readonly from255: (r: number, g: number, b: number, a?: number) => Color; readonly clone: (c: Color) => Color; readonly lerp: (a: Color, b: Color, t: number) => Color; readonly withAlpha: (c: Color, a: number) => Color; readonly multiply: (a: Color, b: Color) => Color; readonly scaleRgb: (c: Color, s: number) => Color; readonly fromHex: (hex: string) => Color; readonly toHex: (c: Color, withAlpha?: boolean) => string; readonly equals: (a: Color, b: Color, epsilon?: number) => boolean; }
```
-## collapseEntry — function
+## collapseEntry — function @experimental
```
(prefab: PrefabData, prefabRef: string, expanded: readonly ProcessedEntity[], rootId: number, sceneParent: number | null, loadPrefab?: SyncPrefabResolver): PrefabInstanceEntry
```
-## collapseInstance — function
+## collapseInstance — function @experimental
```
(prefab: PrefabData, prefabRef: string, expanded: readonly ProcessedEntity[], loadPrefab?: SyncPrefabResolver): PrefabInstanceDelta
```
-## collectExternalEntityRefs — function
+## collectExternalEntityRefs — function @experimental
```
(entities: readonly ExtractEntity[]): ExternalEntityRef[]
```
-## collectGarbage — function
+## collectGarbage — function @experimental
```
(): boolean
```
-## collectNestedPrefabPaths — function
+## collectNestedPrefabPaths — function @experimental
```
(prefab: PrefabData, loadPrefab: (path: string) => PrefabData | null, visited?: Set<string>): string[]
```
-## collidableTileIds — function
+## collidableTileIds — function @experimental
```
(asset: TilesetAsset): number[]
```
-## colliderShapeOutline — function
+## colliderShapeOutline — function @experimental
```
(shape: ColliderShape, center: Vec2, angle: number, ppu: number): ColliderOutline
```
-## collisionRefWithMaterial — function
+## collisionRefWithMaterial — function @experimental
```
(material: CollisionMaterial): string
```
-## color — const
+## color — const @experimental
```
(r?: number, g?: number, b?: number, a?: number) => Color
```
-## compareDrawRank — function
+## compareDrawRank — function @experimental
```
(a: DrawRank, b: DrawRank): number
```
-## compileFsm — function
+## compileFsm — function @experimental
```
(def: FsmDefinition): CompiledFsm
```
@@ -9432,12 +9432,12 @@ BtPlugin
(graph: MaterialGraph): string
```
-## computeEffectiveOrthoSize — function
+## computeEffectiveOrthoSize — function @experimental
```
(baseOrthoSize: number, designAspect: number, actualAspect: number, scaleMode: number, matchWidthOrHeight: number): number
```
-## computeStreaming — function
+## computeStreaming — function @experimental
```
(cells: readonly StreamCell[], focusX: number, focusY: number, loadRadius: number, unloadRadius: number, active: ReadonlySet<string>): StreamDecision
```
@@ -9447,62 +9447,62 @@ BtPlugin
(g: MaterialGraph, fromId: string, toId: string, toSlot: string): MaterialGraph
```
-## contentHashHex — function
+## contentHashHex — function @experimental
```
(data: Uint8Array): string
```
-## contentHashOf — function
+## contentHashOf — function @experimental
```
(data: Uint8Array | string): string
```
-## controllerState — function
+## controllerState — function @experimental
```
(name: string, pages: string[], current?: string): ControllerState
```
-## corePlugin — const
+## corePlugin — const @experimental
```
Plugin
```
-## createAnimClip — function
+## createAnimClip — function @experimental
```
(texture: string, cellWidth: number, cellHeight: number, pageWidth: number, pageHeight: number): AnimClipAssetData
```
-## createBtRunState — function
+## createBtRunState — function @experimental
```
(): BtRunState
```
-## createButton — function
+## createButton — function @experimental
```
(opts: ButtonOptions): ButtonHandle
```
-## createDialog — function
+## createDialog — function @experimental
```
(opts: DialogOptions): DialogHandle
```
-## createDropdown — function
+## createDropdown — function @experimental
```
<T>(opts: DropdownOptions<T>): DropdownHandle<T>
```
-## createEmbeddedSideModuleHost — function
+## createEmbeddedSideModuleHost — function @experimental
```
(registry: EmbeddedSideModuleRegistry): SideModuleHost
```
-## createFetchSideModuleHost — function
+## createFetchSideModuleHost — function @experimental
```
(baseUrl: string): SideModuleHost
```
-## createFsmRunState — function
+## createFsmRunState — function @experimental
```
(fsm: CompiledFsm): FsmRunState
```
@@ -9512,212 +9512,212 @@ Plugin
(module: ESEngineModule, options?: HeadlessAppOptions): App
```
-## createHostBridge — function
+## createHostBridge — function @experimental
```
(scope?: Record<string, unknown>): NativeBridge
```
-## createListView — function
+## createListView — function @experimental
```
<T>(opts: CreateListViewOptions<T>): ListViewHandle<T>
```
-## createLocalAchievements — function
+## createLocalAchievements — function @experimental
```
(): AchievementProvider
```
-## createLocalLeaderboard — function
+## createLocalLeaderboard — function @experimental
```
(options?: LocalLeaderboardOptions): LeaderboardProvider
```
-## createMemoryTransportPair — function
+## createMemoryTransportPair — function @experimental
```
(options?: MemoryTransportOptions): [MemoryTransport, MemoryTransport]
```
-## createMockAdProvider — function
+## createMockAdProvider — function @experimental
```
(options?: MockAdProviderOptions): AdProvider
```
-## createNativeApp — function
+## createNativeApp — function @experimental
```
(bridge: NativeBridge, scope?: Record<string, unknown>): App
```
-## createNativeRegistry — function
+## createNativeRegistry — function @experimental
```
(scope?: Record<string, unknown>): CppRegistry
```
-## createNativeResourceManager — function
+## createNativeResourceManager — function @experimental
```
(scope?: Record<string, unknown>): CppResourceManager
```
-## createNativeWorld — function
+## createNativeWorld — function @experimental
```
(scope?: Record<string, unknown>): World
```
-## createPackagedAssetSource — function
+## createPackagedAssetSource — function @experimental
```
(index: PackagedAssetIndex, options?: PackagedAssetSourceOptions): RuntimeAssetSource
```
-## createProgress — function
+## createProgress — function @experimental
```
(opts: ProgressOptions): ProgressHandle
```
-## createRuntimeSceneConfig — function
+## createRuntimeSceneConfig — function @experimental
```
(name: string, sceneData: SceneData | undefined, options: Omit<LoadRuntimeSceneOptions, "sceneData" | "sceneName">, scenePath?: string): SceneConfig
```
-## createScrollView — function
+## createScrollView — function @experimental
```
(opts: ScrollViewOptions): ScrollViewHandle
```
-## createSlider — function
+## createSlider — function @experimental
```
(opts: SliderOptions): SliderHandle
```
-## createSocket — function
+## createSocket — function @experimental
```
(options: GameSocketOptions): PlatformSocket
```
-## createTakeover — function
+## createTakeover — function @experimental
```
(host: TakeoverHost): Takeover
```
-## createTextInput — function
+## createTextInput — function @experimental
```
(opts: TextInputOptions): TextInputHandle
```
-## createTileset — function
+## createTileset — function @experimental
```
(texture: string, tileWidth?: number, tileHeight?: number, columns?: number): TilesetAsset
```
-## createToggle — function
+## createToggle — function @experimental
```
(opts: ToggleOptions): ToggleHandle
```
-## createWeChatSideModuleHost — function
+## createWeChatSideModuleHost — function @experimental
```
(factories: MiniGameSideModuleFactories): SideModuleHost
```
-## createWebApp — function
+## createWebApp — function @experimental
```
(module: ESEngineModule, options?: CreateWebAppOptions): App
```
-## debug — function
+## debug — function @experimental
```
(category: string, message: string, data?: unknown): void
```
-## decodeImageBitmap — function
+## decodeImageBitmap — function @experimental
```
(src: ImageBitmapSource | PlatformImage, flip: boolean): Promise<ImageBitmap>
```
-## decodeImagePixels — function
+## decodeImagePixels — function @experimental
```
(src: ImageBitmapSource): Promise<DecodedPixels>
```
-## decodeTilemapChunks — function
+## decodeTilemapChunks — function @experimental
```
(blob: string): DecodedChunk[]
```
-## defaultFrameStats — function
+## defaultFrameStats — function @experimental
```
(): FrameStats
```
-## defaultPluralSelector — const
+## defaultPluralSelector — const @experimental
```
PluralSelector
```
-## defineBehavior — function
+## defineBehavior — function @experimental
```
<S extends object>(name: string, def: BehaviorDef<S>): ComponentDef<S>
```
-## defineComponent — function
+## defineComponent — function @experimental
```
<T extends object>(name: string, defaults: T, metadata?: ComponentMetadata): ComponentDef<T>
```
-## defineEvent — function
+## defineEvent — function @experimental
```
<T>(name: string): EventDef<T>
```
-## defineInputMap — function
+## defineInputMap — function @experimental
```
(actions: Record<string, ActionDef>): InputMap
```
-## defineResource — function
+## defineResource — function @experimental
```
<T>(defaultValue: T, name?: string): ResourceDef<T>
```
-## defineSystem — function
+## defineSystem — function @experimental
```
<P extends readonly SystemParam[]>(params: [...P], fn: (...args: InferParams<P>) => void | Promise<void>, options?: SystemOptions): SystemDef
```
-## defineSystemSet — function
+## defineSystemSet — function @experimental
```
(name: string, options: SystemSetOptions): SystemSet
```
-## defineTag — function
+## defineTag — function @experimental
```
(name: string): ComponentDef<{}>
```
-## derived — function
+## derived — function @experimental
```
<T>(sources: ReadonlySignal<unknown>[], compute: () => T): ReadonlySignal<T>
```
-## detectAnchor — function
+## detectAnchor — function @experimental
```
(node: UINodeData): AnchorPreset | null
```
-## detectAnchorAxes — function
+## detectAnchorAxes — function @experimental
```
(node: UINodeData): { h: AnchorAxis | null; v: AnchorAxis | null; }
```
-## diagnosticsPlugin — const
+## diagnosticsPlugin — const @experimental
```
DiagnosticsPlugin
```
-## diffAgainstSource — function
+## diffAgainstSource — function @experimental
```
(source: PrefabData, instance: readonly ProcessedEntity[], options?: DiffOptions): { overrides: PrefabOverride[]; untracked: ProcessedEntity[]; orphanedSourceIds: PrefabEntityId[]; }
```
-## diffCensus — function
+## diffCensus — function @experimental
```
(before: Census, after: Census): CensusDelta[]
```
@@ -9727,512 +9727,512 @@ DiagnosticsPlugin
(g: MaterialGraph, toId: string, toSlot: string): MaterialGraph
```
-## discoverSceneAssets — function
+## discoverSceneAssets — function @experimental
```
(sceneData: SceneData, refResolver?: RefResolver): SceneAssetRefs
```
-## dragPlugin — const
+## dragPlugin — const @experimental
```
DragPlugin
```
-## dragonBonesPlugin — const
+## dragonBonesPlugin — const @experimental
```
() => DragonBonesPlugin
```
-## editorViewHalfExtent — function
+## editorViewHalfExtent — function @experimental
```
(view: EditorViewData, aspect: number): { halfW: number; halfH: number; }
```
-## editorViewHalfHeight — function
+## editorViewHalfHeight — function @experimental
```
(view: EditorViewData): number
```
-## emptyAnimatorController — function
+## emptyAnimatorController — function @experimental
```
(): AnimatorControllerDef
```
-## emptyBt — function
+## emptyBt — function @experimental
```
(): BtDefinition
```
-## emptyFsm — function
+## emptyFsm — function @experimental
```
(): FsmDefinition
```
-## encodeTile — function
+## encodeTile — function @experimental
```
(id: number, flags?: TileFlags): number
```
-## ensureBtIds — function
+## ensureBtIds — function @experimental
```
(def: BtDefinition): BtDefinition
```
-## enterStatePath — function
+## enterStatePath — function @experimental
```
(scope: AnimatorScope, name: string): string[]
```
-## enumOptions — function
+## enumOptions — function @experimental
```
(obj: Record<string, unknown>, only?: readonly string[]): ReadonlyArray<{ label: string; value: number; }>
```
-## error — function
+## error — function @experimental
```
(category: string, message: string, data?: unknown): void
```
-## evalGuard — function
+## evalGuard — function @experimental
```
(bb: Blackboard, guard: BlackboardGuard): boolean
```
-## evalGuards — function
+## evalGuards — function @experimental
```
(bb: Blackboard, guards: BlackboardGuard | BlackboardGuard[]): boolean
```
-## evaluateAnimatorPath — function
+## evaluateAnimatorPath — function @experimental
```
(def: AnimatorControllerDef, currentPath: string, params: AnimatorParamValues, triggers: ReadonlySet<string>, clipFinished?: boolean): AnimatorPathEvalResult
```
-## evaluateAnimatorTransitions — function
+## evaluateAnimatorTransitions — function @experimental
```
(def: AnimatorControllerDef, currentState: string, params: AnimatorParamValues, triggers: ReadonlySet<string>, clipFinished?: boolean): AnimatorEvalResult
```
-## evaluateChannel — function
+## evaluateChannel — function @experimental
```
(channel: PropertyChannel, time: number): number
```
-## eventBindingPlugin — const
+## eventBindingPlugin — const @experimental
```
EventBindingPlugin
```
-## evictTextureDimensions — function
+## evictTextureDimensions — function @experimental
```
(handle: number): void
```
-## expandEntry — function
+## expandEntry — function @experimental
```
(prefab: PrefabData, entry: PrefabInstanceEntry, allocateId: () => number, loadPrefab?: SyncPrefabResolver): { entities: ProcessedEntity[]; rootId: number; }
```
-## expandInstance — function
+## expandInstance — function @experimental
```
(prefab: PrefabData, delta: PrefabInstanceDelta, allocateId: () => number, loadPrefab?: SyncPrefabResolver): { entities: ProcessedEntity[]; rootId: number; }
```
-## extractAnimClipTexturePaths — function
+## extractAnimClipTexturePaths — function @experimental
```
(data: AnimClipAssetData): string[]
```
-## extractPrefab — function
+## extractPrefab — function @experimental
```
(entities: readonly ExtractEntity[], rootId: number, name: string, makeId?: (sourceId: number) => PrefabEntityId): PrefabData
```
-## facingFromQuat — function
+## facingFromQuat — function @experimental
```
(z: number, w: number): number
```
-## fetchDecodePixels — function
+## fetchDecodePixels — function @experimental
```
(url: string): Promise<DecodedPixels>
```
-## findControllerOwner — function
+## findControllerOwner — function @experimental
```
(world: World, entity: Entity, name: string): Entity | null
```
-## findEntityByName — function
+## findEntityByName — function @experimental
```
(world: World, name: string): Entity | null
```
-## findPath — function
+## findPath — function @experimental
```
(grid: NavGrid, start: Cell, goal: Cell, opts?: PathfindOptions): Cell[] | null
```
-## fingerprint — function
+## fingerprint — function @experimental
```
(report: DiagnosticReport): string
```
-## finishDeviceRecovery — function
+## finishDeviceRecovery — function @experimental
```
(): void
```
-## flattenPrefab — function
+## flattenPrefab — function @experimental
```
(prefab: PrefabData, overrides: PrefabOverride[], ctx: FlattenContext): FlattenResult
```
-## flipFlagsH — function
+## flipFlagsH — function @experimental
```
(flags: TileFlags): TileFlags
```
-## flipFlagsV — function
+## flipFlagsV — function @experimental
```
(flags: TileFlags): TileFlags
```
-## flipStampH — function
+## flipStampH — function @experimental
```
(s: TileStamp): TileStamp
```
-## flipStampV — function
+## flipStampV — function @experimental
```
(s: TileStamp): TileStamp
```
-## flushPendingSystems — function
+## flushPendingSystems — function @experimental
```
(app: App): void
```
-## focusPlugin — const
+## focusPlugin — const @experimental
```
FocusPlugin
```
-## folderAlwaysInclude — function
+## folderAlwaysInclude — function @experimental
```
(config: AssetGroupsConfig | null | undefined, folder: string): boolean
```
-## folderGroupMode — function
+## folderGroupMode — function @experimental
```
(config: AssetGroupsConfig | null | undefined, folder: string): AssetGroupMode
```
-## formatActionArg — function
+## formatActionArg — function @experimental
```
(params: Readonly<Record<string, AiParamValue>> | undefined, defs: readonly AiParamDef[], separator?: string): string | undefined
```
-## formatCensusDiff — function
+## formatCensusDiff — function @experimental
```
(before: Census, after: Census, all?: boolean): string
```
-## formatCensusReport — function
+## formatCensusReport — function @experimental
```
(report: CensusReport): string
```
-## fsmEdges — function
+## fsmEdges — function @experimental
```
(def: FsmDefinition): FsmEdge[]
```
-## fsmPlugin — const
+## fsmPlugin — const @experimental
```
FsmPlugin
```
-## fxPreviewOrPlayMode — function
+## fxPreviewOrPlayMode — function @experimental
```
(): boolean
```
-## gearBinding — function
+## gearBinding — function @experimental
```
(controller: string, component: string, property: string, pages: Record<string, GearValue>, tween?: GearTween): GearBinding
```
-## getAddressableType — function
+## getAddressableType — function @experimental
```
(path: string): AddressableAssetType | null
```
-## getAddressableTypeByEditorType — function
+## getAddressableTypeByEditorType — function @experimental
```
(editorType: string): AddressableAssetType | null
```
-## getAllAssetExtensions — function
+## getAllAssetExtensions — function @experimental
```
(): Set<string>
```
-## getAllEffectDefs — function
+## getAllEffectDefs — function @experimental
```
(): EffectDef[]
```
-## getAssetBuildTransform — function
+## getAssetBuildTransform — function @experimental
```
(extensionOrPath: string): AssetBuildTransform | undefined
```
-## getAssetMimeType — function
+## getAssetMimeType — function @experimental
```
(ext: string): string | undefined
```
-## getAssetTypeEntry — function
+## getAssetTypeEntry — function @experimental
```
(extensionOrPath: string): AssetTypeEntry | undefined
```
-## getBt — function
+## getBt — function @experimental
```
(key: string): BtDefinition | undefined
```
-## getCacheForEntity — function
+## getCacheForEntity — function @experimental
```
(entityId: number): BitmapCache | undefined
```
-## getComponent — function
+## getComponent — function @experimental
```
(name: string): AnyComponentDef | undefined
```
-## getComponentAssetFieldDescriptors — function
+## getComponentAssetFieldDescriptors — function @experimental
```
(componentType: string): readonly { field: string; type: AssetFieldType; }[]
```
-## getComponentAssetFields — function
+## getComponentAssetFields — function @experimental
```
(componentType: string): string[]
```
-## getComponentDefaults — function
+## getComponentDefaults — function @experimental
```
(typeName: string): Record<string, unknown> | null
```
-## getComponentFieldMeta — function
+## getComponentFieldMeta — function @experimental
```
(name: string): Readonly<Record<string, FieldMeta>>
```
-## getComponentRegistry — function
+## getComponentRegistry — function @experimental
```
(): Map<string, AnyComponentDef>
```
-## getComponentSkeletalFieldDescriptor — function
+## getComponentSkeletalFieldDescriptor — function @experimental
```
(componentType: string): { skeletonField: string; atlasField: string; runtime: string; } | null
```
-## getContextLossGuardInfo — function
+## getContextLossGuardInfo — function @experimental
```
(): { target: string; lostEventsSeen: number; }
```
-## getControllerPage — function
+## getControllerPage — function @experimental
```
(world: World, entity: Entity, name: string): string | null
```
-## getCustomExtensions — function
+## getCustomExtensions — function @experimental
```
(): string[]
```
-## getDefaultContext — function
+## getDefaultContext — function @experimental
```
(): AppContext
```
-## getDeviceIdentity — function
+## getDeviceIdentity — function @experimental
```
(): DeviceIdentity | null
```
-## getDeviceLostReport — function
+## getDeviceLostReport — function @experimental
```
(): string
```
-## getDeviceStatus — function
+## getDeviceStatus — function @experimental
```
(): number
```
-## getEditorType — function
+## getEditorType — function @experimental
```
(path: string): EditorAssetType
```
-## getEffectDef — function
+## getEffectDef — function @experimental
```
(type: string): EffectDef | undefined
```
-## getEffectTypes — function
+## getEffectTypes — function @experimental
```
(): string[]
```
-## getFsm — function
+## getFsm — function @experimental
```
(key: string): CompiledFsm | undefined
```
-## getLogger — function
+## getLogger — function @experimental
```
(): Logger
```
-## getPlatform — function
+## getPlatform — function @experimental
```
(): PlatformAdapter
```
-## getPlatformType — function
+## getPlatformType — function @experimental
```
(): PlatformAdapter["name"] | null
```
-## getRegisteredAnimatorController — function
+## getRegisteredAnimatorController — function @experimental
```
(key: string): AnimatorControllerDef | undefined
```
-## getReplicatedFields — function
+## getReplicatedFields — function @experimental
```
(name: string): readonly string[]
```
-## getResourceManager — function
+## getResourceManager — function @experimental
```
(): CppResourceManager | null
```
-## getResourceStats — function
+## getResourceStats — function @experimental
```
(): ResourceStats | null
```
-## getTextureDimensions — function
+## getTextureDimensions — function @experimental
```
(handle: number): TextureDimensions | null
```
-## getTheme — function
+## getTheme — function @experimental
```
(): ThemeTokens
```
-## getTilemapSource — function
+## getTilemapSource — function @experimental
```
(path: string): LoadedTilemapSource | undefined
```
-## getUserComponent — function
+## getUserComponent — function @experimental
```
(name: string): ComponentDef<any> | undefined
```
-## getUserComponentFingerprint — function
+## getUserComponentFingerprint — function @experimental
```
(): string
```
-## getUserComponents — function
+## getUserComponents — function @experimental
```
(): Map<string, AnyComponentDef>
```
-## getWeChatPackOptions — function
+## getWeChatPackOptions — function @experimental
```
(): Array<{ type: string; value: string; }>
```
-## hasPlayableCta — function
+## hasPlayableCta — function @experimental
```
(): boolean
```
-## hasVisibility — function
+## hasVisibility — function @experimental
```
(world: World, entity: Entity): boolean
```
-## headlessBasePlugins — const
+## headlessBasePlugins — const @experimental
```
() => Plugin[]
```
-## imageBitmapOptions — function
+## imageBitmapOptions — function @experimental
```
(flip: boolean): ImageBitmapOptions
```
-## indexPackagedManifest — function
+## indexPackagedManifest — function @experimental
```
(manifest: AddressableManifest): PackagedAssetIndex
```
-## info — function
+## info — function @experimental
```
(category: string, message: string, data?: unknown): void
```
-## initNativeGame — function
+## initNativeGame — function @experimental
```
(options: NativeGameOptions): Promise<NativeGame>
```
-## initPlayRealmRuntime — function
+## initPlayRealmRuntime — function @experimental
```
(config: PlayRealmRuntimeConfig): Promise<void>
```
-## initPlayableRuntime — function
+## initPlayableRuntime — function @experimental
```
(config: PlayableRuntimeConfig): Promise<void>
```
-## initRuntime — function
+## initRuntime — function @experimental
```
(config: RuntimeInitConfig): Promise<void>
```
-## inputEventCallbacks — function
+## inputEventCallbacks — function @experimental
```
(state: InputState): InputEventCallbacks
```
-## inputPlugin — const
+## inputPlugin — const @experimental
```
InputPlugin
```
-## inputRouter — const
+## inputRouter — const @experimental
```
InputRouter
```
-## installEditorGrid — function
+## installEditorGrid — function @experimental
```
(app: App): void
```
@@ -10242,282 +10242,282 @@ InputRouter
(bridge: NativeBridge): NativePlatformAdapter
```
-## instantiatePrefab — function
+## instantiatePrefab — function @experimental
```
(world: World, prefab: PrefabData, options?: InstantiatePrefabOptions): Promise<InstantiatePrefabResult>
```
-## interactionController — function
+## interactionController — function @experimental
```
(pages?: string[]): ControllerState
```
-## interpolate — function
+## interpolate — function @experimental
```
(template: string, params?: TParams): string
```
-## intersectRects — function
+## intersectRects — function @experimental
```
(a: ScreenRect, b: ScreenRect): ScreenRect
```
-## invertMatrix4 — function
+## invertMatrix4 — function @experimental
```
(m: Float32Array, result?: Float32Array): Float32Array
```
-## invokeAction — function
+## invokeAction — function @experimental
```
<Ctx>(registry: AiRegistry<Ctx>, name: string, ctx: Ctx, bb: Blackboard, input?: AiActionInput): void | Status
```
-## isAuto — const
+## isAuto — const @experimental
```
(d: Dimension) => boolean
```
-## isBuiltinComponent — function
+## isBuiltinComponent — function @experimental
```
(comp: AnyComponentDef): comp is BuiltinComponentDef<any>
```
-## isCollisionPaletteRef — function
+## isCollisionPaletteRef — function @experimental
```
(refs: readonly string[]): boolean
```
-## isCustomExtension — function
+## isCustomExtension — function @experimental
```
(path: string): boolean
```
-## isDialogOpen — function
+## isDialogOpen — function @experimental
```
(world: World, root: Entity): boolean
```
-## isDropdownOpen — function
+## isDropdownOpen — function @experimental
```
(world: World, e: Entity): boolean
```
-## isEditor — function
+## isEditor — function @experimental
```
(): boolean
```
-## isEmptyStamp — function
+## isEmptyStamp — function @experimental
```
(s: TileStamp): boolean
```
-## isEntityActive — function
+## isEntityActive — function @experimental
```
(world: World, entity: Entity): boolean
```
-## isEntityVisible — function
+## isEntityVisible — function @experimental
```
(world: World, entity: Entity): boolean
```
-## isFxEditPreview — function
+## isFxEditPreview — function @experimental
```
(): boolean
```
-## isHexOrientation — function
+## isHexOrientation — function @experimental
```
(orientation: number): boolean
```
-## isKnownAssetExtension — function
+## isKnownAssetExtension — function @experimental
```
(ext: string): boolean
```
-## isNative — function
+## isNative — function @experimental
```
(): boolean
```
-## isNonOrthogonal — function
+## isNonOrthogonal — function @experimental
```
(orientation: number): boolean
```
-## isPlatformInitialized — function
+## isPlatformInitialized — function @experimental
```
(): boolean
```
-## isPlayMode — function
+## isPlayMode — function @experimental
```
(): boolean
```
-## isRuntime — function
+## isRuntime — function @experimental
```
(): boolean
```
-## isTextureRef — function
+## isTextureRef — function @experimental
```
(v: UniformValue): v is TextureRef
```
-## isWeChat — function
+## isWeChat — function @experimental
```
(): boolean
```
-## isWeb — function
+## isWeb — function @experimental
```
(): boolean
```
-## layerFrontness — function
+## layerFrontness — function @experimental
```
(order: LayerOrder, worldY: number, worldZ: number): number
```
-## layerOrderOf — function
+## layerOrderOf — function @experimental
```
(layer: number, ySortMask: number, depthMask: number): LayerOrder
```
-## leafStateOf — function
+## leafStateOf — function @experimental
```
(def: AnimatorControllerDef, path: string): AnimatorState | null
```
-## lifecyclePlugin — const
+## lifecyclePlugin — const @experimental
```
LifecyclePlugin
```
-## loadComponent — function
+## loadComponent — function @experimental
```
(world: World, entity: Entity, compData: SceneComponentData, entityName?: string): void
```
-## loadInputMapAsset — function
+## loadInputMapAsset — function @experimental
```
(asset: InputMapAsset): InputMap
```
-## loadPackagedAssetIndex — function
+## loadPackagedAssetIndex — function @experimental
```
(manifestPath?: string): Promise<PackagedAssetIndex>
```
-## loadPhysicsModule — function
+## loadPhysicsModule — function @experimental
```
(wasmUrl: string, factory?: PhysicsModuleFactory): Promise<PhysicsWasmModule>
```
-## loadRuntimeScene — function
+## loadRuntimeScene — function @experimental
```
(options: LoadRuntimeSceneOptions): Promise<void>
```
-## loadSceneData — function
+## loadSceneData — function @experimental
```
(world: World, sceneData: SceneData): Map<number, Entity>
```
-## loadSceneWithAssets — function
+## loadSceneWithAssets — function @experimental
```
(world: World, sceneData: SceneData, options?: SceneLoadOptions): Promise<Map<number, Entity>>
```
-## loadTiledMap — function
+## loadTiledMap — function @experimental
```
(world: World, mapData: TiledMapData, textureHandles: Map<string, number>, options?: TilemapLoadOptions): Entity[]
```
-## localizationPlugin — const
+## localizationPlugin — const @experimental
```
LocalizationPlugin
```
-## log — const
+## log — const @experimental
```
Logger
```
-## looksLikeAssetPath — function
+## looksLikeAssetPath — function @experimental
```
(value: unknown): value is string
```
-## makeLosCheck — function
+## makeLosCheck — function @experimental
```
(physics: PhysicsAPI): LosCheck
```
-## makeWidgetInteractable — function
+## makeWidgetInteractable — function @experimental
```
(world: World, entity: Entity, init?: WidgetInteractionInit): void
```
-## markThemed — function
+## markThemed — function @experimental
```
(world: World, entity: Entity, style: ThemeStyleData): void
```
-## matchLocale — function
+## matchLocale — function @experimental
```
(tag: string, available: readonly string[]): string | null
```
-## maxChildren — function
+## maxChildren — function @experimental
```
(type: BtNodeType): number
```
-## measureText — function
+## measureText — function @experimental
```
(text: string, opts: MeasureTextOptions): TextMetrics
```
-## mesh2dPlugin — const
+## mesh2dPlugin — const @experimental
```
Mesh2DPlugin
```
-## messageOf — function
+## messageOf — function @experimental
```
(error: unknown): string
```
-## migratePrefabData — function
+## migratePrefabData — function @experimental
```
(raw: unknown): MigrationResult
```
-## migrateSaveData — function
+## migrateSaveData — function @experimental
```
(version: number, data: unknown, currentVersion: number, migrations: Record<number, SaveMigration>): unknown
```
-## migrateSceneData — function
+## migrateSceneData — function @experimental
```
(raw: SceneData): SceneMigrationResult
```
-## modeToDelivery — function
+## modeToDelivery — function @experimental
```
(mode: AssetGroupMode): BundleMode
```
-## moveAnimatorState — function
+## moveAnimatorState — function @experimental
```
(def: AnimatorControllerDef, name: string, x: number, y: number): AnimatorControllerDef
```
-## moveBtNode — function
+## moveBtNode — function @experimental
```
(def: BtDefinition, id: string, x: number, y: number): BtDefinition
```
@@ -10527,22 +10527,22 @@ Mesh2DPlugin
(g: MaterialGraph, id: string, x: number, y: number): MaterialGraph
```
-## moveState — function
+## moveState — function @experimental
```
(def: FsmDefinition, name: string, x: number, y: number): FsmDefinition
```
-## navGridFromTilemapLayer — function
+## navGridFromTilemapLayer — function @experimental
```
(entity: Entity, opts: BuildNavGridOptions): NavGrid
```
-## navGridFromTiles — function
+## navGridFromTiles — function @experimental
```
(getTile: (x: number, y: number) => number, opts: BuildNavGridOptions): NavGrid
```
-## navPlugin — const
+## navPlugin — const @experimental
```
NavPlugin
```
@@ -10552,382 +10552,382 @@ NavPlugin
(): MaterialGraph
```
-## normalizeAngle — function
+## normalizeAngle — function @experimental
```
(a: number): number
```
-## normalizeBundleMode — function
+## normalizeBundleMode — function @experimental
```
(mode: string | undefined | null): BundleMode
```
-## normalizeCornerMask — function
+## normalizeCornerMask — function @experimental
```
(mask: number): number
```
-## openDialog — function
+## openDialog — function @experimental
```
(world: World, events: UIEventQueue, root: Entity): void
```
-## openDropdown — function
+## openDropdown — function @experimental
```
(world: World, events: UIEventQueue, e: Entity): void
```
-## orientationPerm — function
+## orientationPerm — function @experimental
```
(flags: TileFlags): Perm
```
-## packCorners — function
+## packCorners — function @experimental
```
(tl: number, tr: number, br: number, bl: number): number
```
-## packagedAppOptions — function
+## packagedAppOptions — function @experimental
```
(config: Pick<PackagedGameConfig, "ySortLayers" | "depthLayers" | "colorSpace" | "screenFit">): { ySortLayers?: number; depthLayers?: number; colorSpace?: "gamma" | "linear"; screenFit?: PackagedGameConfig["screenFit"]; }
```
-## packagedRuntimeInit — function
+## packagedRuntimeInit — function @experimental
```
(config: Pick<PackagedGameConfig, "physicsEnabled" | "physicsConfig" | "audioConfig" | "uiTheme" | "uiThemeColors" | "achievements" | "steamAppId" | "screenFit">): { physicsEnabled?: boolean; physicsConfig?: PhysicsPluginConfig; audioConfig?: AudioProjectConfig; uiTheme?: "light"; uiThemeOverrides?: ThemeOverrides; achievements?: string[]; steamAppId?: number; screenFit?: PackagedGameConfig["screenFit"]; }
```
-## paramDefaultValue — function
+## paramDefaultValue — function @experimental
```
(param: ShaderParam): unknown
```
-## parseActionArg — function
+## parseActionArg — function @experimental
```
(arg: string | undefined, params: readonly AiParamDef[], separator?: string): Record<string, AiParamValue>
```
-## parseAnimClipAsset — function
+## parseAnimClipAsset — function @experimental
```
(rawJson: unknown): AnimClipAssetData
```
-## parseAnimClipData — function
+## parseAnimClipData — function @experimental
```
(clipPath: string, data: AnimClipAssetData, textureHandles: Map<string, number>): SpriteAnimClip
```
-## parseAnimationClip — function
+## parseAnimationClip — function @experimental
```
(rawJson: unknown): TimelineAsset
```
-## parseAudioProjectConfig — function
+## parseAudioProjectConfig — function @experimental
```
(raw: unknown): AudioProjectConfig
```
-## parseBusEffects — function
+## parseBusEffects — function @experimental
```
(raw: unknown): BusEffectDef[]
```
-## parseCollisionMaterial — function
+## parseCollisionMaterial — function @experimental
```
(refs: readonly string[]): CollisionMaterial
```
-## parseLocaleTable — function
+## parseLocaleTable — function @experimental
```
(text: string, path: string): LocaleTableAsset
```
-## parseRichText — function
+## parseRichText — function @experimental
```
(input: string): RichTextRun[]
```
-## parseThemeOverrides — function
+## parseThemeOverrides — function @experimental
```
(colors?: Record<string, string>): ThemeOverrides | undefined
```
-## parseTileset — function
+## parseTileset — function @experimental
```
(rawJson: unknown): TilesetAsset
```
-## parseTimelineAsset — function
+## parseTimelineAsset — function @experimental
```
(rawJson: unknown): TimelineAsset
```
-## parseTmjJson — function
+## parseTmjJson — function @experimental
```
(json: Record<string, unknown>): TiledMapData | null
```
-## parseTmjWithExternals — function
+## parseTmjWithExternals — function @experimental
```
(json: Record<string, unknown>, resolveExternal: (source: string) => Promise<string>): Promise<TiledMapData | null>
```
-## particlePlugin — const
+## particlePlugin — const @experimental
```
ParticlePlugin
```
-## pathToWorld — function
+## pathToWorld — function @experimental
```
(grid: NavGrid, path: Cell[]): Vec2[]
```
-## percent — const
+## percent — const @experimental
```
(n: number) => Dimension
```
-## perceptionPlugin — const
+## perceptionPlugin — const @experimental
```
PerceptionPlugin
```
-## platformFetch — function
+## platformFetch — function @experimental
```
(url: string, options?: PlatformRequestOptions): Promise<PlatformResponse>
```
-## platformFileExists — function
+## platformFileExists — function @experimental
```
(path: string): Promise<boolean>
```
-## platformInstantiateWasm — function
+## platformInstantiateWasm — function @experimental
```
(pathOrBuffer: string | ArrayBuffer, imports: WebAssembly.Imports): Promise<WasmInstantiateResult>
```
-## platformReadFile — function
+## platformReadFile — function @experimental
```
(path: string): Promise<ArrayBuffer>
```
-## platformReadTextFile — function
+## platformReadTextFile — function @experimental
```
(path: string): Promise<string>
```
-## playModeOnly — function
+## playModeOnly — function @experimental
```
(): boolean
```
-## playableCta — function
+## playableCta — function @experimental
```
(): void
```
-## pointInHitArea — function
+## pointInHitArea — function @experimental
```
(px: number, py: number, area: HitAreaShape): boolean
```
-## pointInOBB — function
+## pointInOBB — function @experimental
```
(px: number, py: number, worldX: number, worldY: number, worldW: number, worldH: number, pivotX: number, pivotY: number, rotationZ: number, rotationW: number): boolean
```
-## pointInWorldRect — function
+## pointInWorldRect — function @experimental
```
(px: number, py: number, worldX: number, worldY: number, worldW: number, worldH: number, pivotX: number, pivotY: number): boolean
```
-## postProcessPlugin — const
+## postProcessPlugin — const @experimental
```
PostProcessPlugin
```
-## prefabsPlugin — const
+## prefabsPlugin — const @experimental
```
PrefabsPlugin
```
-## preloadNestedPrefabs — function
+## preloadNestedPrefabs — function @experimental
```
(prefab: PrefabData, loadPrefab: (path: string) => Promise<PrefabData>, cache: Map<string, PrefabData>, visited?: Set<string>, depth?: number): Promise<void>
```
-## previewPlugin — function
+## previewPlugin — function @experimental
```
(sceneUrl: string, baseUrl?: string): PreviewPlugin
```
-## probeRegistrations — function
+## probeRegistrations — function @experimental
```
(register: () => Promise<void>): Promise<ProbedRegistrations>
```
-## projectSideModuleIds — function
+## projectSideModuleIds — function @experimental
```
(): string[]
```
-## px — const
+## px — const @experimental
```
(n: number) => Dimension
```
-## quat — const
+## quat — const @experimental
```
(w?: number, x?: number, y?: number, z?: number) => Quat
```
-## quaternionToAngle2D — function
+## quaternionToAngle2D — function @experimental
```
(rz: number, rw: number): number
```
-## radiusInterest — function
+## radiusInterest — function @experimental
```
(radius: number, options?: RadiusInterestOptions): InterestPolicy
```
-## readColliderShapes — function
+## readColliderShapes — function @experimental
```
(world: World, entity: number): ColliderInstance[]
```
-## readFieldPath — function
+## readFieldPath — function @experimental
```
(data: Record<string, unknown>, path: string): unknown
```
-## readPtrField — function
+## readPtrField — function @experimental
```
(f32: Float32Array, u32: Uint32Array, u8: Uint8Array, ptr: number, field: PtrFieldDesc): unknown
```
-## rebuildChildren — function
+## rebuildChildren — function @experimental
```
(entities: ProcessedEntity[]): void
```
-## recoverDevice — function
+## recoverDevice — function @experimental
```
(): boolean
```
-## reflectEsshader — function
+## reflectEsshader — function @experimental
```
(source: string): ShaderReflection
```
-## registerAction — function
+## registerAction — function @experimental
```
(name: string, fn: AiAction<AiContext>): void
```
-## registerAnimatorController — function
+## registerAnimatorController — function @experimental
```
(key: string, def: AnimatorControllerDef): void
```
-## registerAssetBuildTransform — function
+## registerAssetBuildTransform — function @experimental
```
(editorType: EditorAssetType, transform: AssetBuildTransform): void
```
-## registerBt — function
+## registerBt — function @experimental
```
(key: string, def: BtDefinition): BtDefinition
```
-## registerCensusProbe — function
+## registerCensusProbe — function @experimental
```
(probe: CensusProbe): () => void
```
-## registerComponent — function
+## registerComponent — function @experimental
```
(name: string, def: AnyComponentDef): void
```
-## registerCondition — function
+## registerCondition — function @experimental
```
(name: string, fn: AiCondition<AiContext>): void
```
-## registerDrawCallback — function
+## registerDrawCallback — function @experimental
```
(id: string, fn: DrawCallback, scene?: string): void
```
-## registerFsm — function
+## registerFsm — function @experimental
```
(key: string, def: FsmDefinition): CompiledFsm
```
-## registerPackagedSideModules — function
+## registerPackagedSideModules — function @experimental
```
(config: Pick<PackagedGameConfig, "sideModules">): void
```
-## registerPreSceneDrawCallback — function
+## registerPreSceneDrawCallback — function @experimental
```
(id: string, fn: PreSceneDrawCallback): void
```
-## registerSceneComponentCodec — function
+## registerSceneComponentCodec — function @experimental
```
(type: string, codec: SceneComponentCodec): void
```
-## registerSideModule — function
+## registerSideModule — function @experimental
```
(id: string, descriptor: SideModuleDescriptor): void
```
-## registerTilemapSource — function
+## registerTilemapSource — function @experimental
```
(path: string, data: LoadedTilemapSource): void
```
-## registerTimelineAsset — function
+## registerTimelineAsset — function @experimental
```
(path: string, asset: TimelineAsset): void
```
-## remapComponentEntityRefs — function
+## remapComponentEntityRefs — function @experimental
```
(components: ComponentData[], idMapping: Map<PrefabEntityId, number>): void
```
-## remapEntityFields — function
+## remapEntityFields — function @experimental
```
(compData: SceneComponentData, entityMap: Map<number, Entity>): void
```
-## removeAnimatorParam — function
+## removeAnimatorParam — function @experimental
```
(def: AnimatorControllerDef, name: string): AnimatorControllerDef
```
-## removeAnimatorState — function
+## removeAnimatorState — function @experimental
```
(def: AnimatorControllerDef, name: string): AnimatorControllerDef
```
-## removeAnimatorTransition — function
+## removeAnimatorTransition — function @experimental
```
(def: AnimatorControllerDef, from: string, index: number): AnimatorControllerDef
```
-## removeBtNode — function
+## removeBtNode — function @experimental
```
(def: BtDefinition, id: string): BtDefinition
```
-## removeCacheForEntity — function
+## removeCacheForEntity — function @experimental
```
(entityId: number): BitmapCache | undefined
```
@@ -10937,107 +10937,107 @@ PrefabsPlugin
(g: MaterialGraph, id: string): MaterialGraph
```
-## removeState — function
+## removeState — function @experimental
```
(def: FsmDefinition, name: string): FsmDefinition
```
-## removeTransition — function
+## removeTransition — function @experimental
```
(def: FsmDefinition, from: string, index: number): FsmDefinition
```
-## renameAnimatorState — function
+## renameAnimatorState — function @experimental
```
(def: AnimatorControllerDef, oldName: string, newName: string): AnimatorControllerDef
```
-## renameState — function
+## renameState — function @experimental
```
(def: FsmDefinition, oldName: string, newName: string): FsmDefinition
```
-## reparentBtNode — function
+## reparentBtNode — function @experimental
```
(def: BtDefinition, id: string, newParentId: string): BtDefinition
```
-## replicationPlugin — const
+## replicationPlugin — const @experimental
```
ReplicationPlugin
```
-## reportDeviceLost — function
+## reportDeviceLost — function @experimental
```
(reason: number, message: string): void
```
-## requireResourceManager — function
+## requireResourceManager — function @experimental
```
(): CppResourceManager
```
-## resetWorldTo — function
+## resetWorldTo — function @experimental
```
(world: World, sceneData: SceneData): Map<number, Entity>
```
-## resolveAssetGroup — function
+## resolveAssetGroup — function @experimental
```
(projectRelPath: string, config: AssetGroupsConfig | null | undefined): ResolvedAssetGroup
```
-## resolveAtlas — function
+## resolveAtlas — function @experimental
```
(projectRelPath: string, config: AssetGroupsConfig | null | undefined): ResolvedAtlas | null
```
-## resolveAutotile — function
+## resolveAutotile — function @experimental
```
(index: TerrainIndex, neighbors: readonly boolean[]): number
```
-## resolveBindingTarget — function
+## resolveBindingTarget — function @experimental
```
(world: World, from: Entity, name: string): Entity | null
```
-## resolveChildEntity — function
+## resolveChildEntity — function @experimental
```
(world: Pick<World, "tryGet">, rootEntity: Entity, childPath: string): Entity | null
```
-## resolveParams — function
+## resolveParams — function @experimental
```
(def: AnimatorControllerDef, overrides: ReadonlyMap<string, number | boolean>): Record<string, number | boolean>
```
-## resolveRelativePath — function
+## resolveRelativePath — function @experimental
```
(basePath: string, relativePath: string): string
```
-## resolveThemeTokens — function
+## resolveThemeTokens — function @experimental
```
(base: "dark" | "light", overrides?: ThemeOverrides): ThemeTokens
```
-## resolveTilesetModel — function
+## resolveTilesetModel — function @experimental
```
(tilesets: ResolvedTileset[]): TilesetModel
```
-## resolveWang — function
+## resolveWang — function @experimental
```
(index: WangIndex, corners: readonly number[]): number
```
-## rotateFlagsCW — function
+## rotateFlagsCW — function @experimental
```
(flags: TileFlags): TileFlags
```
-## rotateStampCW — function
+## rotateStampCW — function @experimental
```
(s: TileStamp): TileStamp
```
@@ -11047,617 +11047,617 @@ ReplicationPlugin
(app: App, options?: { fps?: number; }): () => void
```
-## safeAreaPlugin — const
+## safeAreaPlugin — const @experimental
```
SafeAreaPlugin
```
-## sampleTimeline — function
+## sampleTimeline — function @experimental
```
(asset: TimelineAsset, time: number, rootEntity: Entity, deps: SampleDeps, opts?: SampleOptions): void
```
-## sampleTimelineInWorld — function
+## sampleTimelineInWorld — function @experimental
```
(asset: TimelineAsset, time: number, world: SampleWorld & Pick<World, "tryGet">, rootEntity: Entity, opts?: SampleOptions): void
```
-## scalar — const
+## scalar — const @experimental
```
{ readonly clamp: (x: number, min: number, max: number) => number; readonly clamp01: (x: number) => number; readonly lerp: (a: number, b: number, t: number) => number; readonly inverseLerp: (a: number, b: number, value: number) => number; readonly remap: (value: number, inMin: number, inMax: number, outMin: number, outMax: number) => number; readonly deg2rad: (deg: number) => number; readonly rad2deg: (rad: number) => number; readonly approximately: (a: number, b: number, epsilon?: number) => boolean; readonly smoothstep: (edge0: number, edge1: number, x: number) => number; readonly mod: (x: number, n: number) => number; readonly sign: (x: number) => number; }
```
-## sceneManagerPlugin — const
+## sceneManagerPlugin — const @experimental
```
Plugin
```
-## sceneUsesI18n — function
+## sceneUsesI18n — function @experimental
```
(sceneData: SceneData): boolean
```
-## screenToUiWorld — function
+## screenToUiWorld — function @experimental
```
(camera: UICameraData, screenGLX: number, screenGLY: number): { x: number; y: number; }
```
-## screenToWorld — function
+## screenToWorld — function @experimental
```
(screenX: number, screenY: number, inverseVP: Float32Array, vpX: number, vpY: number, vpW: number, vpH: number, planeZ?: number): { x: number; y: number; }
```
-## selectBlendClip — function
+## selectBlendClip — function @experimental
```
(blend: AnimatorBlend1D, value: number): AnimatorBlendThreshold
```
-## selectPluralForm — function
+## selectPluralForm — function @experimental
```
(forms: PluralForms, count: number, selector: PluralSelector): string
```
-## senseTarget — function
+## senseTarget — function @experimental
```
(ox: number, oy: number, facing: number, tx: number, ty: number, range: number, halfFov: number, isBlocked?: (ox: number, oy: number, tx: number, ty: number) => boolean): SenseResult
```
-## serializeAnimClip — function
+## serializeAnimClip — function @experimental
```
(asset: AnimClipAssetData): Record<string, unknown>
```
-## serializeScene — function
+## serializeScene — function @experimental
```
(world: World, sceneName?: string): SceneData
```
-## serializeTileset — function
+## serializeTileset — function @experimental
```
(asset: TilesetAsset): Record<string, unknown>
```
-## serializeTimelineAsset — function
+## serializeTimelineAsset — function @experimental
```
(asset: TimelineAsset): Record<string, unknown>
```
-## serializeTimelineToJson — function
+## serializeTimelineToJson — function @experimental
```
(asset: TimelineAsset, indent?: number): string
```
-## servicesPlugin — const
+## servicesPlugin — const @experimental
```
ServicesPlugin
```
-## setAnimatorConditions — function
+## setAnimatorConditions — function @experimental
```
(def: AnimatorControllerDef, from: string, index: number, conditions: AnimatorCondition[]): AnimatorControllerDef
```
-## setAnimatorInitial — function
+## setAnimatorInitial — function @experimental
```
(def: AnimatorControllerDef, name: string): AnimatorControllerDef
```
-## setAnimatorStateClip — function
+## setAnimatorStateClip — function @experimental
```
(def: AnimatorControllerDef, name: string, clip: string): AnimatorControllerDef
```
-## setAnimatorStateProps — function
+## setAnimatorStateProps — function @experimental
```
(def: AnimatorControllerDef, name: string, patch: { speed?: number; loop?: boolean; }): AnimatorControllerDef
```
-## setBtNodeField — function
+## setBtNodeField — function @experimental
```
(def: BtDefinition, id: string, patch: Partial<BtNode>): BtDefinition
```
-## setButtonState — function
+## setButtonState — function @experimental
```
(world: World, entity: Entity, state: string): void
```
-## setCacheForEntity — function
+## setCacheForEntity — function @experimental
```
(entityId: number, cache: BitmapCache): void
```
-## setControllerPage — function
+## setControllerPage — function @experimental
```
(world: World, entity: Entity, name: string, page: string): boolean
```
-## setDefaultContext — function
+## setDefaultContext — function @experimental
```
(ctx: AppContext): void
```
-## setEditorMode — function
+## setEditorMode — function @experimental
```
(active: boolean): void
```
-## setEditorViewHalfHeight — function
+## setEditorViewHalfHeight — function @experimental
```
(view: EditorViewData, halfH: number): void
```
-## setEntityActive — function
+## setEntityActive — function @experimental
```
(world: World, entity: Entity, active: boolean): void
```
-## setEntityVisible — function
+## setEntityVisible — function @experimental
```
(world: World, entity: Entity, visible: boolean): void
```
-## setFxEditPreview — function
+## setFxEditPreview — function @experimental
```
(enabled: boolean): void
```
-## setInitial — function
+## setInitial — function @experimental
```
(def: FsmDefinition, name: string): FsmDefinition
```
-## setLogLevel — function
+## setLogLevel — function @experimental
```
(level: LogLevel): void
```
-## setNavDestination — function
+## setNavDestination — function @experimental
```
(world: World, entity: Entity, target: Vec2): void
```
-## setPlayMode — function
+## setPlayMode — function @experimental
```
(active: boolean): void
```
-## setStateHook — function
+## setStateHook — function @experimental
```
(def: FsmDefinition, name: string, hook: "onEnter" | "onUpdate" | "onExit", action: string, arg?: string, params?: Record<string, AiParamValue>): FsmDefinition
```
-## setTextureBudget — function
+## setTextureBudget — function @experimental
```
(bytes: number): void
```
-## setTextureFilter — function
+## setTextureFilter — function @experimental
```
(textureId: number, filter: TextureFilter): void
```
-## setTextureParams — function
+## setTextureParams — function @experimental
```
(textureId: number, minFilter: TextureFilter, magFilter: TextureFilter, wrapS: TextureWrap, wrapT: TextureWrap): void
```
-## setTextureSliceBorder — function
+## setTextureSliceBorder — function @experimental
```
(textureId: number, left: number, right: number, top: number, bottom: number): void
```
-## setTextureWrap — function
+## setTextureWrap — function @experimental
```
(textureId: number, wrap: TextureWrap): void
```
-## setTheme — function
+## setTheme — function @experimental
```
(tokens: ThemeTokens): void
```
-## setUIVisible — function
+## setUIVisible — function @experimental
```
(world: World, entity: Entity, visible: boolean): void
```
-## setViewTarget — function
+## setViewTarget — function @experimental
```
(host: CameraDirectorHost, entity: number, opts?: { time?: number; curve?: number; }): void
```
-## setWasmErrorHandler — function
+## setWasmErrorHandler — function @experimental
```
(handler: WasmErrorHandler | null): void
```
-## shakeCamera — function
+## shakeCamera — function @experimental
```
(host: CameraDirectorHost, opts?: { amplitude?: number; rotation?: number; frequency?: number; duration?: number; }): void
```
-## shapeCenter — function
+## shapeCenter — function @experimental
```
(shape: ColliderShape, worldPos: Vec2, angle: number, ppu: number): Vec2
```
-## shapeOffset — function
+## shapeOffset — function @experimental
```
(shape: ColliderShape): Vec2
```
-## shutdownDrawAPI — function
+## shutdownDrawAPI — function @experimental
```
(): void
```
-## shutdownGLDebugAPI — function
+## shutdownGLDebugAPI — function @experimental
```
(): void
```
-## shutdownGeometryAPI — function
+## shutdownGeometryAPI — function @experimental
```
(): void
```
-## shutdownMaterialAPI — function
+## shutdownMaterialAPI — function @experimental
```
(): void
```
-## shutdownRendererAPI — function
+## shutdownRendererAPI — function @experimental
```
(): void
```
-## shutdownResourceManager — function
+## shutdownResourceManager — function @experimental
```
(): void
```
-## sideModuleDescriptor — function
+## sideModuleDescriptor — function @experimental
```
(id: SideModuleId): SideModuleDescriptor | undefined
```
-## signal — function
+## signal — function @experimental
```
<T>(initial: T): Signal<T>
```
-## singleStamp — function
+## singleStamp — function @experimental
```
(raw: number): TileStamp
```
-## spawnUIEntity — function
+## spawnUIEntity — function @experimental
```
(init: UIEntityInit): Entity
```
-## spineModuleId — function
+## spineModuleId — function @experimental
```
(version: SpineVersion): SideModuleId
```
-## stackOf — function
+## stackOf — function @experimental
```
(error: unknown): string | undefined
```
-## statsPlugin — const
+## statsPlugin — const @experimental
```
StatsPlugin
```
-## stepFsm — function
+## stepFsm — function @experimental
```
<Ctx>(fsm: CompiledFsm, run: FsmRunState, ctx: Ctx, bb: Blackboard, registry: AiRegistry<Ctx>): boolean
```
-## stepPerception — function
+## stepPerception — function @experimental
```
(world: PerceptionWorldView, isBlocked?: LosCheck): void
```
-## stopNavAgent — function
+## stopNavAgent — function @experimental
```
(world: World, entity: Entity): void
```
-## switchTheme — function
+## switchTheme — function @experimental
```
(world: World, tokens: ThemeTokens): void
```
-## takeCensus — function
+## takeCensus — function @experimental
```
(ctx?: CensusContext): Census
```
-## textInputPlugin — const
+## textInputPlugin — const @experimental
```
TextInputPlugin
```
-## textPlugin — const
+## textPlugin — const @experimental
```
TextPlugin
```
-## textureImportSettingsFrom — function
+## textureImportSettingsFrom — function @experimental
```
(importer: Record<string, unknown> | undefined | null): ParsedTextureImportSettings | undefined
```
-## themeButtonStates — function
+## themeButtonStates — function @experimental
```
(): Record<string, ButtonStateVisual>
```
-## themeColors — function
+## themeColors — function @experimental
```
(): ThemeColors
```
-## themeType — function
+## themeType — function @experimental
```
(): ThemeType
```
-## tickBt — function
+## tickBt — function @experimental
```
<Ctx>(def: BtDefinition, ctx: Ctx, bb: Blackboard, registry: AiRegistry<Ctx>, rs: BtRunState, dt: number): Status
```
-## tileCellCenter — function
+## tileCellCenter — function @experimental
```
(p: TileGridParams, tx: number, ty: number): Vec2Like
```
-## tileCellOutline — function
+## tileCellOutline — function @experimental
```
(p: TileGridParams): Vec2Like[]
```
-## tileCollisionOutlines — function
+## tileCollisionOutlines — function @experimental
```
(chunks: DecodedChunk[], model: TilesetModel, tileW: number, tileH: number, originX: number, originY: number): TileCollisionPiece[]
```
-## tileFlagsOf — function
+## tileFlagsOf — function @experimental
```
(raw: number): TileFlags
```
-## tileIdOf — function
+## tileIdOf — function @experimental
```
(raw: number): number
```
-## tilemapPlugin — const
+## tilemapPlugin — const @experimental
```
TilemapPlugin
```
-## timelinePlugin — const
+## timelinePlugin — const @experimental
```
TimelinePlugin
```
-## timerPlugin — const
+## timerPlugin — const @experimental
```
Plugin
```
-## toBuildPath — function
+## toBuildPath — function @experimental
```
(path: string): string
```
-## trailPlugin — const
+## trailPlugin — const @experimental
```
TrailPlugin
```
-## transitionTo — function
+## transitionTo — function @experimental
```
(host: App | SceneManagerState, targetScene: string, config: TransitionConfig): Promise<void>
```
-## trimTextureCache — function
+## trimTextureCache — function @experimental
```
(): number
```
-## uiHitTestWorld — function
+## uiHitTestWorld — function @experimental
```
(engine: EngineApi | null, registry: CppRegistry, worldX: number, worldY: number, mouseDown?: boolean, mousePressed?: boolean, mouseReleased?: boolean): Entity | null
```
-## uiInteractionPlugin — const
+## uiInteractionPlugin — const @experimental
```
UIInteractionPlugin
```
-## uiLayoutPlugin — const
+## uiLayoutPlugin — const @experimental
```
UILayoutPlugin
```
-## uiLayoutRect — function
+## uiLayoutRect — function @experimental
```
(cam: CameraExtents, fit: CanvasScale | null, width: number, height: number, previewAspect?: number): WorldRect
```
-## uiMaskPlugin — const
+## uiMaskPlugin — const @experimental
```
UIMaskPlugin
```
-## uiPickAllWorld — function
+## uiPickAllWorld — function @experimental
```
(engine: EngineApi | null, registry: CppRegistry, worldX: number, worldY: number): Entity[]
```
-## uiPickWorld — function
+## uiPickWorld — function @experimental
```
(engine: EngineApi | null, registry: CppRegistry, worldX: number, worldY: number): Entity | null
```
-## uiPlugin — const
+## uiPlugin — const @experimental
```
UIPlugin
```
-## uiPlugins — const
+## uiPlugins — const @experimental
```
Plugin[]
```
-## uiRenderOrderPlugin — const
+## uiRenderOrderPlugin — const @experimental
```
UIRenderOrderPlugin
```
-## uiVisibilityPlugin — const
+## uiVisibilityPlugin — const @experimental
```
UIVisibilityPlugin
```
-## uiWorldToScreen — function
+## uiWorldToScreen — function @experimental
```
(camera: UICameraData, worldX: number, worldY: number): { x: number; y: number; }
```
-## unregisterComponent — function
+## unregisterComponent — function @experimental
```
(name: string): void
```
-## unregisterDrawCallback — function
+## unregisterDrawCallback — function @experimental
```
(id: string): void
```
-## unregisterPreSceneDrawCallback — function
+## unregisterPreSceneDrawCallback — function @experimental
```
(id: string): void
```
-## updateAnimatorParam — function
+## updateAnimatorParam — function @experimental
```
(def: AnimatorControllerDef, name: string, patch: Partial<AnimatorParam>): AnimatorControllerDef
```
-## updateAnimatorTransition — function
+## updateAnimatorTransition — function @experimental
```
(def: AnimatorControllerDef, from: string, index: number, patch: Partial<AnimatorTransition>): AnimatorControllerDef
```
-## updateCameraAspectRatio — function
+## updateCameraAspectRatio — function @experimental
```
(world: World, aspectRatio: number): void
```
-## updateTransition — function
+## updateTransition — function @experimental
```
(def: FsmDefinition, from: string, index: number, patch: Partial<FsmTransition>): FsmDefinition
```
-## usesStagger — function
+## usesStagger — function @experimental
```
(orientation: number): boolean
```
-## v2 — const
+## v2 — const @experimental
```
{ readonly create: (x?: number, y?: number) => Vec2; readonly clone: (a: Vec2) => Vec2; readonly add: (a: Vec2, b: Vec2) => Vec2; readonly sub: (a: Vec2, b: Vec2) => Vec2; readonly scale: (a: Vec2, s: number) => Vec2; readonly mul: (a: Vec2, b: Vec2) => Vec2; readonly neg: (a: Vec2) => Vec2; readonly dot: (a: Vec2, b: Vec2) => number; readonly cross: (a: Vec2, b: Vec2) => number; readonly len: (a: Vec2) => number; readonly len2: (a: Vec2) => number; readonly dist: (a: Vec2, b: Vec2) => number; readonly dist2: (a: Vec2, b: Vec2) => number; readonly normalize: (a: Vec2) => Vec2; readonly lerp: (a: Vec2, b: Vec2, t: number) => Vec2; readonly angle: (a: Vec2) => number; readonly fromAngle: (radians: number, length?: number) => Vec2; readonly rotate: (a: Vec2, radians: number) => Vec2; readonly perp: (a: Vec2) => Vec2; readonly equals: (a: Vec2, b: Vec2, epsilon?: number) => boolean; }
```
-## v3 — const
+## v3 — const @experimental
```
{ readonly create: (x?: number, y?: number, z?: number) => Vec3; readonly clone: (a: Vec3) => Vec3; readonly add: (a: Vec3, b: Vec3) => Vec3; readonly sub: (a: Vec3, b: Vec3) => Vec3; readonly scale: (a: Vec3, s: number) => Vec3; readonly mul: (a: Vec3, b: Vec3) => Vec3; readonly neg: (a: Vec3) => Vec3; readonly dot: (a: Vec3, b: Vec3) => number; readonly cross: (a: Vec3, b: Vec3) => Vec3; readonly len: (a: Vec3) => number; readonly len2: (a: Vec3) => number; readonly dist: (a: Vec3, b: Vec3) => number; readonly normalize: (a: Vec3) => Vec3; readonly lerp: (a: Vec3, b: Vec3, t: number) => Vec3; readonly equals: (a: Vec3, b: Vec3, epsilon?: number) => boolean; }
```
-## validateOverrides — function
+## validateOverrides — function @experimental
```
(prefab: PrefabData, options?: { instanceOverrides?: readonly PrefabOverride[]; loadPrefab?: (path: string) => PrefabData | null; }): ValidateResult
```
-## validatePrefab — function
+## validatePrefab — function @experimental
```
(prefab: PrefabData, options?: ValidatePrefabOptions): PrefabDiagnostic[]
```
-## vec2 — const
+## vec2 — const @experimental
```
(x?: number, y?: number) => Vec2
```
-## vec3 — const
+## vec3 — const @experimental
```
(x?: number, y?: number, z?: number) => Vec3
```
-## vec4 — const
+## vec4 — const @experimental
```
(x?: number, y?: number, z?: number, w?: number) => Vec4
```
-## velocityPlugin — const
+## velocityPlugin — const @experimental
```
Plugin
```
-## velocitySystem — const
+## velocitySystem — const @experimental
```
SystemDef
```
-## videoPlugin — const
+## videoPlugin — const @experimental
```
VideoPlugin
```
-## warn — function
+## warn — function @experimental
```
(category: string, message: string, data?: unknown): void
```
-## widgetToPrefab — function
+## widgetToPrefab — function @experimental
```
(build: (world: World) => Entity, name: string): PrefabData
```
-## withActiveRemoteRoot — function
+## withActiveRemoteRoot — function @experimental
```
(config: AssetGroupsConfig | null | undefined, remoteRoot: string): AssetGroupsConfig
```
-## withFolderAlwaysInclude — function
+## withFolderAlwaysInclude — function @experimental
```
(config: AssetGroupsConfig | null | undefined, folder: string, on: boolean): AssetGroupsConfig
```
-## withFolderGroup — function
+## withFolderGroup — function @experimental
```
(config: AssetGroupsConfig | null | undefined, folder: string, mode: AssetGroupMode): AssetGroupsConfig
```
-## wrapSceneSystem — function
+## wrapSceneSystem — function @experimental
```
(app: App, sceneName: string, system: SystemDef): SystemDef
```
-## writeFieldPath — function
+## writeFieldPath — function @experimental
```
(data: Record<string, unknown>, path: string, value: unknown): boolean
```
-## writePtrField — function
+## writePtrField — function @experimental
```
(f32: Float32Array, u32: Uint32Array, u8: Uint8Array, ptr: number, field: PtrFieldDesc, value: PtrFieldValue | unknown): void
```
diff --git a/sdk/etc/index.node.api.md b/sdk/etc/index.node.api.md
index 12724afe6..f9e18d951 100644
--- a/sdk/etc/index.node.api.md
+++ b/sdk/etc/index.node.api.md
@@ -1,24 +1,24 @@
# API surface — esengine/index.node
<!-- Generated by tools/api-surface.mjs — do not edit. Run --update to accept changes. -->
-Symbols: 1486 stable · 19 beta · 1 deprecated
+Symbols: 0 public · 19 beta · 1487 experimental · 1 deprecated
-## ANCHOR_AXES — const
+## ANCHOR_AXES — const @experimental
```
readonly AnchorAxis[]
```
-## ANIM_CLIP_FORMAT_VERSION — const
+## ANIM_CLIP_FORMAT_VERSION — const @experimental
```
"1.4"
```
-## ASSET_GROUP_MODES — const
+## ASSET_GROUP_MODES — const @experimental
```
readonly ["local", "subpackage", "remote"]
```
-## AchievementProvider — interface
+## AchievementProvider — interface @experimental
```
getStat: (name: string) => number
platformBacked: boolean
@@ -29,12 +29,12 @@ unlock: (id: string) => Promise<void>
unlocked: (id: string) => boolean
```
-## Achievements — const
+## Achievements — const @experimental
```
ResourceDef<AchievementsAPI>
```
-## AchievementsAPI — class
+## AchievementsAPI — class @experimental
```
available: boolean
getStat: (name: string) => number
@@ -49,18 +49,18 @@ static new (): AchievementsAPI
static prototype: AchievementsAPI
```
-## ActionDef — interface
+## ActionDef — interface @experimental
```
bindings: Binding[]
type: ActionType
```
-## ActionType — type
+## ActionType — type @experimental
```
'button' | 'axis' | 'axis2d'
```
-## ActivationTrack — interface
+## ActivationTrack — interface @experimental
```
childPath: string
name: string
@@ -68,18 +68,18 @@ ranges: ActivationRange[]
type: "activation"
```
-## AdProvider — interface
+## AdProvider — interface @experimental
```
createInterstitialAd: (adUnitId: string) => PlatformInterstitialAd
createRewardedAd: (adUnitId: string) => PlatformRewardedAd
```
-## Added — function
+## Added — function @experimental
```
<T extends AnyComponentDef>(component: T): AddedWrapper<T>
```
-## AddedEntity — interface
+## AddedEntity — interface @experimental
```
components: ComponentData[]
name: string
@@ -88,26 +88,26 @@ prefabEntityId: string
visible: boolean
```
-## AddedWrapper — interface
+## AddedWrapper — interface @experimental
```
_component: T
_filterType: "added"
```
-## AddressableAssetType — type
+## AddressableAssetType — type @experimental
```
| 'texture' | 'material' | 'spine' | 'bitmap-font' | 'font'
| 'prefab' | 'json' | 'text' | 'binary' | 'audio'
```
-## AddressableManifest — interface
+## AddressableManifest — interface @experimental
```
groups: Record<string, AddressableManifestGroup>
revision: string | undefined
version: "2.0"
```
-## AddressableManifestAsset — interface
+## AddressableManifestAsset — interface @experimental
```
address: string | undefined
compressedFormats: string[] | undefined
@@ -120,19 +120,19 @@ textureImport: ParsedTextureImportSettings | undefined
type: AddressableAssetType
```
-## AddressableManifestGroup — interface
+## AddressableManifestGroup — interface @experimental
```
assets: Record<string, AddressableManifestAsset>
bundleMode: string
labels: string[]
```
-## Ads — const
+## Ads — const @experimental
```
ResourceDef<AdsAPI>
```
-## AdsAPI — class
+## AdsAPI — class @experimental
```
available: boolean
preloadRewarded: (adUnitId: string) => Promise<void>
@@ -144,7 +144,7 @@ static new (takeover: Takeover): AdsAPI
static prototype: AdsAPI
```
-## AiAction — type
+## AiAction — type @experimental
```
(
ctx: Ctx,
@@ -154,30 +154,30 @@ static prototype: AdsAPI
) => void | Status
```
-## AiActionInput — interface
+## AiActionInput — interface @experimental
```
arg: string | undefined
params: Readonly<Record<string, AiParamValue>> | undefined
```
-## AiActionSpec — interface
+## AiActionSpec — interface @experimental
```
params: readonly AiParamDef[] | undefined
run: AiAction<Ctx>
separator: string | undefined
```
-## AiBt — const
+## AiBt — const @experimental
```
ResourceDef<BehaviorTrees>
```
-## AiCondition — type
+## AiCondition — type @experimental
```
(ctx: Ctx, bb: Blackboard) => boolean
```
-## AiContext — interface
+## AiContext — interface @experimental
```
blackboard: Blackboard
commands: CommandsInstance
@@ -189,12 +189,12 @@ set: <C extends AnyComponentDef>(component: C, data: ComponentData<C>) => void
world: World
```
-## AiFsm — const
+## AiFsm — const @experimental
```
ResourceDef<StateMachines>
```
-## AiParamDef — interface
+## AiParamDef — interface @experimental
```
label: string | undefined
max: number | undefined
@@ -207,17 +207,17 @@ tooltip: string | undefined
type: "string" | "number" | "bool" | "enum"
```
-## AiParamValue — type
+## AiParamValue — type @experimental
```
string | number | boolean
```
-## AiParams — type
+## AiParams — type @experimental
```
Readonly<Record<string, AiParamValue>>
```
-## AiRegistry — class
+## AiRegistry — class @experimental
```
actionNames: () => string[]
clear: () => void
@@ -234,17 +234,17 @@ static new <Ctx = unknown>(): AiRegistry<Ctx>
static prototype: AiRegistry<any>
```
-## AlignContent — type
+## AlignContent — type @experimental
```
(typeof AlignContent)[keyof typeof AlignContent]
```
-## AlignItems — type
+## AlignItems — type @experimental
```
(typeof AlignItems)[keyof typeof AlignItems]
```
-## AlignSelf — enum
+## AlignSelf — enum @experimental
```
Auto = 0
Center = 2
@@ -253,7 +253,7 @@ Start = 1
Stretch = 4
```
-## AnchorAxis — enum
+## AnchorAxis — enum @experimental
```
Center = 1
End = 2
@@ -261,7 +261,7 @@ Start = 0
Stretch = 3
```
-## AnchorFields — interface
+## AnchorFields — interface @experimental
```
height: Dimension | undefined
insetBottom: Dimension
@@ -276,18 +276,18 @@ position: number
width: Dimension | undefined
```
-## AnchorPreset — interface
+## AnchorPreset — interface @experimental
```
h: AnchorAxis
v: AnchorAxis
```
-## And — function
+## And — function @experimental
```
(...filters: FilterExpr[]): FilterExpr
```
-## AnimClipAssetData — interface
+## AnimClipAssetData — interface @experimental
```
events: AnimClipEventData[] | undefined
fps: number | undefined
@@ -299,14 +299,14 @@ type: "animation-clip"
version: string
```
-## AnimClipEventData — interface
+## AnimClipEventData — interface @experimental
```
data: unknown
frame: number
name: string
```
-## AnimClipFrameData — interface
+## AnimClipFrameData — interface @experimental
```
atlasFrame: { x: number; y: number; width: number; height: number; pageWidth: number; pageHeight: number; } | undefined
cell: number | undefined
@@ -315,13 +315,13 @@ pivot: AnimClipPivotData | undefined
texture: string | undefined
```
-## AnimClipPivotData — interface
+## AnimClipPivotData — interface @experimental
```
x: number
y: number
```
-## AnimClipSheetData — interface
+## AnimClipSheetData — interface @experimental
```
cellHeight: number
cellWidth: number
@@ -332,7 +332,7 @@ spacing: number
texture: string
```
-## AnimFramesTrack — interface
+## AnimFramesTrack — interface @experimental
```
childPath: string
frames: AnimFrame[]
@@ -340,7 +340,7 @@ name: string
type: "animFrames"
```
-## AnimationPlugin — class
+## AnimationPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -349,18 +349,18 @@ static new (): AnimationPlugin
static prototype: AnimationPlugin
```
-## Animator — const
+## Animator — const @experimental
```
ComponentDef<AnimatorData>
```
-## AnimatorBlend1D — interface
+## AnimatorBlend1D — interface @experimental
```
parameter: string
thresholds: AnimatorBlendThreshold[]
```
-## AnimatorBlendThreshold — interface
+## AnimatorBlendThreshold — interface @experimental
```
clip: string
loop: boolean | undefined
@@ -368,18 +368,18 @@ speed: number | undefined
value: number
```
-## AnimatorCondition — type
+## AnimatorCondition — type @experimental
```
| { param: string; op: 'gt' | 'lt' | 'eq' | 'neq'; value: number }
| { param: string; op: 'true' | 'false' | 'trigger' }
```
-## AnimatorController — const
+## AnimatorController — const @experimental
```
ResourceDef<AnimatorControllerAPI>
```
-## AnimatorControllerAPI — class
+## AnimatorControllerAPI — class @experimental
```
clearControllers: () => void
getBool: (entity: Entity, name: string) => boolean
@@ -398,7 +398,7 @@ static new (): AnimatorControllerAPI
static prototype: AnimatorControllerAPI
```
-## AnimatorControllerDef — interface
+## AnimatorControllerDef — interface @experimental
```
anyStateTransitions: AnimatorTransition[] | undefined
initialState: string
@@ -406,59 +406,59 @@ parameters: AnimatorParam[]
states: AnimatorState[]
```
-## AnimatorData — interface
+## AnimatorData — interface @experimental
```
controller: string
currentState: string
enabled: boolean
```
-## AnimatorEdge — type
+## AnimatorEdge — type @experimental
```
GraphEdge<AnimatorTransition>
```
-## AnimatorEvalResult — interface
+## AnimatorEvalResult — interface @experimental
```
consumedTriggers: string[]
next: string | null
```
-## AnimatorParam — interface
+## AnimatorParam — interface @experimental
```
default: number | boolean | undefined
name: string
type: AnimatorParamType
```
-## AnimatorParamType — type
+## AnimatorParamType — type @experimental
```
'float' | 'bool' | 'trigger'
```
-## AnimatorParamValues — type
+## AnimatorParamValues — type @experimental
```
Readonly<Record<string, number | boolean>>
```
-## AnimatorPathEvalResult — interface
+## AnimatorPathEvalResult — interface @experimental
```
consumedTriggers: string[]
nextPath: string | null
```
-## AnimatorScope — type
+## AnimatorScope — type @experimental
```
Pick<AnimatorControllerDef, 'states' | 'initialState' | 'anyStateTransitions'>
```
-## AnimatorSpineMotion — interface
+## AnimatorSpineMotion — interface @experimental
```
animation: string
loop: boolean | undefined
```
-## AnimatorState — interface
+## AnimatorState — interface @experimental
```
blend: AnimatorBlend1D | undefined
clip: string | undefined
@@ -472,26 +472,26 @@ x: number | undefined
y: number | undefined
```
-## AnimatorSubMachine — interface
+## AnimatorSubMachine — interface @experimental
```
anyStateTransitions: AnimatorTransition[] | undefined
initialState: string
states: AnimatorState[]
```
-## AnimatorTransition — interface
+## AnimatorTransition — interface @experimental
```
conditions: AnimatorCondition[]
hasExitTime: boolean | undefined
to: string
```
-## AnyComponentDef — type
+## AnyComponentDef — type @experimental
```
ComponentDef<any> | BuiltinComponentDef<any>
```
-## App — class
+## App — class @experimental
```
addBundleSystems: (entries: ReadonlyArray<{ schedule: number; system: SystemDef | SystemSet; }>) => App
addEvent: <T>(event: EventDef<T>) => App
@@ -553,7 +553,7 @@ static new: () => App
static prototype: App
```
-## AppContext — class
+## AppContext — class @experimental
```
componentRegistry: Map<string, any>
drainPendingSystems: () => PendingSystemEntry[]
@@ -567,12 +567,12 @@ static new (): AppContext
static prototype: AppContext
```
-## ApplyTilesetRefs — type
+## ApplyTilesetRefs — type @experimental
```
(entity: number, refs: readonly string[]) => void
```
-## ArrayDataSource — class
+## ArrayDataSource — class @experimental
```
append: (items: readonly T[]) => void
getCount: () => number
@@ -586,34 +586,34 @@ static new <T>(items?: readonly T[]): ArrayDataSource<T>
static prototype: ArrayDataSource<any>
```
-## AssetBuildTransform — type
+## AssetBuildTransform — type @experimental
```
(content: string, context: unknown) => string
```
-## AssetContentType — type
+## AssetContentType — type @experimental
```
'json' | 'text' | 'binary' | 'image' | 'audio'
```
-## AssetFieldType — type
+## AssetFieldType — type @experimental
```
'texture' | 'material' | 'font' | 'anim-clip' | 'audio' | 'video' | 'tilemap' | 'tileset' | 'timeline' | 'statemachine' | 'behaviortree' | 'animatorcontroller'
```
-## AssetGroupDef — interface
+## AssetGroupDef — interface @experimental
```
alwaysInclude: boolean | undefined
folder: string
mode: "local" | "subpackage" | "remote"
```
-## AssetGroupMode — type
+## AssetGroupMode — type @experimental
```
typeof ASSET_GROUP_MODES[number]
```
-## AssetGroupsConfig — interface
+## AssetGroupsConfig — interface @experimental
```
activeProfile: string | undefined
atlases: Record<string, AtlasDef> | undefined
@@ -622,7 +622,7 @@ profiles: Record<string, BuildProfile> | undefined
version: string
```
-## AssetPlugin — class
+## AssetPlugin — class @experimental
```
build: (app: App) => void
name: string
@@ -630,7 +630,7 @@ static new (): AssetPlugin
static prototype: AssetPlugin
```
-## AssetRefCounter — class
+## AssetRefCounter — class @experimental
```
addFontRef: (path: string, entity: number) => void
addMaterialRef: (path: string, entity: number) => void
@@ -655,14 +655,14 @@ static new (): AssetRefCounter
static prototype: AssetRefCounter
```
-## AssetRefInfo — interface
+## AssetRefInfo — interface @experimental
```
assetPath: string
entities: number[]
refCount: number
```
-## AssetTypeEntry — interface
+## AssetTypeEntry — interface @experimental
```
addressableType: AddressableAssetType | null
buildTransform: AssetBuildTransform | undefined
@@ -674,17 +674,17 @@ suffixes: string[] | undefined
wechatPackInclude: boolean
```
-## Assets — const
+## Assets — const @experimental
```
ResourceDef<AssetsClass>
```
-## AssetsData — type
+## AssetsData — type @experimental
```
AssetsClass
```
-## AsyncCache — class
+## AsyncCache — class @experimental
```
clear: () => void
clearAll: () => void
@@ -701,24 +701,24 @@ static new <T>(dispose_?: ((value: T) => void) | undefined): AsyncCache<T>
static prototype: AsyncCache<any>
```
-## AtlasDef — interface
+## AtlasDef — interface @experimental
```
folder: string
```
-## AttenuationModel — enum
+## AttenuationModel — enum @experimental
```
Exponential = 2
Inverse = 1
Linear = 0
```
-## Audio — const
+## Audio — const @experimental
```
ResourceDef<AudioAPI>
```
-## AudioAPI — class
+## AudioAPI — class @experimental
```
baseUrl: string
bufferBudget: number
@@ -766,20 +766,20 @@ static new (backend: PlatformAudioBackend, mixer?: AudioMixer | null): AudioAPI
static prototype: AudioAPI
```
-## AudioBackendInitOptions — interface
+## AudioBackendInitOptions — interface @experimental
```
initialPoolSize: number | undefined
mixerConfig: AudioMixerConfig | undefined
```
-## AudioBufferHandle — interface
+## AudioBufferHandle — interface @experimental
```
bytes: number | undefined
duration: number
id: number
```
-## AudioBufferStats — interface
+## AudioBufferStats — interface @experimental
```
bufferBudget: number
bufferBytes: number
@@ -787,7 +787,7 @@ bufferCount: number
evictableCount: number
```
-## AudioBus — class
+## AudioBus — class @experimental
```
addChild: (child: AudioBus) => void
connect: (destination: AudioBus | AudioNode) => void
@@ -803,7 +803,7 @@ static new (context: AudioContext, config: AudioBusConfig): AudioBus
static prototype: AudioBus
```
-## AudioBusConfig — interface
+## AudioBusConfig — interface @experimental
```
muted: boolean | undefined
name: string
@@ -811,7 +811,7 @@ parent: string | undefined
volume: number | undefined
```
-## AudioBusDecl — interface
+## AudioBusDecl — interface @experimental
```
duck: BusDuckRule | undefined
effects: BusEffectDef[] | undefined
@@ -821,7 +821,7 @@ parent: string | undefined
volume: number | undefined
```
-## AudioHandle — interface
+## AudioHandle — interface @experimental
```
currentTime: number
duration: number
@@ -837,17 +837,17 @@ setVolume: (volume: number) => void
stop: () => void
```
-## AudioListener — const
+## AudioListener — const @experimental
```
ComponentDef<AudioListenerData>
```
-## AudioListenerData — interface
+## AudioListenerData — interface @experimental
```
enabled: boolean
```
-## AudioMixer — class
+## AudioMixer — class @experimental
```
busNames: () => string[]
createBus: (config: AudioBusConfig) => AudioBus
@@ -864,7 +864,7 @@ static new (context: AudioContext, config?: AudioMixerConfig): AudioMixer
static prototype: AudioMixer
```
-## AudioMixerConfig — interface
+## AudioMixerConfig — interface @experimental
```
masterVolume: number | undefined
musicVolume: number | undefined
@@ -873,7 +873,7 @@ uiVolume: number | undefined
voiceVolume: number | undefined
```
-## AudioPlugin — class
+## AudioPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -883,7 +883,7 @@ static new (config?: AudioPluginConfig): AudioPlugin
static prototype: AudioPlugin
```
-## AudioPluginConfig — interface
+## AudioPluginConfig — interface @experimental
```
initialPoolSize: number | undefined
masterVolume: number | undefined
@@ -891,7 +891,7 @@ musicVolume: number | undefined
sfxVolume: number | undefined
```
-## AudioPool — class
+## AudioPool — class @experimental
```
acquire: () => PooledAudioNode
activeCount: number
@@ -901,17 +901,17 @@ static new (context: AudioContext, initialSize?: number): AudioPool
static prototype: AudioPool
```
-## AudioProjectConfig — interface
+## AudioProjectConfig — interface @experimental
```
buses: AudioBusDecl[] | undefined
```
-## AudioSource — const
+## AudioSource — const @experimental
```
ComponentDef<AudioSourceData>
```
-## AudioSourceData — interface
+## AudioSourceData — interface @experimental
```
attenuationModel: number
bus: string
@@ -928,7 +928,7 @@ spatial: boolean
volume: number
```
-## AudioTrack — interface
+## AudioTrack — interface @experimental
```
childPath: string
events: AudioEvent[]
@@ -936,37 +936,37 @@ name: string
type: "audio"
```
-## Axis1D — const
+## Axis1D — const @experimental
```
(...bindings: Binding[]) => ActionDef
```
-## Axis2D — const
+## Axis2D — const @experimental
```
(...bindings: Binding[]) => ActionDef
```
-## BUILTIN_SHADER_TEMPLATES — const
+## BUILTIN_SHADER_TEMPLATES — const @experimental
```
readonly BuiltinShaderTemplate[]
```
-## BUILTIN_UI_PREFABS — const
+## BUILTIN_UI_PREFABS — const @experimental
```
Record<string, PrefabData>
```
-## BUILTIN_UI_WIDGET_NAMES — const
+## BUILTIN_UI_WIDGET_NAMES — const @experimental
```
readonly ["Button", "Toggle", "Slider", "Dialog", "TextInput", "Progress", "Dropdown", "ListView", "ScrollView"]
```
-## BUNDLE_MODES — const
+## BUNDLE_MODES — const @experimental
```
readonly BundleMode[]
```
-## Backend — interface
+## Backend — interface @experimental
```
fetchBinary: (path: string) => Promise<ArrayBuffer>
fetchText: (path: string) => Promise<string>
@@ -974,7 +974,7 @@ resolveUrl: (path: string) => string
setBaseUrl: ((url: string) => void) | undefined
```
-## BehaviorContext — interface
+## BehaviorContext — interface @experimental
```
commands: CommandsInstance
entity: number
@@ -987,7 +987,7 @@ time: TimeData
world: World
```
-## BehaviorDef — interface
+## BehaviorDef — interface @experimental
```
destroy: ((ctx: BehaviorContext<S>) => void) | undefined
metadata: ComponentMetadata | undefined
@@ -997,18 +997,18 @@ state: S | undefined
update: ((ctx: BehaviorContext<S>, dt: number) => void) | undefined
```
-## BehaviorTreeAgent — const
+## BehaviorTreeAgent — const @experimental
```
ComponentDef<BehaviorTreeAgentData>
```
-## BehaviorTreeAgentData — interface
+## BehaviorTreeAgentData — interface @experimental
```
bt: string
status: string
```
-## BehaviorTrees — class
+## BehaviorTrees — class @experimental
```
blackboard: (entity: Entity) => Blackboard
status: (entity: Entity) => string | null
@@ -1016,7 +1016,7 @@ static new (states: Map<Entity, BtAgentState>): BehaviorTrees
static prototype: BehaviorTrees
```
-## BezierPoints — interface
+## BezierPoints — interface @experimental
```
p1x: number
p1y: number
@@ -1024,12 +1024,12 @@ p2x: number
p2y: number
```
-## BinaryHandler — type
+## BinaryHandler — type @experimental
```
(payload: Uint8Array) => void
```
-## Binding — type
+## Binding — type @experimental
```
| { kind: 'key'; code: string }
| { kind: 'mouse'; button: number }
@@ -1041,7 +1041,7 @@ p2y: number
| { kind: 'virtual'; id: string }
```
-## BitmapCache — interface
+## BitmapCache — interface @experimental
```
_rt: RenderTextureHandle | null
height: number
@@ -1050,12 +1050,12 @@ valid: boolean
width: number
```
-## BitmapText — const
+## BitmapText — const @experimental
```
BuiltinComponentDef<BitmapTextData>
```
-## BitmapTextData — interface
+## BitmapTextData — interface @experimental
```
align: number
color: Color
@@ -1068,7 +1068,7 @@ spacing: number
text: string
```
-## Blackboard — class
+## Blackboard — class @experimental
```
clearTriggers: () => void
consume: (trigger: string) => void
@@ -1082,19 +1082,19 @@ static new (): Blackboard
static prototype: Blackboard
```
-## BlackboardGuard — interface
+## BlackboardGuard — interface @experimental
```
key: string
op: CompareOp
value: string | number | boolean | undefined
```
-## BlendCurve — type
+## BlendCurve — type @experimental
```
(typeof BlendCurve)[keyof typeof BlendCurve]
```
-## BlendMode — enum
+## BlendMode — enum @experimental
```
Additive = 1
Darken = 7
@@ -1108,19 +1108,19 @@ PremultipliedAlpha = 4
Screen = 3
```
-## BodyType — enum
+## BodyType — enum @experimental
```
Dynamic = 2
Kinematic = 1
Static = 0
```
-## BoxCollider — const
+## BoxCollider — const @experimental
```
BuiltinComponentDef<BoxColliderData>
```
-## BoxColliderData — interface
+## BoxColliderData — interface @experimental
```
categoryBits: number
density: number
@@ -1134,20 +1134,20 @@ radius: number
restitution: number
```
-## BtDefinition — interface
+## BtDefinition — interface @experimental
```
orphans: BtNode[] | undefined
root: BtNode
```
-## BtEdge — interface
+## BtEdge — interface @experimental
```
from: string
id: string
to: string
```
-## BtNode — interface
+## BtNode — interface @experimental
```
arg: string | undefined
children: BtNode[] | undefined
@@ -1162,7 +1162,7 @@ x: number | undefined
y: number | undefined
```
-## BtNodeType — type
+## BtNodeType — type @experimental
```
| 'sequence' | 'selector' | 'parallel'
// decorators (one child)
@@ -1171,7 +1171,7 @@ y: number | undefined
| 'action' | 'condition'
```
-## BtPlugin — class
+## BtPlugin — class @experimental
```
build: (app: App) => void
name: string
@@ -1179,12 +1179,12 @@ static new (): BtPlugin
static prototype: BtPlugin
```
-## BtRunState — type
+## BtRunState — type @experimental
```
Map<string, NodeState>
```
-## BuildNavGridOptions — interface
+## BuildNavGridOptions — interface @experimental
```
blockedTileIds: Iterable<number> | undefined
cellSize: number
@@ -1194,12 +1194,12 @@ origin: Vec2 | undefined
width: number
```
-## BuildProfile — interface
+## BuildProfile — interface @experimental
```
remoteRoot: string | undefined
```
-## BuiltinBridge — class
+## BuiltinBridge — class @experimental
```
connect: (cppRegistry: CppRegistry, module?: ESEngineModule, options?: BridgeConnectOptions) => void
deleteFromEntitySets: (entity: Entity) => string[]
@@ -1224,7 +1224,7 @@ static new (): BuiltinBridge
static prototype: BuiltinBridge
```
-## BuiltinComponentDef — interface
+## BuiltinComponentDef — interface @experimental
```
_builtin: true
_cppName: string
@@ -1244,7 +1244,7 @@ skeletalFields: SkeletalFieldMeta | undefined
transient: boolean
```
-## BuiltinShaderTemplate — interface
+## BuiltinShaderTemplate — interface @experimental
```
defaults: Record<string, unknown>
description: string
@@ -1253,17 +1253,17 @@ label: string
source: string
```
-## BuiltinSideModuleId — type
+## BuiltinSideModuleId — type @experimental
```
'physics' | 'basis' | 'videodec' | 'dragonbones' | `spine:${SpineVersion}`
```
-## BundleMode — type
+## BundleMode — type @experimental
```
'local' | 'lazy' | 'remote'
```
-## BusDuckRule — interface
+## BusDuckRule — interface @experimental
```
amount: number
attack: number | undefined
@@ -1272,24 +1272,24 @@ threshold: number | undefined
trigger: string
```
-## BusEffectDef — type
+## BusEffectDef — type @experimental
```
FilterEffectDef | ReverbEffectDef | CompressorEffectDef
```
-## Button — const
+## Button — const @experimental
```
(...bindings: Binding[]) => ActionDef
```
-## ButtonHandle — interface
+## ButtonHandle — interface @experimental
```
dispose: () => void
entity: number
setDisabled: (disabled: boolean) => void
```
-## ButtonOptions — interface
+## ButtonOptions — interface @experimental
```
background: UIVisualInit | undefined
disabled: boolean | undefined
@@ -1305,39 +1305,39 @@ text: string | TextInit | undefined
world: World
```
-## ButtonStateVisual — interface
+## ButtonStateVisual — interface @experimental
```
color: Color | undefined
scale: number | undefined
sprite: number | undefined
```
-## CAPSULE_ARC_SEGMENTS — const
+## CAPSULE_ARC_SEGMENTS — const @experimental
```
16
```
-## CHUNK_SIZE — const
+## CHUNK_SIZE — const @experimental
```
16
```
-## COLLISION_BRUSHES — const
+## COLLISION_BRUSHES — const @experimental
```
CollisionBrush[]
```
-## COLLISION_PALETTE_REF — const
+## COLLISION_PALETTE_REF — const @experimental
```
"builtin:collision"
```
-## CacheAsBitmap — const
+## CacheAsBitmap — const @experimental
```
ComponentDef<CacheAsBitmapData>
```
-## CacheAsBitmapData — interface
+## CacheAsBitmapData — interface @experimental
```
dirty: boolean
enabled: boolean
@@ -1345,22 +1345,22 @@ height: number
width: number
```
-## CacheBitmap — const
+## CacheBitmap — const @experimental
```
{ create(width: number, height: number): BitmapCache; release(cache: BitmapCache): void; beginDraw(cache: BitmapCache, viewProjection: Float32Array): void; endDraw(): void; resize(cache: BitmapCache, width: number, height: number): void; }
```
-## Camera — const
+## Camera — const @experimental
```
BuiltinComponentDef<CameraData>
```
-## CameraBounds — const
+## CameraBounds — const @experimental
```
ComponentDef<CameraBoundsData>
```
-## CameraBoundsData — interface
+## CameraBoundsData — interface @experimental
```
maxX: number
maxY: number
@@ -1368,7 +1368,7 @@ minX: number
minY: number
```
-## CameraData — interface
+## CameraData — interface @experimental
```
aspectRatio: number
clearFlags: number
@@ -1385,12 +1385,12 @@ showFrustum: boolean
viewport: Vec4
```
-## CameraDirector — const
+## CameraDirector — const @experimental
```
ResourceDef<CameraDirectorState>
```
-## CameraDirectorState — interface
+## CameraDirectorState — interface @experimental
```
blending: boolean
currentMain: CameraPOV | null
@@ -1407,7 +1407,7 @@ startTime: number
target: number
```
-## CameraExtents — interface
+## CameraExtents — interface @experimental
```
cameraX: number
cameraY: number
@@ -1416,7 +1416,7 @@ halfH: number
halfW: number
```
-## CameraPOV — interface
+## CameraPOV — interface @experimental
```
clearFlags: number
cullingMask: number
@@ -1436,7 +1436,7 @@ y: number
z: number
```
-## CameraRenderParams — interface
+## CameraRenderParams — interface @experimental
```
cameraEntity: number | undefined
clearColor: { x: number; y: number; z: number; w: number; } | undefined
@@ -1448,12 +1448,12 @@ viewProjection: Float32Array<ArrayBufferLike>
viewportPixels: Viewport
```
-## CameraView — const
+## CameraView — const @experimental
```
ResourceDef<CameraViewAPI>
```
-## CameraViewAPI — class
+## CameraViewAPI — class @experimental
```
getWorldBounds: () => { left: number; right: number; bottom: number; top: number; } | null
getWorldMousePosition: () => { x: number; y: number; } | null
@@ -1463,12 +1463,12 @@ static new (app_: App): CameraViewAPI
static prototype: CameraViewAPI
```
-## Canvas — const
+## Canvas — const @experimental
```
BuiltinComponentDef<CanvasData>
```
-## CanvasData — interface
+## CanvasData — interface @experimental
```
backgroundColor: Color
designResolution: Vec2
@@ -1478,19 +1478,19 @@ pixelsPerUnit: number
scaleMode: number
```
-## CanvasScale — interface
+## CanvasScale — interface @experimental
```
designResolution: { x: number; y: number; }
matchWidthOrHeight: number
scaleMode: number
```
-## CapsuleCollider — const
+## CapsuleCollider — const @experimental
```
BuiltinComponentDef<CapsuleColliderData>
```
-## CapsuleColliderData — interface
+## CapsuleColliderData — interface @experimental
```
categoryBits: number
density: number
@@ -1504,7 +1504,7 @@ radius: number
restitution: number
```
-## Catalog — class
+## Catalog — class @experimental
```
getAllLabels: () => string[]
getAtlasFrame: (path: string) => AtlasFrameInfo | null
@@ -1522,7 +1522,7 @@ static new (entries: Map<string, CatalogEntry>, addresses: Map<string, string>,
static prototype: Catalog
```
-## CatalogData — interface
+## CatalogData — interface @experimental
```
addresses: Record<string, string> | undefined
entries: Record<string, CatalogEntry>
@@ -1530,7 +1530,7 @@ labels: Record<string, string[]> | undefined
version: number
```
-## CatalogEntry — interface
+## CatalogEntry — interface @experimental
```
atlas: string | undefined
buildPath: string | undefined
@@ -1541,27 +1541,27 @@ type: string
uv: { offset: [number, number]; scale: [number, number]; } | undefined
```
-## Cell — interface
+## Cell — interface @experimental
```
x: number
y: number
```
-## Census — interface
+## Census — interface @experimental
```
atMs: number
entries: ReadonlyMap<string, CensusEntry>
failedProbes: readonly string[]
```
-## CensusContext — interface
+## CensusContext — interface @experimental
```
app: App | undefined
module: ESEngineModule | null | undefined
world: World | undefined
```
-## CensusDelta — interface
+## CensusDelta — interface @experimental
```
after: number
before: number
@@ -1571,7 +1571,7 @@ tier: CensusTier
unit: "count" | "bytes"
```
-## CensusEntry — interface
+## CensusEntry — interface @experimental
```
key: string
tier: CensusTier
@@ -1579,13 +1579,13 @@ unit: "count" | "bytes"
value: number
```
-## CensusProbe — interface
+## CensusProbe — interface @experimental
```
id: string
read: (ctx: CensusContext) => readonly CensusEntry[] | undefined
```
-## CensusReport — interface
+## CensusReport — interface @experimental
```
cycles: number
failedProbes: readonly string[]
@@ -1595,7 +1595,7 @@ projectCycles: number
verdicts: readonly CensusVerdict[]
```
-## CensusSeriesOptions — interface
+## CensusSeriesOptions — interface @experimental
```
boundedSlopeTolerance: number | undefined
projectCycles: number | undefined
@@ -1603,12 +1603,12 @@ trendByteBudgetPerCycle: number | undefined
warmupCycles: number | undefined
```
-## CensusTier — type
+## CensusTier — type @experimental
```
'conserved' | 'bounded' | 'trend' | 'info'
```
-## CensusVerdict — interface
+## CensusVerdict — interface @experimental
```
confidentSlopePerCycle: number
first: number
@@ -1623,28 +1623,28 @@ tier: CensusTier
unit: "count" | "bytes"
```
-## ChainCollider — const
+## ChainCollider — const @experimental
```
ComponentDef<ChainColliderData>
```
-## Changed — function
+## Changed — function @experimental
```
<T extends AnyComponentDef>(component: T): ChangedWrapper<T>
```
-## ChangedWrapper — interface
+## ChangedWrapper — interface @experimental
```
_component: T
_filterType: "changed"
```
-## CharacterController — const
+## CharacterController — const @experimental
```
ComponentDef<CharacterControllerData>
```
-## CharacterControllerData — interface
+## CharacterControllerData — interface @experimental
```
floorMaxAngle: number
floorNormal: Vec2
@@ -1661,22 +1661,22 @@ up: Vec2
velocity: Vec2
```
-## Children — const
+## Children — const @experimental
```
BuiltinComponentDef<ChildrenData>
```
-## ChildrenData — interface
+## ChildrenData — interface @experimental
```
entities: number[]
```
-## CircleCollider — const
+## CircleCollider — const @experimental
```
BuiltinComponentDef<CircleColliderData>
```
-## CircleColliderData — interface
+## CircleColliderData — interface @experimental
```
categoryBits: number
density: number
@@ -1689,7 +1689,7 @@ radius: number
restitution: number
```
-## ClearFlags — enum
+## ClearFlags — enum @experimental
```
Color = 1
ColorAndDepth = 3
@@ -1697,20 +1697,20 @@ Depth = 2
Nothing = 0
```
-## ColliderInstance — interface
+## ColliderInstance — interface @experimental
```
enabled: boolean
isSensor: boolean
shape: ColliderShape
```
-## ColliderOutline — interface
+## ColliderOutline — interface @experimental
```
circles: { c: Vec2; r: number; }[]
polylines: Vec2[][]
```
-## ColliderShape — type
+## ColliderShape — type @experimental
```
| { kind: 'box'; halfExtents: Vec2; offset: Vec2 }
| { kind: 'circle'; radius: number; offset: Vec2 }
@@ -1720,14 +1720,14 @@ polylines: Vec2[][]
| { kind: 'chain'; points: Vec2[]; isLoop: boolean }
```
-## CollisionBrush — interface
+## CollisionBrush — interface @experimental
```
collision: ResolvedTileCollision
id: number
key: string
```
-## CollisionEnterEvent — interface
+## CollisionEnterEvent — interface @experimental
```
contactX: number
contactY: number
@@ -1737,7 +1737,7 @@ normalX: number
normalY: number
```
-## CollisionHitEvent — interface
+## CollisionHitEvent — interface @experimental
```
approachSpeed: number
entityA: number
@@ -1748,14 +1748,14 @@ pointX: number
pointY: number
```
-## CollisionMaterial — interface
+## CollisionMaterial — interface @experimental
```
density: number | undefined
friction: number | undefined
restitution: number | undefined
```
-## Color — interface
+## Color — interface @experimental
```
a: number
b: number
@@ -1763,22 +1763,22 @@ g: number
r: number
```
-## ColorRole — type
+## ColorRole — type @experimental
```
keyof ThemeColors
```
-## Commands — function
+## Commands — function @experimental
```
(): CommandsDescriptor
```
-## CommandsDescriptor — interface
+## CommandsDescriptor — interface @experimental
```
_type: "commands"
```
-## CommandsInstance — class
+## CommandsInstance — class @experimental
```
despawn: (entity: Entity) => CommandsInstance
entity: (entity: Entity) => EntityCommands
@@ -1792,18 +1792,18 @@ static new (world: World, resources: ResourceStorage): CommandsInstance
static prototype: CommandsInstance
```
-## CompareOp — type
+## CompareOp — type @experimental
```
'==' | '!=' | '<' | '<=' | '>' | '>=' | 'truthy' | 'falsy'
```
-## CompiledFsm — interface
+## CompiledFsm — interface @experimental
```
initial: string
states: Map<string, FsmState>
```
-## Completable — interface
+## Completable — interface @experimental
```
cancel: () => void
pause: () => void
@@ -1811,14 +1811,14 @@ resume: () => void
state: TweenState
```
-## ComponentData — type
+## ComponentData — type @experimental
```
C extends BuiltinComponentDef<infer T> ? T :
C extends ComponentDef<infer T> ? T :
never
```
-## ComponentDef — interface
+## ComponentDef — interface @experimental
```
_builtin: false
_default: T
@@ -1838,7 +1838,7 @@ skeletalFields: SkeletalFieldMeta | undefined
transient: boolean
```
-## ComponentMetadata — interface
+## ComponentMetadata — interface @experimental
```
animatableFields: string[] | undefined
assetFields: AssetFieldMeta[] | undefined
@@ -1852,7 +1852,7 @@ skeletalFields: SkeletalFieldMeta | undefined
transient: boolean | undefined
```
-## CompressorEffectDef — interface
+## CompressorEffectDef — interface @experimental
```
attack: number | undefined
kneeDb: number | undefined
@@ -1862,14 +1862,14 @@ thresholdDb: number | undefined
type: "compressor"
```
-## ControllerState — interface
+## ControllerState — interface @experimental
```
current: string
name: string
pages: string[]
```
-## CookedAtlasInfo — interface
+## CookedAtlasInfo — interface @experimental
```
frame: { x: number; y: number; width: number; height: number; }
page: number | undefined
@@ -1877,7 +1877,7 @@ pageHeight: number
pageWidth: number
```
-## CppRegistry — interface
+## CppRegistry — interface @experimental
```
addBitmapText: (entity: Entity, component: BitmapText) => void
addBoxCollider: (entity: Entity, component: BoxCollider) => void
@@ -2007,7 +2007,7 @@ setParent: (child: Entity, parent: Entity) => void
valid: (entity: Entity) => boolean
```
-## CppResourceManager — interface
+## CppResourceManager — interface @experimental
```
acquireTextureByPath: (path: string) => number
createLabelAtlasFont: (textureHandle: number, texWidth: number, texHeight: number, chars: string, charWidth: number, charHeight: number) => number
@@ -2039,7 +2039,7 @@ updateTextureSubregion: (handle: number, x: number, y: number, width: number, he
updateTextureSubregionFromBytes: ((handle: number, x: number, y: number, width: number, height: number, pixels: Uint8Array) => void) | undefined
```
-## CreateListViewOptions — interface
+## CreateListViewOptions — interface @experimental
```
background: UIVisualInit | undefined
data: DataSource<T> | readonly T[]
@@ -2058,7 +2058,7 @@ wheelSpeed: number | undefined
world: World
```
-## CreateWebAppOptions — interface
+## CreateWebAppOptions — interface @experimental
```
colorSpace: "gamma" | "linear" | undefined
depthLayers: number | undefined
@@ -2072,109 +2072,109 @@ wasmBaseUrl: string | undefined
ySortLayers: number | undefined
```
-## CullMode — enum
+## CullMode — enum @experimental
```
Back = 1
Front = 2
None = 0
```
-## DARK_TOKENS — const
+## DARK_TOKENS — const @experimental
```
ThemeTokens
```
-## DEFAULT_ANIM_CLIP_PIVOT — const
+## DEFAULT_ANIM_CLIP_PIVOT — const @experimental
```
AnimClipPivotData
```
-## DEFAULT_DESIGN_HEIGHT — const
+## DEFAULT_DESIGN_HEIGHT — const @experimental
```
number
```
-## DEFAULT_DESIGN_WIDTH — const
+## DEFAULT_DESIGN_WIDTH — const @experimental
```
number
```
-## DEFAULT_EDITOR_GRID — const
+## DEFAULT_EDITOR_GRID — const @experimental
```
EditorGridData
```
-## DEFAULT_EDITOR_VIEW — const
+## DEFAULT_EDITOR_VIEW — const @experimental
```
EditorViewData
```
-## DEFAULT_FALLBACK_DT — const
+## DEFAULT_FALLBACK_DT — const @experimental
```
number
```
-## DEFAULT_FIXED_TIMESTEP — const
+## DEFAULT_FIXED_TIMESTEP — const @experimental
```
number
```
-## DEFAULT_FONT_FAMILY — const
+## DEFAULT_FONT_FAMILY — const @experimental
```
"Arial"
```
-## DEFAULT_FONT_SIZE — const
+## DEFAULT_FONT_SIZE — const @experimental
```
24
```
-## DEFAULT_GRAVITY — const
+## DEFAULT_GRAVITY — const @experimental
```
{ x: number; y: number; }
```
-## DEFAULT_LINE_HEIGHT — const
+## DEFAULT_LINE_HEIGHT — const @experimental
```
1.2
```
-## DEFAULT_MAX_DELTA_TIME — const
+## DEFAULT_MAX_DELTA_TIME — const @experimental
```
0.5
```
-## DEFAULT_PIXELS_PER_UNIT — const
+## DEFAULT_PIXELS_PER_UNIT — const @experimental
```
number
```
-## DEFAULT_SCREEN_SCALING — const
+## DEFAULT_SCREEN_SCALING — const @experimental
```
ScreenScalingData
```
-## DEFAULT_SPINE_SKIN — const
+## DEFAULT_SPINE_SKIN — const @experimental
```
"default"
```
-## DEFAULT_SPRITE_SIZE — const
+## DEFAULT_SPRITE_SIZE — const @experimental
```
{ x: number; y: number; }
```
-## DEFAULT_TEXT_CANVAS_SIZE — const
+## DEFAULT_TEXT_CANVAS_SIZE — const @experimental
```
512
```
-## DEFAULT_UI_CAMERA_INFO — const
+## DEFAULT_UI_CAMERA_INFO — const @experimental
```
{ readonly viewProjection: Float32Array<ArrayBuffer>; readonly vpX: 0; readonly vpY: 0; readonly vpW: 0; readonly vpH: 0; readonly screenW: 0; readonly screenH: 0; readonly worldLeft: 0; readonly worldBottom: 0; readonly worldRight: 0; readonly worldTop: 0; readonly worldMouseX: 0; readonly worldMouseY: 0; readonly valid: false; }
```
-## DataSource — interface
+## DataSource — interface @experimental
```
getCount: () => number
getItem: (index: number) => T
@@ -2183,7 +2183,7 @@ getItemType: ((index: number) => string) | undefined
subscribe: ((listener: (change: DataSourceChange) => void) => Unsubscribe) | undefined
```
-## DataSourceChange — type
+## DataSourceChange — type @experimental
```
| { type: 'insert'; index: number; count: number }
| { type: 'remove'; index: number; count: number }
@@ -2191,7 +2191,7 @@ subscribe: ((listener: (change: DataSourceChange) => void) => Unsubscribe) | und
| { type: 'reset' }
```
-## DataType — enum
+## DataType — enum @experimental
```
Float = 1
Float2 = 2
@@ -2203,21 +2203,21 @@ Int3 = 7
Int4 = 8
```
-## DecodedChunk — interface
+## DecodedChunk — interface @experimental
```
tiles: Uint16Array<ArrayBufferLike>
x: number
y: number
```
-## DecodedPixels — interface
+## DecodedPixels — interface @experimental
```
height: number
pixels: Uint8Array<ArrayBufferLike>
width: number
```
-## DeviceIdentity — interface
+## DeviceIdentity — interface @experimental
```
backend: string
renderer: string
@@ -2225,17 +2225,17 @@ vendor: string
version: string
```
-## DeviceLostReason — const
+## DeviceLostReason — const @experimental
```
{ readonly Unknown: 0; readonly ContextLost: 1; readonly OutOfMemory: 2; readonly Reset: 3; readonly Removed: 4; readonly Destroyed: 5; readonly Validation: 6; readonly Internal: 7; }
```
-## DeviceStatus — const
+## DeviceStatus — const @experimental
```
{ readonly Live: 0; readonly Lost: 1; readonly Recovering: 2; readonly Dead: 3; }
```
-## DiagnosticEvent — interface
+## DiagnosticEvent — interface @experimental
```
context: Record<string, unknown> | undefined
count: number
@@ -2248,7 +2248,7 @@ source: string | undefined
stack: string | undefined
```
-## DiagnosticKind — type
+## DiagnosticKind — type @experimental
```
| 'engine'
/** Reached the host with nobody catching it: `window.onerror`,
@@ -2267,7 +2267,7 @@ stack: string | undefined
| 'game'
```
-## DiagnosticReport — interface
+## DiagnosticReport — interface @experimental
```
context: Record<string, unknown> | undefined
error: unknown
@@ -2276,12 +2276,12 @@ message: string
source: string | undefined
```
-## Diagnostics — const
+## Diagnostics — const @experimental
```
ResourceDef<DiagnosticsAPI>
```
-## DiagnosticsAPI — class
+## DiagnosticsAPI — class @experimental
```
clear: () => void
dropped: number
@@ -2295,13 +2295,13 @@ static new (options?: DiagnosticsOptions): DiagnosticsAPI
static prototype: DiagnosticsAPI
```
-## DiagnosticsOptions — interface
+## DiagnosticsOptions — interface @experimental
```
flushIntervalSec: number | undefined
maxDistinct: number | undefined
```
-## DiagnosticsPlugin — class
+## DiagnosticsPlugin — class @experimental
```
build: (app: App) => void
cleanup: (app: App) => void
@@ -2310,19 +2310,19 @@ static new (options_?: DiagnosticsPluginOptions): DiagnosticsPlugin
static prototype: DiagnosticsPlugin
```
-## DiagnosticsPluginOptions — interface
+## DiagnosticsPluginOptions — interface @experimental
```
captureLevel: LogLevel | undefined
flushIntervalSec: number | undefined
maxDistinct: number | undefined
```
-## DiagnosticsSink — type
+## DiagnosticsSink — type @experimental
```
(events: readonly DiagnosticEvent[]) => void
```
-## DialogHandle — interface
+## DialogHandle — interface @experimental
```
close: () => void
dispose: () => void
@@ -2332,7 +2332,7 @@ open: () => void
panelEntity: number
```
-## DialogOptions — interface
+## DialogOptions — interface @experimental
```
backdropNode: UINodeInit | undefined
backdropVisual: UIVisualInit | undefined
@@ -2347,35 +2347,35 @@ startHidden: boolean | undefined
world: World
```
-## DiffOptions — interface
+## DiffOptions — interface @experimental
```
floatEpsilon: number | undefined
ignoreEntityNames: readonly string[] | undefined
ignoreMetadataKeys: readonly string[] | undefined
```
-## Dimension — interface
+## Dimension — interface @experimental
```
unit: number
value: number
```
-## DimensionUnit — type
+## DimensionUnit — type @experimental
```
(typeof DimensionUnit)[keyof typeof DimensionUnit]
```
-## Disabled — const
+## Disabled — const @experimental
```
ComponentDef<{}>
```
-## DistanceJoint — const
+## DistanceJoint — const @experimental
```
ComponentDef<DistanceJointData>
```
-## DragPlugin — class
+## DragPlugin — class @experimental
```
build: (app: App) => void
dependencies: "uiInteraction"[]
@@ -2384,12 +2384,12 @@ static new (): DragPlugin
static prototype: DragPlugin
```
-## DragState — const
+## DragState — const @experimental
```
ComponentDef<DragStateData>
```
-## DragStateData — interface
+## DragStateData — interface @experimental
```
currentWorldPos: { x: number; y: number; }
deltaWorld: { x: number; y: number; }
@@ -2399,12 +2399,12 @@ startWorldPos: { x: number; y: number; }
totalDeltaWorld: { x: number; y: number; }
```
-## Draggable — const
+## Draggable — const @experimental
```
ComponentDef<DraggableData>
```
-## DraggableData — interface
+## DraggableData — interface @experimental
```
constraintMax: { x: number; y: number; } | null
constraintMin: { x: number; y: number; } | null
@@ -2414,17 +2414,17 @@ lockX: boolean
lockY: boolean
```
-## DragonBones — const
+## DragonBones — const @experimental
```
ResourceDef<DragonBonesManager | null>
```
-## DragonBonesAnimation — const
+## DragonBonesAnimation — const @experimental
```
BuiltinComponentDef<DragonBonesAnimationData>
```
-## DragonBonesAnimationData — interface
+## DragonBonesAnimationData — interface @experimental
```
animation: string
armature: string
@@ -2443,7 +2443,7 @@ skeletonScale: number
timeScale: number
```
-## DragonBonesPlugin — class
+## DragonBonesPlugin — class @experimental
```
acquire: () => Promise<DragonBonesManager | null>
build: (app: App) => void
@@ -2454,12 +2454,12 @@ static new (manager?: DragonBonesManager): DragonBonesPlugin
static prototype: DragonBonesPlugin
```
-## Draw — const
+## Draw — const @experimental
```
DrawAPI
```
-## DrawAPI — interface
+## DrawAPI — interface @experimental
```
begin: (viewProjection: Float32Array) => void
circle: (center: Vec2, radius: number, color: Color, filled?: boolean, segments?: number) => void
@@ -2480,7 +2480,7 @@ texture: (position: Vec2, size: Vec2, textureHandle: number, tint?: Color) => vo
textureRotated: (position: Vec2, size: Vec2, rotation: number, textureHandle: number, tint?: Color) => void
```
-## DrawCallInfo — interface
+## DrawCallInfo — interface @experimental
```
blendMode: number
cameraIndex: number
@@ -2508,12 +2508,12 @@ type: RenderType
vertexCount: number
```
-## DrawCallback — type
+## DrawCallback — type @experimental
```
(elapsed: number) => void
```
-## DrawRank — interface
+## DrawRank — interface @experimental
```
layer: number
order: LayerOrder
@@ -2521,7 +2521,7 @@ worldY: number
worldZ: number
```
-## DropShadowFilterOptions — interface
+## DropShadowFilterOptions — interface @experimental
```
blur: number | undefined
color: { r: number; g: number; b: number; a: number; } | undefined
@@ -2530,7 +2530,7 @@ offsetY: number | undefined
texelSize: { x: number; y: number; } | undefined
```
-## DropdownHandle — interface
+## DropdownHandle — interface @experimental
```
close: () => void
dispose: () => void
@@ -2543,7 +2543,7 @@ open: () => void
setSelectedIndex: (index: number) => void
```
-## DropdownOptions — interface
+## DropdownOptions — interface @experimental
```
buttonStates: { normal?: Color; hover?: Color; pressed?: Color; } | undefined
disabled: boolean | undefined
@@ -2560,17 +2560,17 @@ tabIndex: number | undefined
world: World
```
-## EDITOR_UI_ANCHOR — const
+## EDITOR_UI_ANCHOR — const @experimental
```
{ readonly x: 0; readonly y: 0; }
```
-## EDITOR_VIEW_ENTITY — const
+## EDITOR_VIEW_ENTITY — const @experimental
```
-1
```
-## ESEngineModule — interface
+## ESEngineModule — interface @experimental
```
EstellaContext: new () => CppEngineContext
FS: EmscriptenFS
@@ -2792,12 +2792,12 @@ ui_getCullBit: ((registry: CppRegistry, entity: number) => number) | undefined
ui_getRenderOrder: ((registry: CppRegistry, entity: number) => number) | undefined
```
-## EasingType — type
+## EasingType — type @experimental
```
(typeof EasingType)[keyof typeof EasingType]
```
-## EditorAssetType — type
+## EditorAssetType — type @experimental
```
| 'texture' | 'material' | 'shader' | 'spine-atlas' | 'spine-skeleton'
| 'dragonbones-atlas' | 'dragonbones-skeleton'
@@ -2806,7 +2806,7 @@ ui_getRenderOrder: ((registry: CppRegistry, entity: number) => number) | undefin
| 'unknown'
```
-## EditorBridge — interface
+## EditorBridge — interface @experimental
```
onComponentAdded: ((entity: number, component: string) => void) | undefined
onComponentChanged: ((entity: number, component: string) => void) | undefined
@@ -2817,12 +2817,12 @@ onParentChanged: ((child: number, parent: number | null) => void) | undefined
registerComponent: (name: string, defaults: Record<string, unknown>, isTag: boolean) => void
```
-## EditorGrid — const
+## EditorGrid — const @experimental
```
ResourceDef<EditorGridData>
```
-## EditorGridData — interface
+## EditorGridData — interface @experimental
```
axisX: GridColor
axisY: GridColor
@@ -2833,12 +2833,12 @@ majorEvery: number
spacing: number
```
-## EditorView — const
+## EditorView — const @experimental
```
ResourceDef<EditorViewData>
```
-## EditorViewData — interface
+## EditorViewData — interface @experimental
```
active: boolean
distance: number
@@ -2850,7 +2850,7 @@ x: number
y: number
```
-## EffectDef — interface
+## EffectDef — interface @experimental
```
factory: () => ShaderHandle
label: string
@@ -2860,7 +2860,7 @@ type: string
uniforms: EffectUniformDef[]
```
-## EffectUniformDef — interface
+## EffectUniformDef — interface @experimental
```
defaultValue: number
label: string
@@ -2871,18 +2871,18 @@ neutralValue: number | undefined
step: number
```
-## EmbeddedSideModuleEntry — interface
+## EmbeddedSideModuleEntry — interface @experimental
```
glueBase64: string
wasmBase64: string
```
-## EmbeddedSideModuleRegistry — type
+## EmbeddedSideModuleRegistry — type @experimental
```
Partial<Record<SideModuleId, EmbeddedSideModuleEntry>>
```
-## EmitterShape — enum
+## EmitterShape — enum @experimental
```
Circle = 1
Cone = 3
@@ -2890,17 +2890,17 @@ Point = 0
Rectangle = 2
```
-## EngineApi — type
+## EngineApi — type @experimental
```
NativeEngineApi & Partial<NativeHeap>
```
-## Entity — type
+## Entity — type @experimental
```
number
```
-## EntityCommands — class
+## EntityCommands — class @experimental
```
finalize: () => void
id: () => Entity
@@ -2910,7 +2910,7 @@ static new (commands: CommandsInstance, entity: Entity | null, name?: string): E
static prototype: EntityCommands
```
-## EntityEvent — interface
+## EntityEvent — interface @experimental
```
currentTarget: number
data: TData
@@ -2922,12 +2922,12 @@ target: number
type: string
```
-## EntityEventHandler — type
+## EntityEventHandler — type @experimental
```
(event: EntityEvent<TData>) => void
```
-## EntityEventQueue — class
+## EntityEventQueue — class @experimental
```
clear: () => void
drain: () => readonly EntityEvent[]
@@ -2941,22 +2941,22 @@ static new (): EntityEventQueue
static prototype: EntityEventQueue
```
-## EntityEvents — const
+## EntityEvents — const @experimental
```
ResourceDef<EntityEventQueue>
```
-## EventBinding — const
+## EventBinding — const @experimental
```
ComponentDef<EventBindingData>
```
-## EventBindingData — interface
+## EventBindingData — interface @experimental
```
rows: EventBindingRow[]
```
-## EventBindingPlugin — class
+## EventBindingPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -2965,7 +2965,7 @@ static new (): EventBindingPlugin
static prototype: EventBindingPlugin
```
-## EventBindingRow — interface
+## EventBindingRow — interface @experimental
```
action: string
arg: string | undefined
@@ -2977,25 +2977,25 @@ params: Record<string, AiParamValue> | undefined
target: string | undefined
```
-## EventDef — interface
+## EventDef — interface @experimental
```
_id: symbol
_name: string
_phantom: T | undefined
```
-## EventReader — function
+## EventReader — function @experimental
```
<T>(event: EventDef<T>): EventReaderDescriptor<T>
```
-## EventReaderDescriptor — interface
+## EventReaderDescriptor — interface @experimental
```
_event: EventDef<T>
_type: "event_reader"
```
-## EventReaderInstance — class
+## EventReaderInstance — class @experimental
```
isEmpty: () => boolean
toArray: () => T[]
@@ -3003,7 +3003,7 @@ static new <T>(bus: EventBus<T>): EventReaderInstance<T>
static prototype: EventReaderInstance<any>
```
-## EventRegistry — class
+## EventRegistry — class @experimental
```
getBus: <T>(event: EventDef<T>) => EventBus<T>
register: <T>(event: EventDef<T>) => void
@@ -3012,25 +3012,25 @@ static new (): EventRegistry
static prototype: EventRegistry
```
-## EventWriter — function
+## EventWriter — function @experimental
```
<T>(event: EventDef<T>): EventWriterDescriptor<T>
```
-## EventWriterDescriptor — interface
+## EventWriterDescriptor — interface @experimental
```
_event: EventDef<T>
_type: "event_writer"
```
-## EventWriterInstance — class
+## EventWriterInstance — class @experimental
```
send: (event: T) => void
static new <T>(bus: EventBus<T>): EventWriterInstance<T>
static prototype: EventWriterInstance<any>
```
-## ExternalEntityRef — interface
+## ExternalEntityRef — interface @experimental
```
componentType: string
entityId: number
@@ -3038,7 +3038,7 @@ field: string
target: number
```
-## ExtractEntity — interface
+## ExtractEntity — interface @experimental
```
children: number[]
components: ComponentData[]
@@ -3048,12 +3048,12 @@ parent: number | null
visible: boolean | undefined
```
-## FILL_AXIS — const
+## FILL_AXIS — const @experimental
```
Record<LinearFillDirection, readonly [FillMethod, FillOrigin]>
```
-## FieldMeta — interface
+## FieldMeta — interface @experimental
```
advanced: boolean | undefined
bitmask: { bits?: number; source?: string; } | undefined
@@ -3073,7 +3073,7 @@ tooltip: string | undefined
unit: string | undefined
```
-## FillMethod — enum
+## FillMethod — enum @experimental
```
Horizontal = 0
Radial180 = 4
@@ -3082,7 +3082,7 @@ Radial90 = 3
Vertical = 1
```
-## FillOrigin — enum
+## FillOrigin — enum @experimental
```
Bottom = 2
Left = 0
@@ -3090,7 +3090,7 @@ Right = 1
Top = 3
```
-## FilterEffectDef — interface
+## FilterEffectDef — interface @experimental
```
filter: "lowpass" | "highpass" | "bandpass" | "lowshelf" | "highshelf" | "peaking" | "notch"
frequency: number
@@ -3099,7 +3099,7 @@ q: number | undefined
type: "filter"
```
-## FilterExpr — type
+## FilterExpr — type @experimental
```
| { readonly kind: 'with'; readonly component: AnyComponentDef }
| { readonly kind: 'without'; readonly component: AnyComponentDef }
@@ -3108,12 +3108,12 @@ type: "filter"
| { readonly kind: 'not'; readonly filter: FilterExpr }
```
-## Filters — const
+## Filters — const @experimental
```
{ identityMatrix(): number[]; grayscaleMatrix(): number[]; sepiaMatrix(): number[]; brightnessMatrix(value: number): number[]; contrastMatrix(value: number): number[]; saturationMatrix(value: number): number[]; invertMatrix(): number[]; getColorMatrixShader: () => ShaderHandle; colorMatrixUniforms(matrix: number[]): Record<string, number[]>; }
```
-## FlattenContext — interface
+## FlattenContext — interface @experimental
```
allocateId: () => number
depth: number | undefined
@@ -3121,18 +3121,18 @@ loadPrefab: (path: string) => PrefabData | null
visited: Set<string> | undefined
```
-## FlattenResult — interface
+## FlattenResult — interface @experimental
```
entities: ProcessedEntity[]
rootId: number
```
-## FlexContainer — const
+## FlexContainer — const @experimental
```
BuiltinComponentDef<FlexContainerData>
```
-## FlexContainerData — interface
+## FlexContainerData — interface @experimental
```
alignContent: AlignContent
alignItems: AlignItems
@@ -3143,17 +3143,17 @@ padding: Padding
wrap: FlexWrap
```
-## FlexDirection — type
+## FlexDirection — type @experimental
```
(typeof FlexDirection)[keyof typeof FlexDirection]
```
-## FlexWrap — type
+## FlexWrap — type @experimental
```
(typeof FlexWrap)[keyof typeof FlexWrap]
```
-## FlushReason — enum
+## FlushReason — enum @experimental
```
BatchFull = 0
BlendModeChange = 5
@@ -3166,12 +3166,12 @@ TextureSlotsFull = 1
TypeChange = 7
```
-## FocusManager — const
+## FocusManager — const @experimental
```
ResourceDef<FocusManagerState>
```
-## FocusManagerState — class
+## FocusManagerState — class @experimental
```
blur: () => Entity | null
focus: (entity: Entity, visible?: boolean) => Entity | null
@@ -3182,7 +3182,7 @@ static new (): FocusManagerState
static prototype: FocusManagerState
```
-## FocusPlugin — class
+## FocusPlugin — class @experimental
```
build: (app: App) => void
dependencies: "uiInteraction"[]
@@ -3191,23 +3191,23 @@ static new (): FocusPlugin
static prototype: FocusPlugin
```
-## Focusable — const
+## Focusable — const @experimental
```
ComponentDef<FocusableData>
```
-## FocusableData — interface
+## FocusableData — interface @experimental
```
isFocused: boolean
tabIndex: number
```
-## FollowTarget — const
+## FollowTarget — const @experimental
```
ComponentDef<FollowTargetData>
```
-## FollowTargetData — interface
+## FollowTargetData — interface @experimental
```
damping: number
deadzone: number
@@ -3216,12 +3216,12 @@ offsetY: number
target: number
```
-## FontHandle — type
+## FontHandle — type @experimental
```
number
```
-## ForceFieldType — enum
+## ForceFieldType — enum @experimental
```
Directional = 0
Drag = 3
@@ -3229,13 +3229,13 @@ Point = 1
Vortex = 2
```
-## FrameCaptureData — interface
+## FrameCaptureData — interface @experimental
```
cameraCount: number
drawCalls: DrawCallInfo[]
```
-## FrameHistory — class
+## FrameHistory — class @experimental
```
count: number
getAll: () => FrameSnapshot[]
@@ -3246,14 +3246,14 @@ static new (capacity?: number): FrameHistory
static prototype: FrameHistory
```
-## FrameSnapshot — interface
+## FrameSnapshot — interface @experimental
```
frameTimeMs: number
phaseTimings: Map<string, number>
systemTimings: Map<string, number>
```
-## FrameStats — interface
+## FrameStats — interface @experimental
```
culled: number
drawCalls: number
@@ -3269,23 +3269,23 @@ text: number
triangles: number
```
-## FsmActionRef — type
+## FsmActionRef — type @experimental
```
string | { name: string; arg?: string; params?: Record<string, AiParamValue> }
```
-## FsmDefinition — interface
+## FsmDefinition — interface @experimental
```
initial: string
states: FsmState[]
```
-## FsmEdge — type
+## FsmEdge — type @experimental
```
GraphEdge<FsmTransition>
```
-## FsmPlugin — class
+## FsmPlugin — class @experimental
```
build: (app: App) => void
name: string
@@ -3293,14 +3293,14 @@ static new (): FsmPlugin
static prototype: FsmPlugin
```
-## FsmRunState — interface
+## FsmRunState — interface @experimental
```
current: string
entered: boolean
previous: string | null
```
-## FsmState — interface
+## FsmState — interface @experimental
```
name: string
onEnter: FsmActionRef | undefined
@@ -3311,7 +3311,7 @@ x: number | undefined
y: number | undefined
```
-## FsmTransition — interface
+## FsmTransition — interface @experimental
```
condition: string | undefined
guard: BlackboardGuard | BlackboardGuard[] | undefined
@@ -3319,12 +3319,12 @@ to: string
trigger: string | undefined
```
-## GLDebug — const
+## GLDebug — const @experimental
```
{ enable(): void; disable(): void; check(context: string): number; diagnose(): void; }
```
-## GameSocket — class
+## GameSocket — class @experimental
```
close: (code?: number, reason?: string) => void
connect: () => void
@@ -3335,12 +3335,12 @@ static new (options: GameSocketOptions): GameSocket
static prototype: GameSocket
```
-## GameSocketOptions — type
+## GameSocketOptions — type @experimental
```
PlatformSocketOptions
```
-## GamepadAxis — enum
+## GamepadAxis — enum @experimental
```
LeftX = 0
LeftY = 1
@@ -3348,7 +3348,7 @@ RightX = 2
RightY = 3
```
-## GamepadButton — enum
+## GamepadButton — enum @experimental
```
Back = 8
DpadDown = 13
@@ -3369,7 +3369,7 @@ Start = 9
West = 2
```
-## GamepadSnapshot — interface
+## GamepadSnapshot — interface @experimental
```
axes: number[]
buttons: number[]
@@ -3378,7 +3378,7 @@ index: number
mapping: string
```
-## GearBinding — interface
+## GearBinding — interface @experimental
```
component: string
controller: string
@@ -3387,28 +3387,28 @@ property: string
tween: GearTween | undefined
```
-## GearTween — interface
+## GearTween — interface @experimental
```
duration: number
easing: EasingType
```
-## GearValue — type
+## GearValue — type @experimental
```
number | boolean | string | Color | Vec2 | Vec3
```
-## Geometry — const
+## Geometry — const @experimental
```
{ create(options: GeometryOptions): GeometryHandle; updateVertices(handle: GeometryHandle, vertices: Float32Array, offset?: number): void; release(handle: GeometryHandle): void; isValid(handle: GeometryHandle): boolean; createQuad(width?: number, height?: number): GeometryHandle; createCircle(radius?: number, segments?: number): GeometryHandle; createPolygon(points: Array<{ x: number; y: number; }>): GeometryHandle; }
```
-## GeometryHandle — type
+## GeometryHandle — type @experimental
```
number
```
-## GeometryOptions — interface
+## GeometryOptions — interface @experimental
```
dynamic: boolean | undefined
indices: Uint16Array<ArrayBufferLike> | Uint32Array<ArrayBufferLike> | undefined
@@ -3416,7 +3416,7 @@ layout: VertexAttributeDescriptor[]
vertices: Float32Array<ArrayBufferLike>
```
-## GestureDetector — class
+## GestureDetector — class @experimental
```
onLongPress: ((x: number, y: number) => void) | null
onPinch: ((scale: number, centerX: number, centerY: number) => void) | null
@@ -3428,22 +3428,22 @@ static new (input: InputState): GestureDetector
static prototype: GestureDetector
```
-## GetWorld — function
+## GetWorld — function @experimental
```
(): GetWorldDescriptor
```
-## GetWorldDescriptor — interface
+## GetWorldDescriptor — interface @experimental
```
_type: "get_world"
```
-## GpAxis — const
+## GpAxis — const @experimental
```
(axis: number, pad?: number, scale?: number) => Binding
```
-## GpButton — const
+## GpButton — const @experimental
```
(button: number, pad?: number) => Binding
```
@@ -3474,7 +3474,7 @@ _type: "get_world"
'float' | 'vec2' | 'vec3' | 'vec4'
```
-## Graphics — class
+## Graphics — class @experimental
```
arc: (cx: number, cy: number, radius: number, startAngle: number, endAngle: number, anticlockwise?: boolean, segments?: number) => void
beginFill: (color: Color) => void
@@ -3498,12 +3498,12 @@ static new (): Graphics
static prototype: Graphics
```
-## GridColor — type
+## GridColor — type @experimental
```
[number, number, number, number]
```
-## GridLayoutProvider — class
+## GridLayoutProvider — class @experimental
```
getContentSize: (count: number) => Vec2
getItemRect: (index: number) => Rect
@@ -3512,20 +3512,20 @@ static new (opts: GridLayoutOptions): GridLayoutProvider
static prototype: GridLayoutProvider
```
-## HeadlessAppOptions — interface
+## HeadlessAppOptions — interface @experimental
```
plugins: Plugin[] | undefined
sideModules: SideModuleHost | undefined
```
-## HitAreaShape — type
+## HitAreaShape — type @experimental
```
| { type: 'rect'; x: number; y: number; width: number; height: number }
| { type: 'circle'; cx: number; cy: number; radius: number }
| { type: 'polygon'; points: number[] }
```
-## HttpBackend — class
+## HttpBackend — class @experimental
```
fetchBinary: (path: string) => Promise<ArrayBuffer>
fetchText: (path: string) => Promise<string>
@@ -3535,42 +3535,42 @@ static new (options: HttpBackendOptions): HttpBackend
static prototype: HttpBackend
```
-## INTERACTION_CONTROLLER — const
+## INTERACTION_CONTROLLER — const @experimental
```
"$interaction"
```
-## INTERACTION_PAGES — const
+## INTERACTION_PAGES — const @experimental
```
readonly ["normal", "hover", "pressed", "disabled", "focused"]
```
-## INVALID_ENTITY — const
+## INVALID_ENTITY — const @experimental
```
number
```
-## INVALID_FONT — const
+## INVALID_FONT — const @experimental
```
number
```
-## INVALID_MATERIAL — const
+## INVALID_MATERIAL — const @experimental
```
0
```
-## INVALID_TEXTURE — const
+## INVALID_TEXTURE — const @experimental
```
number
```
-## Identity — const
+## Identity — const @experimental
```
ResourceDef<IdentityAPI>
```
-## IdentityAPI — class
+## IdentityAPI — class @experimental
```
available: boolean
login: () => Promise<LoginResult>
@@ -3579,7 +3579,7 @@ static new (): IdentityAPI
static prototype: IdentityAPI
```
-## ImageSegment — interface
+## ImageSegment — interface @experimental
```
height: number
offsetX: number
@@ -3592,7 +3592,7 @@ valign: ImageValign
width: number
```
-## InferParam — type
+## InferParam — type @experimental
```
P extends QueryDescriptor<infer C> ? QueryInstance<C> :
P extends ResDescriptor<infer T> ? T :
@@ -3605,19 +3605,19 @@ P extends QueryDescriptor<infer C> ? QueryInstance<C> :
never
```
-## InferParams — type
+## InferParams — type @experimental
```
{
[K in keyof P]: InferParam<P[K]>;
}
```
-## Input — const
+## Input — const @experimental
```
ResourceDef<InputState>
```
-## InputHandler — interface
+## InputHandler — interface @experimental
```
onKeyDown: ((code: string, mods: Modifiers) => boolean | void) | undefined
onKeyUp: ((code: string, mods: Modifiers) => boolean | void) | undefined
@@ -3631,7 +3631,7 @@ onTouchStart: ((id: number, x: number, y: number) => boolean | void) | undefined
onWheel: ((deltaX: number, deltaY: number, mods: Modifiers) => boolean | void) | undefined
```
-## InputMap — class
+## InputMap — class @experimental
```
actions: () => string[]
axis2d: (name: string) => Vec2
@@ -3655,13 +3655,13 @@ static new (actions: Record<string, ActionDef>): InputMap
static prototype: InputMap
```
-## InputMapAsset — interface
+## InputMapAsset — interface @experimental
```
actions: Record<string, ActionDef>
version: number
```
-## InputPlugin — class
+## InputPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -3670,7 +3670,7 @@ static new (target?: unknown): InputPlugin
static prototype: InputPlugin
```
-## InputRouter — class
+## InputRouter — class @experimental
```
currentMods: Modifiers
dispatchKeyDown: (code: string) => boolean
@@ -3689,7 +3689,7 @@ static new (): InputRouter
static prototype: InputRouter
```
-## InputState — class
+## InputState — class @experimental
```
beginFixedStep: () => void
clearFrameState: () => void
@@ -3748,7 +3748,7 @@ static new (): InputState
static prototype: InputState
```
-## InstantiatePrefabOptions — interface
+## InstantiatePrefabOptions — interface @experimental
```
assetBaseUrl: string | undefined
assets: Assets | undefined
@@ -3756,57 +3756,57 @@ overrides: PrefabOverride[] | undefined
parent: number | undefined
```
-## InstantiatePrefabResult — interface
+## InstantiatePrefabResult — interface @experimental
```
entities: Map<number, number>
root: number
```
-## Interactable — const
+## Interactable — const @experimental
```
BuiltinComponentDef<InteractableData>
```
-## InteractableData — interface
+## InteractableData — interface @experimental
```
blockRaycast: boolean
enabled: boolean
raycastTarget: boolean
```
-## InterestPolicy — type
+## InterestPolicy — type @experimental
```
(view: InterestView) => ReadonlySet<Entity> | 'all'
```
-## InterestView — interface
+## InterestView — interface @experimental
```
candidates: readonly number[]
connectionId: number
world: World
```
-## InterpType — type
+## InterpType — type @experimental
```
(typeof InterpType)[keyof typeof InterpType]
```
-## JsonResult — interface
+## JsonResult — interface @experimental
```
data: T
```
-## JustifyContent — type
+## JustifyContent — type @experimental
```
(typeof JustifyContent)[keyof typeof JustifyContent]
```
-## Key — const
+## Key — const @experimental
```
(code: string) => Binding
```
-## Keyframe — interface
+## Keyframe — interface @experimental
```
inTangent: number
interpolation: InterpType | undefined
@@ -3815,17 +3815,17 @@ time: number
value: number
```
-## Keys1D — const
+## Keys1D — const @experimental
```
(neg: string, pos: string) => Binding
```
-## Keys2D — const
+## Keys2D — const @experimental
```
(up: string, down: string, left: string, right: string) => Binding
```
-## KineticScroll — class
+## KineticScroll — class @experimental
```
beginDrag: () => void
endDrag: () => void
@@ -3840,31 +3840,31 @@ static new (opts?: KineticScrollOptions): KineticScroll
static prototype: KineticScroll
```
-## LIGHT_TOKENS — const
+## LIGHT_TOKENS — const @experimental
```
ThemeTokens
```
-## LayerOrder — enum
+## LayerOrder — enum @experimental
```
Depth = 2
Painter = 0
YSort = 1
```
-## LayoutProvider — interface
+## LayoutProvider — interface @experimental
```
getContentSize: (count: number) => Vec2
getItemRect: (index: number) => Rect
getVisibleRange: (viewport: Rect, count: number) => [start: number, end: number]
```
-## Leaderboard — const
+## Leaderboard — const @experimental
```
ResourceDef<LeaderboardAPI>
```
-## LeaderboardAPI — class
+## LeaderboardAPI — class @experimental
```
available: boolean
dispose: () => void
@@ -3879,7 +3879,7 @@ static new (module_: () => ESEngineModule | null): LeaderboardAPI
static prototype: LeaderboardAPI
```
-## LeaderboardOptions — interface
+## LeaderboardOptions — interface @experimental
```
key: string | undefined
limit: number | undefined
@@ -3888,18 +3888,18 @@ scope: LeaderboardScope | undefined
style: LeaderboardStyle | undefined
```
-## LeaderboardProvider — interface
+## LeaderboardProvider — interface @experimental
```
canvas: () => PlatformCanvas | null
post: (message: Record<string, unknown>) => void
```
-## LeaderboardScope — type
+## LeaderboardScope — type @experimental
```
'friends' | 'group'
```
-## LeaderboardStyle — interface
+## LeaderboardStyle — interface @experimental
```
avatars: boolean | undefined
background: string | undefined
@@ -3911,22 +3911,22 @@ rowHeight: number | undefined
selfColor: string | undefined
```
-## Lifecycle — const
+## Lifecycle — const @experimental
```
ResourceDef<LifecycleManager>
```
-## LifecycleEvent — type
+## LifecycleEvent — type @experimental
```
'show' | 'hide' | 'pause' | 'resume'
```
-## LifecycleListener — type
+## LifecycleListener — type @experimental
```
(event: LifecycleEvent) => void
```
-## LifecycleManager — class
+## LifecycleManager — class @experimental
```
autoPause: boolean
emit_: (event: LifecycleEvent) => void
@@ -3941,7 +3941,7 @@ static new (autoPause?: boolean): LifecycleManager
static prototype: LifecycleManager
```
-## LifecyclePlugin — class
+## LifecyclePlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -3950,17 +3950,17 @@ static new (options_?: LifecyclePluginOptions | undefined): LifecyclePlugin
static prototype: LifecyclePlugin
```
-## LifecyclePluginOptions — interface
+## LifecyclePluginOptions — interface @experimental
```
autoPause: boolean | undefined
```
-## Light2D — const
+## Light2D — const @experimental
```
BuiltinComponentDef<Light2DData>
```
-## Light2DData — interface
+## Light2DData — interface @experimental
```
color: Color
direction: Vec2
@@ -3974,7 +3974,7 @@ shadowSoftness: number
type: number
```
-## Light2DType — enum
+## Light2DType — enum @experimental
```
Ambient = 2
Directional = 1
@@ -3982,12 +3982,12 @@ Point = 0
Spot = 3
```
-## LinearFillDirection — type
+## LinearFillDirection — type @experimental
```
'right' | 'left' | 'up' | 'down'
```
-## LinearLayoutProvider — class
+## LinearLayoutProvider — class @experimental
```
getContentSize: (count: number) => Vec2
getItemRect: (index: number) => Rect
@@ -3996,20 +3996,20 @@ static new (opts: LinearLayoutOptions): LinearLayoutProvider
static prototype: LinearLayoutProvider
```
-## ListItemTemplate — interface
+## ListItemTemplate — interface @experimental
```
bind: (entity: Entity, data: T, index: number) => void
create: (world: World, parent: Entity) => Entity
```
-## ListLayoutSpec — type
+## ListLayoutSpec — type @experimental
```
| { itemHeight: number | ((index: number) => number); spacing?: number; direction?: 'column' }
| { itemWidth: number; spacing?: number; direction: 'row' }
| { columns: number; itemSize: Vec2; spacing?: Vec2 }
```
-## ListView — class
+## ListView — class @experimental
```
dispose: () => void
getContentSize: () => Vec2
@@ -4024,7 +4024,7 @@ static new <T = unknown>(opts: ListViewOptions<T>): ListView<T>
static prototype: ListView<any>
```
-## ListViewHandle — interface
+## ListViewHandle — interface @experimental
```
content: number
data: DataSource<T>
@@ -4037,7 +4037,7 @@ scrollToIndex: (index: number) => void
view: ListView<T>
```
-## ListViewHost — interface
+## ListViewHost — interface @experimental
```
attachScrollContainer: (entity: Entity, container: ScrollContainer) => void
detachScrollContainer: (entity: Entity) => void
@@ -4045,7 +4045,7 @@ registerListView: (list: ListView<unknown>) => void
unregisterListView: (list: ListView<unknown>) => void
```
-## ListViewOptions — interface
+## ListViewOptions — interface @experimental
```
dataSource: DataSource<T>
layout: LayoutProvider
@@ -4059,14 +4059,14 @@ viewportSize: Vec2
world: World
```
-## ListenOptions — interface
+## ListenOptions — interface @experimental
```
gamepad: boolean | undefined
keyboard: boolean | undefined
mouse: boolean | undefined
```
-## LoadRuntimeSceneOptions — interface
+## LoadRuntimeSceneOptions — interface @experimental
```
app: App
module: ESEngineModule | null
@@ -4082,7 +4082,7 @@ uiTheme: "dark" | "light" | undefined
uiThemeOverrides: ThemeOverrides | undefined
```
-## LoadedTilemapLayer — interface
+## LoadedTilemapLayer — interface @experimental
```
chunks: LoadedTilemapChunk[]
height: number
@@ -4092,7 +4092,7 @@ tiles: Uint16Array<ArrayBufferLike>
width: number
```
-## LoadedTilemapSource — interface
+## LoadedTilemapSource — interface @experimental
```
collisionTileIds: number[] | undefined
hexSideLength: number | undefined
@@ -4109,7 +4109,7 @@ tileWidth: number
tilesets: LoadedTilemapTileset[]
```
-## LoadedTilemapTileset — interface
+## LoadedTilemapTileset — interface @experimental
```
columns: number
firstId: number
@@ -4119,52 +4119,52 @@ spacing: number
textureHandle: number
```
-## LocalLeaderboardOptions — interface
+## LocalLeaderboardOptions — interface @experimental
```
friends: readonly CloudPlayer[] | undefined
height: number | undefined
width: number | undefined
```
-## LocalTransform — const
+## LocalTransform — const @experimental
```
BuiltinComponentDef<TransformData>
```
-## LocalTransformData — type
+## LocalTransformData — type @experimental
```
TransformData
```
-## LocaleCatalog — type
+## LocaleCatalog — type @experimental
```
Record<string, LocaleEntry>
```
-## LocaleEntry — type
+## LocaleEntry — type @experimental
```
string | PluralForms
```
-## LocaleResult — interface
+## LocaleResult — interface @experimental
```
keyCount: number
locale: string
```
-## LocaleTableAsset — interface
+## LocaleTableAsset — interface @experimental
```
entries: LocaleCatalog
locale: string
version: number
```
-## Localization — const
+## Localization — const @experimental
```
ResourceDef<LocalizationAPI>
```
-## LocalizationAPI — class
+## LocalizationAPI — class @experimental
```
addCatalog: (locale: string, entries: LocaleCatalog) => void
availableLocales: () => string[]
@@ -4179,7 +4179,7 @@ static new (locale?: string, fallback?: string): LocalizationAPI
static prototype: LocalizationAPI
```
-## LocalizationOptions — interface
+## LocalizationOptions — interface @experimental
```
catalogs: Record<string, LocaleCatalog> | undefined
fallback: string | undefined
@@ -4187,7 +4187,7 @@ locale: string | undefined
tables: string[] | undefined
```
-## LocalizationPlugin — class
+## LocalizationPlugin — class @experimental
```
build: (app: App) => void
name: string
@@ -4195,7 +4195,7 @@ static new (opts?: LocalizationOptions): LocalizationPlugin
static prototype: LocalizationPlugin
```
-## LogEntry — interface
+## LogEntry — interface @experimental
```
category: string
data: unknown
@@ -4204,12 +4204,12 @@ message: string
timestamp: number
```
-## LogHandler — interface
+## LogHandler — interface @experimental
```
handle: (entry: LogEntry) => void
```
-## LogLevel — enum
+## LogLevel — enum @experimental
```
Debug = 0
Error = 3
@@ -4217,7 +4217,7 @@ Info = 1
Warn = 2
```
-## Logger — class
+## Logger — class @experimental
```
addHandler: (handler: LogHandler) => void
clearHandlers: () => void
@@ -4231,17 +4231,17 @@ static new (): Logger
static prototype: Logger
```
-## LoginResult — interface
+## LoginResult — interface @experimental
```
code: string
```
-## LoopMode — type
+## LoopMode — type @experimental
```
(typeof LoopMode)[keyof typeof LoopMode]
```
-## ManifestModel — class
+## ManifestModel — class @experimental
```
allAssets: () => AddressableManifestAsset[]
assetByKey: (key: string) => AddressableManifestAsset | null
@@ -4265,28 +4265,28 @@ static new (manifest: AddressableManifest): ManifestModel
static prototype: ManifestModel
```
-## Marker — const
+## Marker — const @experimental
```
ComponentDef<MarkerData>
```
-## MarkerData — interface
+## MarkerData — interface @experimental
```
properties: Record<string, string>
type: string
```
-## MaskMode — type
+## MaskMode — type @experimental
```
(typeof MaskMode)[keyof typeof MaskMode]
```
-## Material — const
+## Material — const @experimental
```
{ createShader(vertexSrc: string, fragmentSrc: string): ShaderHandle; releaseShader(shader: ShaderHandle): void; create(options: MaterialOptions): MaterialHandle; compileShader(esshaderSource: string, features?: string[]): ShaderHandle; getSwitch(material: MaterialHandle, name: string): boolean; setSwitch(material: MaterialHandle, name: string, on: boolean): void; get(material: MaterialHandle): MaterialData | undefined; setUniform(material: MaterialHandle, name: string, value: UniformValue): void; getUniform(material: MaterialHandle, name: string): UniformValue | undefined; setBlendMode(material: MaterialHandle, mode: BlendMode): void; getBlendMode(material: MaterialHandle): BlendMode; setDepthTest(material: MaterialHandle, enabled: boolean): void; setDepthWrite(material: MaterialHandle, enabled: boolean): void; setCull(material: MaterialHandle, cull: CullMode): void; getShader(material: MaterialHandle): ShaderHandle; release(material: MaterialHandle): void; isValid(material: MaterialHandle): boolean; renderPreview(material: MaterialHandle, w: number, h: number): Promise<ImageData | null>; releaseAll(): void; createFromAsset(data: MaterialAssetData, shaderHandle: ShaderHandle, parentHandle?: MaterialHandle): MaterialHandle; createInstance(source: MaterialHandle): MaterialHandle; toAssetData(material: MaterialHandle, shaderPath: string, parentPath?: string): MaterialAssetData | null; getUniforms(material: MaterialHandle): Map<string, UniformValue>; tex(textureId: number, slot?: number): TextureRef; }
```
-## MaterialAssetData — interface
+## MaterialAssetData — interface @experimental
```
blendMode: number | undefined
cull: number | undefined
@@ -4300,7 +4300,7 @@ type: "material"
version: string
```
-## MaterialData — interface
+## MaterialData — interface @experimental
```
blendMode: BlendMode
cachedBuffer_: Float32Array<ArrayBufferLike> | null
@@ -4334,12 +4334,12 @@ x: number | undefined
y: number | undefined
```
-## MaterialHandle — type
+## MaterialHandle — type @experimental
```
number
```
-## MaterialOptions — interface
+## MaterialOptions — interface @experimental
```
blendMode: BlendMode | undefined
cull: CullMode | undefined
@@ -4350,7 +4350,7 @@ switches: Record<string, boolean> | undefined
uniforms: Record<string, UniformValue> | undefined
```
-## MeasureTextOptions — interface
+## MeasureTextOptions — interface @experimental
```
bold: boolean | undefined
fontFamily: string | undefined
@@ -4361,7 +4361,7 @@ lineHeight: number | undefined
maxWidth: number | undefined
```
-## MeasuredLinearLayoutProvider — class
+## MeasuredLinearLayoutProvider — class @experimental
```
getContentSize: (count: number) => Vec2
getItemRect: (index: number) => Rect
@@ -4371,7 +4371,7 @@ static new (opts: MeasuredLinearLayoutOptions): MeasuredLinearLayoutProvider
static prototype: MeasuredLinearLayoutProvider
```
-## MemoryTransport — class
+## MemoryTransport — class @experimental
```
dropPending: () => void
flush: (limit?: number) => void
@@ -4383,12 +4383,12 @@ static pair: (options?: MemoryTransportOptions) => [MemoryTransport, MemoryTrans
static prototype: MemoryTransport
```
-## Mesh2D — const
+## Mesh2D — const @experimental
```
BuiltinComponentDef<Mesh2DData>
```
-## Mesh2DAPI — class
+## Mesh2DAPI — class @experimental
```
clearGeometry: (entity: Entity) => void
getGeometry: (entity: Entity) => Mesh2DGeometry | undefined
@@ -4397,7 +4397,7 @@ static new (module_: NonNullable<EngineApi>, registry_: CppRegistry): Mesh2DAPI
static prototype: Mesh2DAPI
```
-## Mesh2DData — interface
+## Mesh2DData — interface @experimental
```
color: Color
enabled: boolean
@@ -4409,7 +4409,7 @@ parallax: Vec2
texture: number
```
-## Mesh2DGeometry — interface
+## Mesh2DGeometry — interface @experimental
```
colors: number[] | undefined
indices: number[]
@@ -4417,7 +4417,7 @@ positions: number[]
uvs: number[] | undefined
```
-## Mesh2DPlugin — class
+## Mesh2DPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -4426,24 +4426,24 @@ static new (): Mesh2DPlugin
static prototype: Mesh2DPlugin
```
-## Meshes2D — const
+## Meshes2D — const @experimental
```
ResourceDef<Mesh2DAPI>
```
-## MessageHandler — type
+## MessageHandler — type @experimental
```
(payload: T) => void
```
-## MessagePortLike — interface
+## MessagePortLike — interface @experimental
```
close: (() => void) | undefined
onmessage: ((event: { data: unknown; }) => void) | null
postMessage: (data: unknown) => void
```
-## MessagePortTransport — class
+## MessagePortTransport — class @experimental
```
close: () => void
on: (event: "message", handler: (data: string | ArrayBuffer) => void) => () => void
@@ -4452,7 +4452,7 @@ static new (port: MessagePortLike | MessagePort): MessagePortTransport
static prototype: MessagePortTransport
```
-## MigrationResult — interface
+## MigrationResult — interface @experimental
```
data: PrefabData
fromVersion: string
@@ -4460,7 +4460,7 @@ migrated: boolean
toVersion: string
```
-## MiniGameSocket — class
+## MiniGameSocket — class @experimental
```
close: (code?: number, reason?: string) => void
connect: () => void
@@ -4471,25 +4471,25 @@ static new (options: GameSocketOptions, global: MiniGameGlobal): MiniGameSocket
static prototype: MiniGameSocket
```
-## MissingAssetCallback — type
+## MissingAssetCallback — type @experimental
```
(missing: MissingAsset[]) => void
```
-## MissingAssetsError — class
+## MissingAssetsError — class @experimental
```
missing: MissingAsset[]
static new (missing: MissingAsset[]): MissingAssetsError
static prototype: MissingAssetsError
```
-## MockAdProviderOptions — interface
+## MockAdProviderOptions — interface @experimental
```
completed: boolean | undefined
durationMs: number | undefined
```
-## Modifiers — interface
+## Modifiers — interface @experimental
```
alt: boolean
ctrl: boolean
@@ -4497,22 +4497,22 @@ meta: boolean
shift: boolean
```
-## MotorJoint — const
+## MotorJoint — const @experimental
```
ComponentDef<MotorJointData>
```
-## MouseButton — const
+## MouseButton — const @experimental
```
(button: number) => Binding
```
-## Mut — function
+## Mut — function @experimental
```
<T extends AnyComponentDef>(component: T): MutWrapper<T>
```
-## MutWrapper — interface
+## MutWrapper — interface @experimental
```
_component: T
_type: "mut"
@@ -4523,27 +4523,27 @@ _type: "mut"
Record<GraphNodeType, NodeSpec>
```
-## Name — const
+## Name — const @experimental
```
ComponentDef<NameData>
```
-## NameData — interface
+## NameData — interface @experimental
```
value: string
```
-## Nav — const
+## Nav — const @experimental
```
ResourceDef<Navigation>
```
-## NavAgent — const
+## NavAgent — const @experimental
```
ComponentDef<NavAgentData>
```
-## NavAgentData — interface
+## NavAgentData — interface @experimental
```
arriveRadius: number
arrived: boolean
@@ -4555,7 +4555,7 @@ targetX: number
targetY: number
```
-## NavGrid — class
+## NavGrid — class @experimental
```
cellSize: number
cellToWorld: (gx: number, gy: number) => Vec2
@@ -4575,7 +4575,7 @@ static new (opts: NavGridOptions): NavGrid
static prototype: NavGrid
```
-## NavGridOptions — interface
+## NavGridOptions — interface @experimental
```
cellSize: number
height: number
@@ -4584,7 +4584,7 @@ walkable: ArrayLike<number> | undefined
width: number
```
-## NavPlugin — class
+## NavPlugin — class @experimental
```
build: (app: App) => void
name: string
@@ -4592,7 +4592,7 @@ static new (): NavPlugin
static prototype: NavPlugin
```
-## Navigation — class
+## Navigation — class @experimental
```
findWorldPath: (from: Vec2, to: Vec2, opts?: PathfindOptions & { radius?: number; }) => Vec2[] | null
grid: NavGrid | null
@@ -4602,18 +4602,18 @@ static new (): Navigation
static prototype: Navigation
```
-## NestedPrefabRef — interface
+## NestedPrefabRef — interface @experimental
```
overrides: PrefabOverride[]
prefabPath: string
```
-## Net — const
+## Net — const @experimental
```
ResourceDef<NetSession>
```
-## NetChannel — class
+## NetChannel — class @experimental
```
dispose: (reason?: string) => void
handle: <Req = unknown, Res = unknown>(type: string, handler: RequestHandler<Req, Res>) => () => void
@@ -4626,22 +4626,22 @@ static new (transport: NetTransport, opts?: NetChannelOptions): NetChannel
static prototype: NetChannel
```
-## NetChannelOptions — interface
+## NetChannelOptions — interface @experimental
```
requestTimeoutMs: number | undefined
```
-## NetGhost — const
+## NetGhost — const @experimental
```
ComponentDef<{}>
```
-## NetRoleKind — type
+## NetRoleKind — type @experimental
```
'offline' | 'server' | 'client'
```
-## NetSession — class
+## NetSession — class @experimental
```
client: ReplicationClient | null
connect: (transport: NetTransport, options?: ReplicationClientOptions) => Promise<ReplicationClient>
@@ -4653,7 +4653,7 @@ static new (app_: App): NetSession
static prototype: NetSession
```
-## NetTransport — interface
+## NetTransport — interface @experimental
```
on: (event: "message", handler: (data: string | ArrayBuffer) => void) => () => void
send: (data: string | ArrayBuffer) => void
@@ -4681,39 +4681,39 @@ output: GraphType | null
params: NodeParamSpec[]
```
-## Not — function
+## Not — function @experimental
```
(filter: FilterExpr): FilterExpr
```
-## OneWayPlatform — const
+## OneWayPlatform — const @experimental
```
ComponentDef<OneWayPlatformData>
```
-## Or — function
+## Or — function @experimental
```
(...filters: FilterExpr[]): FilterExpr
```
-## OutlineFilterOptions — interface
+## OutlineFilterOptions — interface @experimental
```
color: { r: number; g: number; b: number; a: number; } | undefined
texelSize: { x: number; y: number; } | undefined
width: number | undefined
```
-## PREFAB_FORMAT_VERSION — const
+## PREFAB_FORMAT_VERSION — const @experimental
```
"2"
```
-## PTR_LAYOUTS — const
+## PTR_LAYOUTS — const @experimental
```
Record<string, PtrLayout>
```
-## PackagedAssetIndex — interface
+## PackagedAssetIndex — interface @experimental
```
addressOf: (ref: string) => string | null
assetPaths: () => string[]
@@ -4724,13 +4724,13 @@ resolvePath: (ref: string) => string
textureImport: (ref: string) => ParsedTextureImportSettings | undefined
```
-## PackagedAssetSourceOptions — interface
+## PackagedAssetSourceOptions — interface @experimental
```
backend: Backend | undefined
decodePixels: ((path: string, flip: boolean) => Promise<{ width: number; height: number; pixels: Uint8Array; }>) | undefined
```
-## PackagedGameConfig — interface
+## PackagedGameConfig — interface @experimental
```
achievements: string[] | undefined
audioConfig: AudioProjectConfig | undefined
@@ -4749,17 +4749,17 @@ uiThemeColors: Record<string, string> | undefined
ySortLayers: number | undefined
```
-## Parent — const
+## Parent — const @experimental
```
BuiltinComponentDef<ParentData>
```
-## ParentData — interface
+## ParentData — interface @experimental
```
entity: number
```
-## ParsedTextureImportSettings — interface
+## ParsedTextureImportSettings — interface @experimental
```
filter: "linear" | "nearest" | undefined
sliceBorder: { left: number; right: number; top: number; bottom: number; } | undefined
@@ -4767,12 +4767,12 @@ srgb: boolean | undefined
wrap: "repeat" | "clamp" | "mirror" | undefined
```
-## Particle — const
+## Particle — const @experimental
```
ResourceDef<ParticleAPI>
```
-## ParticleAPI — class
+## ParticleAPI — class @experimental
```
getAliveCount: (entity: Entity) => number
play: (entity: Entity) => void
@@ -4785,7 +4785,7 @@ static new (module: NonNullable<EngineApi>, registry: CppRegistry): ParticleAPI
static prototype: ParticleAPI
```
-## ParticleEasing — enum
+## ParticleEasing — enum @experimental
```
EaseIn = 1
EaseInOut = 3
@@ -4793,12 +4793,12 @@ EaseOut = 2
Linear = 0
```
-## ParticleEmitter — const
+## ParticleEmitter — const @experimental
```
BuiltinComponentDef<ParticleEmitterData>
```
-## ParticleEmitterData — interface
+## ParticleEmitterData — interface @experimental
```
angleSpreadMax: number
angleSpreadMin: number
@@ -4862,12 +4862,12 @@ trailPoints: number
trailWidth: number
```
-## ParticleForceField — const
+## ParticleForceField — const @experimental
```
BuiltinComponentDef<ParticleForceFieldData>
```
-## ParticleForceFieldData — interface
+## ParticleForceFieldData — interface @experimental
```
direction: Vec2
enabled: boolean
@@ -4877,7 +4877,7 @@ strength: number
type: number
```
-## ParticlePlugin — class
+## ParticlePlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -4886,19 +4886,19 @@ static new (): ParticlePlugin
static prototype: ParticlePlugin
```
-## PathfindOptions — interface
+## PathfindOptions — interface @experimental
```
clearance: number | undefined
diagonal: boolean | undefined
snapRadius: number | undefined
```
-## Payment — const
+## Payment — const @experimental
```
ResourceDef<PaymentAPI>
```
-## PaymentAPI — class
+## PaymentAPI — class @experimental
```
available: boolean
request: (request: PaymentRequest) => Promise<void>
@@ -4906,33 +4906,33 @@ static new (): PaymentAPI
static prototype: PaymentAPI
```
-## PaymentFailure — interface
+## PaymentFailure — interface @experimental
```
code: number | undefined
```
-## PaymentRequest — type
+## PaymentRequest — type @experimental
```
PlatformPaymentRequest
```
-## Perceiver — const
+## Perceiver — const @experimental
```
ComponentDef<PerceiverData>
```
-## PerceiverData — interface
+## PerceiverData — interface @experimental
```
fovDegrees: number
range: number
```
-## Perception — const
+## Perception — const @experimental
```
ComponentDef<PerceptionData>
```
-## PerceptionData — interface
+## PerceptionData — interface @experimental
```
dirX: number
dirY: number
@@ -4942,7 +4942,7 @@ targetY: number
visible: boolean
```
-## PerceptionPlugin — class
+## PerceptionPlugin — class @experimental
```
build: (app: App) => void
name: string
@@ -4950,34 +4950,34 @@ static new (): PerceptionPlugin
static prototype: PerceptionPlugin
```
-## PerceptionTarget — const
+## PerceptionTarget — const @experimental
```
ComponentDef<{}>
```
-## Physics — const
+## Physics — const @experimental
```
ResourceDef<PhysicsAPI>
```
-## PhysicsContactEventData — interface
+## PhysicsContactEventData — interface @experimental
```
approachSpeed: number | undefined
isSensor: boolean | undefined
other: number
```
-## PhysicsEventType — type
+## PhysicsEventType — type @experimental
```
typeof PhysicsEventType[keyof typeof PhysicsEventType]
```
-## PhysicsEvents — const
+## PhysicsEvents — const @experimental
```
ResourceDef<PhysicsEventsData>
```
-## PhysicsEventsData — interface
+## PhysicsEventsData — interface @experimental
```
collisionEnters: CollisionEnterEvent[]
collisionExits: { entityA: Entity; entityB: Entity; }[]
@@ -4986,12 +4986,12 @@ sensorEnters: SensorEvent[]
sensorExits: SensorEvent[]
```
-## PhysicsModuleFactory — type
+## PhysicsModuleFactory — type @experimental
```
(config?: Record<string, unknown>) => Promise<PhysicsWasmModule>
```
-## PhysicsPlugin — class
+## PhysicsPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -5000,7 +5000,7 @@ static new (wasmUrl: string, config?: PhysicsPluginConfig, factory?: PhysicsModu
static prototype: PhysicsPlugin
```
-## PhysicsPluginConfig — interface
+## PhysicsPluginConfig — interface @experimental
```
collisionLayerMasks: number[] | undefined
contactDampingRatio: number | undefined
@@ -5015,7 +5015,7 @@ restitutionThreshold: number | undefined
subStepCount: number | undefined
```
-## PhysicsWasmModule — interface
+## PhysicsWasmModule — interface @experimental
```
HEAPF32: Float32Array<ArrayBufferLike>
HEAPU32: Uint32Array<ArrayBufferLike>
@@ -5138,7 +5138,7 @@ _physics_step: (dt: number) => void
_physics_updateBodyProperties: (entityId: number, bodyType: number, gravityScale: number, linearDamping: number, angularDamping: number, fixedRotation: number, bullet: number) => void
```
-## PlatformAdapter — interface
+## PlatformAdapter — interface @experimental
```
bindInputEvents: (callbacks: InputEventCallbacks, target?: unknown) => void
canPay: (() => boolean) | undefined
@@ -5193,7 +5193,7 @@ unbindInputEvents: (() => void) | undefined
writeCacheFile: ((key: string, bytes: ArrayBuffer) => Promise<void>) | undefined
```
-## PlatformAudioBackend — interface
+## PlatformAudioBackend — interface @experimental
```
dispose: () => void
ensureResumed: () => Promise<void>
@@ -5210,14 +5210,14 @@ suspend: () => void
unloadBuffer: (handle: AudioBufferHandle) => void
```
-## PlatformCanvas — interface
+## PlatformCanvas — interface @experimental
```
getContext: (contextId: "2d", options?: PlatformCanvasContextAttributes) => PlatformCanvas2DContext | null
height: number
width: number
```
-## PlatformCanvas2DContext — interface
+## PlatformCanvas2DContext — interface @experimental
```
clearRect: (x: number, y: number, w: number, h: number) => void
drawImage: (image: PlatformImageSource, dx: number, dy: number) => void
@@ -5230,7 +5230,7 @@ textAlign: string
textBaseline: string
```
-## PlatformImage — interface
+## PlatformImage — interface @experimental
```
crossOrigin: string | null | undefined
height: number
@@ -5240,7 +5240,7 @@ src: string
width: number
```
-## PlatformRequestOptions — interface
+## PlatformRequestOptions — interface @experimental
```
body: string | ArrayBuffer | undefined
headers: Record<string, string> | undefined
@@ -5249,7 +5249,7 @@ responseType: "json" | "text" | "arraybuffer" | undefined
timeout: number | undefined
```
-## PlatformResponse — interface
+## PlatformResponse — interface @experimental
```
arrayBuffer: () => Promise<ArrayBuffer>
headers: Record<string, string>
@@ -5260,7 +5260,7 @@ statusText: string
text: () => Promise<string>
```
-## PlatformSocket — interface
+## PlatformSocket — interface @experimental
```
close: (code?: number, reason?: string) => void
connect: () => void
@@ -5269,7 +5269,7 @@ readyState: PlatformSocketReadyState
send: (data: string | ArrayBuffer) => void
```
-## PlatformSocketEvents — interface
+## PlatformSocketEvents — interface @experimental
```
close: [code: number, reason: string]
error: [error: unknown]
@@ -5277,30 +5277,30 @@ message: [data: string | ArrayBuffer]
open: []
```
-## PlatformSocketOptions — interface
+## PlatformSocketOptions — interface @experimental
```
protocols: string | string[] | undefined
url: string
```
-## PlatformSocketReadyState — type
+## PlatformSocketReadyState — type @experimental
```
'connecting' | 'open' | 'closing' | 'closed'
```
-## PlatformType — type @deprecated
+## PlatformType — type @experimental @deprecated
```
PlatformName
```
-## PlatformVideoBackend — interface
+## PlatformVideoBackend — interface @experimental
```
createStream: (url: string, options: VideoStreamOptions) => VideoStreamHandle
dispose: () => void
name: string
```
-## PlayConfig — interface
+## PlayConfig — interface @experimental
```
bus: string | undefined
loop: boolean | undefined
@@ -5311,7 +5311,7 @@ startOffset: number | undefined
volume: number | undefined
```
-## PlayRealmRuntimeConfig — interface
+## PlayRealmRuntimeConfig — interface @experimental
```
achievements: string[] | undefined
app: App
@@ -5336,12 +5336,12 @@ uiThemeOverrides: ThemeOverrides | undefined
wasmBaseUrl: string | undefined
```
-## PlayableAdBridge — interface
+## PlayableAdBridge — interface @experimental
```
cta: (() => void) | undefined
```
-## PlayableRuntimeConfig — interface
+## PlayableRuntimeConfig — interface @experimental
```
app: App
assetPathMap: Record<string, string> | undefined
@@ -5360,7 +5360,7 @@ uiThemeOverrides: ThemeOverrides | undefined
ySortLayers: number | undefined
```
-## Plugin — interface
+## Plugin — interface @experimental
```
after: string[] | undefined
before: string[] | undefined
@@ -5371,17 +5371,17 @@ finish: ((app: App) => void) | undefined
name: string | undefined
```
-## PluginDependency — type
+## PluginDependency — type @experimental
```
string | ResourceDef<any>
```
-## PluralCategory — type
+## PluralCategory — type @experimental
```
'zero' | 'one' | 'two' | 'few' | 'many' | 'other'
```
-## PluralForms — interface
+## PluralForms — interface @experimental
```
few: string | undefined
many: string | undefined
@@ -5391,17 +5391,17 @@ two: string | undefined
zero: string | undefined
```
-## PluralSelector — type
+## PluralSelector — type @experimental
```
(count: number) => PluralCategory
```
-## PolygonCollider — const
+## PolygonCollider — const @experimental
```
ComponentDef<PolygonColliderData>
```
-## PooledAudioNode — interface
+## PooledAudioNode — interface @experimental
```
gain: GainNode
inUse: boolean
@@ -5410,12 +5410,12 @@ source: AudioBufferSourceNode | null
startTime: number
```
-## PostProcess — const
+## PostProcess — const @experimental
```
ResourceDef<PostProcessAPI>
```
-## PostProcessAPI — class
+## PostProcessAPI — class @experimental
```
_applyForCamera: (camera: Entity) => void
_applyScreenStack: () => void
@@ -5444,7 +5444,7 @@ static new (): PostProcessAPI
static prototype: PostProcessAPI
```
-## PostProcessPlugin — class
+## PostProcessPlugin — class @experimental
```
build: (app: App) => void
cleanup: (app?: App) => void
@@ -5453,7 +5453,7 @@ static new (): PostProcessPlugin
static prototype: PostProcessPlugin
```
-## PostProcessStack — class
+## PostProcessStack — class @experimental
```
addPass: (name: string, shader: ShaderHandle) => PostProcessStack
clearDirty: () => void
@@ -5475,12 +5475,12 @@ static new (state: PostProcessState): PostProcessStack
static prototype: PostProcessStack
```
-## PostProcessVolume — const
+## PostProcessVolume — const @experimental
```
ComponentDef<PostProcessVolumeData>
```
-## PostProcessVolumeData — interface
+## PostProcessVolumeData — interface @experimental
```
blendDistance: number
effects: { type: string; enabled: boolean; uniforms: Record<string, number>; textures?: Record<string, string>; }[]
@@ -5491,38 +5491,38 @@ size: { x: number; y: number; }
weight: number
```
-## PreSceneDrawCallback — type
+## PreSceneDrawCallback — type @experimental
```
(info: PreSceneDrawInfo) => void
```
-## PreSceneDrawInfo — interface
+## PreSceneDrawInfo — interface @experimental
```
elapsed: number
height: number
width: number
```
-## PredictionOptions — interface
+## PredictionOptions — interface @experimental
```
apply: (world: World, entity: Entity, actions: Record<string, unknown>, dt: number) => void
maxPendingInputs: number | undefined
smoothing: PredictionSmoothing | undefined
```
-## PredictionSmoothing — interface
+## PredictionSmoothing — interface @experimental
```
halfLife: number
maxError: number | undefined
```
-## PrefabComponentData — interface
+## PrefabComponentData — interface @experimental
```
data: Record<string, unknown>
type: string
```
-## PrefabData — interface
+## PrefabData — interface @experimental
```
basePrefab: string | undefined
entities: PrefabEntityData[]
@@ -5532,7 +5532,7 @@ rootEntityId: string
version: string
```
-## PrefabDiagnostic — interface
+## PrefabDiagnostic — interface @experimental
```
code: string
entityId: string | undefined
@@ -5541,12 +5541,12 @@ message: string
severity: PrefabDiagnosticSeverity
```
-## PrefabDiagnosticSeverity — type
+## PrefabDiagnosticSeverity — type @experimental
```
'error' | 'warning'
```
-## PrefabEntityData — interface
+## PrefabEntityData — interface @experimental
```
children: string[]
components: ComponentData[]
@@ -5558,12 +5558,12 @@ prefabEntityId: string
visible: boolean
```
-## PrefabEntityId — type
+## PrefabEntityId — type @experimental
```
string
```
-## PrefabInstanceDelta — interface
+## PrefabInstanceDelta — interface @experimental
```
added: AddedEntity[]
overrides: PrefabOverride[]
@@ -5571,7 +5571,7 @@ prefab: string
removed: string[]
```
-## PrefabInstanceEntry — interface
+## PrefabInstanceEntry — interface @experimental
```
added: AddedEntity[]
id: number
@@ -5581,7 +5581,7 @@ prefab: string
removed: string[]
```
-## PrefabOverride — interface
+## PrefabOverride — interface @experimental
```
componentData: ComponentData | undefined
componentType: string | undefined
@@ -5592,19 +5592,19 @@ type: "property" | "component_added" | "component_replaced" | "component_removed
value: unknown
```
-## PrefabServer — class
+## PrefabServer — class @experimental
```
instantiate: (pathOrAddress: string, options?: { baseUrl?: string; parent?: Entity; overrides?: SpawnOverride[]; scene?: boolean; }) => Promise<InstantiatePrefabResult>
static new (world: World, getAssets: () => AssetsClass, getScenes?: () => SceneManagerState | null): PrefabServer
static prototype: PrefabServer
```
-## Prefabs — const
+## Prefabs — const @experimental
```
ResourceDef<PrefabServer>
```
-## PrefabsPlugin — class
+## PrefabsPlugin — class @experimental
```
build: (app: App) => void
dependencies: ResourceDef<AssetsClass>[]
@@ -5613,7 +5613,7 @@ static new (): PrefabsPlugin
static prototype: PrefabsPlugin
```
-## PreviewPlugin — class
+## PreviewPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -5623,18 +5623,18 @@ static new (sceneUrl: string, baseUrl?: string): PreviewPlugin
static prototype: PreviewPlugin
```
-## PrismaticJoint — const
+## PrismaticJoint — const @experimental
```
ComponentDef<PrismaticJointData>
```
-## ProbedRegistrations — interface
+## ProbedRegistrations — interface @experimental
```
fingerprint: string
pending: PendingSystemEntry[]
```
-## ProcessedEntity — interface
+## ProcessedEntity — interface @experimental
```
children: number[]
components: ComponentData[]
@@ -5646,7 +5646,7 @@ prefabEntityId: string
visible: boolean
```
-## ProgressHandle — interface
+## ProgressHandle — interface @experimental
```
dispose: () => void
entity: number
@@ -5655,7 +5655,7 @@ getValue: () => number
setValue: (v: number) => void
```
-## ProgressOptions — interface
+## ProgressOptions — interface @experimental
```
background: UIVisualInit | undefined
direction: LinearFillDirection | undefined
@@ -5667,19 +5667,19 @@ value: number | undefined
world: World
```
-## ProjectionType — enum
+## ProjectionType — enum @experimental
```
Orthographic = 1
Perspective = 0
```
-## PropertyChannel — interface
+## PropertyChannel — interface @experimental
```
keyframes: Keyframe[]
property: string
```
-## PropertyTrack — interface
+## PropertyTrack — interface @experimental
```
channels: PropertyChannel[]
childPath: string
@@ -5688,13 +5688,13 @@ name: string
type: "property"
```
-## PtrLayout — interface
+## PtrLayout — interface @experimental
```
fields: readonly PtrFieldDesc[]
ptrFn: string
```
-## Quat — interface
+## Quat — interface @experimental
```
w: number
x: number
@@ -5702,12 +5702,12 @@ y: number
z: number
```
-## Query — function
+## Query — function @experimental
```
<C extends QueryArg[]>(...components: C): QueryBuilder<C>
```
-## QueryBuilder — interface
+## QueryBuilder — interface @experimental
```
_addedFilters: { index: number; component: AnyComponentDef; }[]
_changedFilters: { index: number; component: AnyComponentDef; }[]
@@ -5722,7 +5722,7 @@ with: (...components: AnyComponentDef[]) => QueryBuilder<C>
without: (...components: AnyComponentDef[]) => QueryBuilder<C>
```
-## QueryDescriptor — interface
+## QueryDescriptor — interface @experimental
```
_addedFilters: { index: number; component: AnyComponentDef; }[]
_changedFilters: { index: number; component: AnyComponentDef; }[]
@@ -5734,7 +5734,7 @@ _with: AnyComponentDef[]
_without: AnyComponentDef[]
```
-## QueryInstance — class
+## QueryInstance — class @experimental
```
count: () => number
forEach: (callback: (entity: Entity, ...components: ComponentsData<C>) => void) => void
@@ -5746,7 +5746,7 @@ static new <C extends readonly QueryArg[]>(world: World, descriptor: QueryDescri
static prototype: QueryInstance<any>
```
-## QueryResult — type
+## QueryResult — type @experimental
```
[
Entity,
@@ -5754,44 +5754,44 @@ static prototype: QueryInstance<any>
]
```
-## REPLICATION_CHANNEL — const
+## REPLICATION_CHANNEL — const @experimental
```
1
```
-## REPLICATION_PROTOCOL_VERSION — const
+## REPLICATION_PROTOCOL_VERSION — const @experimental
```
2
```
-## RETIRED_COMPONENT_TYPES — const
+## RETIRED_COMPONENT_TYPES — const @experimental
```
ReadonlySet<string>
```
-## RadiusInterestOptions — interface
+## RadiusInterestOptions — interface @experimental
```
position: ((world: World, entity: Entity) => { x: number; y: number; } | null) | undefined
```
-## ReadonlySignal — interface
+## ReadonlySignal — interface @experimental
```
get: () => T
subscribe: (fn: (value: T) => void) => () => void
```
-## Removed — function
+## Removed — function @experimental
```
<T extends AnyComponentDef>(component: T): RemovedQueryDescriptor<T>
```
-## RemovedQueryDescriptor — interface
+## RemovedQueryDescriptor — interface @experimental
```
_component: T
_type: "removed"
```
-## RemovedQueryInstance — class
+## RemovedQueryInstance — class @experimental
```
isEmpty: () => boolean
resetTick: (tick: number) => void
@@ -5800,7 +5800,7 @@ static new <T extends AnyComponentDef>(world: World, component: T, lastRunTick:
static prototype: RemovedQueryInstance<any>
```
-## RenderParams — interface
+## RenderParams — interface @experimental
```
clearColor: { x: number; y: number; z: number; w: number; } | undefined
elapsed: number
@@ -5810,7 +5810,7 @@ viewProjection: Float32Array<ArrayBufferLike>
width: number
```
-## RenderPipeline — class
+## RenderPipeline — class @experimental
```
addPreFlushCallback: (cb: (registry: { _cpp: CppRegistry; }) => void) => void
beginFrame: (elapsedSec?: number) => void
@@ -5826,7 +5826,7 @@ static new (): RenderPipeline
static prototype: RenderPipeline
```
-## RenderStage — enum
+## RenderStage — enum @experimental
```
Background = 0
Opaque = 1
@@ -5834,7 +5834,7 @@ Overlay = 3
Transparent = 2
```
-## RenderStats — interface
+## RenderStats — interface @experimental
```
culled: number
drawCalls: number
@@ -5845,24 +5845,24 @@ text: number
triangles: number
```
-## RenderSurfaceSource — type
+## RenderSurfaceSource — type @experimental
```
| { readonly kind: 'gl-context'; readonly handle: number }
| { readonly kind: 'webgpu'; readonly canvasSelector?: string }
| { readonly kind: 'default' }
```
-## RenderTargetHandle — type
+## RenderTargetHandle — type @experimental
```
number
```
-## RenderTexture — const
+## RenderTexture — const @experimental
```
{ create(options: RenderTextureOptions): RenderTextureHandle; release(rt: RenderTextureHandle): void; resize(rt: RenderTextureHandle, width: number, height: number): RenderTextureHandle; begin(rt: RenderTextureHandle, viewProjection: Float32Array): void; end(): void; getDepthTexture(rt: RenderTextureHandle): number; }
```
-## RenderTextureHandle — interface
+## RenderTextureHandle — interface @experimental
```
_depth: boolean
_filter: "linear" | "nearest"
@@ -5873,7 +5873,7 @@ textureId: number
width: number
```
-## RenderTextureOptions — interface
+## RenderTextureOptions — interface @experimental
```
depth: boolean | undefined
filter: "linear" | "nearest" | undefined
@@ -5881,7 +5881,7 @@ height: number
width: number
```
-## RenderType — enum
+## RenderType — enum @experimental
```
ExternalMesh = 3
Mesh = 2
@@ -5893,23 +5893,23 @@ Text = 4
UIElement = 7
```
-## Renderer — const
+## Renderer — const @experimental
```
{ init(width: number, height: number): void; resize(width: number, height: number): void; beginFrame(elapsedSec?: number): void; updateTransforms(registry: { _cpp: CppRegistry; }): void; begin(viewProjection: Float32Array, target?: RenderTargetHandle, clearFlags?: number, clearColor?: { x: number; y: number; z: number; w: number; }, clearRect?: { x: number; y: number; w: number; h: number; }): void; flush(): void; end(): void; submitAll(registry: { _cpp: CppRegistry; }, skipFlags: number, vpX: number, vpY: number, vpW: number, vpH: number): void; setStage(stage: RenderStage): void; createRenderTarget(width: number, height: number, flags?: number): RenderTargetHandle; releaseRenderTarget(handle: RenderTargetHandle): void; getTargetTexture(handle: RenderTargetHandle): number; getTargetDepthTexture(handle: RenderTargetHandle): number; setClearColor(r: number, g: number, b: number, a: number): void; setViewport(x: number, y: number, w: number, h: number): void; setYSortLayers(mask: number): void; setDepthLayers(mask: number): void; setCullingMask(mask: number): void; setTextureParams(textureId: number, minFilter: number, magFilter: number, wrapS: number, wrapT: number): void; measureBitmapText(fontHandle: number, text: string, fontSize: number, spacing: number): { width: number; height: number; }; getStats(): RenderStats; captureNextFrame(): void; getCapturedData(): FrameCaptureData | null; hasCapturedData(): boolean; replayToDrawCall(drawCallIndex: number): void; getSnapshotImageData(): Promise<ImageData | null>; }
```
-## Replicated — const
+## Replicated — const @experimental
```
ComponentDef<ReplicatedData>
```
-## ReplicatedData — interface
+## ReplicatedData — interface @experimental
```
netId: number
owner: number
```
-## ReplicationClient — class
+## ReplicationClient — class @experimental
```
applyPending: () => void
connect: (transport: NetTransport) => Promise<void>
@@ -5929,7 +5929,7 @@ static new (world: World, options?: ReplicationClientOptions): ReplicationClient
static prototype: ReplicationClient
```
-## ReplicationPlugin — class
+## ReplicationPlugin — class @experimental
```
build: (app: App) => void
name: string
@@ -5937,7 +5937,7 @@ static new (): ReplicationPlugin
static prototype: ReplicationPlugin
```
-## ReplicationServer — class
+## ReplicationServer — class @experimental
```
attachConnection: (transport: NetTransport) => number
beginTick: (fixedDelta: number) => void
@@ -5954,34 +5954,34 @@ static new (world: World): ReplicationServer
static prototype: ReplicationServer
```
-## RequestHandler — type
+## RequestHandler — type @experimental
```
(payload: Req) => Res | Promise<Res>
```
-## Res — function
+## Res — function @experimental
```
<T>(resource: ResourceDef<T>): ResDescriptor<T>
```
-## ResDescriptor — interface
+## ResDescriptor — interface @experimental
```
_resource: ResourceDef<T>
_type: "res"
```
-## ResMut — function
+## ResMut — function @experimental
```
<T>(resource: ResourceDef<T>): ResMutDescriptor<T>
```
-## ResMutDescriptor — interface
+## ResMutDescriptor — interface @experimental
```
_resource: ResourceDef<T>
_type: "res_mut"
```
-## ResMutInstance — class
+## ResMutInstance — class @experimental
```
get: () => T
modify: (fn: (value: T) => void) => void
@@ -5991,20 +5991,20 @@ static new <T>(value: T, setter: (v: T) => void): ResMutInstance<T>
static prototype: ResMutInstance<any>
```
-## ResolvedAssetGroup — interface
+## ResolvedAssetGroup — interface @experimental
```
alwaysInclude: boolean
delivery: BundleMode
name: string
```
-## ResolvedAtlas — interface
+## ResolvedAtlas — interface @experimental
```
folder: string
name: string
```
-## ResolvedTileCollision — interface
+## ResolvedTileCollision — interface @experimental
```
density: number | undefined
friction: number | undefined
@@ -6014,7 +6014,7 @@ sensor: boolean | undefined
shape: { type: "box"; } | { type: "polygon"; points: [number, number][]; } | { type: "circle"; cx: number; cy: number; r: number; }
```
-## ResolvedTileset — interface
+## ResolvedTileset — interface @experimental
```
asset: TilesetAsset
textureHandle: number
@@ -6022,14 +6022,14 @@ textureHeight: number | undefined
textureWidth: number | undefined
```
-## ResourceDef — interface
+## ResourceDef — interface @experimental
```
_default: T
_id: symbol
_name: string
```
-## ResourceStats — interface
+## ResourceStats — interface @experimental
```
cacheHits: number
cacheMisses: number
@@ -6042,7 +6042,7 @@ textureEvictableCount: number
vertexBufferCount: number
```
-## ReverbEffectDef — interface
+## ReverbEffectDef — interface @experimental
```
decay: number | undefined
seconds: number | undefined
@@ -6050,22 +6050,22 @@ type: "reverb"
wet: number | undefined
```
-## RevoluteJoint — const
+## RevoluteJoint — const @experimental
```
ComponentDef<RevoluteJointData>
```
-## RichTextRun — type
+## RichTextRun — type @experimental
```
TextSegment | ImageSegment
```
-## RigidBody — const
+## RigidBody — const @experimental
```
BuiltinComponentDef<RigidBodyData>
```
-## RigidBodyData — interface
+## RigidBodyData — interface @experimental
```
angularDamping: number
bodyType: number
@@ -6076,12 +6076,12 @@ gravityScale: number
linearDamping: number
```
-## RunCondition — type
+## RunCondition — type @experimental
```
() => boolean
```
-## RuntimeAssetSource — interface
+## RuntimeAssetSource — interface @experimental
```
backend: Backend
decodePixels: (path: string, flip: boolean) => Promise<{ width: number; height: number; pixels: Uint8Array; }>
@@ -6091,7 +6091,7 @@ resolveRef: ((ref: string) => string) | undefined
textureImportSettings: ((ref: string) => ParsedTextureImportSettings | undefined) | undefined
```
-## RuntimeBuildConfig — interface
+## RuntimeBuildConfig — interface @experimental
```
assetFailureCooldown: number | undefined
assetLoadTimeout: number | undefined
@@ -6107,12 +6107,12 @@ textCanvasSize: number | undefined
textureCacheBudget: number | undefined
```
-## RuntimeConfig — const
+## RuntimeConfig — const @experimental
```
{ sceneTransitionDuration: number; sceneTransitionColor: { r: number; g: number; b: number; a: number; }; defaultFontFamily: string; canvasScaleMode: number; canvasMatchWidthOrHeight: number; maxDeltaTime: number; maxFixedSteps: number; textCanvasSize: number; assetLoadTimeout: number; assetFailureCooldown: number; textureCacheBudget: number; audioCacheBudget: number; }
```
-## RuntimeInitConfig — interface
+## RuntimeInitConfig — interface @experimental
```
achievements: string[] | undefined
app: App
@@ -6137,42 +6137,42 @@ uiTheme: "dark" | "light" | undefined
uiThemeOverrides: ThemeOverrides | undefined
```
-## RuntimeOnly — const
+## RuntimeOnly — const @experimental
```
ComponentDef<{}>
```
-## SCENE_FORMAT_VERSION — const
+## SCENE_FORMAT_VERSION — const @experimental
```
1
```
-## SCREEN_FIT_OFF — const
+## SCREEN_FIT_OFF — const @experimental
```
-1
```
-## SIDE_MODULES — const
+## SIDE_MODULES — const @experimental
```
Record<BuiltinSideModuleId, SideModuleDescriptor>
```
-## SPINE_VERSIONS — const
+## SPINE_VERSIONS — const @experimental
```
readonly SpineVersion[]
```
-## STATE_PATH_SEP — const
+## STATE_PATH_SEP — const @experimental
```
"/"
```
-## SafeArea — const
+## SafeArea — const @experimental
```
ComponentDef<SafeAreaData>
```
-## SafeAreaData — interface
+## SafeAreaData — interface @experimental
```
applyBottom: boolean
applyLeft: boolean
@@ -6180,7 +6180,7 @@ applyRight: boolean
applyTop: boolean
```
-## SafeAreaPlugin — class
+## SafeAreaPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -6190,33 +6190,33 @@ static new (): SafeAreaPlugin
static prototype: SafeAreaPlugin
```
-## SampleDeps — interface
+## SampleDeps — interface @experimental
```
getComponent: (name: string) => AnyComponentDef | undefined
resolveChild: (root: Entity, childPath: string) => Entity | null
world: SampleWorld
```
-## SampleOptions — interface
+## SampleOptions — interface @experimental
```
skipChannel: ((childPath: string, component: string, property: string) => boolean) | undefined
```
-## SampleWorld — interface
+## SampleWorld — interface @experimental
```
get: (entity: Entity, def: AnyComponentDef) => Record<string, unknown>
has: (entity: Entity, def: AnyComponentDef) => boolean
set: (entity: Entity, def: AnyComponentDef, data: Record<string, unknown>) => void
```
-## SaveEnvelope — interface
+## SaveEnvelope — interface @experimental
```
data: T
savedAt: number
version: number
```
-## SaveManager — class
+## SaveManager — class @experimental
```
has: (slot: string) => boolean
load: <T>(slot: string) => T | null
@@ -6227,7 +6227,7 @@ static new (opts: SaveManagerOptions): SaveManager
static prototype: SaveManager
```
-## SaveManagerOptions — interface
+## SaveManagerOptions — interface @experimental
```
keyPrefix: string | undefined
migrations: Record<number, SaveMigration> | undefined
@@ -6236,12 +6236,12 @@ storage: SaveStorage | undefined
version: number
```
-## SaveMigration — type
+## SaveMigration — type @experimental
```
(data: unknown) => unknown
```
-## SaveStorage — interface
+## SaveStorage — interface @experimental
```
getJSON: <T>(key: string, defaultValue?: T) => T | undefined
has: (key: string) => boolean
@@ -6249,12 +6249,12 @@ remove: (key: string) => void
setJSON: <T>(key: string, value: T) => void
```
-## ScaleMode — type
+## ScaleMode — type @experimental
```
(typeof ScaleMode)[keyof typeof ScaleMode]
```
-## SceneAssetRefs — interface
+## SceneAssetRefs — interface @experimental
```
byType: Map<string, Set<string>>
dragonBones: SpineAssetRef[]
@@ -6264,20 +6264,20 @@ spines: SpineAssetRef[]
unresolved: string[]
```
-## SceneComponentCodec — interface
+## SceneComponentCodec — interface @experimental
```
exportData: ((entity: number, data: Record<string, unknown>) => void) | undefined
importData: ((entity: number, outOfBand: Record<string, unknown>) => void) | undefined
outOfBandFields: readonly string[] | undefined
```
-## SceneComponentData — interface
+## SceneComponentData — interface @experimental
```
data: Record<string, unknown>
type: string
```
-## SceneConfig — interface
+## SceneConfig — interface @experimental
```
cleanup: ((ctx: SceneContext) => void) | undefined
data: SceneData | undefined
@@ -6287,7 +6287,7 @@ setup: ((ctx: SceneContext) => void | Promise<void>) | undefined
systems: { schedule: Schedule; system: SystemDef; }[] | undefined
```
-## SceneContext — interface
+## SceneContext — interface @experimental
```
adopt: (entity: Entity) => void
bindPostProcess: (camera: Entity, stack: PostProcessStack) => void
@@ -6301,7 +6301,7 @@ trackAssets: (byType: ReadonlyMap<string, ReadonlySet<string>>) => void
unbindPostProcess: (camera: Entity) => void
```
-## SceneData — interface
+## SceneData — interface @experimental
```
entities: SceneEntityData[]
generator: string | undefined
@@ -6310,7 +6310,7 @@ textureMetadata: Record<string, TextureMetadata> | undefined
version: string | number
```
-## SceneEntityData — interface
+## SceneEntityData — interface @experimental
```
children: number[]
components: SceneComponentData[]
@@ -6320,13 +6320,13 @@ parent: number | null
visible: boolean | undefined
```
-## SceneLoadCancelled — class
+## SceneLoadCancelled — class @experimental
```
static new (name: string): SceneLoadCancelled
static prototype: SceneLoadCancelled
```
-## SceneLoadOptions — interface
+## SceneLoadOptions — interface @experimental
```
abortOnMissingAssets: boolean | undefined
assetBaseUrl: string | undefined
@@ -6336,17 +6336,17 @@ onMissingAssets: MissingAssetCallback | undefined
onProgress: SceneLoadProgressCallback | undefined
```
-## SceneLoadProgressCallback — type
+## SceneLoadProgressCallback — type @experimental
```
(loaded: number, total: number) => void
```
-## SceneManager — const
+## SceneManager — const @experimental
```
ResourceDef<SceneManagerState>
```
-## SceneManagerState — class
+## SceneManagerState — class @experimental
```
bringToTop: (name: string) => void
getActive: () => string | null
@@ -6378,7 +6378,7 @@ static new (app: App): SceneManagerState
static prototype: SceneManagerState
```
-## SceneMigrationResult — interface
+## SceneMigrationResult — interface @experimental
```
data: SceneData
fromVersion: number
@@ -6386,23 +6386,23 @@ migrated: boolean
toVersion: number
```
-## SceneOwner — const
+## SceneOwner — const @experimental
```
ComponentDef<SceneOwnerData>
```
-## SceneOwnerData — interface
+## SceneOwnerData — interface @experimental
```
persistent: boolean
scene: string
```
-## SceneStatus — type
+## SceneStatus — type @experimental
```
'loading' | 'running' | 'paused' | 'sleeping' | 'unloading'
```
-## SceneStreamHost — interface
+## SceneStreamHost — interface @experimental
```
isLoaded: (name: string) => boolean
isSleeping: (name: string) => boolean
@@ -6412,19 +6412,19 @@ unload: (name: string) => Promise<void>
wake: (name: string) => void
```
-## SceneStreaming — const
+## SceneStreaming — const @experimental
```
ResourceDef<SceneStreamingController>
```
-## SceneStreamingConfig — interface
+## SceneStreamingConfig — interface @experimental
```
loadRadius: number
policy: StreamPolicy | undefined
unloadRadius: number
```
-## SceneStreamingController — class
+## SceneStreamingController — class @experimental
```
clear: () => void
configure: (config: SceneStreamingConfig) => void
@@ -6439,7 +6439,7 @@ static new (host: SceneStreamHost, config?: SceneStreamingConfig): SceneStreamin
static prototype: SceneStreamingController
```
-## Schedule — enum
+## Schedule — enum @experimental
```
First = 1
FixedPostUpdate = 12
@@ -6452,7 +6452,7 @@ Startup = 0
Update = 3
```
-## ScreenInfo — class
+## ScreenInfo — class @experimental
```
dpr: number
height: number
@@ -6464,19 +6464,19 @@ static new (): ScreenInfo
static prototype: ScreenInfo
```
-## ScreenInfoEvents — interface
+## ScreenInfoEvents — interface @experimental
```
orientationchange: [orientation: ScreenOrientation]
resize: [width: number, height: number]
```
-## ScreenOrientation — enum
+## ScreenOrientation — enum @experimental
```
Landscape = "landscape"
Portrait = "portrait"
```
-## ScreenRect — interface
+## ScreenRect — interface @experimental
```
h: number
w: number
@@ -6484,12 +6484,12 @@ x: number
y: number
```
-## ScreenScaling — const
+## ScreenScaling — const @experimental
```
ResourceDef<ScreenScalingData>
```
-## ScreenScalingData — interface
+## ScreenScalingData — interface @experimental
```
designHeight: number
designWidth: number
@@ -6497,7 +6497,7 @@ matchWidthOrHeight: number
scaleMode: number
```
-## ScrollContainer — class
+## ScrollContainer — class @experimental
```
dispose: () => void
getContentSize: () => Vec2
@@ -6517,7 +6517,7 @@ static new (opts: ScrollContainerOptions): ScrollContainer
static prototype: ScrollContainer
```
-## ScrollViewHandle — interface
+## ScrollViewHandle — interface @experimental
```
content: number
dispose: () => void
@@ -6527,7 +6527,7 @@ scrollTo: (offset: Vec2) => void
setContentSize: (size: Vec2) => void
```
-## ScrollViewOptions — interface
+## ScrollViewOptions — interface @experimental
```
background: UIVisualInit | undefined
contentSize: Vec2
@@ -6543,12 +6543,12 @@ wheelSpeed: number | undefined
world: World
```
-## SegmentCollider — const
+## SegmentCollider — const @experimental
```
BuiltinComponentDef<SegmentColliderData>
```
-## SenseResult — interface
+## SenseResult — interface @experimental
```
dirX: number
dirY: number
@@ -6556,13 +6556,13 @@ distance: number
visible: boolean
```
-## SensorEvent — interface
+## SensorEvent — interface @experimental
```
sensorEntity: number
visitorEntity: number
```
-## ServicesPlugin — class
+## ServicesPlugin — class @experimental
```
build: (app: App) => void
name: string
@@ -6570,12 +6570,12 @@ static new (): ServicesPlugin
static prototype: ServicesPlugin
```
-## ShaderHandle — type
+## ShaderHandle — type @experimental
```
number
```
-## ShaderParam — interface
+## ShaderParam — interface @experimental
```
default: number[]
defaultTexture: string | undefined
@@ -6586,39 +6586,39 @@ type: ShaderParamType
ui: string | undefined
```
-## ShaderParamType — type
+## ShaderParamType — type @experimental
```
'float' | 'vec2' | 'vec3' | 'vec4' | 'color' | 'int' | 'texture'
```
-## ShaderReflection — interface
+## ShaderReflection — interface @experimental
```
domain: string
params: ShaderParam[]
```
-## ShaderSources — const
+## ShaderSources — const @experimental
```
{ SPRITE_VERTEX: string; SPRITE_FRAGMENT: string; COLOR_VERTEX: string; COLOR_FRAGMENT: string; }
```
-## ShadowCaster2D — const
+## ShadowCaster2D — const @experimental
```
BuiltinComponentDef<ShadowCaster2DData>
```
-## ShadowCaster2DData — interface
+## ShadowCaster2DData — interface @experimental
```
enabled: boolean
size: Vec2
```
-## ShapeRenderer — const
+## ShapeRenderer — const @experimental
```
BuiltinComponentDef<ShapeRendererData>
```
-## ShapeRendererData — interface
+## ShapeRendererData — interface @experimental
```
color: Color
cornerRadius: number
@@ -6629,19 +6629,19 @@ shapeType: number
size: Vec2
```
-## ShapeType — enum
+## ShapeType — enum @experimental
```
Capsule = 1
Circle = 0
RoundedRect = 2
```
-## Share — const
+## Share — const @experimental
```
ResourceDef<ShareAPI>
```
-## ShareAPI — class
+## ShareAPI — class @experimental
```
available: boolean
setShareCard: (card: ShareCard | (() => ShareCard)) => void
@@ -6650,28 +6650,28 @@ static new (): ShareAPI
static prototype: ShareAPI
```
-## ShareCard — type
+## ShareCard — type @experimental
```
PlatformShareOptions
```
-## SideModuleDescriptor — interface
+## SideModuleDescriptor — interface @experimental
```
file: string
globalName: string | undefined
```
-## SideModuleHost — interface
+## SideModuleHost — interface @experimental
```
acquire: (id: SideModuleId) => Promise<SideModule | null>
```
-## SideModuleId — type
+## SideModuleId — type @experimental
```
BuiltinSideModuleId | (string & {})
```
-## Signal — interface
+## Signal — interface @experimental
```
get: () => T
set: (value: T) => void
@@ -6679,13 +6679,13 @@ subscribe: (fn: (value: T) => void) => () => void
update: (fn: (prev: T) => T) => void
```
-## SimulationSpace — enum
+## SimulationSpace — enum @experimental
```
Local = 1
World = 0
```
-## SliceBorder — interface
+## SliceBorder — interface @experimental
```
bottom: number
left: number
@@ -6693,7 +6693,7 @@ right: number
top: number
```
-## SliderHandle — interface
+## SliderHandle — interface @experimental
```
dispose: () => void
entity: number
@@ -6704,7 +6704,7 @@ setValue: (value: number) => void
trackEntity: number
```
-## SliderOptions — interface
+## SliderOptions — interface @experimental
```
disabled: boolean | undefined
events: UIEventQueue
@@ -6724,19 +6724,19 @@ value: number | undefined
world: World
```
-## SocketReadyState — type
+## SocketReadyState — type @experimental
```
PlatformSocketReadyState
```
-## SourceDelta — interface
+## SourceDelta — interface @experimental
```
added: readonly AddedEntity[]
overrides: readonly PrefabOverride[]
removed: readonly string[]
```
-## SpatialAudioConfig — interface
+## SpatialAudioConfig — interface @experimental
```
maxDistance: number
model: AttenuationModel
@@ -6744,22 +6744,22 @@ refDistance: number
rolloff: number
```
-## SpawnOverride — type
+## SpawnOverride — type @experimental
```
Omit<PrefabOverride, 'prefabEntityId'> & { prefabEntityId?: string }
```
-## Spine — const
+## Spine — const @experimental
```
ResourceDef<SpineManager>
```
-## SpineAnimation — const
+## SpineAnimation — const @experimental
```
BuiltinComponentDef<SpineAnimationData>
```
-## SpineAnimationData — interface
+## SpineAnimationData — interface @experimental
```
animation: string
atlasPath: string
@@ -6777,23 +6777,23 @@ skin: string
timeScale: number
```
-## SpineAnimationDriver — interface
+## SpineAnimationDriver — interface @experimental
```
setAnimation: (entity: Entity, animation: string, loop: boolean) => void
```
-## SpineEvents — const
+## SpineEvents — const @experimental
```
ResourceDef<SpineEventsData>
```
-## SpineLoadResult — interface
+## SpineLoadResult — interface @experimental
```
error: string | undefined
success: boolean
```
-## SpinePlugin — class
+## SpinePlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -6805,7 +6805,7 @@ static new (manager?: SpineManager): SpinePlugin
static prototype: SpinePlugin
```
-## SpineTrack — interface
+## SpineTrack — interface @experimental
```
blendIn: number
childPath: string
@@ -6814,12 +6814,12 @@ name: string
type: "spine"
```
-## Sprite — const
+## Sprite — const @experimental
```
BuiltinComponentDef<SpriteData>
```
-## SpriteAnimClip — interface
+## SpriteAnimClip — interface @experimental
```
events: SpriteAnimEvent[] | undefined
fps: number
@@ -6829,19 +6829,19 @@ loop: boolean
name: string
```
-## SpriteAnimEvent — interface
+## SpriteAnimEvent — interface @experimental
```
data: unknown
frame: number
name: string
```
-## SpriteAnimEventHandler — type
+## SpriteAnimEventHandler — type @experimental
```
(event: SpriteAnimEvent, entity: Entity) => void
```
-## SpriteAnimFrame — interface
+## SpriteAnimFrame — interface @experimental
```
duration: number | undefined
pivot: { x: number; y: number; } | undefined
@@ -6850,7 +6850,7 @@ uvOffset: { x: number; y: number; } | undefined
uvScale: { x: number; y: number; } | undefined
```
-## SpriteAnimTrack — interface
+## SpriteAnimTrack — interface @experimental
```
childPath: string
clip: string
@@ -6859,12 +6859,12 @@ startTime: number
type: "spriteAnim"
```
-## SpriteAnimation — const
+## SpriteAnimation — const @experimental
```
ResourceDef<SpriteAnimationAPI>
```
-## SpriteAnimationAPI — class
+## SpriteAnimationAPI — class @experimental
```
aliasClip: (name: string, clip: SpriteAnimClip) => void
clearClips: () => void
@@ -6881,12 +6881,12 @@ static new (): SpriteAnimationAPI
static prototype: SpriteAnimationAPI
```
-## SpriteAnimator — const
+## SpriteAnimator — const @experimental
```
ComponentDef<SpriteAnimatorData>
```
-## SpriteAnimatorData — interface
+## SpriteAnimatorData — interface @experimental
```
clip: string
currentFrame: number
@@ -6898,7 +6898,7 @@ playing: boolean
speed: number
```
-## SpriteData — interface
+## SpriteData — interface @experimental
```
color: Color
enabled: boolean
@@ -6917,12 +6917,12 @@ uvOffset: Vec2
uvScale: Vec2
```
-## SpriteFilter — const
+## SpriteFilter — const @experimental
```
{ createOutline(options?: OutlineFilterOptions): MaterialHandle; createGlow(options?: OutlineFilterOptions): MaterialHandle; createDropShadow(options?: DropShadowFilterOptions): MaterialHandle; setOutlineColor(material: MaterialHandle, color: { r: number; g: number; b: number; a: number; }): void; setOutlineWidth(material: MaterialHandle, width: number): void; setShadowOffset(material: MaterialHandle, x: number, y: number): void; setShadowBlur(material: MaterialHandle, blur: number): void; }
```
-## StaleOverride — interface
+## StaleOverride — interface @experimental
```
nestedAt: string | undefined
override: PrefabOverride
@@ -6930,18 +6930,18 @@ reason: string
site: "variant" | "nested" | "instance"
```
-## StateMachineAgent — const
+## StateMachineAgent — const @experimental
```
ComponentDef<StateMachineAgentData>
```
-## StateMachineAgentData — interface
+## StateMachineAgentData — interface @experimental
```
current: string
fsm: string
```
-## StateMachines — class
+## StateMachines — class @experimental
```
blackboard: (entity: Entity) => Blackboard
fire: (entity: Entity, trigger: string) => void
@@ -6950,12 +6950,12 @@ static new (states: Map<Entity, AgentState>): StateMachines
static prototype: StateMachines
```
-## Stats — const
+## Stats — const @experimental
```
ResourceDef<FrameStats>
```
-## StatsCollector — class
+## StatsCollector — class @experimental
```
getFps: () => number
getFrameTimeMs: () => number
@@ -6965,7 +6965,7 @@ static new (): StatsCollector
static prototype: StatsCollector
```
-## StatsOverlay — class
+## StatsOverlay — class @experimental
```
dispose: () => void
hide: () => void
@@ -6975,7 +6975,7 @@ static new (container: HTMLElement, position?: StatsPosition): StatsOverlay
static prototype: StatsOverlay
```
-## StatsPlugin — class
+## StatsPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -6984,36 +6984,36 @@ static new (options?: StatsPluginOptions): StatsPlugin
static prototype: StatsPlugin
```
-## StatsPluginOptions — interface
+## StatsPluginOptions — interface @experimental
```
container: HTMLElement | undefined
overlay: boolean | undefined
position: StatsPosition | undefined
```
-## StatsPosition — type
+## StatsPosition — type @experimental
```
'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'
```
-## Status — enum
+## Status — enum @experimental
```
Failure = "failure"
Running = "running"
Success = "success"
```
-## Stick — const
+## Stick — const @experimental
```
(stick: "left" | "right", pad?: number) => Binding
```
-## Storage — const
+## Storage — const @experimental
```
{ getString(key: string, defaultValue?: string): string | undefined; setString(key: string, value: string): void; getNumber(key: string, defaultValue?: number): number | undefined; setNumber(key: string, value: number): void; getBoolean(key: string, defaultValue?: boolean): boolean | undefined; setBoolean(key: string, value: boolean): void; getJSON<T>(key: string, defaultValue?: T): T | undefined; setJSON<T>(key: string, value: T): void; remove(key: string): void; has(key: string): boolean; clear(): void; }
```
-## StreamCell — interface
+## StreamCell — interface @experimental
```
radius: number
scene: string
@@ -7021,34 +7021,34 @@ x: number
y: number
```
-## StreamDecision — interface
+## StreamDecision — interface @experimental
```
toActivate: string[]
toDeactivate: string[]
```
-## StreamPolicy — type
+## StreamPolicy — type @experimental
```
'unload' | 'sleep'
```
-## SubEmitterTrigger — enum
+## SubEmitterTrigger — enum @experimental
```
Birth = 1
Death = 0
```
-## SubmitSkipFlags — const
+## SubmitSkipFlags — const @experimental
```
{ readonly None: 0; readonly Spine: 1; readonly Particles: 2; }
```
-## SubsystemActivity — type
+## SubsystemActivity — type @experimental
```
'stepping' | 'idle' | 'inactive'
```
-## SubsystemEvent — interface
+## SubsystemEvent — interface @experimental
```
atMs: number
detail: string | undefined
@@ -7057,12 +7057,12 @@ phase: SubsystemPhase
seq: number
```
-## SubsystemPhase — type
+## SubsystemPhase — type @experimental
```
'registered' | 'initializing' | 'ready' | 'error'
```
-## SubsystemRegistry — class
+## SubsystemRegistry — class @experimental
```
getStatuses: () => SubsystemStatus[]
markError: (id: string, reason?: string) => void
@@ -7076,7 +7076,7 @@ static new (): SubsystemRegistry
static prototype: SubsystemRegistry
```
-## SubsystemStatus — interface
+## SubsystemStatus — interface @experimental
```
activity: SubsystemActivity
dependsOn: readonly string[]
@@ -7088,17 +7088,17 @@ phase: SubsystemPhase
phaseAgeMs: number
```
-## SwipeDirection — type
+## SwipeDirection — type @experimental
```
'left' | 'right' | 'up' | 'down'
```
-## SyncPrefabResolver — type
+## SyncPrefabResolver — type @experimental
```
(path: string) => PrefabData | null
```
-## SystemDef — interface
+## SystemDef — interface @experimental
```
_fn: (...args: never[]) => void | Promise<void>
_id: symbol
@@ -7108,14 +7108,14 @@ _runAfter: readonly string[] | undefined
_runBefore: readonly string[] | undefined
```
-## SystemOptions — interface
+## SystemOptions — interface @experimental
```
name: string | undefined
runAfter: string[] | undefined
runBefore: string[] | undefined
```
-## SystemParam — type
+## SystemParam — type @experimental
```
| QueryDescriptor<readonly QueryArg[]>
| ResDescriptor<unknown>
@@ -7127,7 +7127,7 @@ runBefore: string[] | undefined
| GetWorldDescriptor
```
-## SystemRunner — class
+## SystemRunner — class @experimental
```
clearTimings: () => void
evict: (systemId: symbol) => void
@@ -7139,7 +7139,7 @@ static new (world: World, resources: ResourceStorage, eventRegistry?: EventRegis
static prototype: SystemRunner
```
-## SystemSet — interface
+## SystemSet — interface @experimental
```
_kind: "set"
_name: string
@@ -7149,7 +7149,7 @@ _runIf: RunCondition | undefined
_systems: readonly SystemDef[]
```
-## SystemSetOptions — interface
+## SystemSetOptions — interface @experimental
```
runAfter: string[] | undefined
runBefore: string[] | undefined
@@ -7157,92 +7157,92 @@ runIf: RunCondition | undefined
systems: SystemDef[]
```
-## TB_E — const
+## TB_E — const @experimental
```
2
```
-## TB_N — const
+## TB_N — const @experimental
```
1
```
-## TB_NE — const
+## TB_NE — const @experimental
```
16
```
-## TB_NW — const
+## TB_NW — const @experimental
```
128
```
-## TB_S — const
+## TB_S — const @experimental
```
4
```
-## TB_SE — const
+## TB_SE — const @experimental
```
32
```
-## TB_SW — const
+## TB_SW — const @experimental
```
64
```
-## TB_W — const
+## TB_W — const @experimental
```
8
```
-## TERRAIN_NEIGHBORS — const
+## TERRAIN_NEIGHBORS — const @experimental
```
readonly { dx: number; dy: number; bit: number; }[]
```
-## THEME_COLOR_ROLES — const
+## THEME_COLOR_ROLES — const @experimental
```
readonly (keyof ThemeColors)[]
```
-## TILESET_FORMAT_VERSION — const
+## TILESET_FORMAT_VERSION — const @experimental
```
"1"
```
-## TILE_FLAGS_MASK — const
+## TILE_FLAGS_MASK — const @experimental
```
number
```
-## TILE_FLIP_D — const
+## TILE_FLIP_D — const @experimental
```
32768
```
-## TILE_FLIP_H — const
+## TILE_FLIP_H — const @experimental
```
8192
```
-## TILE_FLIP_V — const
+## TILE_FLIP_V — const @experimental
```
16384
```
-## TILE_ID_MASK — const
+## TILE_ID_MASK — const @experimental
```
8191
```
-## TParams — type
+## TParams — type @experimental
```
Record<string, string | number>
```
-## Takeover — interface
+## Takeover — interface @experimental
```
active: boolean
around: <T>(show: () => Promise<T>) => Promise<T>
@@ -7250,7 +7250,7 @@ begin: () => void
end: () => void
```
-## TakeoverHost — interface
+## TakeoverHost — interface @experimental
```
isPaused: () => boolean
resumeAudio: () => void
@@ -7258,40 +7258,40 @@ setPaused: (paused: boolean) => void
suspendAudio: () => void
```
-## TerrainColor — interface
+## TerrainColor — interface @experimental
```
color: string
name: string
```
-## TerrainIndex — interface
+## TerrainIndex — interface @experimental
```
byMask: Map<number, number>
mode: TerrainMode
```
-## TerrainIndices — interface
+## TerrainIndices — interface @experimental
```
sets: Map<number, TerrainIndex>
tileTerrain: Map<number, number>
```
-## TerrainMode — type
+## TerrainMode — type @experimental
```
'edge' | 'corner' | 'wang'
```
-## Text — const
+## Text — const @experimental
```
ComponentDef<TextData>
```
-## TextAlign — type
+## TextAlign — type @experimental
```
(typeof TextAlign)[keyof typeof TextAlign]
```
-## TextData — interface
+## TextData — interface @experimental
```
align: TextAlign
bold: boolean
@@ -7318,7 +7318,7 @@ verticalAlign: TextVerticalAlign
wordWrap: boolean
```
-## TextInit — interface
+## TextInit — interface @experimental
```
align: TextAlign | undefined
bold: boolean | undefined
@@ -7345,12 +7345,12 @@ verticalAlign: TextVerticalAlign | undefined
wordWrap: boolean | undefined
```
-## TextInput — const
+## TextInput — const @experimental
```
ComponentDef<TextInputData>
```
-## TextInputData — interface
+## TextInputData — interface @experimental
```
backgroundColor: Color
color: Color
@@ -7372,7 +7372,7 @@ textAlign: TextAlign
value: string
```
-## TextInputHandle — interface
+## TextInputHandle — interface @experimental
```
dispose: () => void
entity: number
@@ -7380,7 +7380,7 @@ getValue: () => string
setValue: (value: string) => void
```
-## TextInputOptions — interface
+## TextInputOptions — interface @experimental
```
backgroundColor: Color | undefined
color: Color | undefined
@@ -7405,7 +7405,7 @@ value: string | undefined
world: World
```
-## TextInputPlugin — class
+## TextInputPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -7415,19 +7415,19 @@ static new (): TextInputPlugin
static prototype: TextInputPlugin
```
-## TextMetrics — interface
+## TextMetrics — interface @experimental
```
height: number
lineCount: number
width: number
```
-## TextOverflow — type
+## TextOverflow — type @experimental
```
(typeof TextOverflow)[keyof typeof TextOverflow]
```
-## TextPlugin — class
+## TextPlugin — class @experimental
```
build: (app: App) => void
name: string
@@ -7435,12 +7435,12 @@ static new (): TextPlugin
static prototype: TextPlugin
```
-## TextRenderMode — type
+## TextRenderMode — type @experimental
```
(typeof TextRenderMode)[keyof typeof TextRenderMode]
```
-## TextSegment — interface
+## TextSegment — interface @experimental
```
bold: boolean
color: Color | null
@@ -7450,46 +7450,46 @@ text: string
type: "text"
```
-## TextVerticalAlign — type
+## TextVerticalAlign — type @experimental
```
(typeof TextVerticalAlign)[keyof typeof TextVerticalAlign]
```
-## TextureDimensions — interface
+## TextureDimensions — interface @experimental
```
height: number
width: number
```
-## TextureFilter — type
+## TextureFilter — type @experimental
```
(typeof TextureFilter)[keyof typeof TextureFilter]
```
-## TextureHandle — type
+## TextureHandle — type @experimental
```
number
```
-## TextureInfo — interface
+## TextureInfo — interface @experimental
```
handle: number
height: number
width: number
```
-## TextureRef — interface
+## TextureRef — interface @experimental
```
slot: number | undefined
textureId: number
```
-## TextureWrap — type
+## TextureWrap — type @experimental
```
(typeof TextureWrap)[keyof typeof TextureWrap]
```
-## ThemeColors — interface
+## ThemeColors — interface @experimental
```
backdrop: Color
control: Color
@@ -7506,18 +7506,18 @@ text: Color
track: Color
```
-## ThemeOverrides — interface
+## ThemeOverrides — interface @experimental
```
colors: Partial<ThemeColors> | undefined
type: Partial<ThemeType> | undefined
```
-## ThemeStyle — const
+## ThemeStyle — const @experimental
```
ComponentDef<ThemeStyleData>
```
-## ThemeStyleData — interface
+## ThemeStyleData — interface @experimental
```
input: { background?: ColorRole; text?: ColorRole; placeholder?: ColorRole; } | undefined
states: Record<string, keyof ThemeColors> | undefined
@@ -7525,20 +7525,20 @@ text: keyof ThemeColors | undefined
visual: keyof ThemeColors | undefined
```
-## ThemeTokens — interface
+## ThemeTokens — interface @experimental
```
colors: ThemeColors
type: ThemeType
```
-## ThemeType — interface
+## ThemeType — interface @experimental
```
body: number
label: number
title: number
```
-## TileCollisionPiece — interface
+## TileCollisionPiece — interface @experimental
```
center: Vec2
circles: { c: Vec2; r: number; }[]
@@ -7547,21 +7547,21 @@ polylines: Vec2[][]
sensor: boolean
```
-## TileCollisionShape — type
+## TileCollisionShape — type @experimental
```
| { type: 'box' }
| { type: 'polygon'; points: [number, number][] }
| { type: 'circle'; cx: number; cy: number; r: number }
```
-## TileFlags — interface
+## TileFlags — interface @experimental
```
flipD: boolean
flipH: boolean
flipV: boolean
```
-## TileGridParams — interface
+## TileGridParams — interface @experimental
```
hexSideLength: number | undefined
orientation: number
@@ -7571,7 +7571,7 @@ tileHeight: number
tileWidth: number
```
-## TileOrientation — enum
+## TileOrientation — enum @experimental
```
Hexagonal = 3
Isometric = 1
@@ -7579,14 +7579,14 @@ Orthogonal = 0
Staggered = 2
```
-## TileStamp — interface
+## TileStamp — interface @experimental
```
cells: number[]
h: number
w: number
```
-## TiledLayerData — interface
+## TiledLayerData — interface @experimental
```
chunks: TiledChunkData[]
height: number
@@ -7601,7 +7601,7 @@ visible: boolean
width: number
```
-## TiledMapData — interface
+## TiledMapData — interface @experimental
```
collisionTileIds: number[]
height: number
@@ -7620,7 +7620,7 @@ tilesets: TiledTilesetData[]
width: number
```
-## TiledTilesetData — interface
+## TiledTilesetData — interface @experimental
```
collectionTiles: TiledCollectionTile[] | undefined
columns: number
@@ -7634,27 +7634,27 @@ tileHeight: number
tileWidth: number
```
-## Tilemap — const
+## Tilemap — const @experimental
```
ComponentDef<TilemapData>
```
-## TilemapAPI — const
+## TilemapAPI — const @experimental
```
{ initLayer(entity: number, width: number, height: number, tileWidth: number, tileHeight: number): void; destroyLayer(entity: number): void; setTile(entity: number, x: number, y: number, tileId: number): void; getTile(entity: number, x: number, y: number): number; fillRect(entity: number, x: number, y: number, w: number, h: number, tileId: number): void; setTiles(entity: number, tiles: Uint16Array): void; setTilesets(entity: number, slots: { firstId: number; textureHandle: number; columns: number; margin?: number; spacing?: number; }[]): void; hasLayer(entity: number): boolean; setRenderProps(entity: number, textureHandle: number, tilesetColumns: number, uvTileW: number, uvTileH: number, sortLayer: number, depth: number, parallaxX: number, parallaxY: number): void; setTint(entity: number, r: number, g: number, b: number, a: number, opacity: number): void; setVisible(entity: number, visible: boolean): void; setOriginEntity(layerKey: number, originEntity: number): void; setTileAnimation(entity: number, tileId: number, frames: { tileId: number; duration: number; }[]): void; clearTileAnimations(entity: number): void; advanceAnimations(entity: number, dtMs: number): void; setTileProperty(entity: number, tileId: number, key: string, value: string): void; getTileProperty(entity: number, x: number, y: number, key: string): string; flipTile(entity: number, x: number, y: number, flipH: boolean, flipV: boolean, flipD: boolean): void; rotateTile(entity: number, x: number, y: number, degrees: number): void; initInfiniteLayer(entity: number, tileWidth: number, tileHeight: number): void; setChunkTiles(entity: number, chunkX: number, chunkY: number, tiles: Uint16Array, width: number, height: number): void; setGridType(entity: number, type: number): void; setHexParams(entity: number, sideLength: number, staggerAxisX: boolean, staggerIndexEven: boolean): void; tileToWorld(entity: number, tx: number, ty: number, originX: number, originY: number): { x: number; y: number; }; worldToTile(entity: number, wx: number, wy: number, originX: number, originY: number): { x: number; y: number; }; exportChunks(entity: number): string; importChunks(entity: number, encoded: string): boolean; }
```
-## TilemapData — interface
+## TilemapData — interface @experimental
```
source: string
```
-## TilemapLayer — const
+## TilemapLayer — const @experimental
```
BuiltinComponentDef<TilemapLayerData>
```
-## TilemapLayerData — interface
+## TilemapLayerData — interface @experimental
```
cellSize: Vec2
hexSideLength: number
@@ -7672,12 +7672,12 @@ tintColor: Color
visible: boolean
```
-## TilemapLiveSync — const
+## TilemapLiveSync — const @experimental
```
{ _bind(fn: ApplyTilesetRefs | null): void; setLayerTilesets(entity: number, refs: readonly string[]): void; }
```
-## TilemapPlugin — class
+## TilemapPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -7687,18 +7687,18 @@ static new (): TilemapPlugin
static prototype: TilemapPlugin
```
-## Tilemaps — const
+## Tilemaps — const @experimental
```
ResourceDef<{ initLayer(entity: number, width: number, height: number, tileWidth: number, tileHeight: number): void; destroyLayer(entity: number): void; setTile(entity: number, x: number, y: number, tileId: number): void; getTile(entity: number, x: number, y: number): number; fillRect(entity: number, x: number, y: number, w: number, h: number, tileId: number): void; setTiles(entity: number, tiles: Uint16Array): void; setTilesets(entity: number, slots: { firstId: number; textureHandle: number; columns: number; margin?: number; spacing?: number; }[]): void; hasLayer(entity: number): boolean; setRenderProps(entity: number, textureHandle: number, tilesetColumns: number, uvTileW: number, uvTileH: number, sortLayer: number, depth: number, parallaxX: number, parallaxY: number): void; setTint(entity: number, r: number, g: number, b: number, a: number, opacity: number): void; setVisible(entity: number, visible: boolean): void; setOriginEntity(layerKey: number, originEntity: number): void; setTileAnimation(entity: number, tileId: number, frames: { tileId: number; duration: number; }[]): void; clearTileAnimations(entity: number): void; advanceAnimations(entity: number, dtMs: number): void; setTileProperty(entity: number, tileId: number, key: string, value: string): void; getTileProperty(entity: number, x: number, y: number, key: string): string; flipTile(entity: number, x: number, y: number, flipH: boolean, flipV: boolean, flipD: boolean): void; rotateTile(entity: number, x: number, y: number, degrees: number): void; initInfiniteLayer(entity: number, tileWidth: number, tileHeight: number): void; setChunkTiles(entity: number, chunkX: number, chunkY: number, tiles: Uint16Array, width: number, height: number): void; setGridType(entity: number, type: number): void; setHexParams(entity: number, sideLength: number, staggerAxisX: boolean, staggerIndexEven: boolean): void; tileToWorld(entity: number, tx: number, ty: number, originX: number, originY: number): { x: number; y: number; }; worldToTile(entity: number, wx: number, wy: number, originX: number, originY: number): { x: number; y: number; }; exportChunks(entity: number): string; importChunks(entity: number, encoded: string): boolean; }>
```
-## TilesetAnimFrame — interface
+## TilesetAnimFrame — interface @experimental
```
durationMs: number
tile: number
```
-## TilesetAsset — interface
+## TilesetAsset — interface @experimental
```
columns: number
margin: number
@@ -7712,7 +7712,7 @@ tiles: Record<number, TilesetTile>
version: string
```
-## TilesetCollision — type
+## TilesetCollision — type @experimental
```
TileCollisionShape & {
/** One-way (jump-through) platform: contacts from behind this normal pass through. */
@@ -7726,7 +7726,7 @@ TileCollisionShape & {
}
```
-## TilesetModel — interface
+## TilesetModel — interface @experimental
```
animations: Map<number, { tileId: number; duration: number; }[]>
collidableTileIds: number[]
@@ -7734,7 +7734,7 @@ slots: TilesetModelSlot[]
tileShapes: Map<number, ResolvedTileCollision>
```
-## TilesetTerrain — interface
+## TilesetTerrain — interface @experimental
```
color: string | undefined
colors: TerrainColor[] | undefined
@@ -7742,7 +7742,7 @@ mode: TerrainMode
name: string
```
-## TilesetTile — interface
+## TilesetTile — interface @experimental
```
animation: TilesetAnimFrame[] | undefined
collision: TilesetCollision | undefined
@@ -7751,19 +7751,19 @@ properties: Record<string, string> | undefined
terrain: TilesetTileTerrain | undefined
```
-## TilesetTileTerrain — interface
+## TilesetTileTerrain — interface @experimental
```
corners: number[] | undefined
mask: number | undefined
set: number
```
-## Time — const
+## Time — const @experimental
```
ResourceDef<TimeData>
```
-## TimeData — interface
+## TimeData — interface @experimental
```
delta: number
elapsed: number
@@ -7775,12 +7775,12 @@ scale: number
unscaledDelta: number
```
-## Timeline — const
+## Timeline — const @experimental
```
ResourceDef<TimelineAPI>
```
-## TimelineAPI — class
+## TimelineAPI — class @experimental
```
clearStates: () => void
ensureState: (entity: Entity, wrapMode: WrapMode, speed: number) => TimelineState
@@ -7796,7 +7796,7 @@ static new (flags_?: PlayerFlagChannel | null): TimelineAPI
static prototype: TimelineAPI
```
-## TimelineAsset — interface
+## TimelineAsset — interface @experimental
```
duration: number
tracks: Track[]
@@ -7805,12 +7805,12 @@ version: string
wrapMode: WrapMode
```
-## TimelinePlayer — const
+## TimelinePlayer — const @experimental
```
ComponentDef<TimelinePlayerData>
```
-## TimelinePlayerData — interface
+## TimelinePlayerData — interface @experimental
```
finished: boolean
playing: boolean
@@ -7819,7 +7819,7 @@ timeline: string
wrapMode: string
```
-## TimelinePlugin — class
+## TimelinePlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -7833,7 +7833,7 @@ static new (): TimelinePlugin
static prototype: TimelinePlugin
```
-## TimerHandle — class
+## TimerHandle — class @experimental
```
cancel: () => void
elapsed: number
@@ -7847,7 +7847,7 @@ static new (manager: TimerManager, id: number): TimerHandle
static prototype: TimerHandle
```
-## TimerManager — class
+## TimerManager — class @experimental
```
activeCount: number
cancel: (id: number) => void
@@ -7866,12 +7866,12 @@ static new (): TimerManager
static prototype: TimerManager
```
-## TimerRes — const
+## TimerRes — const @experimental
```
ResourceDef<TimerManager>
```
-## ToggleHandle — interface
+## ToggleHandle — interface @experimental
```
dispose: () => void
entity: number
@@ -7880,7 +7880,7 @@ setDisabled: (disabled: boolean) => void
setValue: (value: boolean) => void
```
-## ToggleOptions — interface
+## ToggleOptions — interface @experimental
```
background: UIVisualInit | undefined
check: { node?: UINodeInit; color?: Color; sprite?: number; } | undefined
@@ -7896,29 +7896,29 @@ tabIndex: number | undefined
world: World
```
-## TouchPoint — interface
+## TouchPoint — interface @experimental
```
id: number
x: number
y: number
```
-## Track — type
+## Track — type @experimental
```
PropertyTrack | SpineTrack | SpriteAnimTrack | AudioTrack | ActivationTrack | MarkerTrack | CustomEventTrack | AnimFramesTrack
```
-## TrackType — type
+## TrackType — type @experimental
```
(typeof TrackType)[keyof typeof TrackType]
```
-## Trail — const
+## Trail — const @experimental
```
ResourceDef<TrailAPI>
```
-## TrailAPI — class
+## TrailAPI — class @experimental
```
clear: (entity: Entity) => void
update: (dt: number) => void
@@ -7926,7 +7926,7 @@ static new (module: NonNullable<EngineApi>, registry: CppRegistry): TrailAPI
static prototype: TrailAPI
```
-## TrailPlugin — class
+## TrailPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -7935,12 +7935,12 @@ static new (): TrailPlugin
static prototype: TrailPlugin
```
-## TrailRenderer — const
+## TrailRenderer — const @experimental
```
BuiltinComponentDef<TrailRendererData>
```
-## TrailRendererData — interface
+## TrailRendererData — interface @experimental
```
blendMode: number
emitting: boolean
@@ -7956,7 +7956,7 @@ texture: number
time: number
```
-## Transaction — class
+## Transaction — class @experimental
```
add: (op: TransactionOp) => void
addDeferred: (op: TransactionOp) => void
@@ -7970,7 +7970,7 @@ static new (label: string, id?: string): Transaction
static prototype: Transaction
```
-## TransactionManager — class
+## TransactionManager — class @experimental
```
begin: (label: string) => Transaction
canRedo: () => boolean
@@ -7986,23 +7986,23 @@ static new (options?: TransactionManagerOptions): TransactionManager
static prototype: TransactionManager
```
-## TransactionManagerOptions — interface
+## TransactionManagerOptions — interface @experimental
```
historyLimit: number | undefined
```
-## TransactionOp — interface
+## TransactionOp — interface @experimental
```
forward: () => void
reverse: () => void
```
-## Transform — const
+## Transform — const @experimental
```
BuiltinComponentDef<TransformData>
```
-## TransformData — interface
+## TransformData — interface @experimental
```
position: Vec3
rotation: Quat
@@ -8012,14 +8012,14 @@ worldRotation: Quat
worldScale: Vec3
```
-## TransitionConfig — interface
+## TransitionConfig — interface @experimental
```
color: Color | undefined
duration: number
type: "fade"
```
-## TransitionOptions — interface
+## TransitionOptions — interface @experimental
```
color: Color | undefined
duration: number | undefined
@@ -8029,12 +8029,12 @@ onStart: (() => void) | undefined
transition: "fade" | "none" | undefined
```
-## Tween — const
+## Tween — const @experimental
```
ResourceDef<TweenAPI>
```
-## TweenAPI — class
+## TweenAPI — class @experimental
```
activeCompositionCount: number
cancel: (tweenHandle: TweenHandle) => void
@@ -8050,12 +8050,12 @@ static new (module: AnimCore, registry: CppRegistry): TweenAPI
static prototype: TweenAPI
```
-## TweenFactory — type
+## TweenFactory — type @experimental
```
() => Completable
```
-## TweenGroup — class
+## TweenGroup — class @experimental
```
cancel: () => void
checkComplete: () => boolean
@@ -8067,7 +8067,7 @@ static new (tweens: Completable[]): TweenGroup
static prototype: TweenGroup
```
-## TweenHandle — class
+## TweenHandle — class @experimental
```
bezier: (p1x: number, p1y: number, p2x: number, p2y: number) => TweenHandle
cancel: () => void
@@ -8080,7 +8080,7 @@ static new (module: AnimCore, registry: CppRegistry, valueManager: ValueTweenMan
static prototype: TweenHandle
```
-## TweenOptions — interface
+## TweenOptions — interface @experimental
```
delay: number | undefined
easing: EasingType | undefined
@@ -8088,7 +8088,7 @@ loop: LoopMode | undefined
loopCount: number | undefined
```
-## TweenSequence — class
+## TweenSequence — class @experimental
```
cancel: () => void
checkComplete: () => boolean
@@ -8100,17 +8100,17 @@ static new (factories: TweenFactory[]): TweenSequence
static prototype: TweenSequence
```
-## TweenState — type
+## TweenState — type @experimental
```
(typeof TweenState)[keyof typeof TweenState]
```
-## TweenTarget — type
+## TweenTarget — type @experimental
```
(typeof TweenTarget)[keyof typeof TweenTarget]
```
-## UICameraData — interface
+## UICameraData — interface @experimental
```
screenH: number
screenW: number
@@ -8128,44 +8128,44 @@ worldRight: number
worldTop: number
```
-## UICameraInfo — const
+## UICameraInfo — const @experimental
```
ResourceDef<UICameraData>
```
-## UIController — const
+## UIController — const @experimental
```
ComponentDef<UIControllerData>
```
-## UIControllerData — interface
+## UIControllerData — interface @experimental
```
controllers: ControllerState[]
```
-## UIDialog — const
+## UIDialog — const @experimental
```
ComponentDef<UIDialogData>
```
-## UIDialogData — interface
+## UIDialogData — interface @experimental
```
closeOnBackdrop: boolean
closeOnEscape: boolean
```
-## UIDisplay — enum
+## UIDisplay — enum @experimental
```
Flex = 0
None = 1
```
-## UIDropdown — const
+## UIDropdown — const @experimental
```
ComponentDef<UIDropdownData>
```
-## UIDropdownData — interface
+## UIDropdownData — interface @experimental
```
label: number
optionHeight: number
@@ -8173,7 +8173,7 @@ options: string[]
selectedIndex: number
```
-## UIEntityInit — interface
+## UIEntityInit — interface @experimental
```
node: UINodeInit | undefined
parent: number | undefined
@@ -8182,7 +8182,7 @@ visual: UIVisualInit | undefined
world: World
```
-## UIEvent — interface
+## UIEvent — interface @experimental
```
currentTarget: number
data: TData
@@ -8194,12 +8194,12 @@ target: number
type: string
```
-## UIEventHandler — type
+## UIEventHandler — type @experimental
```
(event: EntityEvent<TData>) => void
```
-## UIEventQueue — class
+## UIEventQueue — class @experimental
```
clear: () => void
drain: () => readonly EntityEvent[]
@@ -8213,32 +8213,32 @@ static new (): EntityEventQueue
static prototype: EntityEventQueue
```
-## UIEventType — type
+## UIEventType — type @experimental
```
typeof UIEventType[keyof typeof UIEventType]
```
-## UIEvents — const
+## UIEvents — const @experimental
```
ResourceDef<EntityEventQueue>
```
-## UIGear — const
+## UIGear — const @experimental
```
ComponentDef<UIGearData>
```
-## UIGearData — interface
+## UIGearData — interface @experimental
```
bindings: GearBinding[]
```
-## UIInteraction — const
+## UIInteraction — const @experimental
```
BuiltinComponentDef<UIInteractionData>
```
-## UIInteractionData — interface
+## UIInteractionData — interface @experimental
```
hovered: boolean
justPressed: boolean
@@ -8246,7 +8246,7 @@ justReleased: boolean
pressed: boolean
```
-## UIInteractionPlugin — class
+## UIInteractionPlugin — class @experimental
```
build: (app: App) => void
dependencies: "uiLayout"[]
@@ -8255,17 +8255,17 @@ static new (): UIInteractionPlugin
static prototype: UIInteractionPlugin
```
-## UILayoutGeneration — const
+## UILayoutGeneration — const @experimental
```
ResourceDef<UILayoutGenerationData>
```
-## UILayoutGenerationData — interface
+## UILayoutGenerationData — interface @experimental
```
generation: number
```
-## UILayoutPlugin — class
+## UILayoutPlugin — class @experimental
```
build: (app: App) => void
name: string
@@ -8273,19 +8273,19 @@ static new (): UILayoutPlugin
static prototype: UILayoutPlugin
```
-## UIMask — const
+## UIMask — const @experimental
```
BuiltinComponentDef<UIMaskData>
```
-## UIMaskData — interface
+## UIMaskData — interface @experimental
```
alphaCutoff: number
enabled: boolean
mode: MaskMode
```
-## UIMaskPlugin — class
+## UIMaskPlugin — class @experimental
```
build: (app: App) => void
name: "uiMask"
@@ -8293,12 +8293,12 @@ static new (): UIMaskPlugin
static prototype: UIMaskPlugin
```
-## UINode — const
+## UINode — const @experimental
```
BuiltinComponentDef<UINodeData>
```
-## UINodeInit — interface
+## UINodeInit — interface @experimental
```
fill: boolean | undefined
flexGrow: number | undefined
@@ -8318,7 +8318,7 @@ position: number | undefined
width: Dimension | undefined
```
-## UIPlugin — class
+## UIPlugin — class @experimental
```
attachScrollContainer: (entity: Entity, container: ScrollContainer) => void
build: (app: App) => void
@@ -8332,19 +8332,19 @@ static new (): UIPlugin
static prototype: UIPlugin
```
-## UIPointerEvents — enum
+## UIPointerEvents — enum @experimental
```
Auto = 0
None = 1
```
-## UIPositionType — enum
+## UIPositionType — enum @experimental
```
Absolute = 1
Relative = 0
```
-## UIRenderOrderPlugin — class
+## UIRenderOrderPlugin — class @experimental
```
after: ("text" | "uiInteraction" | "uiMask")[]
build: (app: App) => void
@@ -8354,12 +8354,12 @@ static new (): UIRenderOrderPlugin
static prototype: UIRenderOrderPlugin
```
-## UISlider — const
+## UISlider — const @experimental
```
ComponentDef<UISliderData>
```
-## UISliderData — interface
+## UISliderData — interface @experimental
```
fill: number
handle: number
@@ -8369,18 +8369,18 @@ step: number
value: number
```
-## UIToggle — const
+## UIToggle — const @experimental
```
ComponentDef<UIToggleData>
```
-## UIToggleData — interface
+## UIToggleData — interface @experimental
```
check: number
isOn: boolean
```
-## UIVisibilityPlugin — class
+## UIVisibilityPlugin — class @experimental
```
build: (app: App) => void
dependencies: "uiInteraction"[]
@@ -8389,12 +8389,12 @@ static new (): UIVisibilityPlugin
static prototype: UIVisibilityPlugin
```
-## UIVisual — const
+## UIVisual — const @experimental
```
BuiltinComponentDef<UIVisualData>
```
-## UIVisualData — interface
+## UIVisualData — interface @experimental
```
color: Color
enabled: boolean
@@ -8411,7 +8411,7 @@ uvScale: Vec2
visualType: UIVisualType
```
-## UIVisualInit — interface
+## UIVisualInit — interface @experimental
```
color: { r: number; g: number; b: number; a: number; } | undefined
enabled: boolean | undefined
@@ -8428,7 +8428,7 @@ uvScale: Vec2 | undefined
visualType: UIVisualType | undefined
```
-## UIVisualType — enum
+## UIVisualType — enum @experimental
```
Filled = 5
Image = 2
@@ -8438,23 +8438,23 @@ SolidColor = 1
Tiled = 4
```
-## UniformValue — type
+## UniformValue — type @experimental
```
number | Vec2 | Vec3 | Vec4 | number[] | TextureRef
```
-## Unsubscribe — type
+## Unsubscribe — type @experimental
```
() => void
```
-## ValidatePrefabOptions — interface
+## ValidatePrefabOptions — interface @experimental
```
instanceOverrides: readonly PrefabOverride[] | undefined
loadPrefab: ((path: string) => PrefabData | null) | undefined
```
-## ValidateResult — interface
+## ValidateResult — interface @experimental
```
duplicateIds: string[]
invalidIds: string[]
@@ -8462,7 +8462,7 @@ orphanedChildren: string[]
stale: StaleOverride[]
```
-## ValueTweenHandle — class
+## ValueTweenHandle — class @experimental
```
bezier: (p1x: number, p1y: number, p2x: number, p2y: number) => ValueTweenHandle
cancel: () => void
@@ -8476,26 +8476,26 @@ static new (manager: ValueTweenManager, id: number): ValueTweenHandle
static prototype: ValueTweenHandle
```
-## Vec2 — interface
+## Vec2 — interface @experimental
```
x: number
y: number
```
-## Vec2Like — interface
+## Vec2Like — interface @experimental
```
x: number
y: number
```
-## Vec3 — interface
+## Vec3 — interface @experimental
```
x: number
y: number
z: number
```
-## Vec4 — interface
+## Vec4 — interface @experimental
```
w: number
x: number
@@ -8503,29 +8503,29 @@ y: number
z: number
```
-## Velocity — const
+## Velocity — const @experimental
```
BuiltinComponentDef<VelocityData>
```
-## VelocityData — interface
+## VelocityData — interface @experimental
```
angular: Vec3
linear: Vec3
```
-## VertexAttributeDescriptor — interface
+## VertexAttributeDescriptor — interface @experimental
```
name: string
type: DataType
```
-## Video — const
+## Video — const @experimental
```
ComponentDef<VideoData>
```
-## VideoAPI — class
+## VideoAPI — class @experimental
```
backendName: string
baseUrl: string
@@ -8539,7 +8539,7 @@ static new (backend: PlatformVideoBackend): VideoAPI
static prototype: VideoAPI
```
-## VideoData — interface
+## VideoData — interface @experimental
```
autoplay: boolean
enabled: boolean
@@ -8551,22 +8551,22 @@ source: string
volume: number
```
-## VideoHandle — type
+## VideoHandle — type @experimental
```
VideoStreamHandle
```
-## VideoPlayOptions — type
+## VideoPlayOptions — type @experimental
```
VideoStreamOptions
```
-## VideoPlayer — const
+## VideoPlayer — const @experimental
```
ResourceDef<VideoAPI>
```
-## VideoPlugin — class
+## VideoPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -8576,7 +8576,7 @@ static new (): VideoPlugin
static prototype: VideoPlugin
```
-## VideoStreamHandle — interface
+## VideoStreamHandle — interface @experimental
```
bytes: number | undefined
currentTime: number
@@ -8601,7 +8601,7 @@ textureHandle: number
width: number
```
-## VideoStreamOptions — interface
+## VideoStreamOptions — interface @experimental
```
audioTrackUrl: string | undefined
autoplay: boolean | undefined
@@ -8611,7 +8611,7 @@ playbackRate: number | undefined
volume: number | undefined
```
-## Viewport — interface
+## Viewport — interface @experimental
```
h: number
w: number
@@ -8619,28 +8619,28 @@ x: number
y: number
```
-## Virtual — const
+## Virtual — const @experimental
```
(id: string) => Binding
```
-## WangIndex — interface
+## WangIndex — interface @experimental
```
byKey: Map<number, number>
```
-## WangIndices — interface
+## WangIndices — interface @experimental
```
sets: Map<number, WangIndex>
tileTerrain: Map<number, number>
```
-## WeChatSideModuleFactories — type
+## WeChatSideModuleFactories — type @experimental
```
Partial<Record<SideModuleId, EmscriptenFactory>>
```
-## WeChatSocket — class
+## WeChatSocket — class @experimental
```
close: (code?: number, reason?: string) => void
connect: () => void
@@ -8651,7 +8651,7 @@ static new (options: GameSocketOptions): WeChatSocket
static prototype: WeChatSocket
```
-## WebAppOptions — interface
+## WebAppOptions — interface @experimental
```
colorSpace: "gamma" | "linear" | undefined
depthLayers: number | undefined
@@ -8664,34 +8664,34 @@ sideModules: SideModuleHost | undefined
ySortLayers: number | undefined
```
-## WeldJoint — const
+## WeldJoint — const @experimental
```
ComponentDef<WeldJointData>
```
-## WheelJoint — const
+## WheelJoint — const @experimental
```
ComponentDef<WheelJointData>
```
-## WidgetInteractionInit — interface
+## WidgetInteractionInit — interface @experimental
```
disabled: boolean | undefined
focusable: boolean | undefined
tabIndex: number | undefined
```
-## With — function
+## With — function @experimental
```
(component: AnyComponentDef): FilterExpr
```
-## Without — function
+## Without — function @experimental
```
(component: AnyComponentDef): FilterExpr
```
-## World — class
+## World — class @experimental
```
advanceTick: () => void
anyChangedSince: (component: AnyComponentDef, sinceTick: number) => boolean
@@ -8746,7 +8746,7 @@ static new (): World
static prototype: World
```
-## WorldRect — interface
+## WorldRect — interface @experimental
```
bottom: number
left: number
@@ -8754,62 +8754,62 @@ right: number
top: number
```
-## WorldTransform — const
+## WorldTransform — const @experimental
```
BuiltinComponentDef<TransformData>
```
-## WorldTransformData — type
+## WorldTransformData — type @experimental
```
TransformData
```
-## WrapMode — type
+## WrapMode — type @experimental
```
(typeof WrapMode)[keyof typeof WrapMode]
```
-## actionRefArg — function
+## actionRefArg — function @experimental
```
(ref: FsmActionRef | undefined): string | undefined
```
-## actionRefName — function
+## actionRefName — function @experimental
```
(ref: FsmActionRef | undefined): string
```
-## actionRefParams — function
+## actionRefParams — function @experimental
```
(ref: FsmActionRef | undefined): Record<string, AiParamValue> | undefined
```
-## activeRemoteRoot — function
+## activeRemoteRoot — function @experimental
```
(config: AssetGroupsConfig | null | undefined): string | undefined
```
-## addAnimatorParam — function
+## addAnimatorParam — function @experimental
```
(def: AnimatorControllerDef, name: string, type: AnimatorParamType): AnimatorControllerDef
```
-## addAnimatorState — function
+## addAnimatorState — function @experimental
```
(def: AnimatorControllerDef, name: string, x?: number, y?: number): AnimatorControllerDef
```
-## addAnimatorTransition — function
+## addAnimatorTransition — function @experimental
```
(def: AnimatorControllerDef, from: string, to: string): AnimatorControllerDef
```
-## addBtChild — function
+## addBtChild — function @experimental
```
(def: BtDefinition, parentId: string, type: BtNodeType, x?: number, y?: number): BtDefinition
```
-## addBtOrphan — function
+## addBtOrphan — function @experimental
```
(def: BtDefinition, type: BtNodeType, x?: number, y?: number): BtDefinition
```
@@ -8819,397 +8819,397 @@ TransformData
(g: MaterialGraph, type: GraphNodeType, x: number, y: number): { graph: MaterialGraph; id: string; }
```
-## addStartupSystem — function
+## addStartupSystem — function @experimental
```
(system: SystemDef): void
```
-## addState — function
+## addState — function @experimental
```
(def: FsmDefinition, name: string, x?: number, y?: number): FsmDefinition
```
-## addSystem — function
+## addSystem — function @experimental
```
(system: SystemDef): void
```
-## addSystemSetToSchedule — function
+## addSystemSetToSchedule — function @experimental
```
(schedule: Schedule, set: SystemSet): void
```
-## addSystemToSchedule — function
+## addSystemToSchedule — function @experimental
```
(schedule: Schedule, system: SystemDef): void
```
-## addTransition — function
+## addTransition — function @experimental
```
(def: FsmDefinition, from: string, to: string): FsmDefinition
```
-## agentBlackboard — function
+## agentBlackboard — function @experimental
```
(states: Map<Entity, AgentState>, entity: Entity): Blackboard
```
-## agentBtBlackboard — function
+## agentBtBlackboard — function @experimental
```
(states: Map<Entity, BtAgentState>, entity: Entity): Blackboard
```
-## aiRegistry — const
+## aiRegistry — const @experimental
```
AiRegistry<AiContext>
```
-## analyzeCensusSeries — function
+## analyzeCensusSeries — function @experimental
```
(samples: readonly Census[], opts?: CensusSeriesOptions): CensusReport
```
-## anchorPresetFields — function
+## anchorPresetFields — function @experimental
```
(preset: AnchorPreset): AnchorFields
```
-## animClipCellRect — function
+## animClipCellRect — function @experimental
```
(sheet: AnimClipSheetData, cell: number): { x: number; y: number; width: number; height: number; }
```
-## animClipCellUv — function
+## animClipCellUv — function @experimental
```
(sheet: AnimClipSheetData, cell: number): { uvOffset: { x: number; y: number; }; uvScale: { x: number; y: number; }; }
```
-## animClipDrivesPivot — function
+## animClipDrivesPivot — function @experimental
```
(data: AnimClipAssetData): boolean
```
-## animClipFramePivot — function
+## animClipFramePivot — function @experimental
```
(data: AnimClipAssetData, frame: AnimClipFrameData): AnimClipPivotData | null
```
-## animClipSheetCols — function
+## animClipSheetCols — function @experimental
```
(sheet: AnimClipSheetData): number
```
-## animClipSheetRows — function
+## animClipSheetRows — function @experimental
```
(sheet: AnimClipSheetData): number
```
-## animationPlugin — const
+## animationPlugin — const @experimental
```
AnimationPlugin
```
-## animatorEdges — function
+## animatorEdges — function @experimental
```
(def: AnimatorControllerDef): AnimatorEdge[]
```
-## applyAssetRefResolvers — function
+## applyAssetRefResolvers — function @experimental
```
(app: App, resolveRef: (ref: string) => string): void
```
-## applyAudioProjectConfig — function
+## applyAudioProjectConfig — function @experimental
```
(audio: AudioAPI, config: AudioProjectConfig | undefined): void
```
-## applyBuildRuntimeConfig — function
+## applyBuildRuntimeConfig — function @experimental
```
(app: { setMaxDeltaTime(v: number): void; setMaxFixedSteps(v: number): void; }, config: RuntimeBuildConfig): void
```
-## applyDeltaToSource — function
+## applyDeltaToSource — function @experimental
```
(source: PrefabData, delta: SourceDelta): PrefabData
```
-## applyOverrides — function
+## applyOverrides — function @experimental
```
(entity: OverrideTarget, overrides: readonly PrefabOverride[] | undefined): void
```
-## applyOverridesToSource — function
+## applyOverridesToSource — function @experimental
```
(source: PrefabData, overrides: readonly PrefabOverride[]): PrefabData
```
-## applyRuntimeConfig — function
+## applyRuntimeConfig — function @experimental
```
(components: { Text?: { _default: Record<string, unknown>; }; TextInput?: { _default: Record<string, unknown>; }; Canvas?: { _default: Record<string, unknown>; }; }): void
```
-## applyThemeToWorld — function
+## applyThemeToWorld — function @experimental
```
(world: World): void
```
-## applyWrapMode — function
+## applyWrapMode — function @experimental
```
(time: number, duration: number, mode: WrapMode): { time: number; stopped: boolean; }
```
-## arrayDataSource — function
+## arrayDataSource — function @experimental
```
<T>(items: readonly T[]): ArrayDataSource<T>
```
-## assetPlugin — const
+## assetPlugin — const @experimental
```
AssetPlugin
```
-## atlasCatalogFields — function
+## atlasCatalogFields — function @experimental
```
(atlas: CookedAtlasInfo, pagePath: string): Pick<CatalogEntry, "atlas" | "frame" | "uv">
```
-## audioPlugin — const
+## audioPlugin — const @experimental
```
AudioPlugin
```
-## auto — const
+## auto — const @experimental
```
() => Dimension
```
-## bind — function
+## bind — function @experimental
```
<C extends object, K extends keyof C>(world: World, entity: Entity, component: ComponentDef<C>, field: K, source: ReadonlySignal<C[K]>): () => void
```
-## bindControllerPage — function
+## bindControllerPage — function @experimental
```
(world: World, entity: Entity, controller: string, source: ReadonlySignal<string>): () => void
```
-## bindWidgetValue — function
+## bindWidgetValue — function @experimental
```
<C extends object, K extends keyof C>(world: World, events: UIEventQueue, entity: Entity, component: ComponentDef<C>, field: K, signal: Signal<C[K]>, payloadKey?: string): () => void
```
-## btEdges — function
+## btEdges — function @experimental
```
(def: BtDefinition): BtEdge[]
```
-## btNodes — function
+## btNodes — function @experimental
```
(def: BtDefinition): BtNode[]
```
-## btPlugin — const
+## btPlugin — const @experimental
```
BtPlugin
```
-## bucketOverridesByEntity — function
+## bucketOverridesByEntity — function @experimental
```
(overrides: readonly PrefabOverride[]): Map<PrefabEntityId, PrefabOverride[]>
```
-## buildCollisionPaletteModel — function
+## buildCollisionPaletteModel — function @experimental
```
(material?: CollisionMaterial): TilesetModel
```
-## buildTerrainIndices — function
+## buildTerrainIndices — function @experimental
```
(asset: TilesetAsset): TerrainIndices
```
-## buildText — function
+## buildText — function @experimental
```
(init?: TextInit): TextData
```
-## buildUINode — function
+## buildUINode — function @experimental
```
(init?: UINodeInit): UINodeData
```
-## buildUIVisual — function
+## buildUIVisual — function @experimental
```
(init?: UIVisualInit): UIVisualData
```
-## buildVariant — function
+## buildVariant — function @experimental
```
(base: PrefabData, baseRef: string, name: string, delta: { overrides: readonly PrefabOverride[]; added: readonly AddedEntity[]; }): PrefabData
```
-## buildWangIndices — function
+## buildWangIndices — function @experimental
```
(asset: TilesetAsset): WangIndices
```
-## builtinShaderTemplate — function
+## builtinShaderTemplate — function @experimental
```
(id: string): BuiltinShaderTemplate | undefined
```
-## calculateAttenuation — function
+## calculateAttenuation — function @experimental
```
(distance: number, config?: SpatialAudioConfig): number
```
-## calculatePanning — function
+## calculatePanning — function @experimental
```
(sourceX: number, sourceY: number, listenerX: number, listenerY: number, maxDistance: number): number
```
-## canHaveChildren — function
+## canHaveChildren — function @experimental
```
(type: BtNodeType): boolean
```
-## canonicalMask — function
+## canonicalMask — function @experimental
```
(mode: TerrainMode, mask: number): number
```
-## catalogFromManifest — function
+## catalogFromManifest — function @experimental
```
(manifest: AddressableManifest): Catalog | undefined
```
-## censusProbeIds — function
+## censusProbeIds — function @experimental
```
(): string[]
```
-## clearAllCaches — function
+## clearAllCaches — function @experimental
```
(): void
```
-## clearAnimatorControllerStore — function
+## clearAnimatorControllerStore — function @experimental
```
(): void
```
-## clearBtStore — function
+## clearBtStore — function @experimental
```
(): void
```
-## clearDrawCallbacks — function
+## clearDrawCallbacks — function @experimental
```
(): void
```
-## clearFsmStore — function
+## clearFsmStore — function @experimental
```
(): void
```
-## clearProjectSideModules — function
+## clearProjectSideModules — function @experimental
```
(): void
```
-## clearTilemapSourceCache — function
+## clearTilemapSourceCache — function @experimental
```
(): void
```
-## clearUserComponents — function
+## clearUserComponents — function @experimental
```
(): void
```
-## cloneComponentData — function
+## cloneComponentData — function @experimental
```
(data: Record<string, unknown>): Record<string, unknown>
```
-## cloneComponents — function
+## cloneComponents — function @experimental
```
(components: ComponentData[]): ComponentData[]
```
-## cloneMetadata — function
+## cloneMetadata — function @experimental
```
(metadata: Record<string, unknown>): Record<string, unknown>
```
-## closeDialog — function
+## closeDialog — function @experimental
```
(world: World, events: UIEventQueue, root: Entity): void
```
-## closeDropdown — function
+## closeDropdown — function @experimental
```
(world: World, e: Entity): void
```
-## col — const
+## col — const @experimental
```
{ readonly create: (r?: number, g?: number, b?: number, a?: number) => Color; readonly rgb: (r: number, g: number, b: number) => Color; readonly from255: (r: number, g: number, b: number, a?: number) => Color; readonly clone: (c: Color) => Color; readonly lerp: (a: Color, b: Color, t: number) => Color; readonly withAlpha: (c: Color, a: number) => Color; readonly multiply: (a: Color, b: Color) => Color; readonly scaleRgb: (c: Color, s: number) => Color; readonly fromHex: (hex: string) => Color; readonly toHex: (c: Color, withAlpha?: boolean) => string; readonly equals: (a: Color, b: Color, epsilon?: number) => boolean; }
```
-## collapseEntry — function
+## collapseEntry — function @experimental
```
(prefab: PrefabData, prefabRef: string, expanded: readonly ProcessedEntity[], rootId: number, sceneParent: number | null, loadPrefab?: SyncPrefabResolver): PrefabInstanceEntry
```
-## collapseInstance — function
+## collapseInstance — function @experimental
```
(prefab: PrefabData, prefabRef: string, expanded: readonly ProcessedEntity[], loadPrefab?: SyncPrefabResolver): PrefabInstanceDelta
```
-## collectExternalEntityRefs — function
+## collectExternalEntityRefs — function @experimental
```
(entities: readonly ExtractEntity[]): ExternalEntityRef[]
```
-## collectGarbage — function
+## collectGarbage — function @experimental
```
(): boolean
```
-## collectNestedPrefabPaths — function
+## collectNestedPrefabPaths — function @experimental
```
(prefab: PrefabData, loadPrefab: (path: string) => PrefabData | null, visited?: Set<string>): string[]
```
-## collidableTileIds — function
+## collidableTileIds — function @experimental
```
(asset: TilesetAsset): number[]
```
-## colliderShapeOutline — function
+## colliderShapeOutline — function @experimental
```
(shape: ColliderShape, center: Vec2, angle: number, ppu: number): ColliderOutline
```
-## collisionRefWithMaterial — function
+## collisionRefWithMaterial — function @experimental
```
(material: CollisionMaterial): string
```
-## color — const
+## color — const @experimental
```
(r?: number, g?: number, b?: number, a?: number) => Color
```
-## compareDrawRank — function
+## compareDrawRank — function @experimental
```
(a: DrawRank, b: DrawRank): number
```
-## compileFsm — function
+## compileFsm — function @experimental
```
(def: FsmDefinition): CompiledFsm
```
@@ -9219,12 +9219,12 @@ BtPlugin
(graph: MaterialGraph): string
```
-## computeEffectiveOrthoSize — function
+## computeEffectiveOrthoSize — function @experimental
```
(baseOrthoSize: number, designAspect: number, actualAspect: number, scaleMode: number, matchWidthOrHeight: number): number
```
-## computeStreaming — function
+## computeStreaming — function @experimental
```
(cells: readonly StreamCell[], focusX: number, focusY: number, loadRadius: number, unloadRadius: number, active: ReadonlySet<string>): StreamDecision
```
@@ -9234,62 +9234,62 @@ BtPlugin
(g: MaterialGraph, fromId: string, toId: string, toSlot: string): MaterialGraph
```
-## contentHashHex — function
+## contentHashHex — function @experimental
```
(data: Uint8Array): string
```
-## contentHashOf — function
+## contentHashOf — function @experimental
```
(data: Uint8Array | string): string
```
-## controllerState — function
+## controllerState — function @experimental
```
(name: string, pages: string[], current?: string): ControllerState
```
-## corePlugin — const
+## corePlugin — const @experimental
```
Plugin
```
-## createAnimClip — function
+## createAnimClip — function @experimental
```
(texture: string, cellWidth: number, cellHeight: number, pageWidth: number, pageHeight: number): AnimClipAssetData
```
-## createBtRunState — function
+## createBtRunState — function @experimental
```
(): BtRunState
```
-## createButton — function
+## createButton — function @experimental
```
(opts: ButtonOptions): ButtonHandle
```
-## createDialog — function
+## createDialog — function @experimental
```
(opts: DialogOptions): DialogHandle
```
-## createDropdown — function
+## createDropdown — function @experimental
```
<T>(opts: DropdownOptions<T>): DropdownHandle<T>
```
-## createEmbeddedSideModuleHost — function
+## createEmbeddedSideModuleHost — function @experimental
```
(registry: EmbeddedSideModuleRegistry): SideModuleHost
```
-## createFetchSideModuleHost — function
+## createFetchSideModuleHost — function @experimental
```
(baseUrl: string): SideModuleHost
```
-## createFsmRunState — function
+## createFsmRunState — function @experimental
```
(fsm: CompiledFsm): FsmRunState
```
@@ -9299,187 +9299,187 @@ Plugin
(module: ESEngineModule, options?: HeadlessAppOptions): App
```
-## createListView — function
+## createListView — function @experimental
```
<T>(opts: CreateListViewOptions<T>): ListViewHandle<T>
```
-## createLocalAchievements — function
+## createLocalAchievements — function @experimental
```
(): AchievementProvider
```
-## createLocalLeaderboard — function
+## createLocalLeaderboard — function @experimental
```
(options?: LocalLeaderboardOptions): LeaderboardProvider
```
-## createMemoryTransportPair — function
+## createMemoryTransportPair — function @experimental
```
(options?: MemoryTransportOptions): [MemoryTransport, MemoryTransport]
```
-## createMockAdProvider — function
+## createMockAdProvider — function @experimental
```
(options?: MockAdProviderOptions): AdProvider
```
-## createPackagedAssetSource — function
+## createPackagedAssetSource — function @experimental
```
(index: PackagedAssetIndex, options?: PackagedAssetSourceOptions): RuntimeAssetSource
```
-## createProgress — function
+## createProgress — function @experimental
```
(opts: ProgressOptions): ProgressHandle
```
-## createRuntimeSceneConfig — function
+## createRuntimeSceneConfig — function @experimental
```
(name: string, sceneData: SceneData | undefined, options: Omit<LoadRuntimeSceneOptions, "sceneData" | "sceneName">, scenePath?: string): SceneConfig
```
-## createScrollView — function
+## createScrollView — function @experimental
```
(opts: ScrollViewOptions): ScrollViewHandle
```
-## createSlider — function
+## createSlider — function @experimental
```
(opts: SliderOptions): SliderHandle
```
-## createSocket — function
+## createSocket — function @experimental
```
(options: GameSocketOptions): PlatformSocket
```
-## createTakeover — function
+## createTakeover — function @experimental
```
(host: TakeoverHost): Takeover
```
-## createTextInput — function
+## createTextInput — function @experimental
```
(opts: TextInputOptions): TextInputHandle
```
-## createTileset — function
+## createTileset — function @experimental
```
(texture: string, tileWidth?: number, tileHeight?: number, columns?: number): TilesetAsset
```
-## createToggle — function
+## createToggle — function @experimental
```
(opts: ToggleOptions): ToggleHandle
```
-## createWeChatSideModuleHost — function
+## createWeChatSideModuleHost — function @experimental
```
(factories: MiniGameSideModuleFactories): SideModuleHost
```
-## createWebApp — function
+## createWebApp — function @experimental
```
(module: ESEngineModule, options?: CreateWebAppOptions): App
```
-## debug — function
+## debug — function @experimental
```
(category: string, message: string, data?: unknown): void
```
-## decodeImageBitmap — function
+## decodeImageBitmap — function @experimental
```
(src: ImageBitmapSource | PlatformImage, flip: boolean): Promise<ImageBitmap>
```
-## decodeImagePixels — function
+## decodeImagePixels — function @experimental
```
(src: ImageBitmapSource): Promise<DecodedPixels>
```
-## decodeTilemapChunks — function
+## decodeTilemapChunks — function @experimental
```
(blob: string): DecodedChunk[]
```
-## defaultFrameStats — function
+## defaultFrameStats — function @experimental
```
(): FrameStats
```
-## defaultPluralSelector — const
+## defaultPluralSelector — const @experimental
```
PluralSelector
```
-## defineBehavior — function
+## defineBehavior — function @experimental
```
<S extends object>(name: string, def: BehaviorDef<S>): ComponentDef<S>
```
-## defineComponent — function
+## defineComponent — function @experimental
```
<T extends object>(name: string, defaults: T, metadata?: ComponentMetadata): ComponentDef<T>
```
-## defineEvent — function
+## defineEvent — function @experimental
```
<T>(name: string): EventDef<T>
```
-## defineInputMap — function
+## defineInputMap — function @experimental
```
(actions: Record<string, ActionDef>): InputMap
```
-## defineResource — function
+## defineResource — function @experimental
```
<T>(defaultValue: T, name?: string): ResourceDef<T>
```
-## defineSystem — function
+## defineSystem — function @experimental
```
<P extends readonly SystemParam[]>(params: [...P], fn: (...args: InferParams<P>) => void | Promise<void>, options?: SystemOptions): SystemDef
```
-## defineSystemSet — function
+## defineSystemSet — function @experimental
```
(name: string, options: SystemSetOptions): SystemSet
```
-## defineTag — function
+## defineTag — function @experimental
```
(name: string): ComponentDef<{}>
```
-## derived — function
+## derived — function @experimental
```
<T>(sources: ReadonlySignal<unknown>[], compute: () => T): ReadonlySignal<T>
```
-## detectAnchor — function
+## detectAnchor — function @experimental
```
(node: UINodeData): AnchorPreset | null
```
-## detectAnchorAxes — function
+## detectAnchorAxes — function @experimental
```
(node: UINodeData): { h: AnchorAxis | null; v: AnchorAxis | null; }
```
-## diagnosticsPlugin — const
+## diagnosticsPlugin — const @experimental
```
DiagnosticsPlugin
```
-## diffAgainstSource — function
+## diffAgainstSource — function @experimental
```
(source: PrefabData, instance: readonly ProcessedEntity[], options?: DiffOptions): { overrides: PrefabOverride[]; untracked: ProcessedEntity[]; orphanedSourceIds: PrefabEntityId[]; }
```
-## diffCensus — function
+## diffCensus — function @experimental
```
(before: Census, after: Census): CensusDelta[]
```
@@ -9489,667 +9489,667 @@ DiagnosticsPlugin
(g: MaterialGraph, toId: string, toSlot: string): MaterialGraph
```
-## discoverSceneAssets — function
+## discoverSceneAssets — function @experimental
```
(sceneData: SceneData, refResolver?: RefResolver): SceneAssetRefs
```
-## dragPlugin — const
+## dragPlugin — const @experimental
```
DragPlugin
```
-## dragonBonesPlugin — const
+## dragonBonesPlugin — const @experimental
```
() => DragonBonesPlugin
```
-## editorViewHalfExtent — function
+## editorViewHalfExtent — function @experimental
```
(view: EditorViewData, aspect: number): { halfW: number; halfH: number; }
```
-## editorViewHalfHeight — function
+## editorViewHalfHeight — function @experimental
```
(view: EditorViewData): number
```
-## emptyAnimatorController — function
+## emptyAnimatorController — function @experimental
```
(): AnimatorControllerDef
```
-## emptyBt — function
+## emptyBt — function @experimental
```
(): BtDefinition
```
-## emptyFsm — function
+## emptyFsm — function @experimental
```
(): FsmDefinition
```
-## encodeTile — function
+## encodeTile — function @experimental
```
(id: number, flags?: TileFlags): number
```
-## ensureBtIds — function
+## ensureBtIds — function @experimental
```
(def: BtDefinition): BtDefinition
```
-## enterStatePath — function
+## enterStatePath — function @experimental
```
(scope: AnimatorScope, name: string): string[]
```
-## enumOptions — function
+## enumOptions — function @experimental
```
(obj: Record<string, unknown>, only?: readonly string[]): ReadonlyArray<{ label: string; value: number; }>
```
-## error — function
+## error — function @experimental
```
(category: string, message: string, data?: unknown): void
```
-## evalGuard — function
+## evalGuard — function @experimental
```
(bb: Blackboard, guard: BlackboardGuard): boolean
```
-## evalGuards — function
+## evalGuards — function @experimental
```
(bb: Blackboard, guards: BlackboardGuard | BlackboardGuard[]): boolean
```
-## evaluateAnimatorPath — function
+## evaluateAnimatorPath — function @experimental
```
(def: AnimatorControllerDef, currentPath: string, params: AnimatorParamValues, triggers: ReadonlySet<string>, clipFinished?: boolean): AnimatorPathEvalResult
```
-## evaluateAnimatorTransitions — function
+## evaluateAnimatorTransitions — function @experimental
```
(def: AnimatorControllerDef, currentState: string, params: AnimatorParamValues, triggers: ReadonlySet<string>, clipFinished?: boolean): AnimatorEvalResult
```
-## evaluateChannel — function
+## evaluateChannel — function @experimental
```
(channel: PropertyChannel, time: number): number
```
-## eventBindingPlugin — const
+## eventBindingPlugin — const @experimental
```
EventBindingPlugin
```
-## evictTextureDimensions — function
+## evictTextureDimensions — function @experimental
```
(handle: number): void
```
-## expandEntry — function
+## expandEntry — function @experimental
```
(prefab: PrefabData, entry: PrefabInstanceEntry, allocateId: () => number, loadPrefab?: SyncPrefabResolver): { entities: ProcessedEntity[]; rootId: number; }
```
-## expandInstance — function
+## expandInstance — function @experimental
```
(prefab: PrefabData, delta: PrefabInstanceDelta, allocateId: () => number, loadPrefab?: SyncPrefabResolver): { entities: ProcessedEntity[]; rootId: number; }
```
-## extractAnimClipTexturePaths — function
+## extractAnimClipTexturePaths — function @experimental
```
(data: AnimClipAssetData): string[]
```
-## extractPrefab — function
+## extractPrefab — function @experimental
```
(entities: readonly ExtractEntity[], rootId: number, name: string, makeId?: (sourceId: number) => PrefabEntityId): PrefabData
```
-## facingFromQuat — function
+## facingFromQuat — function @experimental
```
(z: number, w: number): number
```
-## fetchDecodePixels — function
+## fetchDecodePixels — function @experimental
```
(url: string): Promise<DecodedPixels>
```
-## findControllerOwner — function
+## findControllerOwner — function @experimental
```
(world: World, entity: Entity, name: string): Entity | null
```
-## findEntityByName — function
+## findEntityByName — function @experimental
```
(world: World, name: string): Entity | null
```
-## findPath — function
+## findPath — function @experimental
```
(grid: NavGrid, start: Cell, goal: Cell, opts?: PathfindOptions): Cell[] | null
```
-## fingerprint — function
+## fingerprint — function @experimental
```
(report: DiagnosticReport): string
```
-## finishDeviceRecovery — function
+## finishDeviceRecovery — function @experimental
```
(): void
```
-## flattenPrefab — function
+## flattenPrefab — function @experimental
```
(prefab: PrefabData, overrides: PrefabOverride[], ctx: FlattenContext): FlattenResult
```
-## flipFlagsH — function
+## flipFlagsH — function @experimental
```
(flags: TileFlags): TileFlags
```
-## flipFlagsV — function
+## flipFlagsV — function @experimental
```
(flags: TileFlags): TileFlags
```
-## flipStampH — function
+## flipStampH — function @experimental
```
(s: TileStamp): TileStamp
```
-## flipStampV — function
+## flipStampV — function @experimental
```
(s: TileStamp): TileStamp
```
-## flushPendingSystems — function
+## flushPendingSystems — function @experimental
```
(app: App): void
```
-## focusPlugin — const
+## focusPlugin — const @experimental
```
FocusPlugin
```
-## folderAlwaysInclude — function
+## folderAlwaysInclude — function @experimental
```
(config: AssetGroupsConfig | null | undefined, folder: string): boolean
```
-## folderGroupMode — function
+## folderGroupMode — function @experimental
```
(config: AssetGroupsConfig | null | undefined, folder: string): AssetGroupMode
```
-## formatActionArg — function
+## formatActionArg — function @experimental
```
(params: Readonly<Record<string, AiParamValue>> | undefined, defs: readonly AiParamDef[], separator?: string): string | undefined
```
-## formatCensusDiff — function
+## formatCensusDiff — function @experimental
```
(before: Census, after: Census, all?: boolean): string
```
-## formatCensusReport — function
+## formatCensusReport — function @experimental
```
(report: CensusReport): string
```
-## fsmEdges — function
+## fsmEdges — function @experimental
```
(def: FsmDefinition): FsmEdge[]
```
-## fsmPlugin — const
+## fsmPlugin — const @experimental
```
FsmPlugin
```
-## fxPreviewOrPlayMode — function
+## fxPreviewOrPlayMode — function @experimental
```
(): boolean
```
-## gearBinding — function
+## gearBinding — function @experimental
```
(controller: string, component: string, property: string, pages: Record<string, GearValue>, tween?: GearTween): GearBinding
```
-## getAddressableType — function
+## getAddressableType — function @experimental
```
(path: string): AddressableAssetType | null
```
-## getAddressableTypeByEditorType — function
+## getAddressableTypeByEditorType — function @experimental
```
(editorType: string): AddressableAssetType | null
```
-## getAllAssetExtensions — function
+## getAllAssetExtensions — function @experimental
```
(): Set<string>
```
-## getAllEffectDefs — function
+## getAllEffectDefs — function @experimental
```
(): EffectDef[]
```
-## getAssetBuildTransform — function
+## getAssetBuildTransform — function @experimental
```
(extensionOrPath: string): AssetBuildTransform | undefined
```
-## getAssetMimeType — function
+## getAssetMimeType — function @experimental
```
(ext: string): string | undefined
```
-## getAssetTypeEntry — function
+## getAssetTypeEntry — function @experimental
```
(extensionOrPath: string): AssetTypeEntry | undefined
```
-## getBt — function
+## getBt — function @experimental
```
(key: string): BtDefinition | undefined
```
-## getCacheForEntity — function
+## getCacheForEntity — function @experimental
```
(entityId: number): BitmapCache | undefined
```
-## getComponent — function
+## getComponent — function @experimental
```
(name: string): AnyComponentDef | undefined
```
-## getComponentAssetFieldDescriptors — function
+## getComponentAssetFieldDescriptors — function @experimental
```
(componentType: string): readonly { field: string; type: AssetFieldType; }[]
```
-## getComponentAssetFields — function
+## getComponentAssetFields — function @experimental
```
(componentType: string): string[]
```
-## getComponentDefaults — function
+## getComponentDefaults — function @experimental
```
(typeName: string): Record<string, unknown> | null
```
-## getComponentFieldMeta — function
+## getComponentFieldMeta — function @experimental
```
(name: string): Readonly<Record<string, FieldMeta>>
```
-## getComponentRegistry — function
+## getComponentRegistry — function @experimental
```
(): Map<string, AnyComponentDef>
```
-## getComponentSkeletalFieldDescriptor — function
+## getComponentSkeletalFieldDescriptor — function @experimental
```
(componentType: string): { skeletonField: string; atlasField: string; runtime: string; } | null
```
-## getContextLossGuardInfo — function
+## getContextLossGuardInfo — function @experimental
```
(): { target: string; lostEventsSeen: number; }
```
-## getControllerPage — function
+## getControllerPage — function @experimental
```
(world: World, entity: Entity, name: string): string | null
```
-## getCustomExtensions — function
+## getCustomExtensions — function @experimental
```
(): string[]
```
-## getDefaultContext — function
+## getDefaultContext — function @experimental
```
(): AppContext
```
-## getDeviceIdentity — function
+## getDeviceIdentity — function @experimental
```
(): DeviceIdentity | null
```
-## getDeviceLostReport — function
+## getDeviceLostReport — function @experimental
```
(): string
```
-## getDeviceStatus — function
+## getDeviceStatus — function @experimental
```
(): number
```
-## getEditorType — function
+## getEditorType — function @experimental
```
(path: string): EditorAssetType
```
-## getEffectDef — function
+## getEffectDef — function @experimental
```
(type: string): EffectDef | undefined
```
-## getEffectTypes — function
+## getEffectTypes — function @experimental
```
(): string[]
```
-## getFsm — function
+## getFsm — function @experimental
```
(key: string): CompiledFsm | undefined
```
-## getLogger — function
+## getLogger — function @experimental
```
(): Logger
```
-## getPlatform — function
+## getPlatform — function @experimental
```
(): PlatformAdapter
```
-## getPlatformType — function
+## getPlatformType — function @experimental
```
(): PlatformAdapter["name"] | null
```
-## getRegisteredAnimatorController — function
+## getRegisteredAnimatorController — function @experimental
```
(key: string): AnimatorControllerDef | undefined
```
-## getReplicatedFields — function
+## getReplicatedFields — function @experimental
```
(name: string): readonly string[]
```
-## getResourceManager — function
+## getResourceManager — function @experimental
```
(): CppResourceManager | null
```
-## getResourceStats — function
+## getResourceStats — function @experimental
```
(): ResourceStats | null
```
-## getTextureDimensions — function
+## getTextureDimensions — function @experimental
```
(handle: number): TextureDimensions | null
```
-## getTheme — function
+## getTheme — function @experimental
```
(): ThemeTokens
```
-## getTilemapSource — function
+## getTilemapSource — function @experimental
```
(path: string): LoadedTilemapSource | undefined
```
-## getUserComponent — function
+## getUserComponent — function @experimental
```
(name: string): ComponentDef<any> | undefined
```
-## getUserComponentFingerprint — function
+## getUserComponentFingerprint — function @experimental
```
(): string
```
-## getUserComponents — function
+## getUserComponents — function @experimental
```
(): Map<string, AnyComponentDef>
```
-## getWeChatPackOptions — function
+## getWeChatPackOptions — function @experimental
```
(): Array<{ type: string; value: string; }>
```
-## hasPlayableCta — function
+## hasPlayableCta — function @experimental
```
(): boolean
```
-## hasVisibility — function
+## hasVisibility — function @experimental
```
(world: World, entity: Entity): boolean
```
-## headlessBasePlugins — const
+## headlessBasePlugins — const @experimental
```
() => Plugin[]
```
-## imageBitmapOptions — function
+## imageBitmapOptions — function @experimental
```
(flip: boolean): ImageBitmapOptions
```
-## indexPackagedManifest — function
+## indexPackagedManifest — function @experimental
```
(manifest: AddressableManifest): PackagedAssetIndex
```
-## info — function
+## info — function @experimental
```
(category: string, message: string, data?: unknown): void
```
-## initPlayRealmRuntime — function
+## initPlayRealmRuntime — function @experimental
```
(config: PlayRealmRuntimeConfig): Promise<void>
```
-## initPlayableRuntime — function
+## initPlayableRuntime — function @experimental
```
(config: PlayableRuntimeConfig): Promise<void>
```
-## initRuntime — function
+## initRuntime — function @experimental
```
(config: RuntimeInitConfig): Promise<void>
```
-## inputEventCallbacks — function
+## inputEventCallbacks — function @experimental
```
(state: InputState): InputEventCallbacks
```
-## inputPlugin — const
+## inputPlugin — const @experimental
```
InputPlugin
```
-## inputRouter — const
+## inputRouter — const @experimental
```
InputRouter
```
-## installEditorGrid — function
+## installEditorGrid — function @experimental
```
(app: App): void
```
-## instantiatePrefab — function
+## instantiatePrefab — function @experimental
```
(world: World, prefab: PrefabData, options?: InstantiatePrefabOptions): Promise<InstantiatePrefabResult>
```
-## interactionController — function
+## interactionController — function @experimental
```
(pages?: string[]): ControllerState
```
-## interpolate — function
+## interpolate — function @experimental
```
(template: string, params?: TParams): string
```
-## intersectRects — function
+## intersectRects — function @experimental
```
(a: ScreenRect, b: ScreenRect): ScreenRect
```
-## invertMatrix4 — function
+## invertMatrix4 — function @experimental
```
(m: Float32Array, result?: Float32Array): Float32Array
```
-## invokeAction — function
+## invokeAction — function @experimental
```
<Ctx>(registry: AiRegistry<Ctx>, name: string, ctx: Ctx, bb: Blackboard, input?: AiActionInput): void | Status
```
-## isAuto — const
+## isAuto — const @experimental
```
(d: Dimension) => boolean
```
-## isBuiltinComponent — function
+## isBuiltinComponent — function @experimental
```
(comp: AnyComponentDef): comp is BuiltinComponentDef<any>
```
-## isCollisionPaletteRef — function
+## isCollisionPaletteRef — function @experimental
```
(refs: readonly string[]): boolean
```
-## isCustomExtension — function
+## isCustomExtension — function @experimental
```
(path: string): boolean
```
-## isDialogOpen — function
+## isDialogOpen — function @experimental
```
(world: World, root: Entity): boolean
```
-## isDropdownOpen — function
+## isDropdownOpen — function @experimental
```
(world: World, e: Entity): boolean
```
-## isEditor — function
+## isEditor — function @experimental
```
(): boolean
```
-## isEmptyStamp — function
+## isEmptyStamp — function @experimental
```
(s: TileStamp): boolean
```
-## isEntityActive — function
+## isEntityActive — function @experimental
```
(world: World, entity: Entity): boolean
```
-## isEntityVisible — function
+## isEntityVisible — function @experimental
```
(world: World, entity: Entity): boolean
```
-## isFxEditPreview — function
+## isFxEditPreview — function @experimental
```
(): boolean
```
-## isHexOrientation — function
+## isHexOrientation — function @experimental
```
(orientation: number): boolean
```
-## isKnownAssetExtension — function
+## isKnownAssetExtension — function @experimental
```
(ext: string): boolean
```
-## isNative — function
+## isNative — function @experimental
```
(): boolean
```
-## isNonOrthogonal — function
+## isNonOrthogonal — function @experimental
```
(orientation: number): boolean
```
-## isPlatformInitialized — function
+## isPlatformInitialized — function @experimental
```
(): boolean
```
-## isPlayMode — function
+## isPlayMode — function @experimental
```
(): boolean
```
-## isRuntime — function
+## isRuntime — function @experimental
```
(): boolean
```
-## isTextureRef — function
+## isTextureRef — function @experimental
```
(v: UniformValue): v is TextureRef
```
-## isWeChat — function
+## isWeChat — function @experimental
```
(): boolean
```
-## isWeb — function
+## isWeb — function @experimental
```
(): boolean
```
-## layerFrontness — function
+## layerFrontness — function @experimental
```
(order: LayerOrder, worldY: number, worldZ: number): number
```
-## layerOrderOf — function
+## layerOrderOf — function @experimental
```
(layer: number, ySortMask: number, depthMask: number): LayerOrder
```
-## leafStateOf — function
+## leafStateOf — function @experimental
```
(def: AnimatorControllerDef, path: string): AnimatorState | null
```
-## lifecyclePlugin — const
+## lifecyclePlugin — const @experimental
```
LifecyclePlugin
```
-## loadComponent — function
+## loadComponent — function @experimental
```
(world: World, entity: Entity, compData: SceneComponentData, entityName?: string): void
```
@@ -10159,122 +10159,122 @@ LifecyclePlugin
(dir: string): Promise<ESEngineModule>
```
-## loadInputMapAsset — function
+## loadInputMapAsset — function @experimental
```
(asset: InputMapAsset): InputMap
```
-## loadPackagedAssetIndex — function
+## loadPackagedAssetIndex — function @experimental
```
(manifestPath?: string): Promise<PackagedAssetIndex>
```
-## loadPhysicsModule — function
+## loadPhysicsModule — function @experimental
```
(wasmUrl: string, factory?: PhysicsModuleFactory): Promise<PhysicsWasmModule>
```
-## loadRuntimeScene — function
+## loadRuntimeScene — function @experimental
```
(options: LoadRuntimeSceneOptions): Promise<void>
```
-## loadSceneData — function
+## loadSceneData — function @experimental
```
(world: World, sceneData: SceneData): Map<number, Entity>
```
-## loadSceneWithAssets — function
+## loadSceneWithAssets — function @experimental
```
(world: World, sceneData: SceneData, options?: SceneLoadOptions): Promise<Map<number, Entity>>
```
-## loadTiledMap — function
+## loadTiledMap — function @experimental
```
(world: World, mapData: TiledMapData, textureHandles: Map<string, number>, options?: TilemapLoadOptions): Entity[]
```
-## localizationPlugin — const
+## localizationPlugin — const @experimental
```
LocalizationPlugin
```
-## log — const
+## log — const @experimental
```
Logger
```
-## looksLikeAssetPath — function
+## looksLikeAssetPath — function @experimental
```
(value: unknown): value is string
```
-## makeLosCheck — function
+## makeLosCheck — function @experimental
```
(physics: PhysicsAPI): LosCheck
```
-## makeWidgetInteractable — function
+## makeWidgetInteractable — function @experimental
```
(world: World, entity: Entity, init?: WidgetInteractionInit): void
```
-## markThemed — function
+## markThemed — function @experimental
```
(world: World, entity: Entity, style: ThemeStyleData): void
```
-## matchLocale — function
+## matchLocale — function @experimental
```
(tag: string, available: readonly string[]): string | null
```
-## maxChildren — function
+## maxChildren — function @experimental
```
(type: BtNodeType): number
```
-## measureText — function
+## measureText — function @experimental
```
(text: string, opts: MeasureTextOptions): TextMetrics
```
-## mesh2dPlugin — const
+## mesh2dPlugin — const @experimental
```
Mesh2DPlugin
```
-## messageOf — function
+## messageOf — function @experimental
```
(error: unknown): string
```
-## migratePrefabData — function
+## migratePrefabData — function @experimental
```
(raw: unknown): MigrationResult
```
-## migrateSaveData — function
+## migrateSaveData — function @experimental
```
(version: number, data: unknown, currentVersion: number, migrations: Record<number, SaveMigration>): unknown
```
-## migrateSceneData — function
+## migrateSceneData — function @experimental
```
(raw: SceneData): SceneMigrationResult
```
-## modeToDelivery — function
+## modeToDelivery — function @experimental
```
(mode: AssetGroupMode): BundleMode
```
-## moveAnimatorState — function
+## moveAnimatorState — function @experimental
```
(def: AnimatorControllerDef, name: string, x: number, y: number): AnimatorControllerDef
```
-## moveBtNode — function
+## moveBtNode — function @experimental
```
(def: BtDefinition, id: string, x: number, y: number): BtDefinition
```
@@ -10284,22 +10284,22 @@ Mesh2DPlugin
(g: MaterialGraph, id: string, x: number, y: number): MaterialGraph
```
-## moveState — function
+## moveState — function @experimental
```
(def: FsmDefinition, name: string, x: number, y: number): FsmDefinition
```
-## navGridFromTilemapLayer — function
+## navGridFromTilemapLayer — function @experimental
```
(entity: Entity, opts: BuildNavGridOptions): NavGrid
```
-## navGridFromTiles — function
+## navGridFromTiles — function @experimental
```
(getTile: (x: number, y: number) => number, opts: BuildNavGridOptions): NavGrid
```
-## navPlugin — const
+## navPlugin — const @experimental
```
NavPlugin
```
@@ -10314,382 +10314,382 @@ NavPlugin
NodePlatformAdapter
```
-## normalizeAngle — function
+## normalizeAngle — function @experimental
```
(a: number): number
```
-## normalizeBundleMode — function
+## normalizeBundleMode — function @experimental
```
(mode: string | undefined | null): BundleMode
```
-## normalizeCornerMask — function
+## normalizeCornerMask — function @experimental
```
(mask: number): number
```
-## openDialog — function
+## openDialog — function @experimental
```
(world: World, events: UIEventQueue, root: Entity): void
```
-## openDropdown — function
+## openDropdown — function @experimental
```
(world: World, events: UIEventQueue, e: Entity): void
```
-## orientationPerm — function
+## orientationPerm — function @experimental
```
(flags: TileFlags): Perm
```
-## packCorners — function
+## packCorners — function @experimental
```
(tl: number, tr: number, br: number, bl: number): number
```
-## packagedAppOptions — function
+## packagedAppOptions — function @experimental
```
(config: Pick<PackagedGameConfig, "ySortLayers" | "depthLayers" | "colorSpace" | "screenFit">): { ySortLayers?: number; depthLayers?: number; colorSpace?: "gamma" | "linear"; screenFit?: PackagedGameConfig["screenFit"]; }
```
-## packagedRuntimeInit — function
+## packagedRuntimeInit — function @experimental
```
(config: Pick<PackagedGameConfig, "physicsEnabled" | "physicsConfig" | "audioConfig" | "uiTheme" | "uiThemeColors" | "achievements" | "steamAppId" | "screenFit">): { physicsEnabled?: boolean; physicsConfig?: PhysicsPluginConfig; audioConfig?: AudioProjectConfig; uiTheme?: "light"; uiThemeOverrides?: ThemeOverrides; achievements?: string[]; steamAppId?: number; screenFit?: PackagedGameConfig["screenFit"]; }
```
-## paramDefaultValue — function
+## paramDefaultValue — function @experimental
```
(param: ShaderParam): unknown
```
-## parseActionArg — function
+## parseActionArg — function @experimental
```
(arg: string | undefined, params: readonly AiParamDef[], separator?: string): Record<string, AiParamValue>
```
-## parseAnimClipAsset — function
+## parseAnimClipAsset — function @experimental
```
(rawJson: unknown): AnimClipAssetData
```
-## parseAnimClipData — function
+## parseAnimClipData — function @experimental
```
(clipPath: string, data: AnimClipAssetData, textureHandles: Map<string, number>): SpriteAnimClip
```
-## parseAnimationClip — function
+## parseAnimationClip — function @experimental
```
(rawJson: unknown): TimelineAsset
```
-## parseAudioProjectConfig — function
+## parseAudioProjectConfig — function @experimental
```
(raw: unknown): AudioProjectConfig
```
-## parseBusEffects — function
+## parseBusEffects — function @experimental
```
(raw: unknown): BusEffectDef[]
```
-## parseCollisionMaterial — function
+## parseCollisionMaterial — function @experimental
```
(refs: readonly string[]): CollisionMaterial
```
-## parseLocaleTable — function
+## parseLocaleTable — function @experimental
```
(text: string, path: string): LocaleTableAsset
```
-## parseRichText — function
+## parseRichText — function @experimental
```
(input: string): RichTextRun[]
```
-## parseThemeOverrides — function
+## parseThemeOverrides — function @experimental
```
(colors?: Record<string, string>): ThemeOverrides | undefined
```
-## parseTileset — function
+## parseTileset — function @experimental
```
(rawJson: unknown): TilesetAsset
```
-## parseTimelineAsset — function
+## parseTimelineAsset — function @experimental
```
(rawJson: unknown): TimelineAsset
```
-## parseTmjJson — function
+## parseTmjJson — function @experimental
```
(json: Record<string, unknown>): TiledMapData | null
```
-## parseTmjWithExternals — function
+## parseTmjWithExternals — function @experimental
```
(json: Record<string, unknown>, resolveExternal: (source: string) => Promise<string>): Promise<TiledMapData | null>
```
-## particlePlugin — const
+## particlePlugin — const @experimental
```
ParticlePlugin
```
-## pathToWorld — function
+## pathToWorld — function @experimental
```
(grid: NavGrid, path: Cell[]): Vec2[]
```
-## percent — const
+## percent — const @experimental
```
(n: number) => Dimension
```
-## perceptionPlugin — const
+## perceptionPlugin — const @experimental
```
PerceptionPlugin
```
-## platformFetch — function
+## platformFetch — function @experimental
```
(url: string, options?: PlatformRequestOptions): Promise<PlatformResponse>
```
-## platformFileExists — function
+## platformFileExists — function @experimental
```
(path: string): Promise<boolean>
```
-## platformInstantiateWasm — function
+## platformInstantiateWasm — function @experimental
```
(pathOrBuffer: string | ArrayBuffer, imports: WebAssembly.Imports): Promise<WasmInstantiateResult>
```
-## platformReadFile — function
+## platformReadFile — function @experimental
```
(path: string): Promise<ArrayBuffer>
```
-## platformReadTextFile — function
+## platformReadTextFile — function @experimental
```
(path: string): Promise<string>
```
-## playModeOnly — function
+## playModeOnly — function @experimental
```
(): boolean
```
-## playableCta — function
+## playableCta — function @experimental
```
(): void
```
-## pointInHitArea — function
+## pointInHitArea — function @experimental
```
(px: number, py: number, area: HitAreaShape): boolean
```
-## pointInOBB — function
+## pointInOBB — function @experimental
```
(px: number, py: number, worldX: number, worldY: number, worldW: number, worldH: number, pivotX: number, pivotY: number, rotationZ: number, rotationW: number): boolean
```
-## pointInWorldRect — function
+## pointInWorldRect — function @experimental
```
(px: number, py: number, worldX: number, worldY: number, worldW: number, worldH: number, pivotX: number, pivotY: number): boolean
```
-## postProcessPlugin — const
+## postProcessPlugin — const @experimental
```
PostProcessPlugin
```
-## prefabsPlugin — const
+## prefabsPlugin — const @experimental
```
PrefabsPlugin
```
-## preloadNestedPrefabs — function
+## preloadNestedPrefabs — function @experimental
```
(prefab: PrefabData, loadPrefab: (path: string) => Promise<PrefabData>, cache: Map<string, PrefabData>, visited?: Set<string>, depth?: number): Promise<void>
```
-## previewPlugin — function
+## previewPlugin — function @experimental
```
(sceneUrl: string, baseUrl?: string): PreviewPlugin
```
-## probeRegistrations — function
+## probeRegistrations — function @experimental
```
(register: () => Promise<void>): Promise<ProbedRegistrations>
```
-## projectSideModuleIds — function
+## projectSideModuleIds — function @experimental
```
(): string[]
```
-## px — const
+## px — const @experimental
```
(n: number) => Dimension
```
-## quat — const
+## quat — const @experimental
```
(w?: number, x?: number, y?: number, z?: number) => Quat
```
-## quaternionToAngle2D — function
+## quaternionToAngle2D — function @experimental
```
(rz: number, rw: number): number
```
-## radiusInterest — function
+## radiusInterest — function @experimental
```
(radius: number, options?: RadiusInterestOptions): InterestPolicy
```
-## readColliderShapes — function
+## readColliderShapes — function @experimental
```
(world: World, entity: number): ColliderInstance[]
```
-## readFieldPath — function
+## readFieldPath — function @experimental
```
(data: Record<string, unknown>, path: string): unknown
```
-## readPtrField — function
+## readPtrField — function @experimental
```
(f32: Float32Array, u32: Uint32Array, u8: Uint8Array, ptr: number, field: PtrFieldDesc): unknown
```
-## rebuildChildren — function
+## rebuildChildren — function @experimental
```
(entities: ProcessedEntity[]): void
```
-## recoverDevice — function
+## recoverDevice — function @experimental
```
(): boolean
```
-## reflectEsshader — function
+## reflectEsshader — function @experimental
```
(source: string): ShaderReflection
```
-## registerAction — function
+## registerAction — function @experimental
```
(name: string, fn: AiAction<AiContext>): void
```
-## registerAnimatorController — function
+## registerAnimatorController — function @experimental
```
(key: string, def: AnimatorControllerDef): void
```
-## registerAssetBuildTransform — function
+## registerAssetBuildTransform — function @experimental
```
(editorType: EditorAssetType, transform: AssetBuildTransform): void
```
-## registerBt — function
+## registerBt — function @experimental
```
(key: string, def: BtDefinition): BtDefinition
```
-## registerCensusProbe — function
+## registerCensusProbe — function @experimental
```
(probe: CensusProbe): () => void
```
-## registerComponent — function
+## registerComponent — function @experimental
```
(name: string, def: AnyComponentDef): void
```
-## registerCondition — function
+## registerCondition — function @experimental
```
(name: string, fn: AiCondition<AiContext>): void
```
-## registerDrawCallback — function
+## registerDrawCallback — function @experimental
```
(id: string, fn: DrawCallback, scene?: string): void
```
-## registerFsm — function
+## registerFsm — function @experimental
```
(key: string, def: FsmDefinition): CompiledFsm
```
-## registerPackagedSideModules — function
+## registerPackagedSideModules — function @experimental
```
(config: Pick<PackagedGameConfig, "sideModules">): void
```
-## registerPreSceneDrawCallback — function
+## registerPreSceneDrawCallback — function @experimental
```
(id: string, fn: PreSceneDrawCallback): void
```
-## registerSceneComponentCodec — function
+## registerSceneComponentCodec — function @experimental
```
(type: string, codec: SceneComponentCodec): void
```
-## registerSideModule — function
+## registerSideModule — function @experimental
```
(id: string, descriptor: SideModuleDescriptor): void
```
-## registerTilemapSource — function
+## registerTilemapSource — function @experimental
```
(path: string, data: LoadedTilemapSource): void
```
-## registerTimelineAsset — function
+## registerTimelineAsset — function @experimental
```
(path: string, asset: TimelineAsset): void
```
-## remapComponentEntityRefs — function
+## remapComponentEntityRefs — function @experimental
```
(components: ComponentData[], idMapping: Map<PrefabEntityId, number>): void
```
-## remapEntityFields — function
+## remapEntityFields — function @experimental
```
(compData: SceneComponentData, entityMap: Map<number, Entity>): void
```
-## removeAnimatorParam — function
+## removeAnimatorParam — function @experimental
```
(def: AnimatorControllerDef, name: string): AnimatorControllerDef
```
-## removeAnimatorState — function
+## removeAnimatorState — function @experimental
```
(def: AnimatorControllerDef, name: string): AnimatorControllerDef
```
-## removeAnimatorTransition — function
+## removeAnimatorTransition — function @experimental
```
(def: AnimatorControllerDef, from: string, index: number): AnimatorControllerDef
```
-## removeBtNode — function
+## removeBtNode — function @experimental
```
(def: BtDefinition, id: string): BtDefinition
```
-## removeCacheForEntity — function
+## removeCacheForEntity — function @experimental
```
(entityId: number): BitmapCache | undefined
```
@@ -10699,107 +10699,107 @@ PrefabsPlugin
(g: MaterialGraph, id: string): MaterialGraph
```
-## removeState — function
+## removeState — function @experimental
```
(def: FsmDefinition, name: string): FsmDefinition
```
-## removeTransition — function
+## removeTransition — function @experimental
```
(def: FsmDefinition, from: string, index: number): FsmDefinition
```
-## renameAnimatorState — function
+## renameAnimatorState — function @experimental
```
(def: AnimatorControllerDef, oldName: string, newName: string): AnimatorControllerDef
```
-## renameState — function
+## renameState — function @experimental
```
(def: FsmDefinition, oldName: string, newName: string): FsmDefinition
```
-## reparentBtNode — function
+## reparentBtNode — function @experimental
```
(def: BtDefinition, id: string, newParentId: string): BtDefinition
```
-## replicationPlugin — const
+## replicationPlugin — const @experimental
```
ReplicationPlugin
```
-## reportDeviceLost — function
+## reportDeviceLost — function @experimental
```
(reason: number, message: string): void
```
-## requireResourceManager — function
+## requireResourceManager — function @experimental
```
(): CppResourceManager
```
-## resetWorldTo — function
+## resetWorldTo — function @experimental
```
(world: World, sceneData: SceneData): Map<number, Entity>
```
-## resolveAssetGroup — function
+## resolveAssetGroup — function @experimental
```
(projectRelPath: string, config: AssetGroupsConfig | null | undefined): ResolvedAssetGroup
```
-## resolveAtlas — function
+## resolveAtlas — function @experimental
```
(projectRelPath: string, config: AssetGroupsConfig | null | undefined): ResolvedAtlas | null
```
-## resolveAutotile — function
+## resolveAutotile — function @experimental
```
(index: TerrainIndex, neighbors: readonly boolean[]): number
```
-## resolveBindingTarget — function
+## resolveBindingTarget — function @experimental
```
(world: World, from: Entity, name: string): Entity | null
```
-## resolveChildEntity — function
+## resolveChildEntity — function @experimental
```
(world: Pick<World, "tryGet">, rootEntity: Entity, childPath: string): Entity | null
```
-## resolveParams — function
+## resolveParams — function @experimental
```
(def: AnimatorControllerDef, overrides: ReadonlyMap<string, number | boolean>): Record<string, number | boolean>
```
-## resolveRelativePath — function
+## resolveRelativePath — function @experimental
```
(basePath: string, relativePath: string): string
```
-## resolveThemeTokens — function
+## resolveThemeTokens — function @experimental
```
(base: "dark" | "light", overrides?: ThemeOverrides): ThemeTokens
```
-## resolveTilesetModel — function
+## resolveTilesetModel — function @experimental
```
(tilesets: ResolvedTileset[]): TilesetModel
```
-## resolveWang — function
+## resolveWang — function @experimental
```
(index: WangIndex, corners: readonly number[]): number
```
-## rotateFlagsCW — function
+## rotateFlagsCW — function @experimental
```
(flags: TileFlags): TileFlags
```
-## rotateStampCW — function
+## rotateStampCW — function @experimental
```
(s: TileStamp): TileStamp
```
@@ -10809,617 +10809,617 @@ ReplicationPlugin
(app: App, options?: { fps?: number; }): () => void
```
-## safeAreaPlugin — const
+## safeAreaPlugin — const @experimental
```
SafeAreaPlugin
```
-## sampleTimeline — function
+## sampleTimeline — function @experimental
```
(asset: TimelineAsset, time: number, rootEntity: Entity, deps: SampleDeps, opts?: SampleOptions): void
```
-## sampleTimelineInWorld — function
+## sampleTimelineInWorld — function @experimental
```
(asset: TimelineAsset, time: number, world: SampleWorld & Pick<World, "tryGet">, rootEntity: Entity, opts?: SampleOptions): void
```
-## scalar — const
+## scalar — const @experimental
```
{ readonly clamp: (x: number, min: number, max: number) => number; readonly clamp01: (x: number) => number; readonly lerp: (a: number, b: number, t: number) => number; readonly inverseLerp: (a: number, b: number, value: number) => number; readonly remap: (value: number, inMin: number, inMax: number, outMin: number, outMax: number) => number; readonly deg2rad: (deg: number) => number; readonly rad2deg: (rad: number) => number; readonly approximately: (a: number, b: number, epsilon?: number) => boolean; readonly smoothstep: (edge0: number, edge1: number, x: number) => number; readonly mod: (x: number, n: number) => number; readonly sign: (x: number) => number; }
```
-## sceneManagerPlugin — const
+## sceneManagerPlugin — const @experimental
```
Plugin
```
-## sceneUsesI18n — function
+## sceneUsesI18n — function @experimental
```
(sceneData: SceneData): boolean
```
-## screenToUiWorld — function
+## screenToUiWorld — function @experimental
```
(camera: UICameraData, screenGLX: number, screenGLY: number): { x: number; y: number; }
```
-## screenToWorld — function
+## screenToWorld — function @experimental
```
(screenX: number, screenY: number, inverseVP: Float32Array, vpX: number, vpY: number, vpW: number, vpH: number, planeZ?: number): { x: number; y: number; }
```
-## selectBlendClip — function
+## selectBlendClip — function @experimental
```
(blend: AnimatorBlend1D, value: number): AnimatorBlendThreshold
```
-## selectPluralForm — function
+## selectPluralForm — function @experimental
```
(forms: PluralForms, count: number, selector: PluralSelector): string
```
-## senseTarget — function
+## senseTarget — function @experimental
```
(ox: number, oy: number, facing: number, tx: number, ty: number, range: number, halfFov: number, isBlocked?: (ox: number, oy: number, tx: number, ty: number) => boolean): SenseResult
```
-## serializeAnimClip — function
+## serializeAnimClip — function @experimental
```
(asset: AnimClipAssetData): Record<string, unknown>
```
-## serializeScene — function
+## serializeScene — function @experimental
```
(world: World, sceneName?: string): SceneData
```
-## serializeTileset — function
+## serializeTileset — function @experimental
```
(asset: TilesetAsset): Record<string, unknown>
```
-## serializeTimelineAsset — function
+## serializeTimelineAsset — function @experimental
```
(asset: TimelineAsset): Record<string, unknown>
```
-## serializeTimelineToJson — function
+## serializeTimelineToJson — function @experimental
```
(asset: TimelineAsset, indent?: number): string
```
-## servicesPlugin — const
+## servicesPlugin — const @experimental
```
ServicesPlugin
```
-## setAnimatorConditions — function
+## setAnimatorConditions — function @experimental
```
(def: AnimatorControllerDef, from: string, index: number, conditions: AnimatorCondition[]): AnimatorControllerDef
```
-## setAnimatorInitial — function
+## setAnimatorInitial — function @experimental
```
(def: AnimatorControllerDef, name: string): AnimatorControllerDef
```
-## setAnimatorStateClip — function
+## setAnimatorStateClip — function @experimental
```
(def: AnimatorControllerDef, name: string, clip: string): AnimatorControllerDef
```
-## setAnimatorStateProps — function
+## setAnimatorStateProps — function @experimental
```
(def: AnimatorControllerDef, name: string, patch: { speed?: number; loop?: boolean; }): AnimatorControllerDef
```
-## setBtNodeField — function
+## setBtNodeField — function @experimental
```
(def: BtDefinition, id: string, patch: Partial<BtNode>): BtDefinition
```
-## setButtonState — function
+## setButtonState — function @experimental
```
(world: World, entity: Entity, state: string): void
```
-## setCacheForEntity — function
+## setCacheForEntity — function @experimental
```
(entityId: number, cache: BitmapCache): void
```
-## setControllerPage — function
+## setControllerPage — function @experimental
```
(world: World, entity: Entity, name: string, page: string): boolean
```
-## setDefaultContext — function
+## setDefaultContext — function @experimental
```
(ctx: AppContext): void
```
-## setEditorMode — function
+## setEditorMode — function @experimental
```
(active: boolean): void
```
-## setEditorViewHalfHeight — function
+## setEditorViewHalfHeight — function @experimental
```
(view: EditorViewData, halfH: number): void
```
-## setEntityActive — function
+## setEntityActive — function @experimental
```
(world: World, entity: Entity, active: boolean): void
```
-## setEntityVisible — function
+## setEntityVisible — function @experimental
```
(world: World, entity: Entity, visible: boolean): void
```
-## setFxEditPreview — function
+## setFxEditPreview — function @experimental
```
(enabled: boolean): void
```
-## setInitial — function
+## setInitial — function @experimental
```
(def: FsmDefinition, name: string): FsmDefinition
```
-## setLogLevel — function
+## setLogLevel — function @experimental
```
(level: LogLevel): void
```
-## setNavDestination — function
+## setNavDestination — function @experimental
```
(world: World, entity: Entity, target: Vec2): void
```
-## setPlayMode — function
+## setPlayMode — function @experimental
```
(active: boolean): void
```
-## setStateHook — function
+## setStateHook — function @experimental
```
(def: FsmDefinition, name: string, hook: "onEnter" | "onUpdate" | "onExit", action: string, arg?: string, params?: Record<string, AiParamValue>): FsmDefinition
```
-## setTextureBudget — function
+## setTextureBudget — function @experimental
```
(bytes: number): void
```
-## setTextureFilter — function
+## setTextureFilter — function @experimental
```
(textureId: number, filter: TextureFilter): void
```
-## setTextureParams — function
+## setTextureParams — function @experimental
```
(textureId: number, minFilter: TextureFilter, magFilter: TextureFilter, wrapS: TextureWrap, wrapT: TextureWrap): void
```
-## setTextureSliceBorder — function
+## setTextureSliceBorder — function @experimental
```
(textureId: number, left: number, right: number, top: number, bottom: number): void
```
-## setTextureWrap — function
+## setTextureWrap — function @experimental
```
(textureId: number, wrap: TextureWrap): void
```
-## setTheme — function
+## setTheme — function @experimental
```
(tokens: ThemeTokens): void
```
-## setUIVisible — function
+## setUIVisible — function @experimental
```
(world: World, entity: Entity, visible: boolean): void
```
-## setViewTarget — function
+## setViewTarget — function @experimental
```
(host: CameraDirectorHost, entity: number, opts?: { time?: number; curve?: number; }): void
```
-## setWasmErrorHandler — function
+## setWasmErrorHandler — function @experimental
```
(handler: WasmErrorHandler | null): void
```
-## shakeCamera — function
+## shakeCamera — function @experimental
```
(host: CameraDirectorHost, opts?: { amplitude?: number; rotation?: number; frequency?: number; duration?: number; }): void
```
-## shapeCenter — function
+## shapeCenter — function @experimental
```
(shape: ColliderShape, worldPos: Vec2, angle: number, ppu: number): Vec2
```
-## shapeOffset — function
+## shapeOffset — function @experimental
```
(shape: ColliderShape): Vec2
```
-## shutdownDrawAPI — function
+## shutdownDrawAPI — function @experimental
```
(): void
```
-## shutdownGLDebugAPI — function
+## shutdownGLDebugAPI — function @experimental
```
(): void
```
-## shutdownGeometryAPI — function
+## shutdownGeometryAPI — function @experimental
```
(): void
```
-## shutdownMaterialAPI — function
+## shutdownMaterialAPI — function @experimental
```
(): void
```
-## shutdownRendererAPI — function
+## shutdownRendererAPI — function @experimental
```
(): void
```
-## shutdownResourceManager — function
+## shutdownResourceManager — function @experimental
```
(): void
```
-## sideModuleDescriptor — function
+## sideModuleDescriptor — function @experimental
```
(id: SideModuleId): SideModuleDescriptor | undefined
```
-## signal — function
+## signal — function @experimental
```
<T>(initial: T): Signal<T>
```
-## singleStamp — function
+## singleStamp — function @experimental
```
(raw: number): TileStamp
```
-## spawnUIEntity — function
+## spawnUIEntity — function @experimental
```
(init: UIEntityInit): Entity
```
-## spineModuleId — function
+## spineModuleId — function @experimental
```
(version: SpineVersion): SideModuleId
```
-## stackOf — function
+## stackOf — function @experimental
```
(error: unknown): string | undefined
```
-## statsPlugin — const
+## statsPlugin — const @experimental
```
StatsPlugin
```
-## stepFsm — function
+## stepFsm — function @experimental
```
<Ctx>(fsm: CompiledFsm, run: FsmRunState, ctx: Ctx, bb: Blackboard, registry: AiRegistry<Ctx>): boolean
```
-## stepPerception — function
+## stepPerception — function @experimental
```
(world: PerceptionWorldView, isBlocked?: LosCheck): void
```
-## stopNavAgent — function
+## stopNavAgent — function @experimental
```
(world: World, entity: Entity): void
```
-## switchTheme — function
+## switchTheme — function @experimental
```
(world: World, tokens: ThemeTokens): void
```
-## takeCensus — function
+## takeCensus — function @experimental
```
(ctx?: CensusContext): Census
```
-## textInputPlugin — const
+## textInputPlugin — const @experimental
```
TextInputPlugin
```
-## textPlugin — const
+## textPlugin — const @experimental
```
TextPlugin
```
-## textureImportSettingsFrom — function
+## textureImportSettingsFrom — function @experimental
```
(importer: Record<string, unknown> | undefined | null): ParsedTextureImportSettings | undefined
```
-## themeButtonStates — function
+## themeButtonStates — function @experimental
```
(): Record<string, ButtonStateVisual>
```
-## themeColors — function
+## themeColors — function @experimental
```
(): ThemeColors
```
-## themeType — function
+## themeType — function @experimental
```
(): ThemeType
```
-## tickBt — function
+## tickBt — function @experimental
```
<Ctx>(def: BtDefinition, ctx: Ctx, bb: Blackboard, registry: AiRegistry<Ctx>, rs: BtRunState, dt: number): Status
```
-## tileCellCenter — function
+## tileCellCenter — function @experimental
```
(p: TileGridParams, tx: number, ty: number): Vec2Like
```
-## tileCellOutline — function
+## tileCellOutline — function @experimental
```
(p: TileGridParams): Vec2Like[]
```
-## tileCollisionOutlines — function
+## tileCollisionOutlines — function @experimental
```
(chunks: DecodedChunk[], model: TilesetModel, tileW: number, tileH: number, originX: number, originY: number): TileCollisionPiece[]
```
-## tileFlagsOf — function
+## tileFlagsOf — function @experimental
```
(raw: number): TileFlags
```
-## tileIdOf — function
+## tileIdOf — function @experimental
```
(raw: number): number
```
-## tilemapPlugin — const
+## tilemapPlugin — const @experimental
```
TilemapPlugin
```
-## timelinePlugin — const
+## timelinePlugin — const @experimental
```
TimelinePlugin
```
-## timerPlugin — const
+## timerPlugin — const @experimental
```
Plugin
```
-## toBuildPath — function
+## toBuildPath — function @experimental
```
(path: string): string
```
-## trailPlugin — const
+## trailPlugin — const @experimental
```
TrailPlugin
```
-## transitionTo — function
+## transitionTo — function @experimental
```
(host: App | SceneManagerState, targetScene: string, config: TransitionConfig): Promise<void>
```
-## trimTextureCache — function
+## trimTextureCache — function @experimental
```
(): number
```
-## uiHitTestWorld — function
+## uiHitTestWorld — function @experimental
```
(engine: EngineApi | null, registry: CppRegistry, worldX: number, worldY: number, mouseDown?: boolean, mousePressed?: boolean, mouseReleased?: boolean): Entity | null
```
-## uiInteractionPlugin — const
+## uiInteractionPlugin — const @experimental
```
UIInteractionPlugin
```
-## uiLayoutPlugin — const
+## uiLayoutPlugin — const @experimental
```
UILayoutPlugin
```
-## uiLayoutRect — function
+## uiLayoutRect — function @experimental
```
(cam: CameraExtents, fit: CanvasScale | null, width: number, height: number, previewAspect?: number): WorldRect
```
-## uiMaskPlugin — const
+## uiMaskPlugin — const @experimental
```
UIMaskPlugin
```
-## uiPickAllWorld — function
+## uiPickAllWorld — function @experimental
```
(engine: EngineApi | null, registry: CppRegistry, worldX: number, worldY: number): Entity[]
```
-## uiPickWorld — function
+## uiPickWorld — function @experimental
```
(engine: EngineApi | null, registry: CppRegistry, worldX: number, worldY: number): Entity | null
```
-## uiPlugin — const
+## uiPlugin — const @experimental
```
UIPlugin
```
-## uiPlugins — const
+## uiPlugins — const @experimental
```
Plugin[]
```
-## uiRenderOrderPlugin — const
+## uiRenderOrderPlugin — const @experimental
```
UIRenderOrderPlugin
```
-## uiVisibilityPlugin — const
+## uiVisibilityPlugin — const @experimental
```
UIVisibilityPlugin
```
-## uiWorldToScreen — function
+## uiWorldToScreen — function @experimental
```
(camera: UICameraData, worldX: number, worldY: number): { x: number; y: number; }
```
-## unregisterComponent — function
+## unregisterComponent — function @experimental
```
(name: string): void
```
-## unregisterDrawCallback — function
+## unregisterDrawCallback — function @experimental
```
(id: string): void
```
-## unregisterPreSceneDrawCallback — function
+## unregisterPreSceneDrawCallback — function @experimental
```
(id: string): void
```
-## updateAnimatorParam — function
+## updateAnimatorParam — function @experimental
```
(def: AnimatorControllerDef, name: string, patch: Partial<AnimatorParam>): AnimatorControllerDef
```
-## updateAnimatorTransition — function
+## updateAnimatorTransition — function @experimental
```
(def: AnimatorControllerDef, from: string, index: number, patch: Partial<AnimatorTransition>): AnimatorControllerDef
```
-## updateCameraAspectRatio — function
+## updateCameraAspectRatio — function @experimental
```
(world: World, aspectRatio: number): void
```
-## updateTransition — function
+## updateTransition — function @experimental
```
(def: FsmDefinition, from: string, index: number, patch: Partial<FsmTransition>): FsmDefinition
```
-## usesStagger — function
+## usesStagger — function @experimental
```
(orientation: number): boolean
```
-## v2 — const
+## v2 — const @experimental
```
{ readonly create: (x?: number, y?: number) => Vec2; readonly clone: (a: Vec2) => Vec2; readonly add: (a: Vec2, b: Vec2) => Vec2; readonly sub: (a: Vec2, b: Vec2) => Vec2; readonly scale: (a: Vec2, s: number) => Vec2; readonly mul: (a: Vec2, b: Vec2) => Vec2; readonly neg: (a: Vec2) => Vec2; readonly dot: (a: Vec2, b: Vec2) => number; readonly cross: (a: Vec2, b: Vec2) => number; readonly len: (a: Vec2) => number; readonly len2: (a: Vec2) => number; readonly dist: (a: Vec2, b: Vec2) => number; readonly dist2: (a: Vec2, b: Vec2) => number; readonly normalize: (a: Vec2) => Vec2; readonly lerp: (a: Vec2, b: Vec2, t: number) => Vec2; readonly angle: (a: Vec2) => number; readonly fromAngle: (radians: number, length?: number) => Vec2; readonly rotate: (a: Vec2, radians: number) => Vec2; readonly perp: (a: Vec2) => Vec2; readonly equals: (a: Vec2, b: Vec2, epsilon?: number) => boolean; }
```
-## v3 — const
+## v3 — const @experimental
```
{ readonly create: (x?: number, y?: number, z?: number) => Vec3; readonly clone: (a: Vec3) => Vec3; readonly add: (a: Vec3, b: Vec3) => Vec3; readonly sub: (a: Vec3, b: Vec3) => Vec3; readonly scale: (a: Vec3, s: number) => Vec3; readonly mul: (a: Vec3, b: Vec3) => Vec3; readonly neg: (a: Vec3) => Vec3; readonly dot: (a: Vec3, b: Vec3) => number; readonly cross: (a: Vec3, b: Vec3) => Vec3; readonly len: (a: Vec3) => number; readonly len2: (a: Vec3) => number; readonly dist: (a: Vec3, b: Vec3) => number; readonly normalize: (a: Vec3) => Vec3; readonly lerp: (a: Vec3, b: Vec3, t: number) => Vec3; readonly equals: (a: Vec3, b: Vec3, epsilon?: number) => boolean; }
```
-## validateOverrides — function
+## validateOverrides — function @experimental
```
(prefab: PrefabData, options?: { instanceOverrides?: readonly PrefabOverride[]; loadPrefab?: (path: string) => PrefabData | null; }): ValidateResult
```
-## validatePrefab — function
+## validatePrefab — function @experimental
```
(prefab: PrefabData, options?: ValidatePrefabOptions): PrefabDiagnostic[]
```
-## vec2 — const
+## vec2 — const @experimental
```
(x?: number, y?: number) => Vec2
```
-## vec3 — const
+## vec3 — const @experimental
```
(x?: number, y?: number, z?: number) => Vec3
```
-## vec4 — const
+## vec4 — const @experimental
```
(x?: number, y?: number, z?: number, w?: number) => Vec4
```
-## velocityPlugin — const
+## velocityPlugin — const @experimental
```
Plugin
```
-## velocitySystem — const
+## velocitySystem — const @experimental
```
SystemDef
```
-## videoPlugin — const
+## videoPlugin — const @experimental
```
VideoPlugin
```
-## warn — function
+## warn — function @experimental
```
(category: string, message: string, data?: unknown): void
```
-## widgetToPrefab — function
+## widgetToPrefab — function @experimental
```
(build: (world: World) => Entity, name: string): PrefabData
```
-## withActiveRemoteRoot — function
+## withActiveRemoteRoot — function @experimental
```
(config: AssetGroupsConfig | null | undefined, remoteRoot: string): AssetGroupsConfig
```
-## withFolderAlwaysInclude — function
+## withFolderAlwaysInclude — function @experimental
```
(config: AssetGroupsConfig | null | undefined, folder: string, on: boolean): AssetGroupsConfig
```
-## withFolderGroup — function
+## withFolderGroup — function @experimental
```
(config: AssetGroupsConfig | null | undefined, folder: string, mode: AssetGroupMode): AssetGroupsConfig
```
-## wrapSceneSystem — function
+## wrapSceneSystem — function @experimental
```
(app: App, sceneName: string, system: SystemDef): SystemDef
```
-## writeFieldPath — function
+## writeFieldPath — function @experimental
```
(data: Record<string, unknown>, path: string, value: unknown): boolean
```
-## writePtrField — function
+## writePtrField — function @experimental
```
(f32: Float32Array, u32: Uint32Array, u8: Uint8Array, ptr: number, field: PtrFieldDesc, value: PtrFieldValue | unknown): void
```
diff --git a/sdk/etc/minigame.api.md b/sdk/etc/minigame.api.md
index 6b52ee757..e9be7f731 100644
--- a/sdk/etc/minigame.api.md
+++ b/sdk/etc/minigame.api.md
@@ -1,24 +1,24 @@
# API surface — esengine/minigame
<!-- Generated by tools/api-surface.mjs — do not edit. Run --update to accept changes. -->
-Symbols: 1507 stable · 17 beta · 1 deprecated
+Symbols: 0 public · 17 beta · 1508 experimental · 1 deprecated
-## ANCHOR_AXES — const
+## ANCHOR_AXES — const @experimental
```
readonly AnchorAxis[]
```
-## ANIM_CLIP_FORMAT_VERSION — const
+## ANIM_CLIP_FORMAT_VERSION — const @experimental
```
"1.4"
```
-## ASSET_GROUP_MODES — const
+## ASSET_GROUP_MODES — const @experimental
```
readonly ["local", "subpackage", "remote"]
```
-## AchievementProvider — interface
+## AchievementProvider — interface @experimental
```
getStat: (name: string) => number
platformBacked: boolean
@@ -29,12 +29,12 @@ unlock: (id: string) => Promise<void>
unlocked: (id: string) => boolean
```
-## Achievements — const
+## Achievements — const @experimental
```
ResourceDef<AchievementsAPI>
```
-## AchievementsAPI — class
+## AchievementsAPI — class @experimental
```
available: boolean
getStat: (name: string) => number
@@ -49,18 +49,18 @@ static new (): AchievementsAPI
static prototype: AchievementsAPI
```
-## ActionDef — interface
+## ActionDef — interface @experimental
```
bindings: Binding[]
type: ActionType
```
-## ActionType — type
+## ActionType — type @experimental
```
'button' | 'axis' | 'axis2d'
```
-## ActivationTrack — interface
+## ActivationTrack — interface @experimental
```
childPath: string
name: string
@@ -68,18 +68,18 @@ ranges: ActivationRange[]
type: "activation"
```
-## AdProvider — interface
+## AdProvider — interface @experimental
```
createInterstitialAd: (adUnitId: string) => PlatformInterstitialAd
createRewardedAd: (adUnitId: string) => PlatformRewardedAd
```
-## Added — function
+## Added — function @experimental
```
<T extends AnyComponentDef>(component: T): AddedWrapper<T>
```
-## AddedEntity — interface
+## AddedEntity — interface @experimental
```
components: ComponentData[]
name: string
@@ -88,26 +88,26 @@ prefabEntityId: string
visible: boolean
```
-## AddedWrapper — interface
+## AddedWrapper — interface @experimental
```
_component: T
_filterType: "added"
```
-## AddressableAssetType — type
+## AddressableAssetType — type @experimental
```
| 'texture' | 'material' | 'spine' | 'bitmap-font' | 'font'
| 'prefab' | 'json' | 'text' | 'binary' | 'audio'
```
-## AddressableManifest — interface
+## AddressableManifest — interface @experimental
```
groups: Record<string, AddressableManifestGroup>
revision: string | undefined
version: "2.0"
```
-## AddressableManifestAsset — interface
+## AddressableManifestAsset — interface @experimental
```
address: string | undefined
compressedFormats: string[] | undefined
@@ -120,19 +120,19 @@ textureImport: ParsedTextureImportSettings | undefined
type: AddressableAssetType
```
-## AddressableManifestGroup — interface
+## AddressableManifestGroup — interface @experimental
```
assets: Record<string, AddressableManifestAsset>
bundleMode: string
labels: string[]
```
-## Ads — const
+## Ads — const @experimental
```
ResourceDef<AdsAPI>
```
-## AdsAPI — class
+## AdsAPI — class @experimental
```
available: boolean
preloadRewarded: (adUnitId: string) => Promise<void>
@@ -144,7 +144,7 @@ static new (takeover: Takeover): AdsAPI
static prototype: AdsAPI
```
-## AiAction — type
+## AiAction — type @experimental
```
(
ctx: Ctx,
@@ -154,30 +154,30 @@ static prototype: AdsAPI
) => void | Status
```
-## AiActionInput — interface
+## AiActionInput — interface @experimental
```
arg: string | undefined
params: Readonly<Record<string, AiParamValue>> | undefined
```
-## AiActionSpec — interface
+## AiActionSpec — interface @experimental
```
params: readonly AiParamDef[] | undefined
run: AiAction<Ctx>
separator: string | undefined
```
-## AiBt — const
+## AiBt — const @experimental
```
ResourceDef<BehaviorTrees>
```
-## AiCondition — type
+## AiCondition — type @experimental
```
(ctx: Ctx, bb: Blackboard) => boolean
```
-## AiContext — interface
+## AiContext — interface @experimental
```
blackboard: Blackboard
commands: CommandsInstance
@@ -189,12 +189,12 @@ set: <C extends AnyComponentDef>(component: C, data: ComponentData<C>) => void
world: World
```
-## AiFsm — const
+## AiFsm — const @experimental
```
ResourceDef<StateMachines>
```
-## AiParamDef — interface
+## AiParamDef — interface @experimental
```
label: string | undefined
max: number | undefined
@@ -207,17 +207,17 @@ tooltip: string | undefined
type: "string" | "number" | "bool" | "enum"
```
-## AiParamValue — type
+## AiParamValue — type @experimental
```
string | number | boolean
```
-## AiParams — type
+## AiParams — type @experimental
```
Readonly<Record<string, AiParamValue>>
```
-## AiRegistry — class
+## AiRegistry — class @experimental
```
actionNames: () => string[]
clear: () => void
@@ -234,17 +234,17 @@ static new <Ctx = unknown>(): AiRegistry<Ctx>
static prototype: AiRegistry<any>
```
-## AlignContent — type
+## AlignContent — type @experimental
```
(typeof AlignContent)[keyof typeof AlignContent]
```
-## AlignItems — type
+## AlignItems — type @experimental
```
(typeof AlignItems)[keyof typeof AlignItems]
```
-## AlignSelf — enum
+## AlignSelf — enum @experimental
```
Auto = 0
Center = 2
@@ -253,7 +253,7 @@ Start = 1
Stretch = 4
```
-## AnchorAxis — enum
+## AnchorAxis — enum @experimental
```
Center = 1
End = 2
@@ -261,7 +261,7 @@ Start = 0
Stretch = 3
```
-## AnchorFields — interface
+## AnchorFields — interface @experimental
```
height: Dimension | undefined
insetBottom: Dimension
@@ -276,18 +276,18 @@ position: number
width: Dimension | undefined
```
-## AnchorPreset — interface
+## AnchorPreset — interface @experimental
```
h: AnchorAxis
v: AnchorAxis
```
-## And — function
+## And — function @experimental
```
(...filters: FilterExpr[]): FilterExpr
```
-## AnimClipAssetData — interface
+## AnimClipAssetData — interface @experimental
```
events: AnimClipEventData[] | undefined
fps: number | undefined
@@ -299,14 +299,14 @@ type: "animation-clip"
version: string
```
-## AnimClipEventData — interface
+## AnimClipEventData — interface @experimental
```
data: unknown
frame: number
name: string
```
-## AnimClipFrameData — interface
+## AnimClipFrameData — interface @experimental
```
atlasFrame: { x: number; y: number; width: number; height: number; pageWidth: number; pageHeight: number; } | undefined
cell: number | undefined
@@ -315,13 +315,13 @@ pivot: AnimClipPivotData | undefined
texture: string | undefined
```
-## AnimClipPivotData — interface
+## AnimClipPivotData — interface @experimental
```
x: number
y: number
```
-## AnimClipSheetData — interface
+## AnimClipSheetData — interface @experimental
```
cellHeight: number
cellWidth: number
@@ -332,7 +332,7 @@ spacing: number
texture: string
```
-## AnimFramesTrack — interface
+## AnimFramesTrack — interface @experimental
```
childPath: string
frames: AnimFrame[]
@@ -340,7 +340,7 @@ name: string
type: "animFrames"
```
-## AnimationPlugin — class
+## AnimationPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -349,18 +349,18 @@ static new (): AnimationPlugin
static prototype: AnimationPlugin
```
-## Animator — const
+## Animator — const @experimental
```
ComponentDef<AnimatorData>
```
-## AnimatorBlend1D — interface
+## AnimatorBlend1D — interface @experimental
```
parameter: string
thresholds: AnimatorBlendThreshold[]
```
-## AnimatorBlendThreshold — interface
+## AnimatorBlendThreshold — interface @experimental
```
clip: string
loop: boolean | undefined
@@ -368,18 +368,18 @@ speed: number | undefined
value: number
```
-## AnimatorCondition — type
+## AnimatorCondition — type @experimental
```
| { param: string; op: 'gt' | 'lt' | 'eq' | 'neq'; value: number }
| { param: string; op: 'true' | 'false' | 'trigger' }
```
-## AnimatorController — const
+## AnimatorController — const @experimental
```
ResourceDef<AnimatorControllerAPI>
```
-## AnimatorControllerAPI — class
+## AnimatorControllerAPI — class @experimental
```
clearControllers: () => void
getBool: (entity: Entity, name: string) => boolean
@@ -398,7 +398,7 @@ static new (): AnimatorControllerAPI
static prototype: AnimatorControllerAPI
```
-## AnimatorControllerDef — interface
+## AnimatorControllerDef — interface @experimental
```
anyStateTransitions: AnimatorTransition[] | undefined
initialState: string
@@ -406,59 +406,59 @@ parameters: AnimatorParam[]
states: AnimatorState[]
```
-## AnimatorData — interface
+## AnimatorData — interface @experimental
```
controller: string
currentState: string
enabled: boolean
```
-## AnimatorEdge — type
+## AnimatorEdge — type @experimental
```
GraphEdge<AnimatorTransition>
```
-## AnimatorEvalResult — interface
+## AnimatorEvalResult — interface @experimental
```
consumedTriggers: string[]
next: string | null
```
-## AnimatorParam — interface
+## AnimatorParam — interface @experimental
```
default: number | boolean | undefined
name: string
type: AnimatorParamType
```
-## AnimatorParamType — type
+## AnimatorParamType — type @experimental
```
'float' | 'bool' | 'trigger'
```
-## AnimatorParamValues — type
+## AnimatorParamValues — type @experimental
```
Readonly<Record<string, number | boolean>>
```
-## AnimatorPathEvalResult — interface
+## AnimatorPathEvalResult — interface @experimental
```
consumedTriggers: string[]
nextPath: string | null
```
-## AnimatorScope — type
+## AnimatorScope — type @experimental
```
Pick<AnimatorControllerDef, 'states' | 'initialState' | 'anyStateTransitions'>
```
-## AnimatorSpineMotion — interface
+## AnimatorSpineMotion — interface @experimental
```
animation: string
loop: boolean | undefined
```
-## AnimatorState — interface
+## AnimatorState — interface @experimental
```
blend: AnimatorBlend1D | undefined
clip: string | undefined
@@ -472,26 +472,26 @@ x: number | undefined
y: number | undefined
```
-## AnimatorSubMachine — interface
+## AnimatorSubMachine — interface @experimental
```
anyStateTransitions: AnimatorTransition[] | undefined
initialState: string
states: AnimatorState[]
```
-## AnimatorTransition — interface
+## AnimatorTransition — interface @experimental
```
conditions: AnimatorCondition[]
hasExitTime: boolean | undefined
to: string
```
-## AnyComponentDef — type
+## AnyComponentDef — type @experimental
```
ComponentDef<any> | BuiltinComponentDef<any>
```
-## App — class
+## App — class @experimental
```
addBundleSystems: (entries: ReadonlyArray<{ schedule: number; system: SystemDef | SystemSet; }>) => App
addEvent: <T>(event: EventDef<T>) => App
@@ -553,7 +553,7 @@ static new: () => App
static prototype: App
```
-## AppContext — class
+## AppContext — class @experimental
```
componentRegistry: Map<string, any>
drainPendingSystems: () => PendingSystemEntry[]
@@ -567,12 +567,12 @@ static new (): AppContext
static prototype: AppContext
```
-## ApplyTilesetRefs — type
+## ApplyTilesetRefs — type @experimental
```
(entity: number, refs: readonly string[]) => void
```
-## ArrayDataSource — class
+## ArrayDataSource — class @experimental
```
append: (items: readonly T[]) => void
getCount: () => number
@@ -586,34 +586,34 @@ static new <T>(items?: readonly T[]): ArrayDataSource<T>
static prototype: ArrayDataSource<any>
```
-## AssetBuildTransform — type
+## AssetBuildTransform — type @experimental
```
(content: string, context: unknown) => string
```
-## AssetContentType — type
+## AssetContentType — type @experimental
```
'json' | 'text' | 'binary' | 'image' | 'audio'
```
-## AssetFieldType — type
+## AssetFieldType — type @experimental
```
'texture' | 'material' | 'font' | 'anim-clip' | 'audio' | 'video' | 'tilemap' | 'tileset' | 'timeline' | 'statemachine' | 'behaviortree' | 'animatorcontroller'
```
-## AssetGroupDef — interface
+## AssetGroupDef — interface @experimental
```
alwaysInclude: boolean | undefined
folder: string
mode: "local" | "subpackage" | "remote"
```
-## AssetGroupMode — type
+## AssetGroupMode — type @experimental
```
typeof ASSET_GROUP_MODES[number]
```
-## AssetGroupsConfig — interface
+## AssetGroupsConfig — interface @experimental
```
activeProfile: string | undefined
atlases: Record<string, AtlasDef> | undefined
@@ -622,7 +622,7 @@ profiles: Record<string, BuildProfile> | undefined
version: string
```
-## AssetPlugin — class
+## AssetPlugin — class @experimental
```
build: (app: App) => void
name: string
@@ -630,7 +630,7 @@ static new (): AssetPlugin
static prototype: AssetPlugin
```
-## AssetRefCounter — class
+## AssetRefCounter — class @experimental
```
addFontRef: (path: string, entity: number) => void
addMaterialRef: (path: string, entity: number) => void
@@ -655,14 +655,14 @@ static new (): AssetRefCounter
static prototype: AssetRefCounter
```
-## AssetRefInfo — interface
+## AssetRefInfo — interface @experimental
```
assetPath: string
entities: number[]
refCount: number
```
-## AssetTypeEntry — interface
+## AssetTypeEntry — interface @experimental
```
addressableType: AddressableAssetType | null
buildTransform: AssetBuildTransform | undefined
@@ -674,17 +674,17 @@ suffixes: string[] | undefined
wechatPackInclude: boolean
```
-## Assets — const
+## Assets — const @experimental
```
ResourceDef<AssetsClass>
```
-## AssetsData — type
+## AssetsData — type @experimental
```
AssetsClass
```
-## AsyncCache — class
+## AsyncCache — class @experimental
```
clear: () => void
clearAll: () => void
@@ -701,24 +701,24 @@ static new <T>(dispose_?: ((value: T) => void) | undefined): AsyncCache<T>
static prototype: AsyncCache<any>
```
-## AtlasDef — interface
+## AtlasDef — interface @experimental
```
folder: string
```
-## AttenuationModel — enum
+## AttenuationModel — enum @experimental
```
Exponential = 2
Inverse = 1
Linear = 0
```
-## Audio — const
+## Audio — const @experimental
```
ResourceDef<AudioAPI>
```
-## AudioAPI — class
+## AudioAPI — class @experimental
```
baseUrl: string
bufferBudget: number
@@ -766,20 +766,20 @@ static new (backend: PlatformAudioBackend, mixer?: AudioMixer | null): AudioAPI
static prototype: AudioAPI
```
-## AudioBackendInitOptions — interface
+## AudioBackendInitOptions — interface @experimental
```
initialPoolSize: number | undefined
mixerConfig: AudioMixerConfig | undefined
```
-## AudioBufferHandle — interface
+## AudioBufferHandle — interface @experimental
```
bytes: number | undefined
duration: number
id: number
```
-## AudioBufferStats — interface
+## AudioBufferStats — interface @experimental
```
bufferBudget: number
bufferBytes: number
@@ -787,7 +787,7 @@ bufferCount: number
evictableCount: number
```
-## AudioBus — class
+## AudioBus — class @experimental
```
addChild: (child: AudioBus) => void
connect: (destination: AudioBus | AudioNode) => void
@@ -803,7 +803,7 @@ static new (context: AudioContext, config: AudioBusConfig): AudioBus
static prototype: AudioBus
```
-## AudioBusConfig — interface
+## AudioBusConfig — interface @experimental
```
muted: boolean | undefined
name: string
@@ -811,7 +811,7 @@ parent: string | undefined
volume: number | undefined
```
-## AudioBusDecl — interface
+## AudioBusDecl — interface @experimental
```
duck: BusDuckRule | undefined
effects: BusEffectDef[] | undefined
@@ -821,7 +821,7 @@ parent: string | undefined
volume: number | undefined
```
-## AudioHandle — interface
+## AudioHandle — interface @experimental
```
currentTime: number
duration: number
@@ -837,17 +837,17 @@ setVolume: (volume: number) => void
stop: () => void
```
-## AudioListener — const
+## AudioListener — const @experimental
```
ComponentDef<AudioListenerData>
```
-## AudioListenerData — interface
+## AudioListenerData — interface @experimental
```
enabled: boolean
```
-## AudioMixer — class
+## AudioMixer — class @experimental
```
busNames: () => string[]
createBus: (config: AudioBusConfig) => AudioBus
@@ -864,7 +864,7 @@ static new (context: AudioContext, config?: AudioMixerConfig): AudioMixer
static prototype: AudioMixer
```
-## AudioMixerConfig — interface
+## AudioMixerConfig — interface @experimental
```
masterVolume: number | undefined
musicVolume: number | undefined
@@ -873,7 +873,7 @@ uiVolume: number | undefined
voiceVolume: number | undefined
```
-## AudioPlugin — class
+## AudioPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -883,7 +883,7 @@ static new (config?: AudioPluginConfig): AudioPlugin
static prototype: AudioPlugin
```
-## AudioPluginConfig — interface
+## AudioPluginConfig — interface @experimental
```
initialPoolSize: number | undefined
masterVolume: number | undefined
@@ -891,7 +891,7 @@ musicVolume: number | undefined
sfxVolume: number | undefined
```
-## AudioPool — class
+## AudioPool — class @experimental
```
acquire: () => PooledAudioNode
activeCount: number
@@ -901,17 +901,17 @@ static new (context: AudioContext, initialSize?: number): AudioPool
static prototype: AudioPool
```
-## AudioProjectConfig — interface
+## AudioProjectConfig — interface @experimental
```
buses: AudioBusDecl[] | undefined
```
-## AudioSource — const
+## AudioSource — const @experimental
```
ComponentDef<AudioSourceData>
```
-## AudioSourceData — interface
+## AudioSourceData — interface @experimental
```
attenuationModel: number
bus: string
@@ -928,7 +928,7 @@ spatial: boolean
volume: number
```
-## AudioTrack — interface
+## AudioTrack — interface @experimental
```
childPath: string
events: AudioEvent[]
@@ -936,37 +936,37 @@ name: string
type: "audio"
```
-## Axis1D — const
+## Axis1D — const @experimental
```
(...bindings: Binding[]) => ActionDef
```
-## Axis2D — const
+## Axis2D — const @experimental
```
(...bindings: Binding[]) => ActionDef
```
-## BUILTIN_SHADER_TEMPLATES — const
+## BUILTIN_SHADER_TEMPLATES — const @experimental
```
readonly BuiltinShaderTemplate[]
```
-## BUILTIN_UI_PREFABS — const
+## BUILTIN_UI_PREFABS — const @experimental
```
Record<string, PrefabData>
```
-## BUILTIN_UI_WIDGET_NAMES — const
+## BUILTIN_UI_WIDGET_NAMES — const @experimental
```
readonly ["Button", "Toggle", "Slider", "Dialog", "TextInput", "Progress", "Dropdown", "ListView", "ScrollView"]
```
-## BUNDLE_MODES — const
+## BUNDLE_MODES — const @experimental
```
readonly BundleMode[]
```
-## Backend — interface
+## Backend — interface @experimental
```
fetchBinary: (path: string) => Promise<ArrayBuffer>
fetchText: (path: string) => Promise<string>
@@ -974,7 +974,7 @@ resolveUrl: (path: string) => string
setBaseUrl: ((url: string) => void) | undefined
```
-## BehaviorContext — interface
+## BehaviorContext — interface @experimental
```
commands: CommandsInstance
entity: number
@@ -987,7 +987,7 @@ time: TimeData
world: World
```
-## BehaviorDef — interface
+## BehaviorDef — interface @experimental
```
destroy: ((ctx: BehaviorContext<S>) => void) | undefined
metadata: ComponentMetadata | undefined
@@ -997,18 +997,18 @@ state: S | undefined
update: ((ctx: BehaviorContext<S>, dt: number) => void) | undefined
```
-## BehaviorTreeAgent — const
+## BehaviorTreeAgent — const @experimental
```
ComponentDef<BehaviorTreeAgentData>
```
-## BehaviorTreeAgentData — interface
+## BehaviorTreeAgentData — interface @experimental
```
bt: string
status: string
```
-## BehaviorTrees — class
+## BehaviorTrees — class @experimental
```
blackboard: (entity: Entity) => Blackboard
status: (entity: Entity) => string | null
@@ -1016,7 +1016,7 @@ static new (states: Map<Entity, BtAgentState>): BehaviorTrees
static prototype: BehaviorTrees
```
-## BezierPoints — interface
+## BezierPoints — interface @experimental
```
p1x: number
p1y: number
@@ -1024,12 +1024,12 @@ p2x: number
p2y: number
```
-## BinaryHandler — type
+## BinaryHandler — type @experimental
```
(payload: Uint8Array) => void
```
-## Binding — type
+## Binding — type @experimental
```
| { kind: 'key'; code: string }
| { kind: 'mouse'; button: number }
@@ -1041,7 +1041,7 @@ p2y: number
| { kind: 'virtual'; id: string }
```
-## BitmapCache — interface
+## BitmapCache — interface @experimental
```
_rt: RenderTextureHandle | null
height: number
@@ -1050,12 +1050,12 @@ valid: boolean
width: number
```
-## BitmapText — const
+## BitmapText — const @experimental
```
BuiltinComponentDef<BitmapTextData>
```
-## BitmapTextData — interface
+## BitmapTextData — interface @experimental
```
align: number
color: Color
@@ -1068,7 +1068,7 @@ spacing: number
text: string
```
-## Blackboard — class
+## Blackboard — class @experimental
```
clearTriggers: () => void
consume: (trigger: string) => void
@@ -1082,19 +1082,19 @@ static new (): Blackboard
static prototype: Blackboard
```
-## BlackboardGuard — interface
+## BlackboardGuard — interface @experimental
```
key: string
op: CompareOp
value: string | number | boolean | undefined
```
-## BlendCurve — type
+## BlendCurve — type @experimental
```
(typeof BlendCurve)[keyof typeof BlendCurve]
```
-## BlendMode — enum
+## BlendMode — enum @experimental
```
Additive = 1
Darken = 7
@@ -1108,19 +1108,19 @@ PremultipliedAlpha = 4
Screen = 3
```
-## BodyType — enum
+## BodyType — enum @experimental
```
Dynamic = 2
Kinematic = 1
Static = 0
```
-## BoxCollider — const
+## BoxCollider — const @experimental
```
BuiltinComponentDef<BoxColliderData>
```
-## BoxColliderData — interface
+## BoxColliderData — interface @experimental
```
categoryBits: number
density: number
@@ -1134,20 +1134,20 @@ radius: number
restitution: number
```
-## BtDefinition — interface
+## BtDefinition — interface @experimental
```
orphans: BtNode[] | undefined
root: BtNode
```
-## BtEdge — interface
+## BtEdge — interface @experimental
```
from: string
id: string
to: string
```
-## BtNode — interface
+## BtNode — interface @experimental
```
arg: string | undefined
children: BtNode[] | undefined
@@ -1162,7 +1162,7 @@ x: number | undefined
y: number | undefined
```
-## BtNodeType — type
+## BtNodeType — type @experimental
```
| 'sequence' | 'selector' | 'parallel'
// decorators (one child)
@@ -1171,7 +1171,7 @@ y: number | undefined
| 'action' | 'condition'
```
-## BtPlugin — class
+## BtPlugin — class @experimental
```
build: (app: App) => void
name: string
@@ -1179,12 +1179,12 @@ static new (): BtPlugin
static prototype: BtPlugin
```
-## BtRunState — type
+## BtRunState — type @experimental
```
Map<string, NodeState>
```
-## BuildNavGridOptions — interface
+## BuildNavGridOptions — interface @experimental
```
blockedTileIds: Iterable<number> | undefined
cellSize: number
@@ -1194,12 +1194,12 @@ origin: Vec2 | undefined
width: number
```
-## BuildProfile — interface
+## BuildProfile — interface @experimental
```
remoteRoot: string | undefined
```
-## BuiltinBridge — class
+## BuiltinBridge — class @experimental
```
connect: (cppRegistry: CppRegistry, module?: ESEngineModule, options?: BridgeConnectOptions) => void
deleteFromEntitySets: (entity: Entity) => string[]
@@ -1224,7 +1224,7 @@ static new (): BuiltinBridge
static prototype: BuiltinBridge
```
-## BuiltinComponentDef — interface
+## BuiltinComponentDef — interface @experimental
```
_builtin: true
_cppName: string
@@ -1244,7 +1244,7 @@ skeletalFields: SkeletalFieldMeta | undefined
transient: boolean
```
-## BuiltinShaderTemplate — interface
+## BuiltinShaderTemplate — interface @experimental
```
defaults: Record<string, unknown>
description: string
@@ -1253,17 +1253,17 @@ label: string
source: string
```
-## BuiltinSideModuleId — type
+## BuiltinSideModuleId — type @experimental
```
'physics' | 'basis' | 'videodec' | 'dragonbones' | `spine:${SpineVersion}`
```
-## BundleMode — type
+## BundleMode — type @experimental
```
'local' | 'lazy' | 'remote'
```
-## BusDuckRule — interface
+## BusDuckRule — interface @experimental
```
amount: number
attack: number | undefined
@@ -1272,24 +1272,24 @@ threshold: number | undefined
trigger: string
```
-## BusEffectDef — type
+## BusEffectDef — type @experimental
```
FilterEffectDef | ReverbEffectDef | CompressorEffectDef
```
-## Button — const
+## Button — const @experimental
```
(...bindings: Binding[]) => ActionDef
```
-## ButtonHandle — interface
+## ButtonHandle — interface @experimental
```
dispose: () => void
entity: number
setDisabled: (disabled: boolean) => void
```
-## ButtonOptions — interface
+## ButtonOptions — interface @experimental
```
background: UIVisualInit | undefined
disabled: boolean | undefined
@@ -1305,39 +1305,39 @@ text: string | TextInit | undefined
world: World
```
-## ButtonStateVisual — interface
+## ButtonStateVisual — interface @experimental
```
color: Color | undefined
scale: number | undefined
sprite: number | undefined
```
-## CAPSULE_ARC_SEGMENTS — const
+## CAPSULE_ARC_SEGMENTS — const @experimental
```
16
```
-## CHUNK_SIZE — const
+## CHUNK_SIZE — const @experimental
```
16
```
-## COLLISION_BRUSHES — const
+## COLLISION_BRUSHES — const @experimental
```
CollisionBrush[]
```
-## COLLISION_PALETTE_REF — const
+## COLLISION_PALETTE_REF — const @experimental
```
"builtin:collision"
```
-## CacheAsBitmap — const
+## CacheAsBitmap — const @experimental
```
ComponentDef<CacheAsBitmapData>
```
-## CacheAsBitmapData — interface
+## CacheAsBitmapData — interface @experimental
```
dirty: boolean
enabled: boolean
@@ -1345,22 +1345,22 @@ height: number
width: number
```
-## CacheBitmap — const
+## CacheBitmap — const @experimental
```
{ create(width: number, height: number): BitmapCache; release(cache: BitmapCache): void; beginDraw(cache: BitmapCache, viewProjection: Float32Array): void; endDraw(): void; resize(cache: BitmapCache, width: number, height: number): void; }
```
-## Camera — const
+## Camera — const @experimental
```
BuiltinComponentDef<CameraData>
```
-## CameraBounds — const
+## CameraBounds — const @experimental
```
ComponentDef<CameraBoundsData>
```
-## CameraBoundsData — interface
+## CameraBoundsData — interface @experimental
```
maxX: number
maxY: number
@@ -1368,7 +1368,7 @@ minX: number
minY: number
```
-## CameraData — interface
+## CameraData — interface @experimental
```
aspectRatio: number
clearFlags: number
@@ -1385,12 +1385,12 @@ showFrustum: boolean
viewport: Vec4
```
-## CameraDirector — const
+## CameraDirector — const @experimental
```
ResourceDef<CameraDirectorState>
```
-## CameraDirectorState — interface
+## CameraDirectorState — interface @experimental
```
blending: boolean
currentMain: CameraPOV | null
@@ -1407,7 +1407,7 @@ startTime: number
target: number
```
-## CameraExtents — interface
+## CameraExtents — interface @experimental
```
cameraX: number
cameraY: number
@@ -1416,7 +1416,7 @@ halfH: number
halfW: number
```
-## CameraPOV — interface
+## CameraPOV — interface @experimental
```
clearFlags: number
cullingMask: number
@@ -1436,7 +1436,7 @@ y: number
z: number
```
-## CameraRenderParams — interface
+## CameraRenderParams — interface @experimental
```
cameraEntity: number | undefined
clearColor: { x: number; y: number; z: number; w: number; } | undefined
@@ -1448,12 +1448,12 @@ viewProjection: Float32Array<ArrayBufferLike>
viewportPixels: Viewport
```
-## CameraView — const
+## CameraView — const @experimental
```
ResourceDef<CameraViewAPI>
```
-## CameraViewAPI — class
+## CameraViewAPI — class @experimental
```
getWorldBounds: () => { left: number; right: number; bottom: number; top: number; } | null
getWorldMousePosition: () => { x: number; y: number; } | null
@@ -1463,12 +1463,12 @@ static new (app_: App): CameraViewAPI
static prototype: CameraViewAPI
```
-## Canvas — const
+## Canvas — const @experimental
```
BuiltinComponentDef<CanvasData>
```
-## CanvasData — interface
+## CanvasData — interface @experimental
```
backgroundColor: Color
designResolution: Vec2
@@ -1478,19 +1478,19 @@ pixelsPerUnit: number
scaleMode: number
```
-## CanvasScale — interface
+## CanvasScale — interface @experimental
```
designResolution: { x: number; y: number; }
matchWidthOrHeight: number
scaleMode: number
```
-## CapsuleCollider — const
+## CapsuleCollider — const @experimental
```
BuiltinComponentDef<CapsuleColliderData>
```
-## CapsuleColliderData — interface
+## CapsuleColliderData — interface @experimental
```
categoryBits: number
density: number
@@ -1504,7 +1504,7 @@ radius: number
restitution: number
```
-## Catalog — class
+## Catalog — class @experimental
```
getAllLabels: () => string[]
getAtlasFrame: (path: string) => AtlasFrameInfo | null
@@ -1522,7 +1522,7 @@ static new (entries: Map<string, CatalogEntry>, addresses: Map<string, string>,
static prototype: Catalog
```
-## CatalogData — interface
+## CatalogData — interface @experimental
```
addresses: Record<string, string> | undefined
entries: Record<string, CatalogEntry>
@@ -1530,7 +1530,7 @@ labels: Record<string, string[]> | undefined
version: number
```
-## CatalogEntry — interface
+## CatalogEntry — interface @experimental
```
atlas: string | undefined
buildPath: string | undefined
@@ -1541,27 +1541,27 @@ type: string
uv: { offset: [number, number]; scale: [number, number]; } | undefined
```
-## Cell — interface
+## Cell — interface @experimental
```
x: number
y: number
```
-## Census — interface
+## Census — interface @experimental
```
atMs: number
entries: ReadonlyMap<string, CensusEntry>
failedProbes: readonly string[]
```
-## CensusContext — interface
+## CensusContext — interface @experimental
```
app: App | undefined
module: ESEngineModule | null | undefined
world: World | undefined
```
-## CensusDelta — interface
+## CensusDelta — interface @experimental
```
after: number
before: number
@@ -1571,7 +1571,7 @@ tier: CensusTier
unit: "count" | "bytes"
```
-## CensusEntry — interface
+## CensusEntry — interface @experimental
```
key: string
tier: CensusTier
@@ -1579,13 +1579,13 @@ unit: "count" | "bytes"
value: number
```
-## CensusProbe — interface
+## CensusProbe — interface @experimental
```
id: string
read: (ctx: CensusContext) => readonly CensusEntry[] | undefined
```
-## CensusReport — interface
+## CensusReport — interface @experimental
```
cycles: number
failedProbes: readonly string[]
@@ -1595,7 +1595,7 @@ projectCycles: number
verdicts: readonly CensusVerdict[]
```
-## CensusSeriesOptions — interface
+## CensusSeriesOptions — interface @experimental
```
boundedSlopeTolerance: number | undefined
projectCycles: number | undefined
@@ -1603,12 +1603,12 @@ trendByteBudgetPerCycle: number | undefined
warmupCycles: number | undefined
```
-## CensusTier — type
+## CensusTier — type @experimental
```
'conserved' | 'bounded' | 'trend' | 'info'
```
-## CensusVerdict — interface
+## CensusVerdict — interface @experimental
```
confidentSlopePerCycle: number
first: number
@@ -1623,28 +1623,28 @@ tier: CensusTier
unit: "count" | "bytes"
```
-## ChainCollider — const
+## ChainCollider — const @experimental
```
ComponentDef<ChainColliderData>
```
-## Changed — function
+## Changed — function @experimental
```
<T extends AnyComponentDef>(component: T): ChangedWrapper<T>
```
-## ChangedWrapper — interface
+## ChangedWrapper — interface @experimental
```
_component: T
_filterType: "changed"
```
-## CharacterController — const
+## CharacterController — const @experimental
```
ComponentDef<CharacterControllerData>
```
-## CharacterControllerData — interface
+## CharacterControllerData — interface @experimental
```
floorMaxAngle: number
floorNormal: Vec2
@@ -1661,22 +1661,22 @@ up: Vec2
velocity: Vec2
```
-## Children — const
+## Children — const @experimental
```
BuiltinComponentDef<ChildrenData>
```
-## ChildrenData — interface
+## ChildrenData — interface @experimental
```
entities: number[]
```
-## CircleCollider — const
+## CircleCollider — const @experimental
```
BuiltinComponentDef<CircleColliderData>
```
-## CircleColliderData — interface
+## CircleColliderData — interface @experimental
```
categoryBits: number
density: number
@@ -1689,7 +1689,7 @@ radius: number
restitution: number
```
-## ClearFlags — enum
+## ClearFlags — enum @experimental
```
Color = 1
ColorAndDepth = 3
@@ -1697,20 +1697,20 @@ Depth = 2
Nothing = 0
```
-## ColliderInstance — interface
+## ColliderInstance — interface @experimental
```
enabled: boolean
isSensor: boolean
shape: ColliderShape
```
-## ColliderOutline — interface
+## ColliderOutline — interface @experimental
```
circles: { c: Vec2; r: number; }[]
polylines: Vec2[][]
```
-## ColliderShape — type
+## ColliderShape — type @experimental
```
| { kind: 'box'; halfExtents: Vec2; offset: Vec2 }
| { kind: 'circle'; radius: number; offset: Vec2 }
@@ -1720,14 +1720,14 @@ polylines: Vec2[][]
| { kind: 'chain'; points: Vec2[]; isLoop: boolean }
```
-## CollisionBrush — interface
+## CollisionBrush — interface @experimental
```
collision: ResolvedTileCollision
id: number
key: string
```
-## CollisionEnterEvent — interface
+## CollisionEnterEvent — interface @experimental
```
contactX: number
contactY: number
@@ -1737,7 +1737,7 @@ normalX: number
normalY: number
```
-## CollisionHitEvent — interface
+## CollisionHitEvent — interface @experimental
```
approachSpeed: number
entityA: number
@@ -1748,14 +1748,14 @@ pointX: number
pointY: number
```
-## CollisionMaterial — interface
+## CollisionMaterial — interface @experimental
```
density: number | undefined
friction: number | undefined
restitution: number | undefined
```
-## Color — interface
+## Color — interface @experimental
```
a: number
b: number
@@ -1763,22 +1763,22 @@ g: number
r: number
```
-## ColorRole — type
+## ColorRole — type @experimental
```
keyof ThemeColors
```
-## Commands — function
+## Commands — function @experimental
```
(): CommandsDescriptor
```
-## CommandsDescriptor — interface
+## CommandsDescriptor — interface @experimental
```
_type: "commands"
```
-## CommandsInstance — class
+## CommandsInstance — class @experimental
```
despawn: (entity: Entity) => CommandsInstance
entity: (entity: Entity) => EntityCommands
@@ -1792,18 +1792,18 @@ static new (world: World, resources: ResourceStorage): CommandsInstance
static prototype: CommandsInstance
```
-## CompareOp — type
+## CompareOp — type @experimental
```
'==' | '!=' | '<' | '<=' | '>' | '>=' | 'truthy' | 'falsy'
```
-## CompiledFsm — interface
+## CompiledFsm — interface @experimental
```
initial: string
states: Map<string, FsmState>
```
-## Completable — interface
+## Completable — interface @experimental
```
cancel: () => void
pause: () => void
@@ -1811,14 +1811,14 @@ resume: () => void
state: TweenState
```
-## ComponentData — type
+## ComponentData — type @experimental
```
C extends BuiltinComponentDef<infer T> ? T :
C extends ComponentDef<infer T> ? T :
never
```
-## ComponentDef — interface
+## ComponentDef — interface @experimental
```
_builtin: false
_default: T
@@ -1838,7 +1838,7 @@ skeletalFields: SkeletalFieldMeta | undefined
transient: boolean
```
-## ComponentMetadata — interface
+## ComponentMetadata — interface @experimental
```
animatableFields: string[] | undefined
assetFields: AssetFieldMeta[] | undefined
@@ -1852,7 +1852,7 @@ skeletalFields: SkeletalFieldMeta | undefined
transient: boolean | undefined
```
-## CompressorEffectDef — interface
+## CompressorEffectDef — interface @experimental
```
attack: number | undefined
kneeDb: number | undefined
@@ -1862,14 +1862,14 @@ thresholdDb: number | undefined
type: "compressor"
```
-## ControllerState — interface
+## ControllerState — interface @experimental
```
current: string
name: string
pages: string[]
```
-## CookedAtlasInfo — interface
+## CookedAtlasInfo — interface @experimental
```
frame: { x: number; y: number; width: number; height: number; }
page: number | undefined
@@ -1877,7 +1877,7 @@ pageHeight: number
pageWidth: number
```
-## CppRegistry — interface
+## CppRegistry — interface @experimental
```
addBitmapText: (entity: Entity, component: BitmapText) => void
addBoxCollider: (entity: Entity, component: BoxCollider) => void
@@ -2007,7 +2007,7 @@ setParent: (child: Entity, parent: Entity) => void
valid: (entity: Entity) => boolean
```
-## CppResourceManager — interface
+## CppResourceManager — interface @experimental
```
acquireTextureByPath: (path: string) => number
createLabelAtlasFont: (textureHandle: number, texWidth: number, texHeight: number, chars: string, charWidth: number, charHeight: number) => number
@@ -2039,7 +2039,7 @@ updateTextureSubregion: (handle: number, x: number, y: number, width: number, he
updateTextureSubregionFromBytes: ((handle: number, x: number, y: number, width: number, height: number, pixels: Uint8Array) => void) | undefined
```
-## CreateListViewOptions — interface
+## CreateListViewOptions — interface @experimental
```
background: UIVisualInit | undefined
data: DataSource<T> | readonly T[]
@@ -2058,7 +2058,7 @@ wheelSpeed: number | undefined
world: World
```
-## CreateWebAppOptions — interface
+## CreateWebAppOptions — interface @experimental
```
colorSpace: "gamma" | "linear" | undefined
depthLayers: number | undefined
@@ -2072,109 +2072,109 @@ wasmBaseUrl: string | undefined
ySortLayers: number | undefined
```
-## CullMode — enum
+## CullMode — enum @experimental
```
Back = 1
Front = 2
None = 0
```
-## DARK_TOKENS — const
+## DARK_TOKENS — const @experimental
```
ThemeTokens
```
-## DEFAULT_ANIM_CLIP_PIVOT — const
+## DEFAULT_ANIM_CLIP_PIVOT — const @experimental
```
AnimClipPivotData
```
-## DEFAULT_DESIGN_HEIGHT — const
+## DEFAULT_DESIGN_HEIGHT — const @experimental
```
number
```
-## DEFAULT_DESIGN_WIDTH — const
+## DEFAULT_DESIGN_WIDTH — const @experimental
```
number
```
-## DEFAULT_EDITOR_GRID — const
+## DEFAULT_EDITOR_GRID — const @experimental
```
EditorGridData
```
-## DEFAULT_EDITOR_VIEW — const
+## DEFAULT_EDITOR_VIEW — const @experimental
```
EditorViewData
```
-## DEFAULT_FALLBACK_DT — const
+## DEFAULT_FALLBACK_DT — const @experimental
```
number
```
-## DEFAULT_FIXED_TIMESTEP — const
+## DEFAULT_FIXED_TIMESTEP — const @experimental
```
number
```
-## DEFAULT_FONT_FAMILY — const
+## DEFAULT_FONT_FAMILY — const @experimental
```
"Arial"
```
-## DEFAULT_FONT_SIZE — const
+## DEFAULT_FONT_SIZE — const @experimental
```
24
```
-## DEFAULT_GRAVITY — const
+## DEFAULT_GRAVITY — const @experimental
```
{ x: number; y: number; }
```
-## DEFAULT_LINE_HEIGHT — const
+## DEFAULT_LINE_HEIGHT — const @experimental
```
1.2
```
-## DEFAULT_MAX_DELTA_TIME — const
+## DEFAULT_MAX_DELTA_TIME — const @experimental
```
0.5
```
-## DEFAULT_PIXELS_PER_UNIT — const
+## DEFAULT_PIXELS_PER_UNIT — const @experimental
```
number
```
-## DEFAULT_SCREEN_SCALING — const
+## DEFAULT_SCREEN_SCALING — const @experimental
```
ScreenScalingData
```
-## DEFAULT_SPINE_SKIN — const
+## DEFAULT_SPINE_SKIN — const @experimental
```
"default"
```
-## DEFAULT_SPRITE_SIZE — const
+## DEFAULT_SPRITE_SIZE — const @experimental
```
{ x: number; y: number; }
```
-## DEFAULT_TEXT_CANVAS_SIZE — const
+## DEFAULT_TEXT_CANVAS_SIZE — const @experimental
```
512
```
-## DEFAULT_UI_CAMERA_INFO — const
+## DEFAULT_UI_CAMERA_INFO — const @experimental
```
{ readonly viewProjection: Float32Array<ArrayBuffer>; readonly vpX: 0; readonly vpY: 0; readonly vpW: 0; readonly vpH: 0; readonly screenW: 0; readonly screenH: 0; readonly worldLeft: 0; readonly worldBottom: 0; readonly worldRight: 0; readonly worldTop: 0; readonly worldMouseX: 0; readonly worldMouseY: 0; readonly valid: false; }
```
-## DataSource — interface
+## DataSource — interface @experimental
```
getCount: () => number
getItem: (index: number) => T
@@ -2183,7 +2183,7 @@ getItemType: ((index: number) => string) | undefined
subscribe: ((listener: (change: DataSourceChange) => void) => Unsubscribe) | undefined
```
-## DataSourceChange — type
+## DataSourceChange — type @experimental
```
| { type: 'insert'; index: number; count: number }
| { type: 'remove'; index: number; count: number }
@@ -2191,7 +2191,7 @@ subscribe: ((listener: (change: DataSourceChange) => void) => Unsubscribe) | und
| { type: 'reset' }
```
-## DataType — enum
+## DataType — enum @experimental
```
Float = 1
Float2 = 2
@@ -2203,21 +2203,21 @@ Int3 = 7
Int4 = 8
```
-## DecodedChunk — interface
+## DecodedChunk — interface @experimental
```
tiles: Uint16Array<ArrayBufferLike>
x: number
y: number
```
-## DecodedPixels — interface
+## DecodedPixels — interface @experimental
```
height: number
pixels: Uint8Array<ArrayBufferLike>
width: number
```
-## DeviceIdentity — interface
+## DeviceIdentity — interface @experimental
```
backend: string
renderer: string
@@ -2225,17 +2225,17 @@ vendor: string
version: string
```
-## DeviceLostReason — const
+## DeviceLostReason — const @experimental
```
{ readonly Unknown: 0; readonly ContextLost: 1; readonly OutOfMemory: 2; readonly Reset: 3; readonly Removed: 4; readonly Destroyed: 5; readonly Validation: 6; readonly Internal: 7; }
```
-## DeviceStatus — const
+## DeviceStatus — const @experimental
```
{ readonly Live: 0; readonly Lost: 1; readonly Recovering: 2; readonly Dead: 3; }
```
-## DiagnosticEvent — interface
+## DiagnosticEvent — interface @experimental
```
context: Record<string, unknown> | undefined
count: number
@@ -2248,7 +2248,7 @@ source: string | undefined
stack: string | undefined
```
-## DiagnosticKind — type
+## DiagnosticKind — type @experimental
```
| 'engine'
/** Reached the host with nobody catching it: `window.onerror`,
@@ -2267,7 +2267,7 @@ stack: string | undefined
| 'game'
```
-## DiagnosticReport — interface
+## DiagnosticReport — interface @experimental
```
context: Record<string, unknown> | undefined
error: unknown
@@ -2276,12 +2276,12 @@ message: string
source: string | undefined
```
-## Diagnostics — const
+## Diagnostics — const @experimental
```
ResourceDef<DiagnosticsAPI>
```
-## DiagnosticsAPI — class
+## DiagnosticsAPI — class @experimental
```
clear: () => void
dropped: number
@@ -2295,13 +2295,13 @@ static new (options?: DiagnosticsOptions): DiagnosticsAPI
static prototype: DiagnosticsAPI
```
-## DiagnosticsOptions — interface
+## DiagnosticsOptions — interface @experimental
```
flushIntervalSec: number | undefined
maxDistinct: number | undefined
```
-## DiagnosticsPlugin — class
+## DiagnosticsPlugin — class @experimental
```
build: (app: App) => void
cleanup: (app: App) => void
@@ -2310,19 +2310,19 @@ static new (options_?: DiagnosticsPluginOptions): DiagnosticsPlugin
static prototype: DiagnosticsPlugin
```
-## DiagnosticsPluginOptions — interface
+## DiagnosticsPluginOptions — interface @experimental
```
captureLevel: LogLevel | undefined
flushIntervalSec: number | undefined
maxDistinct: number | undefined
```
-## DiagnosticsSink — type
+## DiagnosticsSink — type @experimental
```
(events: readonly DiagnosticEvent[]) => void
```
-## DialogHandle — interface
+## DialogHandle — interface @experimental
```
close: () => void
dispose: () => void
@@ -2332,7 +2332,7 @@ open: () => void
panelEntity: number
```
-## DialogOptions — interface
+## DialogOptions — interface @experimental
```
backdropNode: UINodeInit | undefined
backdropVisual: UIVisualInit | undefined
@@ -2347,35 +2347,35 @@ startHidden: boolean | undefined
world: World
```
-## DiffOptions — interface
+## DiffOptions — interface @experimental
```
floatEpsilon: number | undefined
ignoreEntityNames: readonly string[] | undefined
ignoreMetadataKeys: readonly string[] | undefined
```
-## Dimension — interface
+## Dimension — interface @experimental
```
unit: number
value: number
```
-## DimensionUnit — type
+## DimensionUnit — type @experimental
```
(typeof DimensionUnit)[keyof typeof DimensionUnit]
```
-## Disabled — const
+## Disabled — const @experimental
```
ComponentDef<{}>
```
-## DistanceJoint — const
+## DistanceJoint — const @experimental
```
ComponentDef<DistanceJointData>
```
-## DragPlugin — class
+## DragPlugin — class @experimental
```
build: (app: App) => void
dependencies: "uiInteraction"[]
@@ -2384,12 +2384,12 @@ static new (): DragPlugin
static prototype: DragPlugin
```
-## DragState — const
+## DragState — const @experimental
```
ComponentDef<DragStateData>
```
-## DragStateData — interface
+## DragStateData — interface @experimental
```
currentWorldPos: { x: number; y: number; }
deltaWorld: { x: number; y: number; }
@@ -2399,12 +2399,12 @@ startWorldPos: { x: number; y: number; }
totalDeltaWorld: { x: number; y: number; }
```
-## Draggable — const
+## Draggable — const @experimental
```
ComponentDef<DraggableData>
```
-## DraggableData — interface
+## DraggableData — interface @experimental
```
constraintMax: { x: number; y: number; } | null
constraintMin: { x: number; y: number; } | null
@@ -2414,17 +2414,17 @@ lockX: boolean
lockY: boolean
```
-## DragonBones — const
+## DragonBones — const @experimental
```
ResourceDef<DragonBonesManager | null>
```
-## DragonBonesAnimation — const
+## DragonBonesAnimation — const @experimental
```
BuiltinComponentDef<DragonBonesAnimationData>
```
-## DragonBonesAnimationData — interface
+## DragonBonesAnimationData — interface @experimental
```
animation: string
armature: string
@@ -2443,7 +2443,7 @@ skeletonScale: number
timeScale: number
```
-## DragonBonesPlugin — class
+## DragonBonesPlugin — class @experimental
```
acquire: () => Promise<DragonBonesManager | null>
build: (app: App) => void
@@ -2454,12 +2454,12 @@ static new (manager?: DragonBonesManager): DragonBonesPlugin
static prototype: DragonBonesPlugin
```
-## Draw — const
+## Draw — const @experimental
```
DrawAPI
```
-## DrawAPI — interface
+## DrawAPI — interface @experimental
```
begin: (viewProjection: Float32Array) => void
circle: (center: Vec2, radius: number, color: Color, filled?: boolean, segments?: number) => void
@@ -2480,7 +2480,7 @@ texture: (position: Vec2, size: Vec2, textureHandle: number, tint?: Color) => vo
textureRotated: (position: Vec2, size: Vec2, rotation: number, textureHandle: number, tint?: Color) => void
```
-## DrawCallInfo — interface
+## DrawCallInfo — interface @experimental
```
blendMode: number
cameraIndex: number
@@ -2508,12 +2508,12 @@ type: RenderType
vertexCount: number
```
-## DrawCallback — type
+## DrawCallback — type @experimental
```
(elapsed: number) => void
```
-## DrawRank — interface
+## DrawRank — interface @experimental
```
layer: number
order: LayerOrder
@@ -2521,7 +2521,7 @@ worldY: number
worldZ: number
```
-## DropShadowFilterOptions — interface
+## DropShadowFilterOptions — interface @experimental
```
blur: number | undefined
color: { r: number; g: number; b: number; a: number; } | undefined
@@ -2530,7 +2530,7 @@ offsetY: number | undefined
texelSize: { x: number; y: number; } | undefined
```
-## DropdownHandle — interface
+## DropdownHandle — interface @experimental
```
close: () => void
dispose: () => void
@@ -2543,7 +2543,7 @@ open: () => void
setSelectedIndex: (index: number) => void
```
-## DropdownOptions — interface
+## DropdownOptions — interface @experimental
```
buttonStates: { normal?: Color; hover?: Color; pressed?: Color; } | undefined
disabled: boolean | undefined
@@ -2560,17 +2560,17 @@ tabIndex: number | undefined
world: World
```
-## EDITOR_UI_ANCHOR — const
+## EDITOR_UI_ANCHOR — const @experimental
```
{ readonly x: 0; readonly y: 0; }
```
-## EDITOR_VIEW_ENTITY — const
+## EDITOR_VIEW_ENTITY — const @experimental
```
-1
```
-## ESEngineModule — interface
+## ESEngineModule — interface @experimental
```
EstellaContext: new () => CppEngineContext
FS: EmscriptenFS
@@ -2792,12 +2792,12 @@ ui_getCullBit: ((registry: CppRegistry, entity: number) => number) | undefined
ui_getRenderOrder: ((registry: CppRegistry, entity: number) => number) | undefined
```
-## EasingType — type
+## EasingType — type @experimental
```
(typeof EasingType)[keyof typeof EasingType]
```
-## EditorAssetType — type
+## EditorAssetType — type @experimental
```
| 'texture' | 'material' | 'shader' | 'spine-atlas' | 'spine-skeleton'
| 'dragonbones-atlas' | 'dragonbones-skeleton'
@@ -2806,7 +2806,7 @@ ui_getRenderOrder: ((registry: CppRegistry, entity: number) => number) | undefin
| 'unknown'
```
-## EditorBridge — interface
+## EditorBridge — interface @experimental
```
onComponentAdded: ((entity: number, component: string) => void) | undefined
onComponentChanged: ((entity: number, component: string) => void) | undefined
@@ -2817,12 +2817,12 @@ onParentChanged: ((child: number, parent: number | null) => void) | undefined
registerComponent: (name: string, defaults: Record<string, unknown>, isTag: boolean) => void
```
-## EditorGrid — const
+## EditorGrid — const @experimental
```
ResourceDef<EditorGridData>
```
-## EditorGridData — interface
+## EditorGridData — interface @experimental
```
axisX: GridColor
axisY: GridColor
@@ -2833,12 +2833,12 @@ majorEvery: number
spacing: number
```
-## EditorView — const
+## EditorView — const @experimental
```
ResourceDef<EditorViewData>
```
-## EditorViewData — interface
+## EditorViewData — interface @experimental
```
active: boolean
distance: number
@@ -2850,7 +2850,7 @@ x: number
y: number
```
-## EffectDef — interface
+## EffectDef — interface @experimental
```
factory: () => ShaderHandle
label: string
@@ -2860,7 +2860,7 @@ type: string
uniforms: EffectUniformDef[]
```
-## EffectUniformDef — interface
+## EffectUniformDef — interface @experimental
```
defaultValue: number
label: string
@@ -2871,18 +2871,18 @@ neutralValue: number | undefined
step: number
```
-## EmbeddedSideModuleEntry — interface
+## EmbeddedSideModuleEntry — interface @experimental
```
glueBase64: string
wasmBase64: string
```
-## EmbeddedSideModuleRegistry — type
+## EmbeddedSideModuleRegistry — type @experimental
```
Partial<Record<SideModuleId, EmbeddedSideModuleEntry>>
```
-## EmitterShape — enum
+## EmitterShape — enum @experimental
```
Circle = 1
Cone = 3
@@ -2890,17 +2890,17 @@ Point = 0
Rectangle = 2
```
-## EngineApi — type
+## EngineApi — type @experimental
```
NativeEngineApi & Partial<NativeHeap>
```
-## Entity — type
+## Entity — type @experimental
```
number
```
-## EntityCommands — class
+## EntityCommands — class @experimental
```
finalize: () => void
id: () => Entity
@@ -2910,7 +2910,7 @@ static new (commands: CommandsInstance, entity: Entity | null, name?: string): E
static prototype: EntityCommands
```
-## EntityEvent — interface
+## EntityEvent — interface @experimental
```
currentTarget: number
data: TData
@@ -2922,12 +2922,12 @@ target: number
type: string
```
-## EntityEventHandler — type
+## EntityEventHandler — type @experimental
```
(event: EntityEvent<TData>) => void
```
-## EntityEventQueue — class
+## EntityEventQueue — class @experimental
```
clear: () => void
drain: () => readonly EntityEvent[]
@@ -2941,22 +2941,22 @@ static new (): EntityEventQueue
static prototype: EntityEventQueue
```
-## EntityEvents — const
+## EntityEvents — const @experimental
```
ResourceDef<EntityEventQueue>
```
-## EventBinding — const
+## EventBinding — const @experimental
```
ComponentDef<EventBindingData>
```
-## EventBindingData — interface
+## EventBindingData — interface @experimental
```
rows: EventBindingRow[]
```
-## EventBindingPlugin — class
+## EventBindingPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -2965,7 +2965,7 @@ static new (): EventBindingPlugin
static prototype: EventBindingPlugin
```
-## EventBindingRow — interface
+## EventBindingRow — interface @experimental
```
action: string
arg: string | undefined
@@ -2977,25 +2977,25 @@ params: Record<string, AiParamValue> | undefined
target: string | undefined
```
-## EventDef — interface
+## EventDef — interface @experimental
```
_id: symbol
_name: string
_phantom: T | undefined
```
-## EventReader — function
+## EventReader — function @experimental
```
<T>(event: EventDef<T>): EventReaderDescriptor<T>
```
-## EventReaderDescriptor — interface
+## EventReaderDescriptor — interface @experimental
```
_event: EventDef<T>
_type: "event_reader"
```
-## EventReaderInstance — class
+## EventReaderInstance — class @experimental
```
isEmpty: () => boolean
toArray: () => T[]
@@ -3003,7 +3003,7 @@ static new <T>(bus: EventBus<T>): EventReaderInstance<T>
static prototype: EventReaderInstance<any>
```
-## EventRegistry — class
+## EventRegistry — class @experimental
```
getBus: <T>(event: EventDef<T>) => EventBus<T>
register: <T>(event: EventDef<T>) => void
@@ -3012,25 +3012,25 @@ static new (): EventRegistry
static prototype: EventRegistry
```
-## EventWriter — function
+## EventWriter — function @experimental
```
<T>(event: EventDef<T>): EventWriterDescriptor<T>
```
-## EventWriterDescriptor — interface
+## EventWriterDescriptor — interface @experimental
```
_event: EventDef<T>
_type: "event_writer"
```
-## EventWriterInstance — class
+## EventWriterInstance — class @experimental
```
send: (event: T) => void
static new <T>(bus: EventBus<T>): EventWriterInstance<T>
static prototype: EventWriterInstance<any>
```
-## ExternalEntityRef — interface
+## ExternalEntityRef — interface @experimental
```
componentType: string
entityId: number
@@ -3038,7 +3038,7 @@ field: string
target: number
```
-## ExtractEntity — interface
+## ExtractEntity — interface @experimental
```
children: number[]
components: ComponentData[]
@@ -3048,12 +3048,12 @@ parent: number | null
visible: boolean | undefined
```
-## FILL_AXIS — const
+## FILL_AXIS — const @experimental
```
Record<LinearFillDirection, readonly [FillMethod, FillOrigin]>
```
-## FieldMeta — interface
+## FieldMeta — interface @experimental
```
advanced: boolean | undefined
bitmask: { bits?: number; source?: string; } | undefined
@@ -3073,7 +3073,7 @@ tooltip: string | undefined
unit: string | undefined
```
-## FillMethod — enum
+## FillMethod — enum @experimental
```
Horizontal = 0
Radial180 = 4
@@ -3082,7 +3082,7 @@ Radial90 = 3
Vertical = 1
```
-## FillOrigin — enum
+## FillOrigin — enum @experimental
```
Bottom = 2
Left = 0
@@ -3090,7 +3090,7 @@ Right = 1
Top = 3
```
-## FilterEffectDef — interface
+## FilterEffectDef — interface @experimental
```
filter: "lowpass" | "highpass" | "bandpass" | "lowshelf" | "highshelf" | "peaking" | "notch"
frequency: number
@@ -3099,7 +3099,7 @@ q: number | undefined
type: "filter"
```
-## FilterExpr — type
+## FilterExpr — type @experimental
```
| { readonly kind: 'with'; readonly component: AnyComponentDef }
| { readonly kind: 'without'; readonly component: AnyComponentDef }
@@ -3108,12 +3108,12 @@ type: "filter"
| { readonly kind: 'not'; readonly filter: FilterExpr }
```
-## Filters — const
+## Filters — const @experimental
```
{ identityMatrix(): number[]; grayscaleMatrix(): number[]; sepiaMatrix(): number[]; brightnessMatrix(value: number): number[]; contrastMatrix(value: number): number[]; saturationMatrix(value: number): number[]; invertMatrix(): number[]; getColorMatrixShader: () => ShaderHandle; colorMatrixUniforms(matrix: number[]): Record<string, number[]>; }
```
-## FlattenContext — interface
+## FlattenContext — interface @experimental
```
allocateId: () => number
depth: number | undefined
@@ -3121,18 +3121,18 @@ loadPrefab: (path: string) => PrefabData | null
visited: Set<string> | undefined
```
-## FlattenResult — interface
+## FlattenResult — interface @experimental
```
entities: ProcessedEntity[]
rootId: number
```
-## FlexContainer — const
+## FlexContainer — const @experimental
```
BuiltinComponentDef<FlexContainerData>
```
-## FlexContainerData — interface
+## FlexContainerData — interface @experimental
```
alignContent: AlignContent
alignItems: AlignItems
@@ -3143,17 +3143,17 @@ padding: Padding
wrap: FlexWrap
```
-## FlexDirection — type
+## FlexDirection — type @experimental
```
(typeof FlexDirection)[keyof typeof FlexDirection]
```
-## FlexWrap — type
+## FlexWrap — type @experimental
```
(typeof FlexWrap)[keyof typeof FlexWrap]
```
-## FlushReason — enum
+## FlushReason — enum @experimental
```
BatchFull = 0
BlendModeChange = 5
@@ -3166,12 +3166,12 @@ TextureSlotsFull = 1
TypeChange = 7
```
-## FocusManager — const
+## FocusManager — const @experimental
```
ResourceDef<FocusManagerState>
```
-## FocusManagerState — class
+## FocusManagerState — class @experimental
```
blur: () => Entity | null
focus: (entity: Entity, visible?: boolean) => Entity | null
@@ -3182,7 +3182,7 @@ static new (): FocusManagerState
static prototype: FocusManagerState
```
-## FocusPlugin — class
+## FocusPlugin — class @experimental
```
build: (app: App) => void
dependencies: "uiInteraction"[]
@@ -3191,23 +3191,23 @@ static new (): FocusPlugin
static prototype: FocusPlugin
```
-## Focusable — const
+## Focusable — const @experimental
```
ComponentDef<FocusableData>
```
-## FocusableData — interface
+## FocusableData — interface @experimental
```
isFocused: boolean
tabIndex: number
```
-## FollowTarget — const
+## FollowTarget — const @experimental
```
ComponentDef<FollowTargetData>
```
-## FollowTargetData — interface
+## FollowTargetData — interface @experimental
```
damping: number
deadzone: number
@@ -3216,12 +3216,12 @@ offsetY: number
target: number
```
-## FontHandle — type
+## FontHandle — type @experimental
```
number
```
-## ForceFieldType — enum
+## ForceFieldType — enum @experimental
```
Directional = 0
Drag = 3
@@ -3229,13 +3229,13 @@ Point = 1
Vortex = 2
```
-## FrameCaptureData — interface
+## FrameCaptureData — interface @experimental
```
cameraCount: number
drawCalls: DrawCallInfo[]
```
-## FrameHistory — class
+## FrameHistory — class @experimental
```
count: number
getAll: () => FrameSnapshot[]
@@ -3246,14 +3246,14 @@ static new (capacity?: number): FrameHistory
static prototype: FrameHistory
```
-## FrameSnapshot — interface
+## FrameSnapshot — interface @experimental
```
frameTimeMs: number
phaseTimings: Map<string, number>
systemTimings: Map<string, number>
```
-## FrameStats — interface
+## FrameStats — interface @experimental
```
culled: number
drawCalls: number
@@ -3269,23 +3269,23 @@ text: number
triangles: number
```
-## FsmActionRef — type
+## FsmActionRef — type @experimental
```
string | { name: string; arg?: string; params?: Record<string, AiParamValue> }
```
-## FsmDefinition — interface
+## FsmDefinition — interface @experimental
```
initial: string
states: FsmState[]
```
-## FsmEdge — type
+## FsmEdge — type @experimental
```
GraphEdge<FsmTransition>
```
-## FsmPlugin — class
+## FsmPlugin — class @experimental
```
build: (app: App) => void
name: string
@@ -3293,14 +3293,14 @@ static new (): FsmPlugin
static prototype: FsmPlugin
```
-## FsmRunState — interface
+## FsmRunState — interface @experimental
```
current: string
entered: boolean
previous: string | null
```
-## FsmState — interface
+## FsmState — interface @experimental
```
name: string
onEnter: FsmActionRef | undefined
@@ -3311,7 +3311,7 @@ x: number | undefined
y: number | undefined
```
-## FsmTransition — interface
+## FsmTransition — interface @experimental
```
condition: string | undefined
guard: BlackboardGuard | BlackboardGuard[] | undefined
@@ -3319,12 +3319,12 @@ to: string
trigger: string | undefined
```
-## GLDebug — const
+## GLDebug — const @experimental
```
{ enable(): void; disable(): void; check(context: string): number; diagnose(): void; }
```
-## GameSocket — class
+## GameSocket — class @experimental
```
close: (code?: number, reason?: string) => void
connect: () => void
@@ -3335,12 +3335,12 @@ static new (options: GameSocketOptions): GameSocket
static prototype: GameSocket
```
-## GameSocketOptions — type
+## GameSocketOptions — type @experimental
```
PlatformSocketOptions
```
-## GamepadAxis — enum
+## GamepadAxis — enum @experimental
```
LeftX = 0
LeftY = 1
@@ -3348,7 +3348,7 @@ RightX = 2
RightY = 3
```
-## GamepadButton — enum
+## GamepadButton — enum @experimental
```
Back = 8
DpadDown = 13
@@ -3369,7 +3369,7 @@ Start = 9
West = 2
```
-## GamepadSnapshot — interface
+## GamepadSnapshot — interface @experimental
```
axes: number[]
buttons: number[]
@@ -3378,7 +3378,7 @@ index: number
mapping: string
```
-## GearBinding — interface
+## GearBinding — interface @experimental
```
component: string
controller: string
@@ -3387,28 +3387,28 @@ property: string
tween: GearTween | undefined
```
-## GearTween — interface
+## GearTween — interface @experimental
```
duration: number
easing: EasingType
```
-## GearValue — type
+## GearValue — type @experimental
```
number | boolean | string | Color | Vec2 | Vec3
```
-## Geometry — const
+## Geometry — const @experimental
```
{ create(options: GeometryOptions): GeometryHandle; updateVertices(handle: GeometryHandle, vertices: Float32Array, offset?: number): void; release(handle: GeometryHandle): void; isValid(handle: GeometryHandle): boolean; createQuad(width?: number, height?: number): GeometryHandle; createCircle(radius?: number, segments?: number): GeometryHandle; createPolygon(points: Array<{ x: number; y: number; }>): GeometryHandle; }
```
-## GeometryHandle — type
+## GeometryHandle — type @experimental
```
number
```
-## GeometryOptions — interface
+## GeometryOptions — interface @experimental
```
dynamic: boolean | undefined
indices: Uint16Array<ArrayBufferLike> | Uint32Array<ArrayBufferLike> | undefined
@@ -3416,7 +3416,7 @@ layout: VertexAttributeDescriptor[]
vertices: Float32Array<ArrayBufferLike>
```
-## GestureDetector — class
+## GestureDetector — class @experimental
```
onLongPress: ((x: number, y: number) => void) | null
onPinch: ((scale: number, centerX: number, centerY: number) => void) | null
@@ -3428,22 +3428,22 @@ static new (input: InputState): GestureDetector
static prototype: GestureDetector
```
-## GetWorld — function
+## GetWorld — function @experimental
```
(): GetWorldDescriptor
```
-## GetWorldDescriptor — interface
+## GetWorldDescriptor — interface @experimental
```
_type: "get_world"
```
-## GpAxis — const
+## GpAxis — const @experimental
```
(axis: number, pad?: number, scale?: number) => Binding
```
-## GpButton — const
+## GpButton — const @experimental
```
(button: number, pad?: number) => Binding
```
@@ -3474,7 +3474,7 @@ _type: "get_world"
'float' | 'vec2' | 'vec3' | 'vec4'
```
-## Graphics — class
+## Graphics — class @experimental
```
arc: (cx: number, cy: number, radius: number, startAngle: number, endAngle: number, anticlockwise?: boolean, segments?: number) => void
beginFill: (color: Color) => void
@@ -3498,12 +3498,12 @@ static new (): Graphics
static prototype: Graphics
```
-## GridColor — type
+## GridColor — type @experimental
```
[number, number, number, number]
```
-## GridLayoutProvider — class
+## GridLayoutProvider — class @experimental
```
getContentSize: (count: number) => Vec2
getItemRect: (index: number) => Rect
@@ -3512,20 +3512,20 @@ static new (opts: GridLayoutOptions): GridLayoutProvider
static prototype: GridLayoutProvider
```
-## HeadlessAppOptions — interface
+## HeadlessAppOptions — interface @experimental
```
plugins: Plugin[] | undefined
sideModules: SideModuleHost | undefined
```
-## HitAreaShape — type
+## HitAreaShape — type @experimental
```
| { type: 'rect'; x: number; y: number; width: number; height: number }
| { type: 'circle'; cx: number; cy: number; radius: number }
| { type: 'polygon'; points: number[] }
```
-## HttpBackend — class
+## HttpBackend — class @experimental
```
fetchBinary: (path: string) => Promise<ArrayBuffer>
fetchText: (path: string) => Promise<string>
@@ -3535,42 +3535,42 @@ static new (options: HttpBackendOptions): HttpBackend
static prototype: HttpBackend
```
-## INTERACTION_CONTROLLER — const
+## INTERACTION_CONTROLLER — const @experimental
```
"$interaction"
```
-## INTERACTION_PAGES — const
+## INTERACTION_PAGES — const @experimental
```
readonly ["normal", "hover", "pressed", "disabled", "focused"]
```
-## INVALID_ENTITY — const
+## INVALID_ENTITY — const @experimental
```
number
```
-## INVALID_FONT — const
+## INVALID_FONT — const @experimental
```
number
```
-## INVALID_MATERIAL — const
+## INVALID_MATERIAL — const @experimental
```
0
```
-## INVALID_TEXTURE — const
+## INVALID_TEXTURE — const @experimental
```
number
```
-## Identity — const
+## Identity — const @experimental
```
ResourceDef<IdentityAPI>
```
-## IdentityAPI — class
+## IdentityAPI — class @experimental
```
available: boolean
login: () => Promise<LoginResult>
@@ -3579,7 +3579,7 @@ static new (): IdentityAPI
static prototype: IdentityAPI
```
-## ImageSegment — interface
+## ImageSegment — interface @experimental
```
height: number
offsetX: number
@@ -3592,7 +3592,7 @@ valign: ImageValign
width: number
```
-## InferParam — type
+## InferParam — type @experimental
```
P extends QueryDescriptor<infer C> ? QueryInstance<C> :
P extends ResDescriptor<infer T> ? T :
@@ -3605,19 +3605,19 @@ P extends QueryDescriptor<infer C> ? QueryInstance<C> :
never
```
-## InferParams — type
+## InferParams — type @experimental
```
{
[K in keyof P]: InferParam<P[K]>;
}
```
-## Input — const
+## Input — const @experimental
```
ResourceDef<InputState>
```
-## InputHandler — interface
+## InputHandler — interface @experimental
```
onKeyDown: ((code: string, mods: Modifiers) => boolean | void) | undefined
onKeyUp: ((code: string, mods: Modifiers) => boolean | void) | undefined
@@ -3631,7 +3631,7 @@ onTouchStart: ((id: number, x: number, y: number) => boolean | void) | undefined
onWheel: ((deltaX: number, deltaY: number, mods: Modifiers) => boolean | void) | undefined
```
-## InputMap — class
+## InputMap — class @experimental
```
actions: () => string[]
axis2d: (name: string) => Vec2
@@ -3655,13 +3655,13 @@ static new (actions: Record<string, ActionDef>): InputMap
static prototype: InputMap
```
-## InputMapAsset — interface
+## InputMapAsset — interface @experimental
```
actions: Record<string, ActionDef>
version: number
```
-## InputPlugin — class
+## InputPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -3670,7 +3670,7 @@ static new (target?: unknown): InputPlugin
static prototype: InputPlugin
```
-## InputRouter — class
+## InputRouter — class @experimental
```
currentMods: Modifiers
dispatchKeyDown: (code: string) => boolean
@@ -3689,7 +3689,7 @@ static new (): InputRouter
static prototype: InputRouter
```
-## InputState — class
+## InputState — class @experimental
```
beginFixedStep: () => void
clearFrameState: () => void
@@ -3748,7 +3748,7 @@ static new (): InputState
static prototype: InputState
```
-## InstantiatePrefabOptions — interface
+## InstantiatePrefabOptions — interface @experimental
```
assetBaseUrl: string | undefined
assets: Assets | undefined
@@ -3756,57 +3756,57 @@ overrides: PrefabOverride[] | undefined
parent: number | undefined
```
-## InstantiatePrefabResult — interface
+## InstantiatePrefabResult — interface @experimental
```
entities: Map<number, number>
root: number
```
-## Interactable — const
+## Interactable — const @experimental
```
BuiltinComponentDef<InteractableData>
```
-## InteractableData — interface
+## InteractableData — interface @experimental
```
blockRaycast: boolean
enabled: boolean
raycastTarget: boolean
```
-## InterestPolicy — type
+## InterestPolicy — type @experimental
```
(view: InterestView) => ReadonlySet<Entity> | 'all'
```
-## InterestView — interface
+## InterestView — interface @experimental
```
candidates: readonly number[]
connectionId: number
world: World
```
-## InterpType — type
+## InterpType — type @experimental
```
(typeof InterpType)[keyof typeof InterpType]
```
-## JsonResult — interface
+## JsonResult — interface @experimental
```
data: T
```
-## JustifyContent — type
+## JustifyContent — type @experimental
```
(typeof JustifyContent)[keyof typeof JustifyContent]
```
-## Key — const
+## Key — const @experimental
```
(code: string) => Binding
```
-## Keyframe — interface
+## Keyframe — interface @experimental
```
inTangent: number
interpolation: InterpType | undefined
@@ -3815,17 +3815,17 @@ time: number
value: number
```
-## Keys1D — const
+## Keys1D — const @experimental
```
(neg: string, pos: string) => Binding
```
-## Keys2D — const
+## Keys2D — const @experimental
```
(up: string, down: string, left: string, right: string) => Binding
```
-## KineticScroll — class
+## KineticScroll — class @experimental
```
beginDrag: () => void
endDrag: () => void
@@ -3840,31 +3840,31 @@ static new (opts?: KineticScrollOptions): KineticScroll
static prototype: KineticScroll
```
-## LIGHT_TOKENS — const
+## LIGHT_TOKENS — const @experimental
```
ThemeTokens
```
-## LayerOrder — enum
+## LayerOrder — enum @experimental
```
Depth = 2
Painter = 0
YSort = 1
```
-## LayoutProvider — interface
+## LayoutProvider — interface @experimental
```
getContentSize: (count: number) => Vec2
getItemRect: (index: number) => Rect
getVisibleRange: (viewport: Rect, count: number) => [start: number, end: number]
```
-## Leaderboard — const
+## Leaderboard — const @experimental
```
ResourceDef<LeaderboardAPI>
```
-## LeaderboardAPI — class
+## LeaderboardAPI — class @experimental
```
available: boolean
dispose: () => void
@@ -3879,7 +3879,7 @@ static new (module_: () => ESEngineModule | null): LeaderboardAPI
static prototype: LeaderboardAPI
```
-## LeaderboardOptions — interface
+## LeaderboardOptions — interface @experimental
```
key: string | undefined
limit: number | undefined
@@ -3888,18 +3888,18 @@ scope: LeaderboardScope | undefined
style: LeaderboardStyle | undefined
```
-## LeaderboardProvider — interface
+## LeaderboardProvider — interface @experimental
```
canvas: () => PlatformCanvas | null
post: (message: Record<string, unknown>) => void
```
-## LeaderboardScope — type
+## LeaderboardScope — type @experimental
```
'friends' | 'group'
```
-## LeaderboardStyle — interface
+## LeaderboardStyle — interface @experimental
```
avatars: boolean | undefined
background: string | undefined
@@ -3911,22 +3911,22 @@ rowHeight: number | undefined
selfColor: string | undefined
```
-## Lifecycle — const
+## Lifecycle — const @experimental
```
ResourceDef<LifecycleManager>
```
-## LifecycleEvent — type
+## LifecycleEvent — type @experimental
```
'show' | 'hide' | 'pause' | 'resume'
```
-## LifecycleListener — type
+## LifecycleListener — type @experimental
```
(event: LifecycleEvent) => void
```
-## LifecycleManager — class
+## LifecycleManager — class @experimental
```
autoPause: boolean
emit_: (event: LifecycleEvent) => void
@@ -3941,7 +3941,7 @@ static new (autoPause?: boolean): LifecycleManager
static prototype: LifecycleManager
```
-## LifecyclePlugin — class
+## LifecyclePlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -3950,17 +3950,17 @@ static new (options_?: LifecyclePluginOptions | undefined): LifecyclePlugin
static prototype: LifecyclePlugin
```
-## LifecyclePluginOptions — interface
+## LifecyclePluginOptions — interface @experimental
```
autoPause: boolean | undefined
```
-## Light2D — const
+## Light2D — const @experimental
```
BuiltinComponentDef<Light2DData>
```
-## Light2DData — interface
+## Light2DData — interface @experimental
```
color: Color
direction: Vec2
@@ -3974,7 +3974,7 @@ shadowSoftness: number
type: number
```
-## Light2DType — enum
+## Light2DType — enum @experimental
```
Ambient = 2
Directional = 1
@@ -3982,12 +3982,12 @@ Point = 0
Spot = 3
```
-## LinearFillDirection — type
+## LinearFillDirection — type @experimental
```
'right' | 'left' | 'up' | 'down'
```
-## LinearLayoutProvider — class
+## LinearLayoutProvider — class @experimental
```
getContentSize: (count: number) => Vec2
getItemRect: (index: number) => Rect
@@ -3996,20 +3996,20 @@ static new (opts: LinearLayoutOptions): LinearLayoutProvider
static prototype: LinearLayoutProvider
```
-## ListItemTemplate — interface
+## ListItemTemplate — interface @experimental
```
bind: (entity: Entity, data: T, index: number) => void
create: (world: World, parent: Entity) => Entity
```
-## ListLayoutSpec — type
+## ListLayoutSpec — type @experimental
```
| { itemHeight: number | ((index: number) => number); spacing?: number; direction?: 'column' }
| { itemWidth: number; spacing?: number; direction: 'row' }
| { columns: number; itemSize: Vec2; spacing?: Vec2 }
```
-## ListView — class
+## ListView — class @experimental
```
dispose: () => void
getContentSize: () => Vec2
@@ -4024,7 +4024,7 @@ static new <T = unknown>(opts: ListViewOptions<T>): ListView<T>
static prototype: ListView<any>
```
-## ListViewHandle — interface
+## ListViewHandle — interface @experimental
```
content: number
data: DataSource<T>
@@ -4037,7 +4037,7 @@ scrollToIndex: (index: number) => void
view: ListView<T>
```
-## ListViewHost — interface
+## ListViewHost — interface @experimental
```
attachScrollContainer: (entity: Entity, container: ScrollContainer) => void
detachScrollContainer: (entity: Entity) => void
@@ -4045,7 +4045,7 @@ registerListView: (list: ListView<unknown>) => void
unregisterListView: (list: ListView<unknown>) => void
```
-## ListViewOptions — interface
+## ListViewOptions — interface @experimental
```
dataSource: DataSource<T>
layout: LayoutProvider
@@ -4059,14 +4059,14 @@ viewportSize: Vec2
world: World
```
-## ListenOptions — interface
+## ListenOptions — interface @experimental
```
gamepad: boolean | undefined
keyboard: boolean | undefined
mouse: boolean | undefined
```
-## LoadRuntimeSceneOptions — interface
+## LoadRuntimeSceneOptions — interface @experimental
```
app: App
module: ESEngineModule | null
@@ -4082,7 +4082,7 @@ uiTheme: "dark" | "light" | undefined
uiThemeOverrides: ThemeOverrides | undefined
```
-## LoadedTilemapLayer — interface
+## LoadedTilemapLayer — interface @experimental
```
chunks: LoadedTilemapChunk[]
height: number
@@ -4092,7 +4092,7 @@ tiles: Uint16Array<ArrayBufferLike>
width: number
```
-## LoadedTilemapSource — interface
+## LoadedTilemapSource — interface @experimental
```
collisionTileIds: number[] | undefined
hexSideLength: number | undefined
@@ -4109,7 +4109,7 @@ tileWidth: number
tilesets: LoadedTilemapTileset[]
```
-## LoadedTilemapTileset — interface
+## LoadedTilemapTileset — interface @experimental
```
columns: number
firstId: number
@@ -4119,52 +4119,52 @@ spacing: number
textureHandle: number
```
-## LocalLeaderboardOptions — interface
+## LocalLeaderboardOptions — interface @experimental
```
friends: readonly CloudPlayer[] | undefined
height: number | undefined
width: number | undefined
```
-## LocalTransform — const
+## LocalTransform — const @experimental
```
BuiltinComponentDef<TransformData>
```
-## LocalTransformData — type
+## LocalTransformData — type @experimental
```
TransformData
```
-## LocaleCatalog — type
+## LocaleCatalog — type @experimental
```
Record<string, LocaleEntry>
```
-## LocaleEntry — type
+## LocaleEntry — type @experimental
```
string | PluralForms
```
-## LocaleResult — interface
+## LocaleResult — interface @experimental
```
keyCount: number
locale: string
```
-## LocaleTableAsset — interface
+## LocaleTableAsset — interface @experimental
```
entries: LocaleCatalog
locale: string
version: number
```
-## Localization — const
+## Localization — const @experimental
```
ResourceDef<LocalizationAPI>
```
-## LocalizationAPI — class
+## LocalizationAPI — class @experimental
```
addCatalog: (locale: string, entries: LocaleCatalog) => void
availableLocales: () => string[]
@@ -4179,7 +4179,7 @@ static new (locale?: string, fallback?: string): LocalizationAPI
static prototype: LocalizationAPI
```
-## LocalizationOptions — interface
+## LocalizationOptions — interface @experimental
```
catalogs: Record<string, LocaleCatalog> | undefined
fallback: string | undefined
@@ -4187,7 +4187,7 @@ locale: string | undefined
tables: string[] | undefined
```
-## LocalizationPlugin — class
+## LocalizationPlugin — class @experimental
```
build: (app: App) => void
name: string
@@ -4195,7 +4195,7 @@ static new (opts?: LocalizationOptions): LocalizationPlugin
static prototype: LocalizationPlugin
```
-## LogEntry — interface
+## LogEntry — interface @experimental
```
category: string
data: unknown
@@ -4204,12 +4204,12 @@ message: string
timestamp: number
```
-## LogHandler — interface
+## LogHandler — interface @experimental
```
handle: (entry: LogEntry) => void
```
-## LogLevel — enum
+## LogLevel — enum @experimental
```
Debug = 0
Error = 3
@@ -4217,7 +4217,7 @@ Info = 1
Warn = 2
```
-## Logger — class
+## Logger — class @experimental
```
addHandler: (handler: LogHandler) => void
clearHandlers: () => void
@@ -4231,17 +4231,17 @@ static new (): Logger
static prototype: Logger
```
-## LoginResult — interface
+## LoginResult — interface @experimental
```
code: string
```
-## LoopMode — type
+## LoopMode — type @experimental
```
(typeof LoopMode)[keyof typeof LoopMode]
```
-## ManifestModel — class
+## ManifestModel — class @experimental
```
allAssets: () => AddressableManifestAsset[]
assetByKey: (key: string) => AddressableManifestAsset | null
@@ -4265,28 +4265,28 @@ static new (manifest: AddressableManifest): ManifestModel
static prototype: ManifestModel
```
-## Marker — const
+## Marker — const @experimental
```
ComponentDef<MarkerData>
```
-## MarkerData — interface
+## MarkerData — interface @experimental
```
properties: Record<string, string>
type: string
```
-## MaskMode — type
+## MaskMode — type @experimental
```
(typeof MaskMode)[keyof typeof MaskMode]
```
-## Material — const
+## Material — const @experimental
```
{ createShader(vertexSrc: string, fragmentSrc: string): ShaderHandle; releaseShader(shader: ShaderHandle): void; create(options: MaterialOptions): MaterialHandle; compileShader(esshaderSource: string, features?: string[]): ShaderHandle; getSwitch(material: MaterialHandle, name: string): boolean; setSwitch(material: MaterialHandle, name: string, on: boolean): void; get(material: MaterialHandle): MaterialData | undefined; setUniform(material: MaterialHandle, name: string, value: UniformValue): void; getUniform(material: MaterialHandle, name: string): UniformValue | undefined; setBlendMode(material: MaterialHandle, mode: BlendMode): void; getBlendMode(material: MaterialHandle): BlendMode; setDepthTest(material: MaterialHandle, enabled: boolean): void; setDepthWrite(material: MaterialHandle, enabled: boolean): void; setCull(material: MaterialHandle, cull: CullMode): void; getShader(material: MaterialHandle): ShaderHandle; release(material: MaterialHandle): void; isValid(material: MaterialHandle): boolean; renderPreview(material: MaterialHandle, w: number, h: number): Promise<ImageData | null>; releaseAll(): void; createFromAsset(data: MaterialAssetData, shaderHandle: ShaderHandle, parentHandle?: MaterialHandle): MaterialHandle; createInstance(source: MaterialHandle): MaterialHandle; toAssetData(material: MaterialHandle, shaderPath: string, parentPath?: string): MaterialAssetData | null; getUniforms(material: MaterialHandle): Map<string, UniformValue>; tex(textureId: number, slot?: number): TextureRef; }
```
-## MaterialAssetData — interface
+## MaterialAssetData — interface @experimental
```
blendMode: number | undefined
cull: number | undefined
@@ -4300,7 +4300,7 @@ type: "material"
version: string
```
-## MaterialData — interface
+## MaterialData — interface @experimental
```
blendMode: BlendMode
cachedBuffer_: Float32Array<ArrayBufferLike> | null
@@ -4334,12 +4334,12 @@ x: number | undefined
y: number | undefined
```
-## MaterialHandle — type
+## MaterialHandle — type @experimental
```
number
```
-## MaterialOptions — interface
+## MaterialOptions — interface @experimental
```
blendMode: BlendMode | undefined
cull: CullMode | undefined
@@ -4350,7 +4350,7 @@ switches: Record<string, boolean> | undefined
uniforms: Record<string, UniformValue> | undefined
```
-## MeasureTextOptions — interface
+## MeasureTextOptions — interface @experimental
```
bold: boolean | undefined
fontFamily: string | undefined
@@ -4361,7 +4361,7 @@ lineHeight: number | undefined
maxWidth: number | undefined
```
-## MeasuredLinearLayoutProvider — class
+## MeasuredLinearLayoutProvider — class @experimental
```
getContentSize: (count: number) => Vec2
getItemRect: (index: number) => Rect
@@ -4371,7 +4371,7 @@ static new (opts: MeasuredLinearLayoutOptions): MeasuredLinearLayoutProvider
static prototype: MeasuredLinearLayoutProvider
```
-## MemoryTransport — class
+## MemoryTransport — class @experimental
```
dropPending: () => void
flush: (limit?: number) => void
@@ -4383,12 +4383,12 @@ static pair: (options?: MemoryTransportOptions) => [MemoryTransport, MemoryTrans
static prototype: MemoryTransport
```
-## Mesh2D — const
+## Mesh2D — const @experimental
```
BuiltinComponentDef<Mesh2DData>
```
-## Mesh2DAPI — class
+## Mesh2DAPI — class @experimental
```
clearGeometry: (entity: Entity) => void
getGeometry: (entity: Entity) => Mesh2DGeometry | undefined
@@ -4397,7 +4397,7 @@ static new (module_: NonNullable<EngineApi>, registry_: CppRegistry): Mesh2DAPI
static prototype: Mesh2DAPI
```
-## Mesh2DData — interface
+## Mesh2DData — interface @experimental
```
color: Color
enabled: boolean
@@ -4409,7 +4409,7 @@ parallax: Vec2
texture: number
```
-## Mesh2DGeometry — interface
+## Mesh2DGeometry — interface @experimental
```
colors: number[] | undefined
indices: number[]
@@ -4417,7 +4417,7 @@ positions: number[]
uvs: number[] | undefined
```
-## Mesh2DPlugin — class
+## Mesh2DPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -4426,24 +4426,24 @@ static new (): Mesh2DPlugin
static prototype: Mesh2DPlugin
```
-## Meshes2D — const
+## Meshes2D — const @experimental
```
ResourceDef<Mesh2DAPI>
```
-## MessageHandler — type
+## MessageHandler — type @experimental
```
(payload: T) => void
```
-## MessagePortLike — interface
+## MessagePortLike — interface @experimental
```
close: (() => void) | undefined
onmessage: ((event: { data: unknown; }) => void) | null
postMessage: (data: unknown) => void
```
-## MessagePortTransport — class
+## MessagePortTransport — class @experimental
```
close: () => void
on: (event: "message", handler: (data: string | ArrayBuffer) => void) => () => void
@@ -4452,7 +4452,7 @@ static new (port: MessagePortLike | MessagePort): MessagePortTransport
static prototype: MessagePortTransport
```
-## MigrationResult — interface
+## MigrationResult — interface @experimental
```
data: PrefabData
fromVersion: string
@@ -4460,7 +4460,7 @@ migrated: boolean
toVersion: string
```
-## MiniGameAudioBackend — class
+## MiniGameAudioBackend — class @experimental
```
dispose: () => void
ensureResumed: () => Promise<void>
@@ -4478,14 +4478,14 @@ static new (global: MiniGameGlobal, label?: string): MiniGameAudioBackend
static prototype: MiniGameAudioBackend
```
-## MiniGameCanvas — interface
+## MiniGameCanvas — interface @experimental
```
getContext: (type: string, attributes?: unknown) => unknown
height: number
width: number
```
-## MiniGameFileSystemManager — interface
+## MiniGameFileSystemManager — interface @experimental
```
access: (opts: { path: string; success?: () => void; fail?: (err: { errMsg: string; }) => void; }) => void
accessSync: (path: string) => void
@@ -4494,7 +4494,7 @@ readFileSync: (path: string, encoding?: string) => ArrayBuffer | string
writeFile: (opts: { filePath: string; data: string | ArrayBuffer; encoding?: string; success?: () => void; fail?: (err: { errMsg: string; }) => void; }) => void
```
-## MiniGameGlobal — interface
+## MiniGameGlobal — interface @experimental
```
checkSession: ((opts: { success?: () => void; fail?: (err: unknown) => void; }) => void) | undefined
connectSocket: (opts: { url: string; protocols?: string[]; }) => MiniGameSocketTask
@@ -4539,7 +4539,7 @@ setUserCloudStorage: ((opts: { KVDataList: MiniGameKVData[]; success?: () => voi
shareAppMessage: ((opts: MiniGameShareOptions) => void) | undefined
```
-## MiniGameImage — interface
+## MiniGameImage — interface @experimental
```
height: number
onerror: ((err: unknown) => void) | null
@@ -4548,7 +4548,7 @@ src: string
width: number
```
-## MiniGameInnerAudioContext — interface
+## MiniGameInnerAudioContext — interface @experimental
```
currentTime: number
destroy: () => void
@@ -4567,12 +4567,12 @@ stop: () => void
volume: number
```
-## MiniGameKeyEvent — interface
+## MiniGameKeyEvent — interface @experimental
```
code: string
```
-## MiniGamePlatformAdapter — class
+## MiniGamePlatformAdapter — class @experimental
```
bindInputEvents: (callbacks: InputEventCallbacks, _target?: unknown) => void
canPay: () => boolean
@@ -4616,7 +4616,7 @@ static new (profile: MiniGameProfile): MiniGamePlatformAdapter
static prototype: MiniGamePlatformAdapter
```
-## MiniGameProfile — interface
+## MiniGameProfile — interface @experimental
```
createAudioBackend: (() => PlatformAudioBackend) | undefined
createSocket: ((options: PlatformSocketOptions) => PlatformSocket) | undefined
@@ -4627,7 +4627,7 @@ id: MiniGameVendor
instantiateWasm: ((pathOrBuffer: string | ArrayBuffer, imports: WebAssembly.Imports) => Promise<WasmInstantiateResult>) | undefined
```
-## MiniGameRequestOptions — interface
+## MiniGameRequestOptions — interface @experimental
```
data: string | ArrayBuffer | undefined
fail: ((err: { errMsg: string; }) => void) | undefined
@@ -4639,7 +4639,7 @@ timeout: number | undefined
url: string
```
-## MiniGameRuntimeConfig — interface
+## MiniGameRuntimeConfig — interface @experimental
```
audioConfig: AudioProjectConfig | undefined
colorSpace: "gamma" | "linear" | undefined
@@ -4659,12 +4659,12 @@ uiThemeOverrides: ThemeOverrides | undefined
ySortLayers: number | undefined
```
-## MiniGameSideModuleFactories — type
+## MiniGameSideModuleFactories — type @experimental
```
Partial<Record<SideModuleId, EmscriptenFactory>>
```
-## MiniGameSocket — class
+## MiniGameSocket — class @experimental
```
close: (code?: number, reason?: string) => void
connect: () => void
@@ -4675,7 +4675,7 @@ static new (options: GameSocketOptions, global: MiniGameGlobal): MiniGameSocket
static prototype: MiniGameSocket
```
-## MiniGameSocketTask — interface
+## MiniGameSocketTask — interface @experimental
```
close: (opts: { code?: number; reason?: string; }) => void
onClose: (cb: (res: { code: number; reason: string; }) => void) => void
@@ -4685,12 +4685,12 @@ onOpen: (cb: (res?: unknown) => void) => void
send: (opts: { data: string | ArrayBuffer; }) => void
```
-## MiniGameStorageInfo — interface
+## MiniGameStorageInfo — interface @experimental
```
keys: string[]
```
-## MiniGameSystemInfo — interface
+## MiniGameSystemInfo — interface @experimental
```
language: string | undefined
pixelRatio: number | undefined
@@ -4699,42 +4699,42 @@ windowHeight: number | undefined
windowWidth: number | undefined
```
-## MiniGameTouch — interface
+## MiniGameTouch — interface @experimental
```
clientX: number
clientY: number
identifier: number
```
-## MiniGameTouchEvent — interface
+## MiniGameTouchEvent — interface @experimental
```
changedTouches: MiniGameTouch[]
```
-## MiniGameVendor — type
+## MiniGameVendor — type @experimental
```
'wechat' | 'douyin' | (string & {})
```
-## MissingAssetCallback — type
+## MissingAssetCallback — type @experimental
```
(missing: MissingAsset[]) => void
```
-## MissingAssetsError — class
+## MissingAssetsError — class @experimental
```
missing: MissingAsset[]
static new (missing: MissingAsset[]): MissingAssetsError
static prototype: MissingAssetsError
```
-## MockAdProviderOptions — interface
+## MockAdProviderOptions — interface @experimental
```
completed: boolean | undefined
durationMs: number | undefined
```
-## Modifiers — interface
+## Modifiers — interface @experimental
```
alt: boolean
ctrl: boolean
@@ -4742,22 +4742,22 @@ meta: boolean
shift: boolean
```
-## MotorJoint — const
+## MotorJoint — const @experimental
```
ComponentDef<MotorJointData>
```
-## MouseButton — const
+## MouseButton — const @experimental
```
(button: number) => Binding
```
-## Mut — function
+## Mut — function @experimental
```
<T extends AnyComponentDef>(component: T): MutWrapper<T>
```
-## MutWrapper — interface
+## MutWrapper — interface @experimental
```
_component: T
_type: "mut"
@@ -4768,27 +4768,27 @@ _type: "mut"
Record<GraphNodeType, NodeSpec>
```
-## Name — const
+## Name — const @experimental
```
ComponentDef<NameData>
```
-## NameData — interface
+## NameData — interface @experimental
```
value: string
```
-## Nav — const
+## Nav — const @experimental
```
ResourceDef<Navigation>
```
-## NavAgent — const
+## NavAgent — const @experimental
```
ComponentDef<NavAgentData>
```
-## NavAgentData — interface
+## NavAgentData — interface @experimental
```
arriveRadius: number
arrived: boolean
@@ -4800,7 +4800,7 @@ targetX: number
targetY: number
```
-## NavGrid — class
+## NavGrid — class @experimental
```
cellSize: number
cellToWorld: (gx: number, gy: number) => Vec2
@@ -4820,7 +4820,7 @@ static new (opts: NavGridOptions): NavGrid
static prototype: NavGrid
```
-## NavGridOptions — interface
+## NavGridOptions — interface @experimental
```
cellSize: number
height: number
@@ -4829,7 +4829,7 @@ walkable: ArrayLike<number> | undefined
width: number
```
-## NavPlugin — class
+## NavPlugin — class @experimental
```
build: (app: App) => void
name: string
@@ -4837,7 +4837,7 @@ static new (): NavPlugin
static prototype: NavPlugin
```
-## Navigation — class
+## Navigation — class @experimental
```
findWorldPath: (from: Vec2, to: Vec2, opts?: PathfindOptions & { radius?: number; }) => Vec2[] | null
grid: NavGrid | null
@@ -4847,18 +4847,18 @@ static new (): Navigation
static prototype: Navigation
```
-## NestedPrefabRef — interface
+## NestedPrefabRef — interface @experimental
```
overrides: PrefabOverride[]
prefabPath: string
```
-## Net — const
+## Net — const @experimental
```
ResourceDef<NetSession>
```
-## NetChannel — class
+## NetChannel — class @experimental
```
dispose: (reason?: string) => void
handle: <Req = unknown, Res = unknown>(type: string, handler: RequestHandler<Req, Res>) => () => void
@@ -4871,22 +4871,22 @@ static new (transport: NetTransport, opts?: NetChannelOptions): NetChannel
static prototype: NetChannel
```
-## NetChannelOptions — interface
+## NetChannelOptions — interface @experimental
```
requestTimeoutMs: number | undefined
```
-## NetGhost — const
+## NetGhost — const @experimental
```
ComponentDef<{}>
```
-## NetRoleKind — type
+## NetRoleKind — type @experimental
```
'offline' | 'server' | 'client'
```
-## NetSession — class
+## NetSession — class @experimental
```
client: ReplicationClient | null
connect: (transport: NetTransport, options?: ReplicationClientOptions) => Promise<ReplicationClient>
@@ -4898,7 +4898,7 @@ static new (app_: App): NetSession
static prototype: NetSession
```
-## NetTransport — interface
+## NetTransport — interface @experimental
```
on: (event: "message", handler: (data: string | ArrayBuffer) => void) => () => void
send: (data: string | ArrayBuffer) => void
@@ -4926,39 +4926,39 @@ output: GraphType | null
params: NodeParamSpec[]
```
-## Not — function
+## Not — function @experimental
```
(filter: FilterExpr): FilterExpr
```
-## OneWayPlatform — const
+## OneWayPlatform — const @experimental
```
ComponentDef<OneWayPlatformData>
```
-## Or — function
+## Or — function @experimental
```
(...filters: FilterExpr[]): FilterExpr
```
-## OutlineFilterOptions — interface
+## OutlineFilterOptions — interface @experimental
```
color: { r: number; g: number; b: number; a: number; } | undefined
texelSize: { x: number; y: number; } | undefined
width: number | undefined
```
-## PREFAB_FORMAT_VERSION — const
+## PREFAB_FORMAT_VERSION — const @experimental
```
"2"
```
-## PTR_LAYOUTS — const
+## PTR_LAYOUTS — const @experimental
```
Record<string, PtrLayout>
```
-## PackagedAssetIndex — interface
+## PackagedAssetIndex — interface @experimental
```
addressOf: (ref: string) => string | null
assetPaths: () => string[]
@@ -4969,13 +4969,13 @@ resolvePath: (ref: string) => string
textureImport: (ref: string) => ParsedTextureImportSettings | undefined
```
-## PackagedAssetSourceOptions — interface
+## PackagedAssetSourceOptions — interface @experimental
```
backend: Backend | undefined
decodePixels: ((path: string, flip: boolean) => Promise<{ width: number; height: number; pixels: Uint8Array; }>) | undefined
```
-## PackagedGameConfig — interface
+## PackagedGameConfig — interface @experimental
```
achievements: string[] | undefined
audioConfig: AudioProjectConfig | undefined
@@ -4994,17 +4994,17 @@ uiThemeColors: Record<string, string> | undefined
ySortLayers: number | undefined
```
-## Parent — const
+## Parent — const @experimental
```
BuiltinComponentDef<ParentData>
```
-## ParentData — interface
+## ParentData — interface @experimental
```
entity: number
```
-## ParsedTextureImportSettings — interface
+## ParsedTextureImportSettings — interface @experimental
```
filter: "linear" | "nearest" | undefined
sliceBorder: { left: number; right: number; top: number; bottom: number; } | undefined
@@ -5012,12 +5012,12 @@ srgb: boolean | undefined
wrap: "repeat" | "clamp" | "mirror" | undefined
```
-## Particle — const
+## Particle — const @experimental
```
ResourceDef<ParticleAPI>
```
-## ParticleAPI — class
+## ParticleAPI — class @experimental
```
getAliveCount: (entity: Entity) => number
play: (entity: Entity) => void
@@ -5030,7 +5030,7 @@ static new (module: NonNullable<EngineApi>, registry: CppRegistry): ParticleAPI
static prototype: ParticleAPI
```
-## ParticleEasing — enum
+## ParticleEasing — enum @experimental
```
EaseIn = 1
EaseInOut = 3
@@ -5038,12 +5038,12 @@ EaseOut = 2
Linear = 0
```
-## ParticleEmitter — const
+## ParticleEmitter — const @experimental
```
BuiltinComponentDef<ParticleEmitterData>
```
-## ParticleEmitterData — interface
+## ParticleEmitterData — interface @experimental
```
angleSpreadMax: number
angleSpreadMin: number
@@ -5107,12 +5107,12 @@ trailPoints: number
trailWidth: number
```
-## ParticleForceField — const
+## ParticleForceField — const @experimental
```
BuiltinComponentDef<ParticleForceFieldData>
```
-## ParticleForceFieldData — interface
+## ParticleForceFieldData — interface @experimental
```
direction: Vec2
enabled: boolean
@@ -5122,7 +5122,7 @@ strength: number
type: number
```
-## ParticlePlugin — class
+## ParticlePlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -5131,19 +5131,19 @@ static new (): ParticlePlugin
static prototype: ParticlePlugin
```
-## PathfindOptions — interface
+## PathfindOptions — interface @experimental
```
clearance: number | undefined
diagonal: boolean | undefined
snapRadius: number | undefined
```
-## Payment — const
+## Payment — const @experimental
```
ResourceDef<PaymentAPI>
```
-## PaymentAPI — class
+## PaymentAPI — class @experimental
```
available: boolean
request: (request: PaymentRequest) => Promise<void>
@@ -5151,33 +5151,33 @@ static new (): PaymentAPI
static prototype: PaymentAPI
```
-## PaymentFailure — interface
+## PaymentFailure — interface @experimental
```
code: number | undefined
```
-## PaymentRequest — type
+## PaymentRequest — type @experimental
```
PlatformPaymentRequest
```
-## Perceiver — const
+## Perceiver — const @experimental
```
ComponentDef<PerceiverData>
```
-## PerceiverData — interface
+## PerceiverData — interface @experimental
```
fovDegrees: number
range: number
```
-## Perception — const
+## Perception — const @experimental
```
ComponentDef<PerceptionData>
```
-## PerceptionData — interface
+## PerceptionData — interface @experimental
```
dirX: number
dirY: number
@@ -5187,7 +5187,7 @@ targetY: number
visible: boolean
```
-## PerceptionPlugin — class
+## PerceptionPlugin — class @experimental
```
build: (app: App) => void
name: string
@@ -5195,34 +5195,34 @@ static new (): PerceptionPlugin
static prototype: PerceptionPlugin
```
-## PerceptionTarget — const
+## PerceptionTarget — const @experimental
```
ComponentDef<{}>
```
-## Physics — const
+## Physics — const @experimental
```
ResourceDef<PhysicsAPI>
```
-## PhysicsContactEventData — interface
+## PhysicsContactEventData — interface @experimental
```
approachSpeed: number | undefined
isSensor: boolean | undefined
other: number
```
-## PhysicsEventType — type
+## PhysicsEventType — type @experimental
```
typeof PhysicsEventType[keyof typeof PhysicsEventType]
```
-## PhysicsEvents — const
+## PhysicsEvents — const @experimental
```
ResourceDef<PhysicsEventsData>
```
-## PhysicsEventsData — interface
+## PhysicsEventsData — interface @experimental
```
collisionEnters: CollisionEnterEvent[]
collisionExits: { entityA: Entity; entityB: Entity; }[]
@@ -5231,12 +5231,12 @@ sensorEnters: SensorEvent[]
sensorExits: SensorEvent[]
```
-## PhysicsModuleFactory — type
+## PhysicsModuleFactory — type @experimental
```
(config?: Record<string, unknown>) => Promise<PhysicsWasmModule>
```
-## PhysicsPlugin — class
+## PhysicsPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -5245,7 +5245,7 @@ static new (wasmUrl: string, config?: PhysicsPluginConfig, factory?: PhysicsModu
static prototype: PhysicsPlugin
```
-## PhysicsPluginConfig — interface
+## PhysicsPluginConfig — interface @experimental
```
collisionLayerMasks: number[] | undefined
contactDampingRatio: number | undefined
@@ -5260,7 +5260,7 @@ restitutionThreshold: number | undefined
subStepCount: number | undefined
```
-## PhysicsWasmModule — interface
+## PhysicsWasmModule — interface @experimental
```
HEAPF32: Float32Array<ArrayBufferLike>
HEAPU32: Uint32Array<ArrayBufferLike>
@@ -5383,7 +5383,7 @@ _physics_step: (dt: number) => void
_physics_updateBodyProperties: (entityId: number, bodyType: number, gravityScale: number, linearDamping: number, angularDamping: number, fixedRotation: number, bullet: number) => void
```
-## PlatformAdapter — interface
+## PlatformAdapter — interface @experimental
```
bindInputEvents: (callbacks: InputEventCallbacks, target?: unknown) => void
canPay: (() => boolean) | undefined
@@ -5438,7 +5438,7 @@ unbindInputEvents: (() => void) | undefined
writeCacheFile: ((key: string, bytes: ArrayBuffer) => Promise<void>) | undefined
```
-## PlatformAudioBackend — interface
+## PlatformAudioBackend — interface @experimental
```
dispose: () => void
ensureResumed: () => Promise<void>
@@ -5455,14 +5455,14 @@ suspend: () => void
unloadBuffer: (handle: AudioBufferHandle) => void
```
-## PlatformCanvas — interface
+## PlatformCanvas — interface @experimental
```
getContext: (contextId: "2d", options?: PlatformCanvasContextAttributes) => PlatformCanvas2DContext | null
height: number
width: number
```
-## PlatformCanvas2DContext — interface
+## PlatformCanvas2DContext — interface @experimental
```
clearRect: (x: number, y: number, w: number, h: number) => void
drawImage: (image: PlatformImageSource, dx: number, dy: number) => void
@@ -5475,7 +5475,7 @@ textAlign: string
textBaseline: string
```
-## PlatformImage — interface
+## PlatformImage — interface @experimental
```
crossOrigin: string | null | undefined
height: number
@@ -5485,7 +5485,7 @@ src: string
width: number
```
-## PlatformRequestOptions — interface
+## PlatformRequestOptions — interface @experimental
```
body: string | ArrayBuffer | undefined
headers: Record<string, string> | undefined
@@ -5494,7 +5494,7 @@ responseType: "json" | "text" | "arraybuffer" | undefined
timeout: number | undefined
```
-## PlatformResponse — interface
+## PlatformResponse — interface @experimental
```
arrayBuffer: () => Promise<ArrayBuffer>
headers: Record<string, string>
@@ -5505,7 +5505,7 @@ statusText: string
text: () => Promise<string>
```
-## PlatformSocket — interface
+## PlatformSocket — interface @experimental
```
close: (code?: number, reason?: string) => void
connect: () => void
@@ -5514,7 +5514,7 @@ readyState: PlatformSocketReadyState
send: (data: string | ArrayBuffer) => void
```
-## PlatformSocketEvents — interface
+## PlatformSocketEvents — interface @experimental
```
close: [code: number, reason: string]
error: [error: unknown]
@@ -5522,30 +5522,30 @@ message: [data: string | ArrayBuffer]
open: []
```
-## PlatformSocketOptions — interface
+## PlatformSocketOptions — interface @experimental
```
protocols: string | string[] | undefined
url: string
```
-## PlatformSocketReadyState — type
+## PlatformSocketReadyState — type @experimental
```
'connecting' | 'open' | 'closing' | 'closed'
```
-## PlatformType — type @deprecated
+## PlatformType — type @experimental @deprecated
```
PlatformName
```
-## PlatformVideoBackend — interface
+## PlatformVideoBackend — interface @experimental
```
createStream: (url: string, options: VideoStreamOptions) => VideoStreamHandle
dispose: () => void
name: string
```
-## PlayConfig — interface
+## PlayConfig — interface @experimental
```
bus: string | undefined
loop: boolean | undefined
@@ -5556,7 +5556,7 @@ startOffset: number | undefined
volume: number | undefined
```
-## PlayRealmRuntimeConfig — interface
+## PlayRealmRuntimeConfig — interface @experimental
```
achievements: string[] | undefined
app: App
@@ -5581,12 +5581,12 @@ uiThemeOverrides: ThemeOverrides | undefined
wasmBaseUrl: string | undefined
```
-## PlayableAdBridge — interface
+## PlayableAdBridge — interface @experimental
```
cta: (() => void) | undefined
```
-## PlayableRuntimeConfig — interface
+## PlayableRuntimeConfig — interface @experimental
```
app: App
assetPathMap: Record<string, string> | undefined
@@ -5605,7 +5605,7 @@ uiThemeOverrides: ThemeOverrides | undefined
ySortLayers: number | undefined
```
-## Plugin — interface
+## Plugin — interface @experimental
```
after: string[] | undefined
before: string[] | undefined
@@ -5616,17 +5616,17 @@ finish: ((app: App) => void) | undefined
name: string | undefined
```
-## PluginDependency — type
+## PluginDependency — type @experimental
```
string | ResourceDef<any>
```
-## PluralCategory — type
+## PluralCategory — type @experimental
```
'zero' | 'one' | 'two' | 'few' | 'many' | 'other'
```
-## PluralForms — interface
+## PluralForms — interface @experimental
```
few: string | undefined
many: string | undefined
@@ -5636,17 +5636,17 @@ two: string | undefined
zero: string | undefined
```
-## PluralSelector — type
+## PluralSelector — type @experimental
```
(count: number) => PluralCategory
```
-## PolygonCollider — const
+## PolygonCollider — const @experimental
```
ComponentDef<PolygonColliderData>
```
-## PooledAudioNode — interface
+## PooledAudioNode — interface @experimental
```
gain: GainNode
inUse: boolean
@@ -5655,12 +5655,12 @@ source: AudioBufferSourceNode | null
startTime: number
```
-## PostProcess — const
+## PostProcess — const @experimental
```
ResourceDef<PostProcessAPI>
```
-## PostProcessAPI — class
+## PostProcessAPI — class @experimental
```
_applyForCamera: (camera: Entity) => void
_applyScreenStack: () => void
@@ -5689,7 +5689,7 @@ static new (): PostProcessAPI
static prototype: PostProcessAPI
```
-## PostProcessPlugin — class
+## PostProcessPlugin — class @experimental
```
build: (app: App) => void
cleanup: (app?: App) => void
@@ -5698,7 +5698,7 @@ static new (): PostProcessPlugin
static prototype: PostProcessPlugin
```
-## PostProcessStack — class
+## PostProcessStack — class @experimental
```
addPass: (name: string, shader: ShaderHandle) => PostProcessStack
clearDirty: () => void
@@ -5720,12 +5720,12 @@ static new (state: PostProcessState): PostProcessStack
static prototype: PostProcessStack
```
-## PostProcessVolume — const
+## PostProcessVolume — const @experimental
```
ComponentDef<PostProcessVolumeData>
```
-## PostProcessVolumeData — interface
+## PostProcessVolumeData — interface @experimental
```
blendDistance: number
effects: { type: string; enabled: boolean; uniforms: Record<string, number>; textures?: Record<string, string>; }[]
@@ -5736,38 +5736,38 @@ size: { x: number; y: number; }
weight: number
```
-## PreSceneDrawCallback — type
+## PreSceneDrawCallback — type @experimental
```
(info: PreSceneDrawInfo) => void
```
-## PreSceneDrawInfo — interface
+## PreSceneDrawInfo — interface @experimental
```
elapsed: number
height: number
width: number
```
-## PredictionOptions — interface
+## PredictionOptions — interface @experimental
```
apply: (world: World, entity: Entity, actions: Record<string, unknown>, dt: number) => void
maxPendingInputs: number | undefined
smoothing: PredictionSmoothing | undefined
```
-## PredictionSmoothing — interface
+## PredictionSmoothing — interface @experimental
```
halfLife: number
maxError: number | undefined
```
-## PrefabComponentData — interface
+## PrefabComponentData — interface @experimental
```
data: Record<string, unknown>
type: string
```
-## PrefabData — interface
+## PrefabData — interface @experimental
```
basePrefab: string | undefined
entities: PrefabEntityData[]
@@ -5777,7 +5777,7 @@ rootEntityId: string
version: string
```
-## PrefabDiagnostic — interface
+## PrefabDiagnostic — interface @experimental
```
code: string
entityId: string | undefined
@@ -5786,12 +5786,12 @@ message: string
severity: PrefabDiagnosticSeverity
```
-## PrefabDiagnosticSeverity — type
+## PrefabDiagnosticSeverity — type @experimental
```
'error' | 'warning'
```
-## PrefabEntityData — interface
+## PrefabEntityData — interface @experimental
```
children: string[]
components: ComponentData[]
@@ -5803,12 +5803,12 @@ prefabEntityId: string
visible: boolean
```
-## PrefabEntityId — type
+## PrefabEntityId — type @experimental
```
string
```
-## PrefabInstanceDelta — interface
+## PrefabInstanceDelta — interface @experimental
```
added: AddedEntity[]
overrides: PrefabOverride[]
@@ -5816,7 +5816,7 @@ prefab: string
removed: string[]
```
-## PrefabInstanceEntry — interface
+## PrefabInstanceEntry — interface @experimental
```
added: AddedEntity[]
id: number
@@ -5826,7 +5826,7 @@ prefab: string
removed: string[]
```
-## PrefabOverride — interface
+## PrefabOverride — interface @experimental
```
componentData: ComponentData | undefined
componentType: string | undefined
@@ -5837,19 +5837,19 @@ type: "property" | "component_added" | "component_replaced" | "component_removed
value: unknown
```
-## PrefabServer — class
+## PrefabServer — class @experimental
```
instantiate: (pathOrAddress: string, options?: { baseUrl?: string; parent?: Entity; overrides?: SpawnOverride[]; scene?: boolean; }) => Promise<InstantiatePrefabResult>
static new (world: World, getAssets: () => AssetsClass, getScenes?: () => SceneManagerState | null): PrefabServer
static prototype: PrefabServer
```
-## Prefabs — const
+## Prefabs — const @experimental
```
ResourceDef<PrefabServer>
```
-## PrefabsPlugin — class
+## PrefabsPlugin — class @experimental
```
build: (app: App) => void
dependencies: ResourceDef<AssetsClass>[]
@@ -5858,7 +5858,7 @@ static new (): PrefabsPlugin
static prototype: PrefabsPlugin
```
-## PreviewPlugin — class
+## PreviewPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -5868,18 +5868,18 @@ static new (sceneUrl: string, baseUrl?: string): PreviewPlugin
static prototype: PreviewPlugin
```
-## PrismaticJoint — const
+## PrismaticJoint — const @experimental
```
ComponentDef<PrismaticJointData>
```
-## ProbedRegistrations — interface
+## ProbedRegistrations — interface @experimental
```
fingerprint: string
pending: PendingSystemEntry[]
```
-## ProcessedEntity — interface
+## ProcessedEntity — interface @experimental
```
children: number[]
components: ComponentData[]
@@ -5891,7 +5891,7 @@ prefabEntityId: string
visible: boolean
```
-## ProgressHandle — interface
+## ProgressHandle — interface @experimental
```
dispose: () => void
entity: number
@@ -5900,7 +5900,7 @@ getValue: () => number
setValue: (v: number) => void
```
-## ProgressOptions — interface
+## ProgressOptions — interface @experimental
```
background: UIVisualInit | undefined
direction: LinearFillDirection | undefined
@@ -5912,19 +5912,19 @@ value: number | undefined
world: World
```
-## ProjectionType — enum
+## ProjectionType — enum @experimental
```
Orthographic = 1
Perspective = 0
```
-## PropertyChannel — interface
+## PropertyChannel — interface @experimental
```
keyframes: Keyframe[]
property: string
```
-## PropertyTrack — interface
+## PropertyTrack — interface @experimental
```
channels: PropertyChannel[]
childPath: string
@@ -5933,13 +5933,13 @@ name: string
type: "property"
```
-## PtrLayout — interface
+## PtrLayout — interface @experimental
```
fields: readonly PtrFieldDesc[]
ptrFn: string
```
-## Quat — interface
+## Quat — interface @experimental
```
w: number
x: number
@@ -5947,12 +5947,12 @@ y: number
z: number
```
-## Query — function
+## Query — function @experimental
```
<C extends QueryArg[]>(...components: C): QueryBuilder<C>
```
-## QueryBuilder — interface
+## QueryBuilder — interface @experimental
```
_addedFilters: { index: number; component: AnyComponentDef; }[]
_changedFilters: { index: number; component: AnyComponentDef; }[]
@@ -5967,7 +5967,7 @@ with: (...components: AnyComponentDef[]) => QueryBuilder<C>
without: (...components: AnyComponentDef[]) => QueryBuilder<C>
```
-## QueryDescriptor — interface
+## QueryDescriptor — interface @experimental
```
_addedFilters: { index: number; component: AnyComponentDef; }[]
_changedFilters: { index: number; component: AnyComponentDef; }[]
@@ -5979,7 +5979,7 @@ _with: AnyComponentDef[]
_without: AnyComponentDef[]
```
-## QueryInstance — class
+## QueryInstance — class @experimental
```
count: () => number
forEach: (callback: (entity: Entity, ...components: ComponentsData<C>) => void) => void
@@ -5991,7 +5991,7 @@ static new <C extends readonly QueryArg[]>(world: World, descriptor: QueryDescri
static prototype: QueryInstance<any>
```
-## QueryResult — type
+## QueryResult — type @experimental
```
[
Entity,
@@ -5999,44 +5999,44 @@ static prototype: QueryInstance<any>
]
```
-## REPLICATION_CHANNEL — const
+## REPLICATION_CHANNEL — const @experimental
```
1
```
-## REPLICATION_PROTOCOL_VERSION — const
+## REPLICATION_PROTOCOL_VERSION — const @experimental
```
2
```
-## RETIRED_COMPONENT_TYPES — const
+## RETIRED_COMPONENT_TYPES — const @experimental
```
ReadonlySet<string>
```
-## RadiusInterestOptions — interface
+## RadiusInterestOptions — interface @experimental
```
position: ((world: World, entity: Entity) => { x: number; y: number; } | null) | undefined
```
-## ReadonlySignal — interface
+## ReadonlySignal — interface @experimental
```
get: () => T
subscribe: (fn: (value: T) => void) => () => void
```
-## Removed — function
+## Removed — function @experimental
```
<T extends AnyComponentDef>(component: T): RemovedQueryDescriptor<T>
```
-## RemovedQueryDescriptor — interface
+## RemovedQueryDescriptor — interface @experimental
```
_component: T
_type: "removed"
```
-## RemovedQueryInstance — class
+## RemovedQueryInstance — class @experimental
```
isEmpty: () => boolean
resetTick: (tick: number) => void
@@ -6045,7 +6045,7 @@ static new <T extends AnyComponentDef>(world: World, component: T, lastRunTick:
static prototype: RemovedQueryInstance<any>
```
-## RenderParams — interface
+## RenderParams — interface @experimental
```
clearColor: { x: number; y: number; z: number; w: number; } | undefined
elapsed: number
@@ -6055,7 +6055,7 @@ viewProjection: Float32Array<ArrayBufferLike>
width: number
```
-## RenderPipeline — class
+## RenderPipeline — class @experimental
```
addPreFlushCallback: (cb: (registry: { _cpp: CppRegistry; }) => void) => void
beginFrame: (elapsedSec?: number) => void
@@ -6071,7 +6071,7 @@ static new (): RenderPipeline
static prototype: RenderPipeline
```
-## RenderStage — enum
+## RenderStage — enum @experimental
```
Background = 0
Opaque = 1
@@ -6079,7 +6079,7 @@ Overlay = 3
Transparent = 2
```
-## RenderStats — interface
+## RenderStats — interface @experimental
```
culled: number
drawCalls: number
@@ -6090,24 +6090,24 @@ text: number
triangles: number
```
-## RenderSurfaceSource — type
+## RenderSurfaceSource — type @experimental
```
| { readonly kind: 'gl-context'; readonly handle: number }
| { readonly kind: 'webgpu'; readonly canvasSelector?: string }
| { readonly kind: 'default' }
```
-## RenderTargetHandle — type
+## RenderTargetHandle — type @experimental
```
number
```
-## RenderTexture — const
+## RenderTexture — const @experimental
```
{ create(options: RenderTextureOptions): RenderTextureHandle; release(rt: RenderTextureHandle): void; resize(rt: RenderTextureHandle, width: number, height: number): RenderTextureHandle; begin(rt: RenderTextureHandle, viewProjection: Float32Array): void; end(): void; getDepthTexture(rt: RenderTextureHandle): number; }
```
-## RenderTextureHandle — interface
+## RenderTextureHandle — interface @experimental
```
_depth: boolean
_filter: "linear" | "nearest"
@@ -6118,7 +6118,7 @@ textureId: number
width: number
```
-## RenderTextureOptions — interface
+## RenderTextureOptions — interface @experimental
```
depth: boolean | undefined
filter: "linear" | "nearest" | undefined
@@ -6126,7 +6126,7 @@ height: number
width: number
```
-## RenderType — enum
+## RenderType — enum @experimental
```
ExternalMesh = 3
Mesh = 2
@@ -6138,23 +6138,23 @@ Text = 4
UIElement = 7
```
-## Renderer — const
+## Renderer — const @experimental
```
{ init(width: number, height: number): void; resize(width: number, height: number): void; beginFrame(elapsedSec?: number): void; updateTransforms(registry: { _cpp: CppRegistry; }): void; begin(viewProjection: Float32Array, target?: RenderTargetHandle, clearFlags?: number, clearColor?: { x: number; y: number; z: number; w: number; }, clearRect?: { x: number; y: number; w: number; h: number; }): void; flush(): void; end(): void; submitAll(registry: { _cpp: CppRegistry; }, skipFlags: number, vpX: number, vpY: number, vpW: number, vpH: number): void; setStage(stage: RenderStage): void; createRenderTarget(width: number, height: number, flags?: number): RenderTargetHandle; releaseRenderTarget(handle: RenderTargetHandle): void; getTargetTexture(handle: RenderTargetHandle): number; getTargetDepthTexture(handle: RenderTargetHandle): number; setClearColor(r: number, g: number, b: number, a: number): void; setViewport(x: number, y: number, w: number, h: number): void; setYSortLayers(mask: number): void; setDepthLayers(mask: number): void; setCullingMask(mask: number): void; setTextureParams(textureId: number, minFilter: number, magFilter: number, wrapS: number, wrapT: number): void; measureBitmapText(fontHandle: number, text: string, fontSize: number, spacing: number): { width: number; height: number; }; getStats(): RenderStats; captureNextFrame(): void; getCapturedData(): FrameCaptureData | null; hasCapturedData(): boolean; replayToDrawCall(drawCallIndex: number): void; getSnapshotImageData(): Promise<ImageData | null>; }
```
-## Replicated — const
+## Replicated — const @experimental
```
ComponentDef<ReplicatedData>
```
-## ReplicatedData — interface
+## ReplicatedData — interface @experimental
```
netId: number
owner: number
```
-## ReplicationClient — class
+## ReplicationClient — class @experimental
```
applyPending: () => void
connect: (transport: NetTransport) => Promise<void>
@@ -6174,7 +6174,7 @@ static new (world: World, options?: ReplicationClientOptions): ReplicationClient
static prototype: ReplicationClient
```
-## ReplicationPlugin — class
+## ReplicationPlugin — class @experimental
```
build: (app: App) => void
name: string
@@ -6182,7 +6182,7 @@ static new (): ReplicationPlugin
static prototype: ReplicationPlugin
```
-## ReplicationServer — class
+## ReplicationServer — class @experimental
```
attachConnection: (transport: NetTransport) => number
beginTick: (fixedDelta: number) => void
@@ -6199,34 +6199,34 @@ static new (world: World): ReplicationServer
static prototype: ReplicationServer
```
-## RequestHandler — type
+## RequestHandler — type @experimental
```
(payload: Req) => Res | Promise<Res>
```
-## Res — function
+## Res — function @experimental
```
<T>(resource: ResourceDef<T>): ResDescriptor<T>
```
-## ResDescriptor — interface
+## ResDescriptor — interface @experimental
```
_resource: ResourceDef<T>
_type: "res"
```
-## ResMut — function
+## ResMut — function @experimental
```
<T>(resource: ResourceDef<T>): ResMutDescriptor<T>
```
-## ResMutDescriptor — interface
+## ResMutDescriptor — interface @experimental
```
_resource: ResourceDef<T>
_type: "res_mut"
```
-## ResMutInstance — class
+## ResMutInstance — class @experimental
```
get: () => T
modify: (fn: (value: T) => void) => void
@@ -6236,20 +6236,20 @@ static new <T>(value: T, setter: (v: T) => void): ResMutInstance<T>
static prototype: ResMutInstance<any>
```
-## ResolvedAssetGroup — interface
+## ResolvedAssetGroup — interface @experimental
```
alwaysInclude: boolean
delivery: BundleMode
name: string
```
-## ResolvedAtlas — interface
+## ResolvedAtlas — interface @experimental
```
folder: string
name: string
```
-## ResolvedTileCollision — interface
+## ResolvedTileCollision — interface @experimental
```
density: number | undefined
friction: number | undefined
@@ -6259,7 +6259,7 @@ sensor: boolean | undefined
shape: { type: "box"; } | { type: "polygon"; points: [number, number][]; } | { type: "circle"; cx: number; cy: number; r: number; }
```
-## ResolvedTileset — interface
+## ResolvedTileset — interface @experimental
```
asset: TilesetAsset
textureHandle: number
@@ -6267,14 +6267,14 @@ textureHeight: number | undefined
textureWidth: number | undefined
```
-## ResourceDef — interface
+## ResourceDef — interface @experimental
```
_default: T
_id: symbol
_name: string
```
-## ResourceStats — interface
+## ResourceStats — interface @experimental
```
cacheHits: number
cacheMisses: number
@@ -6287,7 +6287,7 @@ textureEvictableCount: number
vertexBufferCount: number
```
-## ReverbEffectDef — interface
+## ReverbEffectDef — interface @experimental
```
decay: number | undefined
seconds: number | undefined
@@ -6295,22 +6295,22 @@ type: "reverb"
wet: number | undefined
```
-## RevoluteJoint — const
+## RevoluteJoint — const @experimental
```
ComponentDef<RevoluteJointData>
```
-## RichTextRun — type
+## RichTextRun — type @experimental
```
TextSegment | ImageSegment
```
-## RigidBody — const
+## RigidBody — const @experimental
```
BuiltinComponentDef<RigidBodyData>
```
-## RigidBodyData — interface
+## RigidBodyData — interface @experimental
```
angularDamping: number
bodyType: number
@@ -6321,12 +6321,12 @@ gravityScale: number
linearDamping: number
```
-## RunCondition — type
+## RunCondition — type @experimental
```
() => boolean
```
-## RuntimeAssetSource — interface
+## RuntimeAssetSource — interface @experimental
```
backend: Backend
decodePixels: (path: string, flip: boolean) => Promise<{ width: number; height: number; pixels: Uint8Array; }>
@@ -6336,7 +6336,7 @@ resolveRef: ((ref: string) => string) | undefined
textureImportSettings: ((ref: string) => ParsedTextureImportSettings | undefined) | undefined
```
-## RuntimeBuildConfig — interface
+## RuntimeBuildConfig — interface @experimental
```
assetFailureCooldown: number | undefined
assetLoadTimeout: number | undefined
@@ -6352,12 +6352,12 @@ textCanvasSize: number | undefined
textureCacheBudget: number | undefined
```
-## RuntimeConfig — const
+## RuntimeConfig — const @experimental
```
{ sceneTransitionDuration: number; sceneTransitionColor: { r: number; g: number; b: number; a: number; }; defaultFontFamily: string; canvasScaleMode: number; canvasMatchWidthOrHeight: number; maxDeltaTime: number; maxFixedSteps: number; textCanvasSize: number; assetLoadTimeout: number; assetFailureCooldown: number; textureCacheBudget: number; audioCacheBudget: number; }
```
-## RuntimeInitConfig — interface
+## RuntimeInitConfig — interface @experimental
```
achievements: string[] | undefined
app: App
@@ -6382,42 +6382,42 @@ uiTheme: "dark" | "light" | undefined
uiThemeOverrides: ThemeOverrides | undefined
```
-## RuntimeOnly — const
+## RuntimeOnly — const @experimental
```
ComponentDef<{}>
```
-## SCENE_FORMAT_VERSION — const
+## SCENE_FORMAT_VERSION — const @experimental
```
1
```
-## SCREEN_FIT_OFF — const
+## SCREEN_FIT_OFF — const @experimental
```
-1
```
-## SIDE_MODULES — const
+## SIDE_MODULES — const @experimental
```
Record<BuiltinSideModuleId, SideModuleDescriptor>
```
-## SPINE_VERSIONS — const
+## SPINE_VERSIONS — const @experimental
```
readonly SpineVersion[]
```
-## STATE_PATH_SEP — const
+## STATE_PATH_SEP — const @experimental
```
"/"
```
-## SafeArea — const
+## SafeArea — const @experimental
```
ComponentDef<SafeAreaData>
```
-## SafeAreaData — interface
+## SafeAreaData — interface @experimental
```
applyBottom: boolean
applyLeft: boolean
@@ -6425,7 +6425,7 @@ applyRight: boolean
applyTop: boolean
```
-## SafeAreaPlugin — class
+## SafeAreaPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -6435,33 +6435,33 @@ static new (): SafeAreaPlugin
static prototype: SafeAreaPlugin
```
-## SampleDeps — interface
+## SampleDeps — interface @experimental
```
getComponent: (name: string) => AnyComponentDef | undefined
resolveChild: (root: Entity, childPath: string) => Entity | null
world: SampleWorld
```
-## SampleOptions — interface
+## SampleOptions — interface @experimental
```
skipChannel: ((childPath: string, component: string, property: string) => boolean) | undefined
```
-## SampleWorld — interface
+## SampleWorld — interface @experimental
```
get: (entity: Entity, def: AnyComponentDef) => Record<string, unknown>
has: (entity: Entity, def: AnyComponentDef) => boolean
set: (entity: Entity, def: AnyComponentDef, data: Record<string, unknown>) => void
```
-## SaveEnvelope — interface
+## SaveEnvelope — interface @experimental
```
data: T
savedAt: number
version: number
```
-## SaveManager — class
+## SaveManager — class @experimental
```
has: (slot: string) => boolean
load: <T>(slot: string) => T | null
@@ -6472,7 +6472,7 @@ static new (opts: SaveManagerOptions): SaveManager
static prototype: SaveManager
```
-## SaveManagerOptions — interface
+## SaveManagerOptions — interface @experimental
```
keyPrefix: string | undefined
migrations: Record<number, SaveMigration> | undefined
@@ -6481,12 +6481,12 @@ storage: SaveStorage | undefined
version: number
```
-## SaveMigration — type
+## SaveMigration — type @experimental
```
(data: unknown) => unknown
```
-## SaveStorage — interface
+## SaveStorage — interface @experimental
```
getJSON: <T>(key: string, defaultValue?: T) => T | undefined
has: (key: string) => boolean
@@ -6494,12 +6494,12 @@ remove: (key: string) => void
setJSON: <T>(key: string, value: T) => void
```
-## ScaleMode — type
+## ScaleMode — type @experimental
```
(typeof ScaleMode)[keyof typeof ScaleMode]
```
-## SceneAssetRefs — interface
+## SceneAssetRefs — interface @experimental
```
byType: Map<string, Set<string>>
dragonBones: SpineAssetRef[]
@@ -6509,20 +6509,20 @@ spines: SpineAssetRef[]
unresolved: string[]
```
-## SceneComponentCodec — interface
+## SceneComponentCodec — interface @experimental
```
exportData: ((entity: number, data: Record<string, unknown>) => void) | undefined
importData: ((entity: number, outOfBand: Record<string, unknown>) => void) | undefined
outOfBandFields: readonly string[] | undefined
```
-## SceneComponentData — interface
+## SceneComponentData — interface @experimental
```
data: Record<string, unknown>
type: string
```
-## SceneConfig — interface
+## SceneConfig — interface @experimental
```
cleanup: ((ctx: SceneContext) => void) | undefined
data: SceneData | undefined
@@ -6532,7 +6532,7 @@ setup: ((ctx: SceneContext) => void | Promise<void>) | undefined
systems: { schedule: Schedule; system: SystemDef; }[] | undefined
```
-## SceneContext — interface
+## SceneContext — interface @experimental
```
adopt: (entity: Entity) => void
bindPostProcess: (camera: Entity, stack: PostProcessStack) => void
@@ -6546,7 +6546,7 @@ trackAssets: (byType: ReadonlyMap<string, ReadonlySet<string>>) => void
unbindPostProcess: (camera: Entity) => void
```
-## SceneData — interface
+## SceneData — interface @experimental
```
entities: SceneEntityData[]
generator: string | undefined
@@ -6555,7 +6555,7 @@ textureMetadata: Record<string, TextureMetadata> | undefined
version: string | number
```
-## SceneEntityData — interface
+## SceneEntityData — interface @experimental
```
children: number[]
components: SceneComponentData[]
@@ -6565,13 +6565,13 @@ parent: number | null
visible: boolean | undefined
```
-## SceneLoadCancelled — class
+## SceneLoadCancelled — class @experimental
```
static new (name: string): SceneLoadCancelled
static prototype: SceneLoadCancelled
```
-## SceneLoadOptions — interface
+## SceneLoadOptions — interface @experimental
```
abortOnMissingAssets: boolean | undefined
assetBaseUrl: string | undefined
@@ -6581,17 +6581,17 @@ onMissingAssets: MissingAssetCallback | undefined
onProgress: SceneLoadProgressCallback | undefined
```
-## SceneLoadProgressCallback — type
+## SceneLoadProgressCallback — type @experimental
```
(loaded: number, total: number) => void
```
-## SceneManager — const
+## SceneManager — const @experimental
```
ResourceDef<SceneManagerState>
```
-## SceneManagerState — class
+## SceneManagerState — class @experimental
```
bringToTop: (name: string) => void
getActive: () => string | null
@@ -6623,7 +6623,7 @@ static new (app: App): SceneManagerState
static prototype: SceneManagerState
```
-## SceneMigrationResult — interface
+## SceneMigrationResult — interface @experimental
```
data: SceneData
fromVersion: number
@@ -6631,23 +6631,23 @@ migrated: boolean
toVersion: number
```
-## SceneOwner — const
+## SceneOwner — const @experimental
```
ComponentDef<SceneOwnerData>
```
-## SceneOwnerData — interface
+## SceneOwnerData — interface @experimental
```
persistent: boolean
scene: string
```
-## SceneStatus — type
+## SceneStatus — type @experimental
```
'loading' | 'running' | 'paused' | 'sleeping' | 'unloading'
```
-## SceneStreamHost — interface
+## SceneStreamHost — interface @experimental
```
isLoaded: (name: string) => boolean
isSleeping: (name: string) => boolean
@@ -6657,19 +6657,19 @@ unload: (name: string) => Promise<void>
wake: (name: string) => void
```
-## SceneStreaming — const
+## SceneStreaming — const @experimental
```
ResourceDef<SceneStreamingController>
```
-## SceneStreamingConfig — interface
+## SceneStreamingConfig — interface @experimental
```
loadRadius: number
policy: StreamPolicy | undefined
unloadRadius: number
```
-## SceneStreamingController — class
+## SceneStreamingController — class @experimental
```
clear: () => void
configure: (config: SceneStreamingConfig) => void
@@ -6684,7 +6684,7 @@ static new (host: SceneStreamHost, config?: SceneStreamingConfig): SceneStreamin
static prototype: SceneStreamingController
```
-## Schedule — enum
+## Schedule — enum @experimental
```
First = 1
FixedPostUpdate = 12
@@ -6697,7 +6697,7 @@ Startup = 0
Update = 3
```
-## ScreenInfo — class
+## ScreenInfo — class @experimental
```
dpr: number
height: number
@@ -6709,19 +6709,19 @@ static new (): ScreenInfo
static prototype: ScreenInfo
```
-## ScreenInfoEvents — interface
+## ScreenInfoEvents — interface @experimental
```
orientationchange: [orientation: ScreenOrientation]
resize: [width: number, height: number]
```
-## ScreenOrientation — enum
+## ScreenOrientation — enum @experimental
```
Landscape = "landscape"
Portrait = "portrait"
```
-## ScreenRect — interface
+## ScreenRect — interface @experimental
```
h: number
w: number
@@ -6729,12 +6729,12 @@ x: number
y: number
```
-## ScreenScaling — const
+## ScreenScaling — const @experimental
```
ResourceDef<ScreenScalingData>
```
-## ScreenScalingData — interface
+## ScreenScalingData — interface @experimental
```
designHeight: number
designWidth: number
@@ -6742,7 +6742,7 @@ matchWidthOrHeight: number
scaleMode: number
```
-## ScrollContainer — class
+## ScrollContainer — class @experimental
```
dispose: () => void
getContentSize: () => Vec2
@@ -6762,7 +6762,7 @@ static new (opts: ScrollContainerOptions): ScrollContainer
static prototype: ScrollContainer
```
-## ScrollViewHandle — interface
+## ScrollViewHandle — interface @experimental
```
content: number
dispose: () => void
@@ -6772,7 +6772,7 @@ scrollTo: (offset: Vec2) => void
setContentSize: (size: Vec2) => void
```
-## ScrollViewOptions — interface
+## ScrollViewOptions — interface @experimental
```
background: UIVisualInit | undefined
contentSize: Vec2
@@ -6788,12 +6788,12 @@ wheelSpeed: number | undefined
world: World
```
-## SegmentCollider — const
+## SegmentCollider — const @experimental
```
BuiltinComponentDef<SegmentColliderData>
```
-## SenseResult — interface
+## SenseResult — interface @experimental
```
dirX: number
dirY: number
@@ -6801,13 +6801,13 @@ distance: number
visible: boolean
```
-## SensorEvent — interface
+## SensorEvent — interface @experimental
```
sensorEntity: number
visitorEntity: number
```
-## ServicesPlugin — class
+## ServicesPlugin — class @experimental
```
build: (app: App) => void
name: string
@@ -6815,12 +6815,12 @@ static new (): ServicesPlugin
static prototype: ServicesPlugin
```
-## ShaderHandle — type
+## ShaderHandle — type @experimental
```
number
```
-## ShaderParam — interface
+## ShaderParam — interface @experimental
```
default: number[]
defaultTexture: string | undefined
@@ -6831,39 +6831,39 @@ type: ShaderParamType
ui: string | undefined
```
-## ShaderParamType — type
+## ShaderParamType — type @experimental
```
'float' | 'vec2' | 'vec3' | 'vec4' | 'color' | 'int' | 'texture'
```
-## ShaderReflection — interface
+## ShaderReflection — interface @experimental
```
domain: string
params: ShaderParam[]
```
-## ShaderSources — const
+## ShaderSources — const @experimental
```
{ SPRITE_VERTEX: string; SPRITE_FRAGMENT: string; COLOR_VERTEX: string; COLOR_FRAGMENT: string; }
```
-## ShadowCaster2D — const
+## ShadowCaster2D — const @experimental
```
BuiltinComponentDef<ShadowCaster2DData>
```
-## ShadowCaster2DData — interface
+## ShadowCaster2DData — interface @experimental
```
enabled: boolean
size: Vec2
```
-## ShapeRenderer — const
+## ShapeRenderer — const @experimental
```
BuiltinComponentDef<ShapeRendererData>
```
-## ShapeRendererData — interface
+## ShapeRendererData — interface @experimental
```
color: Color
cornerRadius: number
@@ -6874,19 +6874,19 @@ shapeType: number
size: Vec2
```
-## ShapeType — enum
+## ShapeType — enum @experimental
```
Capsule = 1
Circle = 0
RoundedRect = 2
```
-## Share — const
+## Share — const @experimental
```
ResourceDef<ShareAPI>
```
-## ShareAPI — class
+## ShareAPI — class @experimental
```
available: boolean
setShareCard: (card: ShareCard | (() => ShareCard)) => void
@@ -6895,28 +6895,28 @@ static new (): ShareAPI
static prototype: ShareAPI
```
-## ShareCard — type
+## ShareCard — type @experimental
```
PlatformShareOptions
```
-## SideModuleDescriptor — interface
+## SideModuleDescriptor — interface @experimental
```
file: string
globalName: string | undefined
```
-## SideModuleHost — interface
+## SideModuleHost — interface @experimental
```
acquire: (id: SideModuleId) => Promise<SideModule | null>
```
-## SideModuleId — type
+## SideModuleId — type @experimental
```
BuiltinSideModuleId | (string & {})
```
-## Signal — interface
+## Signal — interface @experimental
```
get: () => T
set: (value: T) => void
@@ -6924,13 +6924,13 @@ subscribe: (fn: (value: T) => void) => () => void
update: (fn: (prev: T) => T) => void
```
-## SimulationSpace — enum
+## SimulationSpace — enum @experimental
```
Local = 1
World = 0
```
-## SliceBorder — interface
+## SliceBorder — interface @experimental
```
bottom: number
left: number
@@ -6938,7 +6938,7 @@ right: number
top: number
```
-## SliderHandle — interface
+## SliderHandle — interface @experimental
```
dispose: () => void
entity: number
@@ -6949,7 +6949,7 @@ setValue: (value: number) => void
trackEntity: number
```
-## SliderOptions — interface
+## SliderOptions — interface @experimental
```
disabled: boolean | undefined
events: UIEventQueue
@@ -6969,19 +6969,19 @@ value: number | undefined
world: World
```
-## SocketReadyState — type
+## SocketReadyState — type @experimental
```
PlatformSocketReadyState
```
-## SourceDelta — interface
+## SourceDelta — interface @experimental
```
added: readonly AddedEntity[]
overrides: readonly PrefabOverride[]
removed: readonly string[]
```
-## SpatialAudioConfig — interface
+## SpatialAudioConfig — interface @experimental
```
maxDistance: number
model: AttenuationModel
@@ -6989,22 +6989,22 @@ refDistance: number
rolloff: number
```
-## SpawnOverride — type
+## SpawnOverride — type @experimental
```
Omit<PrefabOverride, 'prefabEntityId'> & { prefabEntityId?: string }
```
-## Spine — const
+## Spine — const @experimental
```
ResourceDef<SpineManager>
```
-## SpineAnimation — const
+## SpineAnimation — const @experimental
```
BuiltinComponentDef<SpineAnimationData>
```
-## SpineAnimationData — interface
+## SpineAnimationData — interface @experimental
```
animation: string
atlasPath: string
@@ -7022,23 +7022,23 @@ skin: string
timeScale: number
```
-## SpineAnimationDriver — interface
+## SpineAnimationDriver — interface @experimental
```
setAnimation: (entity: Entity, animation: string, loop: boolean) => void
```
-## SpineEvents — const
+## SpineEvents — const @experimental
```
ResourceDef<SpineEventsData>
```
-## SpineLoadResult — interface
+## SpineLoadResult — interface @experimental
```
error: string | undefined
success: boolean
```
-## SpinePlugin — class
+## SpinePlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -7050,7 +7050,7 @@ static new (manager?: SpineManager): SpinePlugin
static prototype: SpinePlugin
```
-## SpineTrack — interface
+## SpineTrack — interface @experimental
```
blendIn: number
childPath: string
@@ -7059,12 +7059,12 @@ name: string
type: "spine"
```
-## Sprite — const
+## Sprite — const @experimental
```
BuiltinComponentDef<SpriteData>
```
-## SpriteAnimClip — interface
+## SpriteAnimClip — interface @experimental
```
events: SpriteAnimEvent[] | undefined
fps: number
@@ -7074,19 +7074,19 @@ loop: boolean
name: string
```
-## SpriteAnimEvent — interface
+## SpriteAnimEvent — interface @experimental
```
data: unknown
frame: number
name: string
```
-## SpriteAnimEventHandler — type
+## SpriteAnimEventHandler — type @experimental
```
(event: SpriteAnimEvent, entity: Entity) => void
```
-## SpriteAnimFrame — interface
+## SpriteAnimFrame — interface @experimental
```
duration: number | undefined
pivot: { x: number; y: number; } | undefined
@@ -7095,7 +7095,7 @@ uvOffset: { x: number; y: number; } | undefined
uvScale: { x: number; y: number; } | undefined
```
-## SpriteAnimTrack — interface
+## SpriteAnimTrack — interface @experimental
```
childPath: string
clip: string
@@ -7104,12 +7104,12 @@ startTime: number
type: "spriteAnim"
```
-## SpriteAnimation — const
+## SpriteAnimation — const @experimental
```
ResourceDef<SpriteAnimationAPI>
```
-## SpriteAnimationAPI — class
+## SpriteAnimationAPI — class @experimental
```
aliasClip: (name: string, clip: SpriteAnimClip) => void
clearClips: () => void
@@ -7126,12 +7126,12 @@ static new (): SpriteAnimationAPI
static prototype: SpriteAnimationAPI
```
-## SpriteAnimator — const
+## SpriteAnimator — const @experimental
```
ComponentDef<SpriteAnimatorData>
```
-## SpriteAnimatorData — interface
+## SpriteAnimatorData — interface @experimental
```
clip: string
currentFrame: number
@@ -7143,7 +7143,7 @@ playing: boolean
speed: number
```
-## SpriteData — interface
+## SpriteData — interface @experimental
```
color: Color
enabled: boolean
@@ -7162,12 +7162,12 @@ uvOffset: Vec2
uvScale: Vec2
```
-## SpriteFilter — const
+## SpriteFilter — const @experimental
```
{ createOutline(options?: OutlineFilterOptions): MaterialHandle; createGlow(options?: OutlineFilterOptions): MaterialHandle; createDropShadow(options?: DropShadowFilterOptions): MaterialHandle; setOutlineColor(material: MaterialHandle, color: { r: number; g: number; b: number; a: number; }): void; setOutlineWidth(material: MaterialHandle, width: number): void; setShadowOffset(material: MaterialHandle, x: number, y: number): void; setShadowBlur(material: MaterialHandle, blur: number): void; }
```
-## StaleOverride — interface
+## StaleOverride — interface @experimental
```
nestedAt: string | undefined
override: PrefabOverride
@@ -7175,18 +7175,18 @@ reason: string
site: "variant" | "nested" | "instance"
```
-## StateMachineAgent — const
+## StateMachineAgent — const @experimental
```
ComponentDef<StateMachineAgentData>
```
-## StateMachineAgentData — interface
+## StateMachineAgentData — interface @experimental
```
current: string
fsm: string
```
-## StateMachines — class
+## StateMachines — class @experimental
```
blackboard: (entity: Entity) => Blackboard
fire: (entity: Entity, trigger: string) => void
@@ -7195,12 +7195,12 @@ static new (states: Map<Entity, AgentState>): StateMachines
static prototype: StateMachines
```
-## Stats — const
+## Stats — const @experimental
```
ResourceDef<FrameStats>
```
-## StatsCollector — class
+## StatsCollector — class @experimental
```
getFps: () => number
getFrameTimeMs: () => number
@@ -7210,7 +7210,7 @@ static new (): StatsCollector
static prototype: StatsCollector
```
-## StatsOverlay — class
+## StatsOverlay — class @experimental
```
dispose: () => void
hide: () => void
@@ -7220,7 +7220,7 @@ static new (container: HTMLElement, position?: StatsPosition): StatsOverlay
static prototype: StatsOverlay
```
-## StatsPlugin — class
+## StatsPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -7229,36 +7229,36 @@ static new (options?: StatsPluginOptions): StatsPlugin
static prototype: StatsPlugin
```
-## StatsPluginOptions — interface
+## StatsPluginOptions — interface @experimental
```
container: HTMLElement | undefined
overlay: boolean | undefined
position: StatsPosition | undefined
```
-## StatsPosition — type
+## StatsPosition — type @experimental
```
'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'
```
-## Status — enum
+## Status — enum @experimental
```
Failure = "failure"
Running = "running"
Success = "success"
```
-## Stick — const
+## Stick — const @experimental
```
(stick: "left" | "right", pad?: number) => Binding
```
-## Storage — const
+## Storage — const @experimental
```
{ getString(key: string, defaultValue?: string): string | undefined; setString(key: string, value: string): void; getNumber(key: string, defaultValue?: number): number | undefined; setNumber(key: string, value: number): void; getBoolean(key: string, defaultValue?: boolean): boolean | undefined; setBoolean(key: string, value: boolean): void; getJSON<T>(key: string, defaultValue?: T): T | undefined; setJSON<T>(key: string, value: T): void; remove(key: string): void; has(key: string): boolean; clear(): void; }
```
-## StreamCell — interface
+## StreamCell — interface @experimental
```
radius: number
scene: string
@@ -7266,34 +7266,34 @@ x: number
y: number
```
-## StreamDecision — interface
+## StreamDecision — interface @experimental
```
toActivate: string[]
toDeactivate: string[]
```
-## StreamPolicy — type
+## StreamPolicy — type @experimental
```
'unload' | 'sleep'
```
-## SubEmitterTrigger — enum
+## SubEmitterTrigger — enum @experimental
```
Birth = 1
Death = 0
```
-## SubmitSkipFlags — const
+## SubmitSkipFlags — const @experimental
```
{ readonly None: 0; readonly Spine: 1; readonly Particles: 2; }
```
-## SubsystemActivity — type
+## SubsystemActivity — type @experimental
```
'stepping' | 'idle' | 'inactive'
```
-## SubsystemEvent — interface
+## SubsystemEvent — interface @experimental
```
atMs: number
detail: string | undefined
@@ -7302,12 +7302,12 @@ phase: SubsystemPhase
seq: number
```
-## SubsystemPhase — type
+## SubsystemPhase — type @experimental
```
'registered' | 'initializing' | 'ready' | 'error'
```
-## SubsystemRegistry — class
+## SubsystemRegistry — class @experimental
```
getStatuses: () => SubsystemStatus[]
markError: (id: string, reason?: string) => void
@@ -7321,7 +7321,7 @@ static new (): SubsystemRegistry
static prototype: SubsystemRegistry
```
-## SubsystemStatus — interface
+## SubsystemStatus — interface @experimental
```
activity: SubsystemActivity
dependsOn: readonly string[]
@@ -7333,17 +7333,17 @@ phase: SubsystemPhase
phaseAgeMs: number
```
-## SwipeDirection — type
+## SwipeDirection — type @experimental
```
'left' | 'right' | 'up' | 'down'
```
-## SyncPrefabResolver — type
+## SyncPrefabResolver — type @experimental
```
(path: string) => PrefabData | null
```
-## SystemDef — interface
+## SystemDef — interface @experimental
```
_fn: (...args: never[]) => void | Promise<void>
_id: symbol
@@ -7353,14 +7353,14 @@ _runAfter: readonly string[] | undefined
_runBefore: readonly string[] | undefined
```
-## SystemOptions — interface
+## SystemOptions — interface @experimental
```
name: string | undefined
runAfter: string[] | undefined
runBefore: string[] | undefined
```
-## SystemParam — type
+## SystemParam — type @experimental
```
| QueryDescriptor<readonly QueryArg[]>
| ResDescriptor<unknown>
@@ -7372,7 +7372,7 @@ runBefore: string[] | undefined
| GetWorldDescriptor
```
-## SystemRunner — class
+## SystemRunner — class @experimental
```
clearTimings: () => void
evict: (systemId: symbol) => void
@@ -7384,7 +7384,7 @@ static new (world: World, resources: ResourceStorage, eventRegistry?: EventRegis
static prototype: SystemRunner
```
-## SystemSet — interface
+## SystemSet — interface @experimental
```
_kind: "set"
_name: string
@@ -7394,7 +7394,7 @@ _runIf: RunCondition | undefined
_systems: readonly SystemDef[]
```
-## SystemSetOptions — interface
+## SystemSetOptions — interface @experimental
```
runAfter: string[] | undefined
runBefore: string[] | undefined
@@ -7402,92 +7402,92 @@ runIf: RunCondition | undefined
systems: SystemDef[]
```
-## TB_E — const
+## TB_E — const @experimental
```
2
```
-## TB_N — const
+## TB_N — const @experimental
```
1
```
-## TB_NE — const
+## TB_NE — const @experimental
```
16
```
-## TB_NW — const
+## TB_NW — const @experimental
```
128
```
-## TB_S — const
+## TB_S — const @experimental
```
4
```
-## TB_SE — const
+## TB_SE — const @experimental
```
32
```
-## TB_SW — const
+## TB_SW — const @experimental
```
64
```
-## TB_W — const
+## TB_W — const @experimental
```
8
```
-## TERRAIN_NEIGHBORS — const
+## TERRAIN_NEIGHBORS — const @experimental
```
readonly { dx: number; dy: number; bit: number; }[]
```
-## THEME_COLOR_ROLES — const
+## THEME_COLOR_ROLES — const @experimental
```
readonly (keyof ThemeColors)[]
```
-## TILESET_FORMAT_VERSION — const
+## TILESET_FORMAT_VERSION — const @experimental
```
"1"
```
-## TILE_FLAGS_MASK — const
+## TILE_FLAGS_MASK — const @experimental
```
number
```
-## TILE_FLIP_D — const
+## TILE_FLIP_D — const @experimental
```
32768
```
-## TILE_FLIP_H — const
+## TILE_FLIP_H — const @experimental
```
8192
```
-## TILE_FLIP_V — const
+## TILE_FLIP_V — const @experimental
```
16384
```
-## TILE_ID_MASK — const
+## TILE_ID_MASK — const @experimental
```
8191
```
-## TParams — type
+## TParams — type @experimental
```
Record<string, string | number>
```
-## Takeover — interface
+## Takeover — interface @experimental
```
active: boolean
around: <T>(show: () => Promise<T>) => Promise<T>
@@ -7495,7 +7495,7 @@ begin: () => void
end: () => void
```
-## TakeoverHost — interface
+## TakeoverHost — interface @experimental
```
isPaused: () => boolean
resumeAudio: () => void
@@ -7503,40 +7503,40 @@ setPaused: (paused: boolean) => void
suspendAudio: () => void
```
-## TerrainColor — interface
+## TerrainColor — interface @experimental
```
color: string
name: string
```
-## TerrainIndex — interface
+## TerrainIndex — interface @experimental
```
byMask: Map<number, number>
mode: TerrainMode
```
-## TerrainIndices — interface
+## TerrainIndices — interface @experimental
```
sets: Map<number, TerrainIndex>
tileTerrain: Map<number, number>
```
-## TerrainMode — type
+## TerrainMode — type @experimental
```
'edge' | 'corner' | 'wang'
```
-## Text — const
+## Text — const @experimental
```
ComponentDef<TextData>
```
-## TextAlign — type
+## TextAlign — type @experimental
```
(typeof TextAlign)[keyof typeof TextAlign]
```
-## TextData — interface
+## TextData — interface @experimental
```
align: TextAlign
bold: boolean
@@ -7563,7 +7563,7 @@ verticalAlign: TextVerticalAlign
wordWrap: boolean
```
-## TextInit — interface
+## TextInit — interface @experimental
```
align: TextAlign | undefined
bold: boolean | undefined
@@ -7590,12 +7590,12 @@ verticalAlign: TextVerticalAlign | undefined
wordWrap: boolean | undefined
```
-## TextInput — const
+## TextInput — const @experimental
```
ComponentDef<TextInputData>
```
-## TextInputData — interface
+## TextInputData — interface @experimental
```
backgroundColor: Color
color: Color
@@ -7617,7 +7617,7 @@ textAlign: TextAlign
value: string
```
-## TextInputHandle — interface
+## TextInputHandle — interface @experimental
```
dispose: () => void
entity: number
@@ -7625,7 +7625,7 @@ getValue: () => string
setValue: (value: string) => void
```
-## TextInputOptions — interface
+## TextInputOptions — interface @experimental
```
backgroundColor: Color | undefined
color: Color | undefined
@@ -7650,7 +7650,7 @@ value: string | undefined
world: World
```
-## TextInputPlugin — class
+## TextInputPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -7660,19 +7660,19 @@ static new (): TextInputPlugin
static prototype: TextInputPlugin
```
-## TextMetrics — interface
+## TextMetrics — interface @experimental
```
height: number
lineCount: number
width: number
```
-## TextOverflow — type
+## TextOverflow — type @experimental
```
(typeof TextOverflow)[keyof typeof TextOverflow]
```
-## TextPlugin — class
+## TextPlugin — class @experimental
```
build: (app: App) => void
name: string
@@ -7680,12 +7680,12 @@ static new (): TextPlugin
static prototype: TextPlugin
```
-## TextRenderMode — type
+## TextRenderMode — type @experimental
```
(typeof TextRenderMode)[keyof typeof TextRenderMode]
```
-## TextSegment — interface
+## TextSegment — interface @experimental
```
bold: boolean
color: Color | null
@@ -7695,46 +7695,46 @@ text: string
type: "text"
```
-## TextVerticalAlign — type
+## TextVerticalAlign — type @experimental
```
(typeof TextVerticalAlign)[keyof typeof TextVerticalAlign]
```
-## TextureDimensions — interface
+## TextureDimensions — interface @experimental
```
height: number
width: number
```
-## TextureFilter — type
+## TextureFilter — type @experimental
```
(typeof TextureFilter)[keyof typeof TextureFilter]
```
-## TextureHandle — type
+## TextureHandle — type @experimental
```
number
```
-## TextureInfo — interface
+## TextureInfo — interface @experimental
```
handle: number
height: number
width: number
```
-## TextureRef — interface
+## TextureRef — interface @experimental
```
slot: number | undefined
textureId: number
```
-## TextureWrap — type
+## TextureWrap — type @experimental
```
(typeof TextureWrap)[keyof typeof TextureWrap]
```
-## ThemeColors — interface
+## ThemeColors — interface @experimental
```
backdrop: Color
control: Color
@@ -7751,18 +7751,18 @@ text: Color
track: Color
```
-## ThemeOverrides — interface
+## ThemeOverrides — interface @experimental
```
colors: Partial<ThemeColors> | undefined
type: Partial<ThemeType> | undefined
```
-## ThemeStyle — const
+## ThemeStyle — const @experimental
```
ComponentDef<ThemeStyleData>
```
-## ThemeStyleData — interface
+## ThemeStyleData — interface @experimental
```
input: { background?: ColorRole; text?: ColorRole; placeholder?: ColorRole; } | undefined
states: Record<string, keyof ThemeColors> | undefined
@@ -7770,20 +7770,20 @@ text: keyof ThemeColors | undefined
visual: keyof ThemeColors | undefined
```
-## ThemeTokens — interface
+## ThemeTokens — interface @experimental
```
colors: ThemeColors
type: ThemeType
```
-## ThemeType — interface
+## ThemeType — interface @experimental
```
body: number
label: number
title: number
```
-## TileCollisionPiece — interface
+## TileCollisionPiece — interface @experimental
```
center: Vec2
circles: { c: Vec2; r: number; }[]
@@ -7792,21 +7792,21 @@ polylines: Vec2[][]
sensor: boolean
```
-## TileCollisionShape — type
+## TileCollisionShape — type @experimental
```
| { type: 'box' }
| { type: 'polygon'; points: [number, number][] }
| { type: 'circle'; cx: number; cy: number; r: number }
```
-## TileFlags — interface
+## TileFlags — interface @experimental
```
flipD: boolean
flipH: boolean
flipV: boolean
```
-## TileGridParams — interface
+## TileGridParams — interface @experimental
```
hexSideLength: number | undefined
orientation: number
@@ -7816,7 +7816,7 @@ tileHeight: number
tileWidth: number
```
-## TileOrientation — enum
+## TileOrientation — enum @experimental
```
Hexagonal = 3
Isometric = 1
@@ -7824,14 +7824,14 @@ Orthogonal = 0
Staggered = 2
```
-## TileStamp — interface
+## TileStamp — interface @experimental
```
cells: number[]
h: number
w: number
```
-## TiledLayerData — interface
+## TiledLayerData — interface @experimental
```
chunks: TiledChunkData[]
height: number
@@ -7846,7 +7846,7 @@ visible: boolean
width: number
```
-## TiledMapData — interface
+## TiledMapData — interface @experimental
```
collisionTileIds: number[]
height: number
@@ -7865,7 +7865,7 @@ tilesets: TiledTilesetData[]
width: number
```
-## TiledTilesetData — interface
+## TiledTilesetData — interface @experimental
```
collectionTiles: TiledCollectionTile[] | undefined
columns: number
@@ -7879,27 +7879,27 @@ tileHeight: number
tileWidth: number
```
-## Tilemap — const
+## Tilemap — const @experimental
```
ComponentDef<TilemapData>
```
-## TilemapAPI — const
+## TilemapAPI — const @experimental
```
{ initLayer(entity: number, width: number, height: number, tileWidth: number, tileHeight: number): void; destroyLayer(entity: number): void; setTile(entity: number, x: number, y: number, tileId: number): void; getTile(entity: number, x: number, y: number): number; fillRect(entity: number, x: number, y: number, w: number, h: number, tileId: number): void; setTiles(entity: number, tiles: Uint16Array): void; setTilesets(entity: number, slots: { firstId: number; textureHandle: number; columns: number; margin?: number; spacing?: number; }[]): void; hasLayer(entity: number): boolean; setRenderProps(entity: number, textureHandle: number, tilesetColumns: number, uvTileW: number, uvTileH: number, sortLayer: number, depth: number, parallaxX: number, parallaxY: number): void; setTint(entity: number, r: number, g: number, b: number, a: number, opacity: number): void; setVisible(entity: number, visible: boolean): void; setOriginEntity(layerKey: number, originEntity: number): void; setTileAnimation(entity: number, tileId: number, frames: { tileId: number; duration: number; }[]): void; clearTileAnimations(entity: number): void; advanceAnimations(entity: number, dtMs: number): void; setTileProperty(entity: number, tileId: number, key: string, value: string): void; getTileProperty(entity: number, x: number, y: number, key: string): string; flipTile(entity: number, x: number, y: number, flipH: boolean, flipV: boolean, flipD: boolean): void; rotateTile(entity: number, x: number, y: number, degrees: number): void; initInfiniteLayer(entity: number, tileWidth: number, tileHeight: number): void; setChunkTiles(entity: number, chunkX: number, chunkY: number, tiles: Uint16Array, width: number, height: number): void; setGridType(entity: number, type: number): void; setHexParams(entity: number, sideLength: number, staggerAxisX: boolean, staggerIndexEven: boolean): void; tileToWorld(entity: number, tx: number, ty: number, originX: number, originY: number): { x: number; y: number; }; worldToTile(entity: number, wx: number, wy: number, originX: number, originY: number): { x: number; y: number; }; exportChunks(entity: number): string; importChunks(entity: number, encoded: string): boolean; }
```
-## TilemapData — interface
+## TilemapData — interface @experimental
```
source: string
```
-## TilemapLayer — const
+## TilemapLayer — const @experimental
```
BuiltinComponentDef<TilemapLayerData>
```
-## TilemapLayerData — interface
+## TilemapLayerData — interface @experimental
```
cellSize: Vec2
hexSideLength: number
@@ -7917,12 +7917,12 @@ tintColor: Color
visible: boolean
```
-## TilemapLiveSync — const
+## TilemapLiveSync — const @experimental
```
{ _bind(fn: ApplyTilesetRefs | null): void; setLayerTilesets(entity: number, refs: readonly string[]): void; }
```
-## TilemapPlugin — class
+## TilemapPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -7932,18 +7932,18 @@ static new (): TilemapPlugin
static prototype: TilemapPlugin
```
-## Tilemaps — const
+## Tilemaps — const @experimental
```
ResourceDef<{ initLayer(entity: number, width: number, height: number, tileWidth: number, tileHeight: number): void; destroyLayer(entity: number): void; setTile(entity: number, x: number, y: number, tileId: number): void; getTile(entity: number, x: number, y: number): number; fillRect(entity: number, x: number, y: number, w: number, h: number, tileId: number): void; setTiles(entity: number, tiles: Uint16Array): void; setTilesets(entity: number, slots: { firstId: number; textureHandle: number; columns: number; margin?: number; spacing?: number; }[]): void; hasLayer(entity: number): boolean; setRenderProps(entity: number, textureHandle: number, tilesetColumns: number, uvTileW: number, uvTileH: number, sortLayer: number, depth: number, parallaxX: number, parallaxY: number): void; setTint(entity: number, r: number, g: number, b: number, a: number, opacity: number): void; setVisible(entity: number, visible: boolean): void; setOriginEntity(layerKey: number, originEntity: number): void; setTileAnimation(entity: number, tileId: number, frames: { tileId: number; duration: number; }[]): void; clearTileAnimations(entity: number): void; advanceAnimations(entity: number, dtMs: number): void; setTileProperty(entity: number, tileId: number, key: string, value: string): void; getTileProperty(entity: number, x: number, y: number, key: string): string; flipTile(entity: number, x: number, y: number, flipH: boolean, flipV: boolean, flipD: boolean): void; rotateTile(entity: number, x: number, y: number, degrees: number): void; initInfiniteLayer(entity: number, tileWidth: number, tileHeight: number): void; setChunkTiles(entity: number, chunkX: number, chunkY: number, tiles: Uint16Array, width: number, height: number): void; setGridType(entity: number, type: number): void; setHexParams(entity: number, sideLength: number, staggerAxisX: boolean, staggerIndexEven: boolean): void; tileToWorld(entity: number, tx: number, ty: number, originX: number, originY: number): { x: number; y: number; }; worldToTile(entity: number, wx: number, wy: number, originX: number, originY: number): { x: number; y: number; }; exportChunks(entity: number): string; importChunks(entity: number, encoded: string): boolean; }>
```
-## TilesetAnimFrame — interface
+## TilesetAnimFrame — interface @experimental
```
durationMs: number
tile: number
```
-## TilesetAsset — interface
+## TilesetAsset — interface @experimental
```
columns: number
margin: number
@@ -7957,7 +7957,7 @@ tiles: Record<number, TilesetTile>
version: string
```
-## TilesetCollision — type
+## TilesetCollision — type @experimental
```
TileCollisionShape & {
/** One-way (jump-through) platform: contacts from behind this normal pass through. */
@@ -7971,7 +7971,7 @@ TileCollisionShape & {
}
```
-## TilesetModel — interface
+## TilesetModel — interface @experimental
```
animations: Map<number, { tileId: number; duration: number; }[]>
collidableTileIds: number[]
@@ -7979,7 +7979,7 @@ slots: TilesetModelSlot[]
tileShapes: Map<number, ResolvedTileCollision>
```
-## TilesetTerrain — interface
+## TilesetTerrain — interface @experimental
```
color: string | undefined
colors: TerrainColor[] | undefined
@@ -7987,7 +7987,7 @@ mode: TerrainMode
name: string
```
-## TilesetTile — interface
+## TilesetTile — interface @experimental
```
animation: TilesetAnimFrame[] | undefined
collision: TilesetCollision | undefined
@@ -7996,19 +7996,19 @@ properties: Record<string, string> | undefined
terrain: TilesetTileTerrain | undefined
```
-## TilesetTileTerrain — interface
+## TilesetTileTerrain — interface @experimental
```
corners: number[] | undefined
mask: number | undefined
set: number
```
-## Time — const
+## Time — const @experimental
```
ResourceDef<TimeData>
```
-## TimeData — interface
+## TimeData — interface @experimental
```
delta: number
elapsed: number
@@ -8020,12 +8020,12 @@ scale: number
unscaledDelta: number
```
-## Timeline — const
+## Timeline — const @experimental
```
ResourceDef<TimelineAPI>
```
-## TimelineAPI — class
+## TimelineAPI — class @experimental
```
clearStates: () => void
ensureState: (entity: Entity, wrapMode: WrapMode, speed: number) => TimelineState
@@ -8041,7 +8041,7 @@ static new (flags_?: PlayerFlagChannel | null): TimelineAPI
static prototype: TimelineAPI
```
-## TimelineAsset — interface
+## TimelineAsset — interface @experimental
```
duration: number
tracks: Track[]
@@ -8050,12 +8050,12 @@ version: string
wrapMode: WrapMode
```
-## TimelinePlayer — const
+## TimelinePlayer — const @experimental
```
ComponentDef<TimelinePlayerData>
```
-## TimelinePlayerData — interface
+## TimelinePlayerData — interface @experimental
```
finished: boolean
playing: boolean
@@ -8064,7 +8064,7 @@ timeline: string
wrapMode: string
```
-## TimelinePlugin — class
+## TimelinePlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -8078,7 +8078,7 @@ static new (): TimelinePlugin
static prototype: TimelinePlugin
```
-## TimerHandle — class
+## TimerHandle — class @experimental
```
cancel: () => void
elapsed: number
@@ -8092,7 +8092,7 @@ static new (manager: TimerManager, id: number): TimerHandle
static prototype: TimerHandle
```
-## TimerManager — class
+## TimerManager — class @experimental
```
activeCount: number
cancel: (id: number) => void
@@ -8111,12 +8111,12 @@ static new (): TimerManager
static prototype: TimerManager
```
-## TimerRes — const
+## TimerRes — const @experimental
```
ResourceDef<TimerManager>
```
-## ToggleHandle — interface
+## ToggleHandle — interface @experimental
```
dispose: () => void
entity: number
@@ -8125,7 +8125,7 @@ setDisabled: (disabled: boolean) => void
setValue: (value: boolean) => void
```
-## ToggleOptions — interface
+## ToggleOptions — interface @experimental
```
background: UIVisualInit | undefined
check: { node?: UINodeInit; color?: Color; sprite?: number; } | undefined
@@ -8141,29 +8141,29 @@ tabIndex: number | undefined
world: World
```
-## TouchPoint — interface
+## TouchPoint — interface @experimental
```
id: number
x: number
y: number
```
-## Track — type
+## Track — type @experimental
```
PropertyTrack | SpineTrack | SpriteAnimTrack | AudioTrack | ActivationTrack | MarkerTrack | CustomEventTrack | AnimFramesTrack
```
-## TrackType — type
+## TrackType — type @experimental
```
(typeof TrackType)[keyof typeof TrackType]
```
-## Trail — const
+## Trail — const @experimental
```
ResourceDef<TrailAPI>
```
-## TrailAPI — class
+## TrailAPI — class @experimental
```
clear: (entity: Entity) => void
update: (dt: number) => void
@@ -8171,7 +8171,7 @@ static new (module: NonNullable<EngineApi>, registry: CppRegistry): TrailAPI
static prototype: TrailAPI
```
-## TrailPlugin — class
+## TrailPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -8180,12 +8180,12 @@ static new (): TrailPlugin
static prototype: TrailPlugin
```
-## TrailRenderer — const
+## TrailRenderer — const @experimental
```
BuiltinComponentDef<TrailRendererData>
```
-## TrailRendererData — interface
+## TrailRendererData — interface @experimental
```
blendMode: number
emitting: boolean
@@ -8201,7 +8201,7 @@ texture: number
time: number
```
-## Transaction — class
+## Transaction — class @experimental
```
add: (op: TransactionOp) => void
addDeferred: (op: TransactionOp) => void
@@ -8215,7 +8215,7 @@ static new (label: string, id?: string): Transaction
static prototype: Transaction
```
-## TransactionManager — class
+## TransactionManager — class @experimental
```
begin: (label: string) => Transaction
canRedo: () => boolean
@@ -8231,23 +8231,23 @@ static new (options?: TransactionManagerOptions): TransactionManager
static prototype: TransactionManager
```
-## TransactionManagerOptions — interface
+## TransactionManagerOptions — interface @experimental
```
historyLimit: number | undefined
```
-## TransactionOp — interface
+## TransactionOp — interface @experimental
```
forward: () => void
reverse: () => void
```
-## Transform — const
+## Transform — const @experimental
```
BuiltinComponentDef<TransformData>
```
-## TransformData — interface
+## TransformData — interface @experimental
```
position: Vec3
rotation: Quat
@@ -8257,14 +8257,14 @@ worldRotation: Quat
worldScale: Vec3
```
-## TransitionConfig — interface
+## TransitionConfig — interface @experimental
```
color: Color | undefined
duration: number
type: "fade"
```
-## TransitionOptions — interface
+## TransitionOptions — interface @experimental
```
color: Color | undefined
duration: number | undefined
@@ -8274,12 +8274,12 @@ onStart: (() => void) | undefined
transition: "fade" | "none" | undefined
```
-## Tween — const
+## Tween — const @experimental
```
ResourceDef<TweenAPI>
```
-## TweenAPI — class
+## TweenAPI — class @experimental
```
activeCompositionCount: number
cancel: (tweenHandle: TweenHandle) => void
@@ -8295,12 +8295,12 @@ static new (module: AnimCore, registry: CppRegistry): TweenAPI
static prototype: TweenAPI
```
-## TweenFactory — type
+## TweenFactory — type @experimental
```
() => Completable
```
-## TweenGroup — class
+## TweenGroup — class @experimental
```
cancel: () => void
checkComplete: () => boolean
@@ -8312,7 +8312,7 @@ static new (tweens: Completable[]): TweenGroup
static prototype: TweenGroup
```
-## TweenHandle — class
+## TweenHandle — class @experimental
```
bezier: (p1x: number, p1y: number, p2x: number, p2y: number) => TweenHandle
cancel: () => void
@@ -8325,7 +8325,7 @@ static new (module: AnimCore, registry: CppRegistry, valueManager: ValueTweenMan
static prototype: TweenHandle
```
-## TweenOptions — interface
+## TweenOptions — interface @experimental
```
delay: number | undefined
easing: EasingType | undefined
@@ -8333,7 +8333,7 @@ loop: LoopMode | undefined
loopCount: number | undefined
```
-## TweenSequence — class
+## TweenSequence — class @experimental
```
cancel: () => void
checkComplete: () => boolean
@@ -8345,17 +8345,17 @@ static new (factories: TweenFactory[]): TweenSequence
static prototype: TweenSequence
```
-## TweenState — type
+## TweenState — type @experimental
```
(typeof TweenState)[keyof typeof TweenState]
```
-## TweenTarget — type
+## TweenTarget — type @experimental
```
(typeof TweenTarget)[keyof typeof TweenTarget]
```
-## UICameraData — interface
+## UICameraData — interface @experimental
```
screenH: number
screenW: number
@@ -8373,44 +8373,44 @@ worldRight: number
worldTop: number
```
-## UICameraInfo — const
+## UICameraInfo — const @experimental
```
ResourceDef<UICameraData>
```
-## UIController — const
+## UIController — const @experimental
```
ComponentDef<UIControllerData>
```
-## UIControllerData — interface
+## UIControllerData — interface @experimental
```
controllers: ControllerState[]
```
-## UIDialog — const
+## UIDialog — const @experimental
```
ComponentDef<UIDialogData>
```
-## UIDialogData — interface
+## UIDialogData — interface @experimental
```
closeOnBackdrop: boolean
closeOnEscape: boolean
```
-## UIDisplay — enum
+## UIDisplay — enum @experimental
```
Flex = 0
None = 1
```
-## UIDropdown — const
+## UIDropdown — const @experimental
```
ComponentDef<UIDropdownData>
```
-## UIDropdownData — interface
+## UIDropdownData — interface @experimental
```
label: number
optionHeight: number
@@ -8418,7 +8418,7 @@ options: string[]
selectedIndex: number
```
-## UIEntityInit — interface
+## UIEntityInit — interface @experimental
```
node: UINodeInit | undefined
parent: number | undefined
@@ -8427,7 +8427,7 @@ visual: UIVisualInit | undefined
world: World
```
-## UIEvent — interface
+## UIEvent — interface @experimental
```
currentTarget: number
data: TData
@@ -8439,12 +8439,12 @@ target: number
type: string
```
-## UIEventHandler — type
+## UIEventHandler — type @experimental
```
(event: EntityEvent<TData>) => void
```
-## UIEventQueue — class
+## UIEventQueue — class @experimental
```
clear: () => void
drain: () => readonly EntityEvent[]
@@ -8458,32 +8458,32 @@ static new (): EntityEventQueue
static prototype: EntityEventQueue
```
-## UIEventType — type
+## UIEventType — type @experimental
```
typeof UIEventType[keyof typeof UIEventType]
```
-## UIEvents — const
+## UIEvents — const @experimental
```
ResourceDef<EntityEventQueue>
```
-## UIGear — const
+## UIGear — const @experimental
```
ComponentDef<UIGearData>
```
-## UIGearData — interface
+## UIGearData — interface @experimental
```
bindings: GearBinding[]
```
-## UIInteraction — const
+## UIInteraction — const @experimental
```
BuiltinComponentDef<UIInteractionData>
```
-## UIInteractionData — interface
+## UIInteractionData — interface @experimental
```
hovered: boolean
justPressed: boolean
@@ -8491,7 +8491,7 @@ justReleased: boolean
pressed: boolean
```
-## UIInteractionPlugin — class
+## UIInteractionPlugin — class @experimental
```
build: (app: App) => void
dependencies: "uiLayout"[]
@@ -8500,17 +8500,17 @@ static new (): UIInteractionPlugin
static prototype: UIInteractionPlugin
```
-## UILayoutGeneration — const
+## UILayoutGeneration — const @experimental
```
ResourceDef<UILayoutGenerationData>
```
-## UILayoutGenerationData — interface
+## UILayoutGenerationData — interface @experimental
```
generation: number
```
-## UILayoutPlugin — class
+## UILayoutPlugin — class @experimental
```
build: (app: App) => void
name: string
@@ -8518,19 +8518,19 @@ static new (): UILayoutPlugin
static prototype: UILayoutPlugin
```
-## UIMask — const
+## UIMask — const @experimental
```
BuiltinComponentDef<UIMaskData>
```
-## UIMaskData — interface
+## UIMaskData — interface @experimental
```
alphaCutoff: number
enabled: boolean
mode: MaskMode
```
-## UIMaskPlugin — class
+## UIMaskPlugin — class @experimental
```
build: (app: App) => void
name: "uiMask"
@@ -8538,12 +8538,12 @@ static new (): UIMaskPlugin
static prototype: UIMaskPlugin
```
-## UINode — const
+## UINode — const @experimental
```
BuiltinComponentDef<UINodeData>
```
-## UINodeInit — interface
+## UINodeInit — interface @experimental
```
fill: boolean | undefined
flexGrow: number | undefined
@@ -8563,7 +8563,7 @@ position: number | undefined
width: Dimension | undefined
```
-## UIPlugin — class
+## UIPlugin — class @experimental
```
attachScrollContainer: (entity: Entity, container: ScrollContainer) => void
build: (app: App) => void
@@ -8577,19 +8577,19 @@ static new (): UIPlugin
static prototype: UIPlugin
```
-## UIPointerEvents — enum
+## UIPointerEvents — enum @experimental
```
Auto = 0
None = 1
```
-## UIPositionType — enum
+## UIPositionType — enum @experimental
```
Absolute = 1
Relative = 0
```
-## UIRenderOrderPlugin — class
+## UIRenderOrderPlugin — class @experimental
```
after: ("text" | "uiInteraction" | "uiMask")[]
build: (app: App) => void
@@ -8599,12 +8599,12 @@ static new (): UIRenderOrderPlugin
static prototype: UIRenderOrderPlugin
```
-## UISlider — const
+## UISlider — const @experimental
```
ComponentDef<UISliderData>
```
-## UISliderData — interface
+## UISliderData — interface @experimental
```
fill: number
handle: number
@@ -8614,18 +8614,18 @@ step: number
value: number
```
-## UIToggle — const
+## UIToggle — const @experimental
```
ComponentDef<UIToggleData>
```
-## UIToggleData — interface
+## UIToggleData — interface @experimental
```
check: number
isOn: boolean
```
-## UIVisibilityPlugin — class
+## UIVisibilityPlugin — class @experimental
```
build: (app: App) => void
dependencies: "uiInteraction"[]
@@ -8634,12 +8634,12 @@ static new (): UIVisibilityPlugin
static prototype: UIVisibilityPlugin
```
-## UIVisual — const
+## UIVisual — const @experimental
```
BuiltinComponentDef<UIVisualData>
```
-## UIVisualData — interface
+## UIVisualData — interface @experimental
```
color: Color
enabled: boolean
@@ -8656,7 +8656,7 @@ uvScale: Vec2
visualType: UIVisualType
```
-## UIVisualInit — interface
+## UIVisualInit — interface @experimental
```
color: { r: number; g: number; b: number; a: number; } | undefined
enabled: boolean | undefined
@@ -8673,7 +8673,7 @@ uvScale: Vec2 | undefined
visualType: UIVisualType | undefined
```
-## UIVisualType — enum
+## UIVisualType — enum @experimental
```
Filled = 5
Image = 2
@@ -8683,23 +8683,23 @@ SolidColor = 1
Tiled = 4
```
-## UniformValue — type
+## UniformValue — type @experimental
```
number | Vec2 | Vec3 | Vec4 | number[] | TextureRef
```
-## Unsubscribe — type
+## Unsubscribe — type @experimental
```
() => void
```
-## ValidatePrefabOptions — interface
+## ValidatePrefabOptions — interface @experimental
```
instanceOverrides: readonly PrefabOverride[] | undefined
loadPrefab: ((path: string) => PrefabData | null) | undefined
```
-## ValidateResult — interface
+## ValidateResult — interface @experimental
```
duplicateIds: string[]
invalidIds: string[]
@@ -8707,7 +8707,7 @@ orphanedChildren: string[]
stale: StaleOverride[]
```
-## ValueTweenHandle — class
+## ValueTweenHandle — class @experimental
```
bezier: (p1x: number, p1y: number, p2x: number, p2y: number) => ValueTweenHandle
cancel: () => void
@@ -8721,26 +8721,26 @@ static new (manager: ValueTweenManager, id: number): ValueTweenHandle
static prototype: ValueTweenHandle
```
-## Vec2 — interface
+## Vec2 — interface @experimental
```
x: number
y: number
```
-## Vec2Like — interface
+## Vec2Like — interface @experimental
```
x: number
y: number
```
-## Vec3 — interface
+## Vec3 — interface @experimental
```
x: number
y: number
z: number
```
-## Vec4 — interface
+## Vec4 — interface @experimental
```
w: number
x: number
@@ -8748,29 +8748,29 @@ y: number
z: number
```
-## Velocity — const
+## Velocity — const @experimental
```
BuiltinComponentDef<VelocityData>
```
-## VelocityData — interface
+## VelocityData — interface @experimental
```
angular: Vec3
linear: Vec3
```
-## VertexAttributeDescriptor — interface
+## VertexAttributeDescriptor — interface @experimental
```
name: string
type: DataType
```
-## Video — const
+## Video — const @experimental
```
ComponentDef<VideoData>
```
-## VideoAPI — class
+## VideoAPI — class @experimental
```
backendName: string
baseUrl: string
@@ -8784,7 +8784,7 @@ static new (backend: PlatformVideoBackend): VideoAPI
static prototype: VideoAPI
```
-## VideoData — interface
+## VideoData — interface @experimental
```
autoplay: boolean
enabled: boolean
@@ -8796,22 +8796,22 @@ source: string
volume: number
```
-## VideoHandle — type
+## VideoHandle — type @experimental
```
VideoStreamHandle
```
-## VideoPlayOptions — type
+## VideoPlayOptions — type @experimental
```
VideoStreamOptions
```
-## VideoPlayer — const
+## VideoPlayer — const @experimental
```
ResourceDef<VideoAPI>
```
-## VideoPlugin — class
+## VideoPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -8821,7 +8821,7 @@ static new (): VideoPlugin
static prototype: VideoPlugin
```
-## VideoStreamHandle — interface
+## VideoStreamHandle — interface @experimental
```
bytes: number | undefined
currentTime: number
@@ -8846,7 +8846,7 @@ textureHandle: number
width: number
```
-## VideoStreamOptions — interface
+## VideoStreamOptions — interface @experimental
```
audioTrackUrl: string | undefined
autoplay: boolean | undefined
@@ -8856,7 +8856,7 @@ playbackRate: number | undefined
volume: number | undefined
```
-## Viewport — interface
+## Viewport — interface @experimental
```
h: number
w: number
@@ -8864,28 +8864,28 @@ x: number
y: number
```
-## Virtual — const
+## Virtual — const @experimental
```
(id: string) => Binding
```
-## WangIndex — interface
+## WangIndex — interface @experimental
```
byKey: Map<number, number>
```
-## WangIndices — interface
+## WangIndices — interface @experimental
```
sets: Map<number, WangIndex>
tileTerrain: Map<number, number>
```
-## WeChatSideModuleFactories — type
+## WeChatSideModuleFactories — type @experimental
```
Partial<Record<SideModuleId, EmscriptenFactory>>
```
-## WeChatSocket — class
+## WeChatSocket — class @experimental
```
close: (code?: number, reason?: string) => void
connect: () => void
@@ -8896,7 +8896,7 @@ static new (options: GameSocketOptions): WeChatSocket
static prototype: WeChatSocket
```
-## WebAppOptions — interface
+## WebAppOptions — interface @experimental
```
colorSpace: "gamma" | "linear" | undefined
depthLayers: number | undefined
@@ -8909,34 +8909,34 @@ sideModules: SideModuleHost | undefined
ySortLayers: number | undefined
```
-## WeldJoint — const
+## WeldJoint — const @experimental
```
ComponentDef<WeldJointData>
```
-## WheelJoint — const
+## WheelJoint — const @experimental
```
ComponentDef<WheelJointData>
```
-## WidgetInteractionInit — interface
+## WidgetInteractionInit — interface @experimental
```
disabled: boolean | undefined
focusable: boolean | undefined
tabIndex: number | undefined
```
-## With — function
+## With — function @experimental
```
(component: AnyComponentDef): FilterExpr
```
-## Without — function
+## Without — function @experimental
```
(component: AnyComponentDef): FilterExpr
```
-## World — class
+## World — class @experimental
```
advanceTick: () => void
anyChangedSince: (component: AnyComponentDef, sinceTick: number) => boolean
@@ -8991,7 +8991,7 @@ static new (): World
static prototype: World
```
-## WorldRect — interface
+## WorldRect — interface @experimental
```
bottom: number
left: number
@@ -8999,62 +8999,62 @@ right: number
top: number
```
-## WorldTransform — const
+## WorldTransform — const @experimental
```
BuiltinComponentDef<TransformData>
```
-## WorldTransformData — type
+## WorldTransformData — type @experimental
```
TransformData
```
-## WrapMode — type
+## WrapMode — type @experimental
```
(typeof WrapMode)[keyof typeof WrapMode]
```
-## actionRefArg — function
+## actionRefArg — function @experimental
```
(ref: FsmActionRef | undefined): string | undefined
```
-## actionRefName — function
+## actionRefName — function @experimental
```
(ref: FsmActionRef | undefined): string
```
-## actionRefParams — function
+## actionRefParams — function @experimental
```
(ref: FsmActionRef | undefined): Record<string, AiParamValue> | undefined
```
-## activeRemoteRoot — function
+## activeRemoteRoot — function @experimental
```
(config: AssetGroupsConfig | null | undefined): string | undefined
```
-## addAnimatorParam — function
+## addAnimatorParam — function @experimental
```
(def: AnimatorControllerDef, name: string, type: AnimatorParamType): AnimatorControllerDef
```
-## addAnimatorState — function
+## addAnimatorState — function @experimental
```
(def: AnimatorControllerDef, name: string, x?: number, y?: number): AnimatorControllerDef
```
-## addAnimatorTransition — function
+## addAnimatorTransition — function @experimental
```
(def: AnimatorControllerDef, from: string, to: string): AnimatorControllerDef
```
-## addBtChild — function
+## addBtChild — function @experimental
```
(def: BtDefinition, parentId: string, type: BtNodeType, x?: number, y?: number): BtDefinition
```
-## addBtOrphan — function
+## addBtOrphan — function @experimental
```
(def: BtDefinition, type: BtNodeType, x?: number, y?: number): BtDefinition
```
@@ -9064,397 +9064,397 @@ TransformData
(g: MaterialGraph, type: GraphNodeType, x: number, y: number): { graph: MaterialGraph; id: string; }
```
-## addStartupSystem — function
+## addStartupSystem — function @experimental
```
(system: SystemDef): void
```
-## addState — function
+## addState — function @experimental
```
(def: FsmDefinition, name: string, x?: number, y?: number): FsmDefinition
```
-## addSystem — function
+## addSystem — function @experimental
```
(system: SystemDef): void
```
-## addSystemSetToSchedule — function
+## addSystemSetToSchedule — function @experimental
```
(schedule: Schedule, set: SystemSet): void
```
-## addSystemToSchedule — function
+## addSystemToSchedule — function @experimental
```
(schedule: Schedule, system: SystemDef): void
```
-## addTransition — function
+## addTransition — function @experimental
```
(def: FsmDefinition, from: string, to: string): FsmDefinition
```
-## agentBlackboard — function
+## agentBlackboard — function @experimental
```
(states: Map<Entity, AgentState>, entity: Entity): Blackboard
```
-## agentBtBlackboard — function
+## agentBtBlackboard — function @experimental
```
(states: Map<Entity, BtAgentState>, entity: Entity): Blackboard
```
-## aiRegistry — const
+## aiRegistry — const @experimental
```
AiRegistry<AiContext>
```
-## analyzeCensusSeries — function
+## analyzeCensusSeries — function @experimental
```
(samples: readonly Census[], opts?: CensusSeriesOptions): CensusReport
```
-## anchorPresetFields — function
+## anchorPresetFields — function @experimental
```
(preset: AnchorPreset): AnchorFields
```
-## animClipCellRect — function
+## animClipCellRect — function @experimental
```
(sheet: AnimClipSheetData, cell: number): { x: number; y: number; width: number; height: number; }
```
-## animClipCellUv — function
+## animClipCellUv — function @experimental
```
(sheet: AnimClipSheetData, cell: number): { uvOffset: { x: number; y: number; }; uvScale: { x: number; y: number; }; }
```
-## animClipDrivesPivot — function
+## animClipDrivesPivot — function @experimental
```
(data: AnimClipAssetData): boolean
```
-## animClipFramePivot — function
+## animClipFramePivot — function @experimental
```
(data: AnimClipAssetData, frame: AnimClipFrameData): AnimClipPivotData | null
```
-## animClipSheetCols — function
+## animClipSheetCols — function @experimental
```
(sheet: AnimClipSheetData): number
```
-## animClipSheetRows — function
+## animClipSheetRows — function @experimental
```
(sheet: AnimClipSheetData): number
```
-## animationPlugin — const
+## animationPlugin — const @experimental
```
AnimationPlugin
```
-## animatorEdges — function
+## animatorEdges — function @experimental
```
(def: AnimatorControllerDef): AnimatorEdge[]
```
-## applyAssetRefResolvers — function
+## applyAssetRefResolvers — function @experimental
```
(app: App, resolveRef: (ref: string) => string): void
```
-## applyAudioProjectConfig — function
+## applyAudioProjectConfig — function @experimental
```
(audio: AudioAPI, config: AudioProjectConfig | undefined): void
```
-## applyBuildRuntimeConfig — function
+## applyBuildRuntimeConfig — function @experimental
```
(app: { setMaxDeltaTime(v: number): void; setMaxFixedSteps(v: number): void; }, config: RuntimeBuildConfig): void
```
-## applyDeltaToSource — function
+## applyDeltaToSource — function @experimental
```
(source: PrefabData, delta: SourceDelta): PrefabData
```
-## applyOverrides — function
+## applyOverrides — function @experimental
```
(entity: OverrideTarget, overrides: readonly PrefabOverride[] | undefined): void
```
-## applyOverridesToSource — function
+## applyOverridesToSource — function @experimental
```
(source: PrefabData, overrides: readonly PrefabOverride[]): PrefabData
```
-## applyRuntimeConfig — function
+## applyRuntimeConfig — function @experimental
```
(components: { Text?: { _default: Record<string, unknown>; }; TextInput?: { _default: Record<string, unknown>; }; Canvas?: { _default: Record<string, unknown>; }; }): void
```
-## applyThemeToWorld — function
+## applyThemeToWorld — function @experimental
```
(world: World): void
```
-## applyWrapMode — function
+## applyWrapMode — function @experimental
```
(time: number, duration: number, mode: WrapMode): { time: number; stopped: boolean; }
```
-## arrayDataSource — function
+## arrayDataSource — function @experimental
```
<T>(items: readonly T[]): ArrayDataSource<T>
```
-## assetPlugin — const
+## assetPlugin — const @experimental
```
AssetPlugin
```
-## atlasCatalogFields — function
+## atlasCatalogFields — function @experimental
```
(atlas: CookedAtlasInfo, pagePath: string): Pick<CatalogEntry, "atlas" | "frame" | "uv">
```
-## audioPlugin — const
+## audioPlugin — const @experimental
```
AudioPlugin
```
-## auto — const
+## auto — const @experimental
```
() => Dimension
```
-## bind — function
+## bind — function @experimental
```
<C extends object, K extends keyof C>(world: World, entity: Entity, component: ComponentDef<C>, field: K, source: ReadonlySignal<C[K]>): () => void
```
-## bindControllerPage — function
+## bindControllerPage — function @experimental
```
(world: World, entity: Entity, controller: string, source: ReadonlySignal<string>): () => void
```
-## bindWidgetValue — function
+## bindWidgetValue — function @experimental
```
<C extends object, K extends keyof C>(world: World, events: UIEventQueue, entity: Entity, component: ComponentDef<C>, field: K, signal: Signal<C[K]>, payloadKey?: string): () => void
```
-## btEdges — function
+## btEdges — function @experimental
```
(def: BtDefinition): BtEdge[]
```
-## btNodes — function
+## btNodes — function @experimental
```
(def: BtDefinition): BtNode[]
```
-## btPlugin — const
+## btPlugin — const @experimental
```
BtPlugin
```
-## bucketOverridesByEntity — function
+## bucketOverridesByEntity — function @experimental
```
(overrides: readonly PrefabOverride[]): Map<PrefabEntityId, PrefabOverride[]>
```
-## buildCollisionPaletteModel — function
+## buildCollisionPaletteModel — function @experimental
```
(material?: CollisionMaterial): TilesetModel
```
-## buildTerrainIndices — function
+## buildTerrainIndices — function @experimental
```
(asset: TilesetAsset): TerrainIndices
```
-## buildText — function
+## buildText — function @experimental
```
(init?: TextInit): TextData
```
-## buildUINode — function
+## buildUINode — function @experimental
```
(init?: UINodeInit): UINodeData
```
-## buildUIVisual — function
+## buildUIVisual — function @experimental
```
(init?: UIVisualInit): UIVisualData
```
-## buildVariant — function
+## buildVariant — function @experimental
```
(base: PrefabData, baseRef: string, name: string, delta: { overrides: readonly PrefabOverride[]; added: readonly AddedEntity[]; }): PrefabData
```
-## buildWangIndices — function
+## buildWangIndices — function @experimental
```
(asset: TilesetAsset): WangIndices
```
-## builtinShaderTemplate — function
+## builtinShaderTemplate — function @experimental
```
(id: string): BuiltinShaderTemplate | undefined
```
-## calculateAttenuation — function
+## calculateAttenuation — function @experimental
```
(distance: number, config?: SpatialAudioConfig): number
```
-## calculatePanning — function
+## calculatePanning — function @experimental
```
(sourceX: number, sourceY: number, listenerX: number, listenerY: number, maxDistance: number): number
```
-## canHaveChildren — function
+## canHaveChildren — function @experimental
```
(type: BtNodeType): boolean
```
-## canonicalMask — function
+## canonicalMask — function @experimental
```
(mode: TerrainMode, mask: number): number
```
-## catalogFromManifest — function
+## catalogFromManifest — function @experimental
```
(manifest: AddressableManifest): Catalog | undefined
```
-## censusProbeIds — function
+## censusProbeIds — function @experimental
```
(): string[]
```
-## clearAllCaches — function
+## clearAllCaches — function @experimental
```
(): void
```
-## clearAnimatorControllerStore — function
+## clearAnimatorControllerStore — function @experimental
```
(): void
```
-## clearBtStore — function
+## clearBtStore — function @experimental
```
(): void
```
-## clearDrawCallbacks — function
+## clearDrawCallbacks — function @experimental
```
(): void
```
-## clearFsmStore — function
+## clearFsmStore — function @experimental
```
(): void
```
-## clearProjectSideModules — function
+## clearProjectSideModules — function @experimental
```
(): void
```
-## clearTilemapSourceCache — function
+## clearTilemapSourceCache — function @experimental
```
(): void
```
-## clearUserComponents — function
+## clearUserComponents — function @experimental
```
(): void
```
-## cloneComponentData — function
+## cloneComponentData — function @experimental
```
(data: Record<string, unknown>): Record<string, unknown>
```
-## cloneComponents — function
+## cloneComponents — function @experimental
```
(components: ComponentData[]): ComponentData[]
```
-## cloneMetadata — function
+## cloneMetadata — function @experimental
```
(metadata: Record<string, unknown>): Record<string, unknown>
```
-## closeDialog — function
+## closeDialog — function @experimental
```
(world: World, events: UIEventQueue, root: Entity): void
```
-## closeDropdown — function
+## closeDropdown — function @experimental
```
(world: World, e: Entity): void
```
-## col — const
+## col — const @experimental
```
{ readonly create: (r?: number, g?: number, b?: number, a?: number) => Color; readonly rgb: (r: number, g: number, b: number) => Color; readonly from255: (r: number, g: number, b: number, a?: number) => Color; readonly clone: (c: Color) => Color; readonly lerp: (a: Color, b: Color, t: number) => Color; readonly withAlpha: (c: Color, a: number) => Color; readonly multiply: (a: Color, b: Color) => Color; readonly scaleRgb: (c: Color, s: number) => Color; readonly fromHex: (hex: string) => Color; readonly toHex: (c: Color, withAlpha?: boolean) => string; readonly equals: (a: Color, b: Color, epsilon?: number) => boolean; }
```
-## collapseEntry — function
+## collapseEntry — function @experimental
```
(prefab: PrefabData, prefabRef: string, expanded: readonly ProcessedEntity[], rootId: number, sceneParent: number | null, loadPrefab?: SyncPrefabResolver): PrefabInstanceEntry
```
-## collapseInstance — function
+## collapseInstance — function @experimental
```
(prefab: PrefabData, prefabRef: string, expanded: readonly ProcessedEntity[], loadPrefab?: SyncPrefabResolver): PrefabInstanceDelta
```
-## collectExternalEntityRefs — function
+## collectExternalEntityRefs — function @experimental
```
(entities: readonly ExtractEntity[]): ExternalEntityRef[]
```
-## collectGarbage — function
+## collectGarbage — function @experimental
```
(): boolean
```
-## collectNestedPrefabPaths — function
+## collectNestedPrefabPaths — function @experimental
```
(prefab: PrefabData, loadPrefab: (path: string) => PrefabData | null, visited?: Set<string>): string[]
```
-## collidableTileIds — function
+## collidableTileIds — function @experimental
```
(asset: TilesetAsset): number[]
```
-## colliderShapeOutline — function
+## colliderShapeOutline — function @experimental
```
(shape: ColliderShape, center: Vec2, angle: number, ppu: number): ColliderOutline
```
-## collisionRefWithMaterial — function
+## collisionRefWithMaterial — function @experimental
```
(material: CollisionMaterial): string
```
-## color — const
+## color — const @experimental
```
(r?: number, g?: number, b?: number, a?: number) => Color
```
-## compareDrawRank — function
+## compareDrawRank — function @experimental
```
(a: DrawRank, b: DrawRank): number
```
-## compileFsm — function
+## compileFsm — function @experimental
```
(def: FsmDefinition): CompiledFsm
```
@@ -9464,12 +9464,12 @@ BtPlugin
(graph: MaterialGraph): string
```
-## computeEffectiveOrthoSize — function
+## computeEffectiveOrthoSize — function @experimental
```
(baseOrthoSize: number, designAspect: number, actualAspect: number, scaleMode: number, matchWidthOrHeight: number): number
```
-## computeStreaming — function
+## computeStreaming — function @experimental
```
(cells: readonly StreamCell[], focusX: number, focusY: number, loadRadius: number, unloadRadius: number, active: ReadonlySet<string>): StreamDecision
```
@@ -9479,62 +9479,62 @@ BtPlugin
(g: MaterialGraph, fromId: string, toId: string, toSlot: string): MaterialGraph
```
-## contentHashHex — function
+## contentHashHex — function @experimental
```
(data: Uint8Array): string
```
-## contentHashOf — function
+## contentHashOf — function @experimental
```
(data: Uint8Array | string): string
```
-## controllerState — function
+## controllerState — function @experimental
```
(name: string, pages: string[], current?: string): ControllerState
```
-## corePlugin — const
+## corePlugin — const @experimental
```
Plugin
```
-## createAnimClip — function
+## createAnimClip — function @experimental
```
(texture: string, cellWidth: number, cellHeight: number, pageWidth: number, pageHeight: number): AnimClipAssetData
```
-## createBtRunState — function
+## createBtRunState — function @experimental
```
(): BtRunState
```
-## createButton — function
+## createButton — function @experimental
```
(opts: ButtonOptions): ButtonHandle
```
-## createDialog — function
+## createDialog — function @experimental
```
(opts: DialogOptions): DialogHandle
```
-## createDropdown — function
+## createDropdown — function @experimental
```
<T>(opts: DropdownOptions<T>): DropdownHandle<T>
```
-## createEmbeddedSideModuleHost — function
+## createEmbeddedSideModuleHost — function @experimental
```
(registry: EmbeddedSideModuleRegistry): SideModuleHost
```
-## createFetchSideModuleHost — function
+## createFetchSideModuleHost — function @experimental
```
(baseUrl: string): SideModuleHost
```
-## createFsmRunState — function
+## createFsmRunState — function @experimental
```
(fsm: CompiledFsm): FsmRunState
```
@@ -9544,192 +9544,192 @@ Plugin
(module: ESEngineModule, options?: HeadlessAppOptions): App
```
-## createListView — function
+## createListView — function @experimental
```
<T>(opts: CreateListViewOptions<T>): ListViewHandle<T>
```
-## createLocalAchievements — function
+## createLocalAchievements — function @experimental
```
(): AchievementProvider
```
-## createLocalLeaderboard — function
+## createLocalLeaderboard — function @experimental
```
(options?: LocalLeaderboardOptions): LeaderboardProvider
```
-## createMemoryTransportPair — function
+## createMemoryTransportPair — function @experimental
```
(options?: MemoryTransportOptions): [MemoryTransport, MemoryTransport]
```
-## createMiniGameSideModuleHost — function
+## createMiniGameSideModuleHost — function @experimental
```
(factories: MiniGameSideModuleFactories): SideModuleHost
```
-## createMockAdProvider — function
+## createMockAdProvider — function @experimental
```
(options?: MockAdProviderOptions): AdProvider
```
-## createPackagedAssetSource — function
+## createPackagedAssetSource — function @experimental
```
(index: PackagedAssetIndex, options?: PackagedAssetSourceOptions): RuntimeAssetSource
```
-## createProgress — function
+## createProgress — function @experimental
```
(opts: ProgressOptions): ProgressHandle
```
-## createRuntimeSceneConfig — function
+## createRuntimeSceneConfig — function @experimental
```
(name: string, sceneData: SceneData | undefined, options: Omit<LoadRuntimeSceneOptions, "sceneData" | "sceneName">, scenePath?: string): SceneConfig
```
-## createScrollView — function
+## createScrollView — function @experimental
```
(opts: ScrollViewOptions): ScrollViewHandle
```
-## createSlider — function
+## createSlider — function @experimental
```
(opts: SliderOptions): SliderHandle
```
-## createSocket — function
+## createSocket — function @experimental
```
(options: GameSocketOptions): PlatformSocket
```
-## createTakeover — function
+## createTakeover — function @experimental
```
(host: TakeoverHost): Takeover
```
-## createTextInput — function
+## createTextInput — function @experimental
```
(opts: TextInputOptions): TextInputHandle
```
-## createTileset — function
+## createTileset — function @experimental
```
(texture: string, tileWidth?: number, tileHeight?: number, columns?: number): TilesetAsset
```
-## createToggle — function
+## createToggle — function @experimental
```
(opts: ToggleOptions): ToggleHandle
```
-## createWeChatSideModuleHost — function
+## createWeChatSideModuleHost — function @experimental
```
(factories: MiniGameSideModuleFactories): SideModuleHost
```
-## createWebApp — function
+## createWebApp — function @experimental
```
(module: ESEngineModule, options?: CreateWebAppOptions): App
```
-## debug — function
+## debug — function @experimental
```
(category: string, message: string, data?: unknown): void
```
-## decodeImageBitmap — function
+## decodeImageBitmap — function @experimental
```
(src: ImageBitmapSource | PlatformImage, flip: boolean): Promise<ImageBitmap>
```
-## decodeImagePixels — function
+## decodeImagePixels — function @experimental
```
(src: ImageBitmapSource): Promise<DecodedPixels>
```
-## decodeTilemapChunks — function
+## decodeTilemapChunks — function @experimental
```
(blob: string): DecodedChunk[]
```
-## defaultFrameStats — function
+## defaultFrameStats — function @experimental
```
(): FrameStats
```
-## defaultPluralSelector — const
+## defaultPluralSelector — const @experimental
```
PluralSelector
```
-## defineBehavior — function
+## defineBehavior — function @experimental
```
<S extends object>(name: string, def: BehaviorDef<S>): ComponentDef<S>
```
-## defineComponent — function
+## defineComponent — function @experimental
```
<T extends object>(name: string, defaults: T, metadata?: ComponentMetadata): ComponentDef<T>
```
-## defineEvent — function
+## defineEvent — function @experimental
```
<T>(name: string): EventDef<T>
```
-## defineInputMap — function
+## defineInputMap — function @experimental
```
(actions: Record<string, ActionDef>): InputMap
```
-## defineResource — function
+## defineResource — function @experimental
```
<T>(defaultValue: T, name?: string): ResourceDef<T>
```
-## defineSystem — function
+## defineSystem — function @experimental
```
<P extends readonly SystemParam[]>(params: [...P], fn: (...args: InferParams<P>) => void | Promise<void>, options?: SystemOptions): SystemDef
```
-## defineSystemSet — function
+## defineSystemSet — function @experimental
```
(name: string, options: SystemSetOptions): SystemSet
```
-## defineTag — function
+## defineTag — function @experimental
```
(name: string): ComponentDef<{}>
```
-## derived — function
+## derived — function @experimental
```
<T>(sources: ReadonlySignal<unknown>[], compute: () => T): ReadonlySignal<T>
```
-## detectAnchor — function
+## detectAnchor — function @experimental
```
(node: UINodeData): AnchorPreset | null
```
-## detectAnchorAxes — function
+## detectAnchorAxes — function @experimental
```
(node: UINodeData): { h: AnchorAxis | null; v: AnchorAxis | null; }
```
-## diagnosticsPlugin — const
+## diagnosticsPlugin — const @experimental
```
DiagnosticsPlugin
```
-## diffAgainstSource — function
+## diffAgainstSource — function @experimental
```
(source: PrefabData, instance: readonly ProcessedEntity[], options?: DiffOptions): { overrides: PrefabOverride[]; untracked: ProcessedEntity[]; orphanedSourceIds: PrefabEntityId[]; }
```
-## diffCensus — function
+## diffCensus — function @experimental
```
(before: Census, after: Census): CensusDelta[]
```
@@ -9739,797 +9739,797 @@ DiagnosticsPlugin
(g: MaterialGraph, toId: string, toSlot: string): MaterialGraph
```
-## discoverSceneAssets — function
+## discoverSceneAssets — function @experimental
```
(sceneData: SceneData, refResolver?: RefResolver): SceneAssetRefs
```
-## dragPlugin — const
+## dragPlugin — const @experimental
```
DragPlugin
```
-## dragonBonesPlugin — const
+## dragonBonesPlugin — const @experimental
```
() => DragonBonesPlugin
```
-## editorViewHalfExtent — function
+## editorViewHalfExtent — function @experimental
```
(view: EditorViewData, aspect: number): { halfW: number; halfH: number; }
```
-## editorViewHalfHeight — function
+## editorViewHalfHeight — function @experimental
```
(view: EditorViewData): number
```
-## emptyAnimatorController — function
+## emptyAnimatorController — function @experimental
```
(): AnimatorControllerDef
```
-## emptyBt — function
+## emptyBt — function @experimental
```
(): BtDefinition
```
-## emptyFsm — function
+## emptyFsm — function @experimental
```
(): FsmDefinition
```
-## encodeTile — function
+## encodeTile — function @experimental
```
(id: number, flags?: TileFlags): number
```
-## ensureBtIds — function
+## ensureBtIds — function @experimental
```
(def: BtDefinition): BtDefinition
```
-## enterStatePath — function
+## enterStatePath — function @experimental
```
(scope: AnimatorScope, name: string): string[]
```
-## enumOptions — function
+## enumOptions — function @experimental
```
(obj: Record<string, unknown>, only?: readonly string[]): ReadonlyArray<{ label: string; value: number; }>
```
-## error — function
+## error — function @experimental
```
(category: string, message: string, data?: unknown): void
```
-## evalGuard — function
+## evalGuard — function @experimental
```
(bb: Blackboard, guard: BlackboardGuard): boolean
```
-## evalGuards — function
+## evalGuards — function @experimental
```
(bb: Blackboard, guards: BlackboardGuard | BlackboardGuard[]): boolean
```
-## evaluateAnimatorPath — function
+## evaluateAnimatorPath — function @experimental
```
(def: AnimatorControllerDef, currentPath: string, params: AnimatorParamValues, triggers: ReadonlySet<string>, clipFinished?: boolean): AnimatorPathEvalResult
```
-## evaluateAnimatorTransitions — function
+## evaluateAnimatorTransitions — function @experimental
```
(def: AnimatorControllerDef, currentState: string, params: AnimatorParamValues, triggers: ReadonlySet<string>, clipFinished?: boolean): AnimatorEvalResult
```
-## evaluateChannel — function
+## evaluateChannel — function @experimental
```
(channel: PropertyChannel, time: number): number
```
-## eventBindingPlugin — const
+## eventBindingPlugin — const @experimental
```
EventBindingPlugin
```
-## evictTextureDimensions — function
+## evictTextureDimensions — function @experimental
```
(handle: number): void
```
-## expandEntry — function
+## expandEntry — function @experimental
```
(prefab: PrefabData, entry: PrefabInstanceEntry, allocateId: () => number, loadPrefab?: SyncPrefabResolver): { entities: ProcessedEntity[]; rootId: number; }
```
-## expandInstance — function
+## expandInstance — function @experimental
```
(prefab: PrefabData, delta: PrefabInstanceDelta, allocateId: () => number, loadPrefab?: SyncPrefabResolver): { entities: ProcessedEntity[]; rootId: number; }
```
-## extractAnimClipTexturePaths — function
+## extractAnimClipTexturePaths — function @experimental
```
(data: AnimClipAssetData): string[]
```
-## extractPrefab — function
+## extractPrefab — function @experimental
```
(entities: readonly ExtractEntity[], rootId: number, name: string, makeId?: (sourceId: number) => PrefabEntityId): PrefabData
```
-## facingFromQuat — function
+## facingFromQuat — function @experimental
```
(z: number, w: number): number
```
-## fetchDecodePixels — function
+## fetchDecodePixels — function @experimental
```
(url: string): Promise<DecodedPixels>
```
-## findControllerOwner — function
+## findControllerOwner — function @experimental
```
(world: World, entity: Entity, name: string): Entity | null
```
-## findEntityByName — function
+## findEntityByName — function @experimental
```
(world: World, name: string): Entity | null
```
-## findPath — function
+## findPath — function @experimental
```
(grid: NavGrid, start: Cell, goal: Cell, opts?: PathfindOptions): Cell[] | null
```
-## fingerprint — function
+## fingerprint — function @experimental
```
(report: DiagnosticReport): string
```
-## finishDeviceRecovery — function
+## finishDeviceRecovery — function @experimental
```
(): void
```
-## flattenPrefab — function
+## flattenPrefab — function @experimental
```
(prefab: PrefabData, overrides: PrefabOverride[], ctx: FlattenContext): FlattenResult
```
-## flipFlagsH — function
+## flipFlagsH — function @experimental
```
(flags: TileFlags): TileFlags
```
-## flipFlagsV — function
+## flipFlagsV — function @experimental
```
(flags: TileFlags): TileFlags
```
-## flipStampH — function
+## flipStampH — function @experimental
```
(s: TileStamp): TileStamp
```
-## flipStampV — function
+## flipStampV — function @experimental
```
(s: TileStamp): TileStamp
```
-## flushPendingSystems — function
+## flushPendingSystems — function @experimental
```
(app: App): void
```
-## focusPlugin — const
+## focusPlugin — const @experimental
```
FocusPlugin
```
-## folderAlwaysInclude — function
+## folderAlwaysInclude — function @experimental
```
(config: AssetGroupsConfig | null | undefined, folder: string): boolean
```
-## folderGroupMode — function
+## folderGroupMode — function @experimental
```
(config: AssetGroupsConfig | null | undefined, folder: string): AssetGroupMode
```
-## formatActionArg — function
+## formatActionArg — function @experimental
```
(params: Readonly<Record<string, AiParamValue>> | undefined, defs: readonly AiParamDef[], separator?: string): string | undefined
```
-## formatCensusDiff — function
+## formatCensusDiff — function @experimental
```
(before: Census, after: Census, all?: boolean): string
```
-## formatCensusReport — function
+## formatCensusReport — function @experimental
```
(report: CensusReport): string
```
-## fsmEdges — function
+## fsmEdges — function @experimental
```
(def: FsmDefinition): FsmEdge[]
```
-## fsmPlugin — const
+## fsmPlugin — const @experimental
```
FsmPlugin
```
-## fxPreviewOrPlayMode — function
+## fxPreviewOrPlayMode — function @experimental
```
(): boolean
```
-## gearBinding — function
+## gearBinding — function @experimental
```
(controller: string, component: string, property: string, pages: Record<string, GearValue>, tween?: GearTween): GearBinding
```
-## getAddressableType — function
+## getAddressableType — function @experimental
```
(path: string): AddressableAssetType | null
```
-## getAddressableTypeByEditorType — function
+## getAddressableTypeByEditorType — function @experimental
```
(editorType: string): AddressableAssetType | null
```
-## getAllAssetExtensions — function
+## getAllAssetExtensions — function @experimental
```
(): Set<string>
```
-## getAllEffectDefs — function
+## getAllEffectDefs — function @experimental
```
(): EffectDef[]
```
-## getAssetBuildTransform — function
+## getAssetBuildTransform — function @experimental
```
(extensionOrPath: string): AssetBuildTransform | undefined
```
-## getAssetMimeType — function
+## getAssetMimeType — function @experimental
```
(ext: string): string | undefined
```
-## getAssetTypeEntry — function
+## getAssetTypeEntry — function @experimental
```
(extensionOrPath: string): AssetTypeEntry | undefined
```
-## getBt — function
+## getBt — function @experimental
```
(key: string): BtDefinition | undefined
```
-## getCacheForEntity — function
+## getCacheForEntity — function @experimental
```
(entityId: number): BitmapCache | undefined
```
-## getComponent — function
+## getComponent — function @experimental
```
(name: string): AnyComponentDef | undefined
```
-## getComponentAssetFieldDescriptors — function
+## getComponentAssetFieldDescriptors — function @experimental
```
(componentType: string): readonly { field: string; type: AssetFieldType; }[]
```
-## getComponentAssetFields — function
+## getComponentAssetFields — function @experimental
```
(componentType: string): string[]
```
-## getComponentDefaults — function
+## getComponentDefaults — function @experimental
```
(typeName: string): Record<string, unknown> | null
```
-## getComponentFieldMeta — function
+## getComponentFieldMeta — function @experimental
```
(name: string): Readonly<Record<string, FieldMeta>>
```
-## getComponentRegistry — function
+## getComponentRegistry — function @experimental
```
(): Map<string, AnyComponentDef>
```
-## getComponentSkeletalFieldDescriptor — function
+## getComponentSkeletalFieldDescriptor — function @experimental
```
(componentType: string): { skeletonField: string; atlasField: string; runtime: string; } | null
```
-## getContextLossGuardInfo — function
+## getContextLossGuardInfo — function @experimental
```
(): { target: string; lostEventsSeen: number; }
```
-## getControllerPage — function
+## getControllerPage — function @experimental
```
(world: World, entity: Entity, name: string): string | null
```
-## getCustomExtensions — function
+## getCustomExtensions — function @experimental
```
(): string[]
```
-## getDefaultContext — function
+## getDefaultContext — function @experimental
```
(): AppContext
```
-## getDeviceIdentity — function
+## getDeviceIdentity — function @experimental
```
(): DeviceIdentity | null
```
-## getDeviceLostReport — function
+## getDeviceLostReport — function @experimental
```
(): string
```
-## getDeviceStatus — function
+## getDeviceStatus — function @experimental
```
(): number
```
-## getEditorType — function
+## getEditorType — function @experimental
```
(path: string): EditorAssetType
```
-## getEffectDef — function
+## getEffectDef — function @experimental
```
(type: string): EffectDef | undefined
```
-## getEffectTypes — function
+## getEffectTypes — function @experimental
```
(): string[]
```
-## getFsm — function
+## getFsm — function @experimental
```
(key: string): CompiledFsm | undefined
```
-## getLogger — function
+## getLogger — function @experimental
```
(): Logger
```
-## getPlatform — function
+## getPlatform — function @experimental
```
(): PlatformAdapter
```
-## getPlatformType — function
+## getPlatformType — function @experimental
```
(): PlatformAdapter["name"] | null
```
-## getRegisteredAnimatorController — function
+## getRegisteredAnimatorController — function @experimental
```
(key: string): AnimatorControllerDef | undefined
```
-## getReplicatedFields — function
+## getReplicatedFields — function @experimental
```
(name: string): readonly string[]
```
-## getResourceManager — function
+## getResourceManager — function @experimental
```
(): CppResourceManager | null
```
-## getResourceStats — function
+## getResourceStats — function @experimental
```
(): ResourceStats | null
```
-## getTextureDimensions — function
+## getTextureDimensions — function @experimental
```
(handle: number): TextureDimensions | null
```
-## getTheme — function
+## getTheme — function @experimental
```
(): ThemeTokens
```
-## getTilemapSource — function
+## getTilemapSource — function @experimental
```
(path: string): LoadedTilemapSource | undefined
```
-## getUserComponent — function
+## getUserComponent — function @experimental
```
(name: string): ComponentDef<any> | undefined
```
-## getUserComponentFingerprint — function
+## getUserComponentFingerprint — function @experimental
```
(): string
```
-## getUserComponents — function
+## getUserComponents — function @experimental
```
(): Map<string, AnyComponentDef>
```
-## getWeChatPackOptions — function
+## getWeChatPackOptions — function @experimental
```
(): Array<{ type: string; value: string; }>
```
-## hasPlayableCta — function
+## hasPlayableCta — function @experimental
```
(): boolean
```
-## hasVisibility — function
+## hasVisibility — function @experimental
```
(world: World, entity: Entity): boolean
```
-## headlessBasePlugins — const
+## headlessBasePlugins — const @experimental
```
() => Plugin[]
```
-## imageBitmapOptions — function
+## imageBitmapOptions — function @experimental
```
(flip: boolean): ImageBitmapOptions
```
-## indexPackagedManifest — function
+## indexPackagedManifest — function @experimental
```
(manifest: AddressableManifest): PackagedAssetIndex
```
-## info — function
+## info — function @experimental
```
(category: string, message: string, data?: unknown): void
```
-## initMiniGameRuntime — function
+## initMiniGameRuntime — function @experimental
```
(config: MiniGameRuntimeConfig): Promise<void>
```
-## initPlayRealmRuntime — function
+## initPlayRealmRuntime — function @experimental
```
(config: PlayRealmRuntimeConfig): Promise<void>
```
-## initPlayableRuntime — function
+## initPlayableRuntime — function @experimental
```
(config: PlayableRuntimeConfig): Promise<void>
```
-## initRuntime — function
+## initRuntime — function @experimental
```
(config: RuntimeInitConfig): Promise<void>
```
-## inputEventCallbacks — function
+## inputEventCallbacks — function @experimental
```
(state: InputState): InputEventCallbacks
```
-## inputPlugin — const
+## inputPlugin — const @experimental
```
InputPlugin
```
-## inputRouter — const
+## inputRouter — const @experimental
```
InputRouter
```
-## installEditorGrid — function
+## installEditorGrid — function @experimental
```
(app: App): void
```
-## installMiniGamePlatform — function
+## installMiniGamePlatform — function @experimental
```
(profile: MiniGameProfile, adapter?: MiniGamePlatformAdapter): MiniGamePlatformAdapter
```
-## instantiatePrefab — function
+## instantiatePrefab — function @experimental
```
(world: World, prefab: PrefabData, options?: InstantiatePrefabOptions): Promise<InstantiatePrefabResult>
```
-## interactionController — function
+## interactionController — function @experimental
```
(pages?: string[]): ControllerState
```
-## interpolate — function
+## interpolate — function @experimental
```
(template: string, params?: TParams): string
```
-## intersectRects — function
+## intersectRects — function @experimental
```
(a: ScreenRect, b: ScreenRect): ScreenRect
```
-## invertMatrix4 — function
+## invertMatrix4 — function @experimental
```
(m: Float32Array, result?: Float32Array): Float32Array
```
-## invokeAction — function
+## invokeAction — function @experimental
```
<Ctx>(registry: AiRegistry<Ctx>, name: string, ctx: Ctx, bb: Blackboard, input?: AiActionInput): void | Status
```
-## isAuto — const
+## isAuto — const @experimental
```
(d: Dimension) => boolean
```
-## isBuiltinComponent — function
+## isBuiltinComponent — function @experimental
```
(comp: AnyComponentDef): comp is BuiltinComponentDef<any>
```
-## isCollisionPaletteRef — function
+## isCollisionPaletteRef — function @experimental
```
(refs: readonly string[]): boolean
```
-## isCustomExtension — function
+## isCustomExtension — function @experimental
```
(path: string): boolean
```
-## isDialogOpen — function
+## isDialogOpen — function @experimental
```
(world: World, root: Entity): boolean
```
-## isDropdownOpen — function
+## isDropdownOpen — function @experimental
```
(world: World, e: Entity): boolean
```
-## isEditor — function
+## isEditor — function @experimental
```
(): boolean
```
-## isEmptyStamp — function
+## isEmptyStamp — function @experimental
```
(s: TileStamp): boolean
```
-## isEntityActive — function
+## isEntityActive — function @experimental
```
(world: World, entity: Entity): boolean
```
-## isEntityVisible — function
+## isEntityVisible — function @experimental
```
(world: World, entity: Entity): boolean
```
-## isFxEditPreview — function
+## isFxEditPreview — function @experimental
```
(): boolean
```
-## isHexOrientation — function
+## isHexOrientation — function @experimental
```
(orientation: number): boolean
```
-## isKnownAssetExtension — function
+## isKnownAssetExtension — function @experimental
```
(ext: string): boolean
```
-## isNative — function
+## isNative — function @experimental
```
(): boolean
```
-## isNonOrthogonal — function
+## isNonOrthogonal — function @experimental
```
(orientation: number): boolean
```
-## isPlatformInitialized — function
+## isPlatformInitialized — function @experimental
```
(): boolean
```
-## isPlayMode — function
+## isPlayMode — function @experimental
```
(): boolean
```
-## isRuntime — function
+## isRuntime — function @experimental
```
(): boolean
```
-## isTextureRef — function
+## isTextureRef — function @experimental
```
(v: UniformValue): v is TextureRef
```
-## isWeChat — function
+## isWeChat — function @experimental
```
(): boolean
```
-## isWeb — function
+## isWeb — function @experimental
```
(): boolean
```
-## layerFrontness — function
+## layerFrontness — function @experimental
```
(order: LayerOrder, worldY: number, worldZ: number): number
```
-## layerOrderOf — function
+## layerOrderOf — function @experimental
```
(layer: number, ySortMask: number, depthMask: number): LayerOrder
```
-## leafStateOf — function
+## leafStateOf — function @experimental
```
(def: AnimatorControllerDef, path: string): AnimatorState | null
```
-## lifecyclePlugin — const
+## lifecyclePlugin — const @experimental
```
LifecyclePlugin
```
-## loadComponent — function
+## loadComponent — function @experimental
```
(world: World, entity: Entity, compData: SceneComponentData, entityName?: string): void
```
-## loadInputMapAsset — function
+## loadInputMapAsset — function @experimental
```
(asset: InputMapAsset): InputMap
```
-## loadPackagedAssetIndex — function
+## loadPackagedAssetIndex — function @experimental
```
(manifestPath?: string): Promise<PackagedAssetIndex>
```
-## loadPhysicsModule — function
+## loadPhysicsModule — function @experimental
```
(wasmUrl: string, factory?: PhysicsModuleFactory): Promise<PhysicsWasmModule>
```
-## loadRuntimeScene — function
+## loadRuntimeScene — function @experimental
```
(options: LoadRuntimeSceneOptions): Promise<void>
```
-## loadSceneData — function
+## loadSceneData — function @experimental
```
(world: World, sceneData: SceneData): Map<number, Entity>
```
-## loadSceneWithAssets — function
+## loadSceneWithAssets — function @experimental
```
(world: World, sceneData: SceneData, options?: SceneLoadOptions): Promise<Map<number, Entity>>
```
-## loadTiledMap — function
+## loadTiledMap — function @experimental
```
(world: World, mapData: TiledMapData, textureHandles: Map<string, number>, options?: TilemapLoadOptions): Entity[]
```
-## localizationPlugin — const
+## localizationPlugin — const @experimental
```
LocalizationPlugin
```
-## log — const
+## log — const @experimental
```
Logger
```
-## looksLikeAssetPath — function
+## looksLikeAssetPath — function @experimental
```
(value: unknown): value is string
```
-## makeLosCheck — function
+## makeLosCheck — function @experimental
```
(physics: PhysicsAPI): LosCheck
```
-## makeWidgetInteractable — function
+## makeWidgetInteractable — function @experimental
```
(world: World, entity: Entity, init?: WidgetInteractionInit): void
```
-## markThemed — function
+## markThemed — function @experimental
```
(world: World, entity: Entity, style: ThemeStyleData): void
```
-## matchLocale — function
+## matchLocale — function @experimental
```
(tag: string, available: readonly string[]): string | null
```
-## maxChildren — function
+## maxChildren — function @experimental
```
(type: BtNodeType): number
```
-## measureText — function
+## measureText — function @experimental
```
(text: string, opts: MeasureTextOptions): TextMetrics
```
-## mesh2dPlugin — const
+## mesh2dPlugin — const @experimental
```
Mesh2DPlugin
```
-## messageOf — function
+## messageOf — function @experimental
```
(error: unknown): string
```
-## migratePrefabData — function
+## migratePrefabData — function @experimental
```
(raw: unknown): MigrationResult
```
-## migrateSaveData — function
+## migrateSaveData — function @experimental
```
(version: number, data: unknown, currentVersion: number, migrations: Record<number, SaveMigration>): unknown
```
-## migrateSceneData — function
+## migrateSceneData — function @experimental
```
(raw: SceneData): SceneMigrationResult
```
-## modeToDelivery — function
+## modeToDelivery — function @experimental
```
(mode: AssetGroupMode): BundleMode
```
-## moveAnimatorState — function
+## moveAnimatorState — function @experimental
```
(def: AnimatorControllerDef, name: string, x: number, y: number): AnimatorControllerDef
```
-## moveBtNode — function
+## moveBtNode — function @experimental
```
(def: BtDefinition, id: string, x: number, y: number): BtDefinition
```
@@ -10539,22 +10539,22 @@ Mesh2DPlugin
(g: MaterialGraph, id: string, x: number, y: number): MaterialGraph
```
-## moveState — function
+## moveState — function @experimental
```
(def: FsmDefinition, name: string, x: number, y: number): FsmDefinition
```
-## navGridFromTilemapLayer — function
+## navGridFromTilemapLayer — function @experimental
```
(entity: Entity, opts: BuildNavGridOptions): NavGrid
```
-## navGridFromTiles — function
+## navGridFromTiles — function @experimental
```
(getTile: (x: number, y: number) => number, opts: BuildNavGridOptions): NavGrid
```
-## navPlugin — const
+## navPlugin — const @experimental
```
NavPlugin
```
@@ -10564,382 +10564,382 @@ NavPlugin
(): MaterialGraph
```
-## normalizeAngle — function
+## normalizeAngle — function @experimental
```
(a: number): number
```
-## normalizeBundleMode — function
+## normalizeBundleMode — function @experimental
```
(mode: string | undefined | null): BundleMode
```
-## normalizeCornerMask — function
+## normalizeCornerMask — function @experimental
```
(mask: number): number
```
-## openDialog — function
+## openDialog — function @experimental
```
(world: World, events: UIEventQueue, root: Entity): void
```
-## openDropdown — function
+## openDropdown — function @experimental
```
(world: World, events: UIEventQueue, e: Entity): void
```
-## orientationPerm — function
+## orientationPerm — function @experimental
```
(flags: TileFlags): Perm
```
-## packCorners — function
+## packCorners — function @experimental
```
(tl: number, tr: number, br: number, bl: number): number
```
-## packagedAppOptions — function
+## packagedAppOptions — function @experimental
```
(config: Pick<PackagedGameConfig, "ySortLayers" | "depthLayers" | "colorSpace" | "screenFit">): { ySortLayers?: number; depthLayers?: number; colorSpace?: "gamma" | "linear"; screenFit?: PackagedGameConfig["screenFit"]; }
```
-## packagedRuntimeInit — function
+## packagedRuntimeInit — function @experimental
```
(config: Pick<PackagedGameConfig, "physicsEnabled" | "physicsConfig" | "audioConfig" | "uiTheme" | "uiThemeColors" | "achievements" | "steamAppId" | "screenFit">): { physicsEnabled?: boolean; physicsConfig?: PhysicsPluginConfig; audioConfig?: AudioProjectConfig; uiTheme?: "light"; uiThemeOverrides?: ThemeOverrides; achievements?: string[]; steamAppId?: number; screenFit?: PackagedGameConfig["screenFit"]; }
```
-## paramDefaultValue — function
+## paramDefaultValue — function @experimental
```
(param: ShaderParam): unknown
```
-## parseActionArg — function
+## parseActionArg — function @experimental
```
(arg: string | undefined, params: readonly AiParamDef[], separator?: string): Record<string, AiParamValue>
```
-## parseAnimClipAsset — function
+## parseAnimClipAsset — function @experimental
```
(rawJson: unknown): AnimClipAssetData
```
-## parseAnimClipData — function
+## parseAnimClipData — function @experimental
```
(clipPath: string, data: AnimClipAssetData, textureHandles: Map<string, number>): SpriteAnimClip
```
-## parseAnimationClip — function
+## parseAnimationClip — function @experimental
```
(rawJson: unknown): TimelineAsset
```
-## parseAudioProjectConfig — function
+## parseAudioProjectConfig — function @experimental
```
(raw: unknown): AudioProjectConfig
```
-## parseBusEffects — function
+## parseBusEffects — function @experimental
```
(raw: unknown): BusEffectDef[]
```
-## parseCollisionMaterial — function
+## parseCollisionMaterial — function @experimental
```
(refs: readonly string[]): CollisionMaterial
```
-## parseLocaleTable — function
+## parseLocaleTable — function @experimental
```
(text: string, path: string): LocaleTableAsset
```
-## parseRichText — function
+## parseRichText — function @experimental
```
(input: string): RichTextRun[]
```
-## parseThemeOverrides — function
+## parseThemeOverrides — function @experimental
```
(colors?: Record<string, string>): ThemeOverrides | undefined
```
-## parseTileset — function
+## parseTileset — function @experimental
```
(rawJson: unknown): TilesetAsset
```
-## parseTimelineAsset — function
+## parseTimelineAsset — function @experimental
```
(rawJson: unknown): TimelineAsset
```
-## parseTmjJson — function
+## parseTmjJson — function @experimental
```
(json: Record<string, unknown>): TiledMapData | null
```
-## parseTmjWithExternals — function
+## parseTmjWithExternals — function @experimental
```
(json: Record<string, unknown>, resolveExternal: (source: string) => Promise<string>): Promise<TiledMapData | null>
```
-## particlePlugin — const
+## particlePlugin — const @experimental
```
ParticlePlugin
```
-## pathToWorld — function
+## pathToWorld — function @experimental
```
(grid: NavGrid, path: Cell[]): Vec2[]
```
-## percent — const
+## percent — const @experimental
```
(n: number) => Dimension
```
-## perceptionPlugin — const
+## perceptionPlugin — const @experimental
```
PerceptionPlugin
```
-## platformFetch — function
+## platformFetch — function @experimental
```
(url: string, options?: PlatformRequestOptions): Promise<PlatformResponse>
```
-## platformFileExists — function
+## platformFileExists — function @experimental
```
(path: string): Promise<boolean>
```
-## platformInstantiateWasm — function
+## platformInstantiateWasm — function @experimental
```
(pathOrBuffer: string | ArrayBuffer, imports: WebAssembly.Imports): Promise<WasmInstantiateResult>
```
-## platformReadFile — function
+## platformReadFile — function @experimental
```
(path: string): Promise<ArrayBuffer>
```
-## platformReadTextFile — function
+## platformReadTextFile — function @experimental
```
(path: string): Promise<string>
```
-## playModeOnly — function
+## playModeOnly — function @experimental
```
(): boolean
```
-## playableCta — function
+## playableCta — function @experimental
```
(): void
```
-## pointInHitArea — function
+## pointInHitArea — function @experimental
```
(px: number, py: number, area: HitAreaShape): boolean
```
-## pointInOBB — function
+## pointInOBB — function @experimental
```
(px: number, py: number, worldX: number, worldY: number, worldW: number, worldH: number, pivotX: number, pivotY: number, rotationZ: number, rotationW: number): boolean
```
-## pointInWorldRect — function
+## pointInWorldRect — function @experimental
```
(px: number, py: number, worldX: number, worldY: number, worldW: number, worldH: number, pivotX: number, pivotY: number): boolean
```
-## postProcessPlugin — const
+## postProcessPlugin — const @experimental
```
PostProcessPlugin
```
-## prefabsPlugin — const
+## prefabsPlugin — const @experimental
```
PrefabsPlugin
```
-## preloadNestedPrefabs — function
+## preloadNestedPrefabs — function @experimental
```
(prefab: PrefabData, loadPrefab: (path: string) => Promise<PrefabData>, cache: Map<string, PrefabData>, visited?: Set<string>, depth?: number): Promise<void>
```
-## previewPlugin — function
+## previewPlugin — function @experimental
```
(sceneUrl: string, baseUrl?: string): PreviewPlugin
```
-## probeRegistrations — function
+## probeRegistrations — function @experimental
```
(register: () => Promise<void>): Promise<ProbedRegistrations>
```
-## projectSideModuleIds — function
+## projectSideModuleIds — function @experimental
```
(): string[]
```
-## px — const
+## px — const @experimental
```
(n: number) => Dimension
```
-## quat — const
+## quat — const @experimental
```
(w?: number, x?: number, y?: number, z?: number) => Quat
```
-## quaternionToAngle2D — function
+## quaternionToAngle2D — function @experimental
```
(rz: number, rw: number): number
```
-## radiusInterest — function
+## radiusInterest — function @experimental
```
(radius: number, options?: RadiusInterestOptions): InterestPolicy
```
-## readColliderShapes — function
+## readColliderShapes — function @experimental
```
(world: World, entity: number): ColliderInstance[]
```
-## readFieldPath — function
+## readFieldPath — function @experimental
```
(data: Record<string, unknown>, path: string): unknown
```
-## readPtrField — function
+## readPtrField — function @experimental
```
(f32: Float32Array, u32: Uint32Array, u8: Uint8Array, ptr: number, field: PtrFieldDesc): unknown
```
-## rebuildChildren — function
+## rebuildChildren — function @experimental
```
(entities: ProcessedEntity[]): void
```
-## recoverDevice — function
+## recoverDevice — function @experimental
```
(): boolean
```
-## reflectEsshader — function
+## reflectEsshader — function @experimental
```
(source: string): ShaderReflection
```
-## registerAction — function
+## registerAction — function @experimental
```
(name: string, fn: AiAction<AiContext>): void
```
-## registerAnimatorController — function
+## registerAnimatorController — function @experimental
```
(key: string, def: AnimatorControllerDef): void
```
-## registerAssetBuildTransform — function
+## registerAssetBuildTransform — function @experimental
```
(editorType: EditorAssetType, transform: AssetBuildTransform): void
```
-## registerBt — function
+## registerBt — function @experimental
```
(key: string, def: BtDefinition): BtDefinition
```
-## registerCensusProbe — function
+## registerCensusProbe — function @experimental
```
(probe: CensusProbe): () => void
```
-## registerComponent — function
+## registerComponent — function @experimental
```
(name: string, def: AnyComponentDef): void
```
-## registerCondition — function
+## registerCondition — function @experimental
```
(name: string, fn: AiCondition<AiContext>): void
```
-## registerDrawCallback — function
+## registerDrawCallback — function @experimental
```
(id: string, fn: DrawCallback, scene?: string): void
```
-## registerFsm — function
+## registerFsm — function @experimental
```
(key: string, def: FsmDefinition): CompiledFsm
```
-## registerPackagedSideModules — function
+## registerPackagedSideModules — function @experimental
```
(config: Pick<PackagedGameConfig, "sideModules">): void
```
-## registerPreSceneDrawCallback — function
+## registerPreSceneDrawCallback — function @experimental
```
(id: string, fn: PreSceneDrawCallback): void
```
-## registerSceneComponentCodec — function
+## registerSceneComponentCodec — function @experimental
```
(type: string, codec: SceneComponentCodec): void
```
-## registerSideModule — function
+## registerSideModule — function @experimental
```
(id: string, descriptor: SideModuleDescriptor): void
```
-## registerTilemapSource — function
+## registerTilemapSource — function @experimental
```
(path: string, data: LoadedTilemapSource): void
```
-## registerTimelineAsset — function
+## registerTimelineAsset — function @experimental
```
(path: string, asset: TimelineAsset): void
```
-## remapComponentEntityRefs — function
+## remapComponentEntityRefs — function @experimental
```
(components: ComponentData[], idMapping: Map<PrefabEntityId, number>): void
```
-## remapEntityFields — function
+## remapEntityFields — function @experimental
```
(compData: SceneComponentData, entityMap: Map<number, Entity>): void
```
-## removeAnimatorParam — function
+## removeAnimatorParam — function @experimental
```
(def: AnimatorControllerDef, name: string): AnimatorControllerDef
```
-## removeAnimatorState — function
+## removeAnimatorState — function @experimental
```
(def: AnimatorControllerDef, name: string): AnimatorControllerDef
```
-## removeAnimatorTransition — function
+## removeAnimatorTransition — function @experimental
```
(def: AnimatorControllerDef, from: string, index: number): AnimatorControllerDef
```
-## removeBtNode — function
+## removeBtNode — function @experimental
```
(def: BtDefinition, id: string): BtDefinition
```
-## removeCacheForEntity — function
+## removeCacheForEntity — function @experimental
```
(entityId: number): BitmapCache | undefined
```
@@ -10949,107 +10949,107 @@ PrefabsPlugin
(g: MaterialGraph, id: string): MaterialGraph
```
-## removeState — function
+## removeState — function @experimental
```
(def: FsmDefinition, name: string): FsmDefinition
```
-## removeTransition — function
+## removeTransition — function @experimental
```
(def: FsmDefinition, from: string, index: number): FsmDefinition
```
-## renameAnimatorState — function
+## renameAnimatorState — function @experimental
```
(def: AnimatorControllerDef, oldName: string, newName: string): AnimatorControllerDef
```
-## renameState — function
+## renameState — function @experimental
```
(def: FsmDefinition, oldName: string, newName: string): FsmDefinition
```
-## reparentBtNode — function
+## reparentBtNode — function @experimental
```
(def: BtDefinition, id: string, newParentId: string): BtDefinition
```
-## replicationPlugin — const
+## replicationPlugin — const @experimental
```
ReplicationPlugin
```
-## reportDeviceLost — function
+## reportDeviceLost — function @experimental
```
(reason: number, message: string): void
```
-## requireResourceManager — function
+## requireResourceManager — function @experimental
```
(): CppResourceManager
```
-## resetWorldTo — function
+## resetWorldTo — function @experimental
```
(world: World, sceneData: SceneData): Map<number, Entity>
```
-## resolveAssetGroup — function
+## resolveAssetGroup — function @experimental
```
(projectRelPath: string, config: AssetGroupsConfig | null | undefined): ResolvedAssetGroup
```
-## resolveAtlas — function
+## resolveAtlas — function @experimental
```
(projectRelPath: string, config: AssetGroupsConfig | null | undefined): ResolvedAtlas | null
```
-## resolveAutotile — function
+## resolveAutotile — function @experimental
```
(index: TerrainIndex, neighbors: readonly boolean[]): number
```
-## resolveBindingTarget — function
+## resolveBindingTarget — function @experimental
```
(world: World, from: Entity, name: string): Entity | null
```
-## resolveChildEntity — function
+## resolveChildEntity — function @experimental
```
(world: Pick<World, "tryGet">, rootEntity: Entity, childPath: string): Entity | null
```
-## resolveParams — function
+## resolveParams — function @experimental
```
(def: AnimatorControllerDef, overrides: ReadonlyMap<string, number | boolean>): Record<string, number | boolean>
```
-## resolveRelativePath — function
+## resolveRelativePath — function @experimental
```
(basePath: string, relativePath: string): string
```
-## resolveThemeTokens — function
+## resolveThemeTokens — function @experimental
```
(base: "dark" | "light", overrides?: ThemeOverrides): ThemeTokens
```
-## resolveTilesetModel — function
+## resolveTilesetModel — function @experimental
```
(tilesets: ResolvedTileset[]): TilesetModel
```
-## resolveWang — function
+## resolveWang — function @experimental
```
(index: WangIndex, corners: readonly number[]): number
```
-## rotateFlagsCW — function
+## rotateFlagsCW — function @experimental
```
(flags: TileFlags): TileFlags
```
-## rotateStampCW — function
+## rotateStampCW — function @experimental
```
(s: TileStamp): TileStamp
```
@@ -11059,617 +11059,617 @@ ReplicationPlugin
(app: App, options?: { fps?: number; }): () => void
```
-## safeAreaPlugin — const
+## safeAreaPlugin — const @experimental
```
SafeAreaPlugin
```
-## sampleTimeline — function
+## sampleTimeline — function @experimental
```
(asset: TimelineAsset, time: number, rootEntity: Entity, deps: SampleDeps, opts?: SampleOptions): void
```
-## sampleTimelineInWorld — function
+## sampleTimelineInWorld — function @experimental
```
(asset: TimelineAsset, time: number, world: SampleWorld & Pick<World, "tryGet">, rootEntity: Entity, opts?: SampleOptions): void
```
-## scalar — const
+## scalar — const @experimental
```
{ readonly clamp: (x: number, min: number, max: number) => number; readonly clamp01: (x: number) => number; readonly lerp: (a: number, b: number, t: number) => number; readonly inverseLerp: (a: number, b: number, value: number) => number; readonly remap: (value: number, inMin: number, inMax: number, outMin: number, outMax: number) => number; readonly deg2rad: (deg: number) => number; readonly rad2deg: (rad: number) => number; readonly approximately: (a: number, b: number, epsilon?: number) => boolean; readonly smoothstep: (edge0: number, edge1: number, x: number) => number; readonly mod: (x: number, n: number) => number; readonly sign: (x: number) => number; }
```
-## sceneManagerPlugin — const
+## sceneManagerPlugin — const @experimental
```
Plugin
```
-## sceneUsesI18n — function
+## sceneUsesI18n — function @experimental
```
(sceneData: SceneData): boolean
```
-## screenToUiWorld — function
+## screenToUiWorld — function @experimental
```
(camera: UICameraData, screenGLX: number, screenGLY: number): { x: number; y: number; }
```
-## screenToWorld — function
+## screenToWorld — function @experimental
```
(screenX: number, screenY: number, inverseVP: Float32Array, vpX: number, vpY: number, vpW: number, vpH: number, planeZ?: number): { x: number; y: number; }
```
-## selectBlendClip — function
+## selectBlendClip — function @experimental
```
(blend: AnimatorBlend1D, value: number): AnimatorBlendThreshold
```
-## selectPluralForm — function
+## selectPluralForm — function @experimental
```
(forms: PluralForms, count: number, selector: PluralSelector): string
```
-## senseTarget — function
+## senseTarget — function @experimental
```
(ox: number, oy: number, facing: number, tx: number, ty: number, range: number, halfFov: number, isBlocked?: (ox: number, oy: number, tx: number, ty: number) => boolean): SenseResult
```
-## serializeAnimClip — function
+## serializeAnimClip — function @experimental
```
(asset: AnimClipAssetData): Record<string, unknown>
```
-## serializeScene — function
+## serializeScene — function @experimental
```
(world: World, sceneName?: string): SceneData
```
-## serializeTileset — function
+## serializeTileset — function @experimental
```
(asset: TilesetAsset): Record<string, unknown>
```
-## serializeTimelineAsset — function
+## serializeTimelineAsset — function @experimental
```
(asset: TimelineAsset): Record<string, unknown>
```
-## serializeTimelineToJson — function
+## serializeTimelineToJson — function @experimental
```
(asset: TimelineAsset, indent?: number): string
```
-## servicesPlugin — const
+## servicesPlugin — const @experimental
```
ServicesPlugin
```
-## setAnimatorConditions — function
+## setAnimatorConditions — function @experimental
```
(def: AnimatorControllerDef, from: string, index: number, conditions: AnimatorCondition[]): AnimatorControllerDef
```
-## setAnimatorInitial — function
+## setAnimatorInitial — function @experimental
```
(def: AnimatorControllerDef, name: string): AnimatorControllerDef
```
-## setAnimatorStateClip — function
+## setAnimatorStateClip — function @experimental
```
(def: AnimatorControllerDef, name: string, clip: string): AnimatorControllerDef
```
-## setAnimatorStateProps — function
+## setAnimatorStateProps — function @experimental
```
(def: AnimatorControllerDef, name: string, patch: { speed?: number; loop?: boolean; }): AnimatorControllerDef
```
-## setBtNodeField — function
+## setBtNodeField — function @experimental
```
(def: BtDefinition, id: string, patch: Partial<BtNode>): BtDefinition
```
-## setButtonState — function
+## setButtonState — function @experimental
```
(world: World, entity: Entity, state: string): void
```
-## setCacheForEntity — function
+## setCacheForEntity — function @experimental
```
(entityId: number, cache: BitmapCache): void
```
-## setControllerPage — function
+## setControllerPage — function @experimental
```
(world: World, entity: Entity, name: string, page: string): boolean
```
-## setDefaultContext — function
+## setDefaultContext — function @experimental
```
(ctx: AppContext): void
```
-## setEditorMode — function
+## setEditorMode — function @experimental
```
(active: boolean): void
```
-## setEditorViewHalfHeight — function
+## setEditorViewHalfHeight — function @experimental
```
(view: EditorViewData, halfH: number): void
```
-## setEntityActive — function
+## setEntityActive — function @experimental
```
(world: World, entity: Entity, active: boolean): void
```
-## setEntityVisible — function
+## setEntityVisible — function @experimental
```
(world: World, entity: Entity, visible: boolean): void
```
-## setFxEditPreview — function
+## setFxEditPreview — function @experimental
```
(enabled: boolean): void
```
-## setInitial — function
+## setInitial — function @experimental
```
(def: FsmDefinition, name: string): FsmDefinition
```
-## setLogLevel — function
+## setLogLevel — function @experimental
```
(level: LogLevel): void
```
-## setNavDestination — function
+## setNavDestination — function @experimental
```
(world: World, entity: Entity, target: Vec2): void
```
-## setPlayMode — function
+## setPlayMode — function @experimental
```
(active: boolean): void
```
-## setStateHook — function
+## setStateHook — function @experimental
```
(def: FsmDefinition, name: string, hook: "onEnter" | "onUpdate" | "onExit", action: string, arg?: string, params?: Record<string, AiParamValue>): FsmDefinition
```
-## setTextureBudget — function
+## setTextureBudget — function @experimental
```
(bytes: number): void
```
-## setTextureFilter — function
+## setTextureFilter — function @experimental
```
(textureId: number, filter: TextureFilter): void
```
-## setTextureParams — function
+## setTextureParams — function @experimental
```
(textureId: number, minFilter: TextureFilter, magFilter: TextureFilter, wrapS: TextureWrap, wrapT: TextureWrap): void
```
-## setTextureSliceBorder — function
+## setTextureSliceBorder — function @experimental
```
(textureId: number, left: number, right: number, top: number, bottom: number): void
```
-## setTextureWrap — function
+## setTextureWrap — function @experimental
```
(textureId: number, wrap: TextureWrap): void
```
-## setTheme — function
+## setTheme — function @experimental
```
(tokens: ThemeTokens): void
```
-## setUIVisible — function
+## setUIVisible — function @experimental
```
(world: World, entity: Entity, visible: boolean): void
```
-## setViewTarget — function
+## setViewTarget — function @experimental
```
(host: CameraDirectorHost, entity: number, opts?: { time?: number; curve?: number; }): void
```
-## setWasmErrorHandler — function
+## setWasmErrorHandler — function @experimental
```
(handler: WasmErrorHandler | null): void
```
-## shakeCamera — function
+## shakeCamera — function @experimental
```
(host: CameraDirectorHost, opts?: { amplitude?: number; rotation?: number; frequency?: number; duration?: number; }): void
```
-## shapeCenter — function
+## shapeCenter — function @experimental
```
(shape: ColliderShape, worldPos: Vec2, angle: number, ppu: number): Vec2
```
-## shapeOffset — function
+## shapeOffset — function @experimental
```
(shape: ColliderShape): Vec2
```
-## shutdownDrawAPI — function
+## shutdownDrawAPI — function @experimental
```
(): void
```
-## shutdownGLDebugAPI — function
+## shutdownGLDebugAPI — function @experimental
```
(): void
```
-## shutdownGeometryAPI — function
+## shutdownGeometryAPI — function @experimental
```
(): void
```
-## shutdownMaterialAPI — function
+## shutdownMaterialAPI — function @experimental
```
(): void
```
-## shutdownRendererAPI — function
+## shutdownRendererAPI — function @experimental
```
(): void
```
-## shutdownResourceManager — function
+## shutdownResourceManager — function @experimental
```
(): void
```
-## sideModuleDescriptor — function
+## sideModuleDescriptor — function @experimental
```
(id: SideModuleId): SideModuleDescriptor | undefined
```
-## signal — function
+## signal — function @experimental
```
<T>(initial: T): Signal<T>
```
-## singleStamp — function
+## singleStamp — function @experimental
```
(raw: number): TileStamp
```
-## spawnUIEntity — function
+## spawnUIEntity — function @experimental
```
(init: UIEntityInit): Entity
```
-## spineModuleId — function
+## spineModuleId — function @experimental
```
(version: SpineVersion): SideModuleId
```
-## stackOf — function
+## stackOf — function @experimental
```
(error: unknown): string | undefined
```
-## statsPlugin — const
+## statsPlugin — const @experimental
```
StatsPlugin
```
-## stepFsm — function
+## stepFsm — function @experimental
```
<Ctx>(fsm: CompiledFsm, run: FsmRunState, ctx: Ctx, bb: Blackboard, registry: AiRegistry<Ctx>): boolean
```
-## stepPerception — function
+## stepPerception — function @experimental
```
(world: PerceptionWorldView, isBlocked?: LosCheck): void
```
-## stopNavAgent — function
+## stopNavAgent — function @experimental
```
(world: World, entity: Entity): void
```
-## switchTheme — function
+## switchTheme — function @experimental
```
(world: World, tokens: ThemeTokens): void
```
-## takeCensus — function
+## takeCensus — function @experimental
```
(ctx?: CensusContext): Census
```
-## textInputPlugin — const
+## textInputPlugin — const @experimental
```
TextInputPlugin
```
-## textPlugin — const
+## textPlugin — const @experimental
```
TextPlugin
```
-## textureImportSettingsFrom — function
+## textureImportSettingsFrom — function @experimental
```
(importer: Record<string, unknown> | undefined | null): ParsedTextureImportSettings | undefined
```
-## themeButtonStates — function
+## themeButtonStates — function @experimental
```
(): Record<string, ButtonStateVisual>
```
-## themeColors — function
+## themeColors — function @experimental
```
(): ThemeColors
```
-## themeType — function
+## themeType — function @experimental
```
(): ThemeType
```
-## tickBt — function
+## tickBt — function @experimental
```
<Ctx>(def: BtDefinition, ctx: Ctx, bb: Blackboard, registry: AiRegistry<Ctx>, rs: BtRunState, dt: number): Status
```
-## tileCellCenter — function
+## tileCellCenter — function @experimental
```
(p: TileGridParams, tx: number, ty: number): Vec2Like
```
-## tileCellOutline — function
+## tileCellOutline — function @experimental
```
(p: TileGridParams): Vec2Like[]
```
-## tileCollisionOutlines — function
+## tileCollisionOutlines — function @experimental
```
(chunks: DecodedChunk[], model: TilesetModel, tileW: number, tileH: number, originX: number, originY: number): TileCollisionPiece[]
```
-## tileFlagsOf — function
+## tileFlagsOf — function @experimental
```
(raw: number): TileFlags
```
-## tileIdOf — function
+## tileIdOf — function @experimental
```
(raw: number): number
```
-## tilemapPlugin — const
+## tilemapPlugin — const @experimental
```
TilemapPlugin
```
-## timelinePlugin — const
+## timelinePlugin — const @experimental
```
TimelinePlugin
```
-## timerPlugin — const
+## timerPlugin — const @experimental
```
Plugin
```
-## toBuildPath — function
+## toBuildPath — function @experimental
```
(path: string): string
```
-## trailPlugin — const
+## trailPlugin — const @experimental
```
TrailPlugin
```
-## transitionTo — function
+## transitionTo — function @experimental
```
(host: App | SceneManagerState, targetScene: string, config: TransitionConfig): Promise<void>
```
-## trimTextureCache — function
+## trimTextureCache — function @experimental
```
(): number
```
-## uiHitTestWorld — function
+## uiHitTestWorld — function @experimental
```
(engine: EngineApi | null, registry: CppRegistry, worldX: number, worldY: number, mouseDown?: boolean, mousePressed?: boolean, mouseReleased?: boolean): Entity | null
```
-## uiInteractionPlugin — const
+## uiInteractionPlugin — const @experimental
```
UIInteractionPlugin
```
-## uiLayoutPlugin — const
+## uiLayoutPlugin — const @experimental
```
UILayoutPlugin
```
-## uiLayoutRect — function
+## uiLayoutRect — function @experimental
```
(cam: CameraExtents, fit: CanvasScale | null, width: number, height: number, previewAspect?: number): WorldRect
```
-## uiMaskPlugin — const
+## uiMaskPlugin — const @experimental
```
UIMaskPlugin
```
-## uiPickAllWorld — function
+## uiPickAllWorld — function @experimental
```
(engine: EngineApi | null, registry: CppRegistry, worldX: number, worldY: number): Entity[]
```
-## uiPickWorld — function
+## uiPickWorld — function @experimental
```
(engine: EngineApi | null, registry: CppRegistry, worldX: number, worldY: number): Entity | null
```
-## uiPlugin — const
+## uiPlugin — const @experimental
```
UIPlugin
```
-## uiPlugins — const
+## uiPlugins — const @experimental
```
Plugin[]
```
-## uiRenderOrderPlugin — const
+## uiRenderOrderPlugin — const @experimental
```
UIRenderOrderPlugin
```
-## uiVisibilityPlugin — const
+## uiVisibilityPlugin — const @experimental
```
UIVisibilityPlugin
```
-## uiWorldToScreen — function
+## uiWorldToScreen — function @experimental
```
(camera: UICameraData, worldX: number, worldY: number): { x: number; y: number; }
```
-## unregisterComponent — function
+## unregisterComponent — function @experimental
```
(name: string): void
```
-## unregisterDrawCallback — function
+## unregisterDrawCallback — function @experimental
```
(id: string): void
```
-## unregisterPreSceneDrawCallback — function
+## unregisterPreSceneDrawCallback — function @experimental
```
(id: string): void
```
-## updateAnimatorParam — function
+## updateAnimatorParam — function @experimental
```
(def: AnimatorControllerDef, name: string, patch: Partial<AnimatorParam>): AnimatorControllerDef
```
-## updateAnimatorTransition — function
+## updateAnimatorTransition — function @experimental
```
(def: AnimatorControllerDef, from: string, index: number, patch: Partial<AnimatorTransition>): AnimatorControllerDef
```
-## updateCameraAspectRatio — function
+## updateCameraAspectRatio — function @experimental
```
(world: World, aspectRatio: number): void
```
-## updateTransition — function
+## updateTransition — function @experimental
```
(def: FsmDefinition, from: string, index: number, patch: Partial<FsmTransition>): FsmDefinition
```
-## usesStagger — function
+## usesStagger — function @experimental
```
(orientation: number): boolean
```
-## v2 — const
+## v2 — const @experimental
```
{ readonly create: (x?: number, y?: number) => Vec2; readonly clone: (a: Vec2) => Vec2; readonly add: (a: Vec2, b: Vec2) => Vec2; readonly sub: (a: Vec2, b: Vec2) => Vec2; readonly scale: (a: Vec2, s: number) => Vec2; readonly mul: (a: Vec2, b: Vec2) => Vec2; readonly neg: (a: Vec2) => Vec2; readonly dot: (a: Vec2, b: Vec2) => number; readonly cross: (a: Vec2, b: Vec2) => number; readonly len: (a: Vec2) => number; readonly len2: (a: Vec2) => number; readonly dist: (a: Vec2, b: Vec2) => number; readonly dist2: (a: Vec2, b: Vec2) => number; readonly normalize: (a: Vec2) => Vec2; readonly lerp: (a: Vec2, b: Vec2, t: number) => Vec2; readonly angle: (a: Vec2) => number; readonly fromAngle: (radians: number, length?: number) => Vec2; readonly rotate: (a: Vec2, radians: number) => Vec2; readonly perp: (a: Vec2) => Vec2; readonly equals: (a: Vec2, b: Vec2, epsilon?: number) => boolean; }
```
-## v3 — const
+## v3 — const @experimental
```
{ readonly create: (x?: number, y?: number, z?: number) => Vec3; readonly clone: (a: Vec3) => Vec3; readonly add: (a: Vec3, b: Vec3) => Vec3; readonly sub: (a: Vec3, b: Vec3) => Vec3; readonly scale: (a: Vec3, s: number) => Vec3; readonly mul: (a: Vec3, b: Vec3) => Vec3; readonly neg: (a: Vec3) => Vec3; readonly dot: (a: Vec3, b: Vec3) => number; readonly cross: (a: Vec3, b: Vec3) => Vec3; readonly len: (a: Vec3) => number; readonly len2: (a: Vec3) => number; readonly dist: (a: Vec3, b: Vec3) => number; readonly normalize: (a: Vec3) => Vec3; readonly lerp: (a: Vec3, b: Vec3, t: number) => Vec3; readonly equals: (a: Vec3, b: Vec3, epsilon?: number) => boolean; }
```
-## validateOverrides — function
+## validateOverrides — function @experimental
```
(prefab: PrefabData, options?: { instanceOverrides?: readonly PrefabOverride[]; loadPrefab?: (path: string) => PrefabData | null; }): ValidateResult
```
-## validatePrefab — function
+## validatePrefab — function @experimental
```
(prefab: PrefabData, options?: ValidatePrefabOptions): PrefabDiagnostic[]
```
-## vec2 — const
+## vec2 — const @experimental
```
(x?: number, y?: number) => Vec2
```
-## vec3 — const
+## vec3 — const @experimental
```
(x?: number, y?: number, z?: number) => Vec3
```
-## vec4 — const
+## vec4 — const @experimental
```
(x?: number, y?: number, z?: number, w?: number) => Vec4
```
-## velocityPlugin — const
+## velocityPlugin — const @experimental
```
Plugin
```
-## velocitySystem — const
+## velocitySystem — const @experimental
```
SystemDef
```
-## videoPlugin — const
+## videoPlugin — const @experimental
```
VideoPlugin
```
-## warn — function
+## warn — function @experimental
```
(category: string, message: string, data?: unknown): void
```
-## widgetToPrefab — function
+## widgetToPrefab — function @experimental
```
(build: (world: World) => Entity, name: string): PrefabData
```
-## withActiveRemoteRoot — function
+## withActiveRemoteRoot — function @experimental
```
(config: AssetGroupsConfig | null | undefined, remoteRoot: string): AssetGroupsConfig
```
-## withFolderAlwaysInclude — function
+## withFolderAlwaysInclude — function @experimental
```
(config: AssetGroupsConfig | null | undefined, folder: string, on: boolean): AssetGroupsConfig
```
-## withFolderGroup — function
+## withFolderGroup — function @experimental
```
(config: AssetGroupsConfig | null | undefined, folder: string, mode: AssetGroupMode): AssetGroupsConfig
```
-## wrapSceneSystem — function
+## wrapSceneSystem — function @experimental
```
(app: App, sceneName: string, system: SystemDef): SystemDef
```
-## writeFieldPath — function
+## writeFieldPath — function @experimental
```
(data: Record<string, unknown>, path: string, value: unknown): boolean
```
-## writePtrField — function
+## writePtrField — function @experimental
```
(f32: Float32Array, u32: Uint32Array, u8: Uint8Array, ptr: number, field: PtrFieldDesc, value: PtrFieldValue | unknown): void
```
diff --git a/sdk/etc/physics.api.md b/sdk/etc/physics.api.md
index 221460223..24f9d1422 100644
--- a/sdk/etc/physics.api.md
+++ b/sdk/etc/physics.api.md
@@ -1,21 +1,21 @@
# API surface — esengine/physics
<!-- Generated by tools/api-surface.mjs — do not edit. Run --update to accept changes. -->
-Symbols: 68 stable · 0 beta · 0 deprecated
+Symbols: 0 public · 0 beta · 68 experimental · 0 deprecated
-## BodyType — enum
+## BodyType — enum @experimental
```
Dynamic = 2
Kinematic = 1
Static = 0
```
-## BoxCollider — const
+## BoxCollider — const @experimental
```
BuiltinComponentDef<BoxColliderData>
```
-## BoxColliderData — interface
+## BoxColliderData — interface @experimental
```
categoryBits: number
density: number
@@ -29,17 +29,17 @@ radius: number
restitution: number
```
-## CAPSULE_ARC_SEGMENTS — const
+## CAPSULE_ARC_SEGMENTS — const @experimental
```
16
```
-## CapsuleCollider — const
+## CapsuleCollider — const @experimental
```
BuiltinComponentDef<CapsuleColliderData>
```
-## CapsuleColliderData — interface
+## CapsuleColliderData — interface @experimental
```
categoryBits: number
density: number
@@ -53,12 +53,12 @@ radius: number
restitution: number
```
-## ChainCollider — const
+## ChainCollider — const @experimental
```
ComponentDef<ChainColliderData>
```
-## ChainColliderData — interface
+## ChainColliderData — interface @experimental
```
categoryBits: number
enabled: boolean
@@ -69,12 +69,12 @@ points: Vec2[]
restitution: number
```
-## CharacterController — const
+## CharacterController — const @experimental
```
ComponentDef<CharacterControllerData>
```
-## CharacterControllerData — interface
+## CharacterControllerData — interface @experimental
```
floorMaxAngle: number
floorNormal: Vec2
@@ -91,12 +91,12 @@ up: Vec2
velocity: Vec2
```
-## CircleCollider — const
+## CircleCollider — const @experimental
```
BuiltinComponentDef<CircleColliderData>
```
-## CircleColliderData — interface
+## CircleColliderData — interface @experimental
```
categoryBits: number
density: number
@@ -109,20 +109,20 @@ radius: number
restitution: number
```
-## ColliderInstance — interface
+## ColliderInstance — interface @experimental
```
enabled: boolean
isSensor: boolean
shape: ColliderShape
```
-## ColliderOutline — interface
+## ColliderOutline — interface @experimental
```
circles: { c: Vec2; r: number; }[]
polylines: Vec2[][]
```
-## ColliderShape — type
+## ColliderShape — type @experimental
```
| { kind: 'box'; halfExtents: Vec2; offset: Vec2 }
| { kind: 'circle'; radius: number; offset: Vec2 }
@@ -132,7 +132,7 @@ polylines: Vec2[][]
| { kind: 'chain'; points: Vec2[]; isLoop: boolean }
```
-## CollisionEnterEvent — interface
+## CollisionEnterEvent — interface @experimental
```
contactX: number
contactY: number
@@ -142,7 +142,7 @@ normalX: number
normalY: number
```
-## CollisionHitEvent — interface
+## CollisionHitEvent — interface @experimental
```
approachSpeed: number
entityA: number
@@ -153,12 +153,12 @@ pointX: number
pointY: number
```
-## DistanceJoint — const
+## DistanceJoint — const @experimental
```
ComponentDef<DistanceJointData>
```
-## DistanceJointData — interface
+## DistanceJointData — interface @experimental
```
anchorA: Vec2
anchorB: Vec2
@@ -177,19 +177,19 @@ minLength: number
motorSpeed: number
```
-## MassData — interface
+## MassData — interface @experimental
```
centerOfMass: Vec2
inertia: number
mass: number
```
-## MotorJoint — const
+## MotorJoint — const @experimental
```
ComponentDef<MotorJointData>
```
-## MotorJointData — interface
+## MotorJointData — interface @experimental
```
angularDampingRatio: number
angularHertz: number
@@ -206,7 +206,7 @@ maxVelocityForce: number
maxVelocityTorque: number
```
-## MoveAndSlideParams — interface
+## MoveAndSlideParams — interface @experimental
```
floorMaxAngle: number
maxSlides: number
@@ -224,7 +224,7 @@ velY: number
wasOnFloor: boolean
```
-## MoveAndSlideResult — interface
+## MoveAndSlideResult — interface @experimental
```
floorNormalX: number
floorNormalY: number
@@ -237,23 +237,23 @@ x: number
y: number
```
-## OneWayPlatform — const
+## OneWayPlatform — const @experimental
```
ComponentDef<OneWayPlatformData>
```
-## OneWayPlatformData — interface
+## OneWayPlatformData — interface @experimental
```
enabled: boolean
normal: Vec2
```
-## Physics — const
+## Physics — const @experimental
```
ResourceDef<PhysicsAPI>
```
-## PhysicsAPI — class
+## PhysicsAPI — class @experimental
```
applyAngularImpulse: (entity: Entity, impulse: number) => void
applyForce: (entity: Entity, force: Vec2) => void
@@ -330,19 +330,19 @@ static setDebugDraw: (app: App, enabled: boolean) => void
static setDebugDrawConfig: (app: App, config: Partial<PhysicsDebugDrawConfig>) => void
```
-## PhysicsContactEventData — interface
+## PhysicsContactEventData — interface @experimental
```
approachSpeed: number | undefined
isSensor: boolean | undefined
other: number
```
-## PhysicsDebugDraw — const
+## PhysicsDebugDraw — const @experimental
```
ResourceDef<PhysicsDebugDrawConfig>
```
-## PhysicsDebugDrawConfig — interface
+## PhysicsDebugDrawConfig — interface @experimental
```
enabled: boolean
showColliders: boolean
@@ -350,17 +350,17 @@ showContacts: boolean
showVelocity: boolean
```
-## PhysicsEventType — type
+## PhysicsEventType — type @experimental
```
typeof PhysicsEventType[keyof typeof PhysicsEventType]
```
-## PhysicsEvents — const
+## PhysicsEvents — const @experimental
```
ResourceDef<PhysicsEventsData>
```
-## PhysicsEventsData — interface
+## PhysicsEventsData — interface @experimental
```
collisionEnters: CollisionEnterEvent[]
collisionExits: { entityA: Entity; entityB: Entity; }[]
@@ -369,12 +369,12 @@ sensorEnters: SensorEvent[]
sensorExits: SensorEvent[]
```
-## PhysicsModuleFactory — type
+## PhysicsModuleFactory — type @experimental
```
(config?: Record<string, unknown>) => Promise<PhysicsWasmModule>
```
-## PhysicsPlugin — class
+## PhysicsPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -383,7 +383,7 @@ static new (wasmUrl: string, config?: PhysicsPluginConfig, factory?: PhysicsModu
static prototype: PhysicsPlugin
```
-## PhysicsPluginConfig — interface
+## PhysicsPluginConfig — interface @experimental
```
collisionLayerMasks: number[] | undefined
contactDampingRatio: number | undefined
@@ -398,7 +398,7 @@ restitutionThreshold: number | undefined
subStepCount: number | undefined
```
-## PhysicsWasmModule — interface
+## PhysicsWasmModule — interface @experimental
```
HEAPF32: Float32Array<ArrayBufferLike>
HEAPU32: Uint32Array<ArrayBufferLike>
@@ -521,12 +521,12 @@ _physics_step: (dt: number) => void
_physics_updateBodyProperties: (entityId: number, bodyType: number, gravityScale: number, linearDamping: number, angularDamping: number, fixedRotation: number, bullet: number) => void
```
-## PolygonCollider — const
+## PolygonCollider — const @experimental
```
ComponentDef<PolygonColliderData>
```
-## PolygonColliderData — interface
+## PolygonColliderData — interface @experimental
```
categoryBits: number
density: number
@@ -539,12 +539,12 @@ restitution: number
vertices: Vec2[]
```
-## PrismaticJoint — const
+## PrismaticJoint — const @experimental
```
ComponentDef<PrismaticJointData>
```
-## PrismaticJointData — interface
+## PrismaticJointData — interface @experimental
```
anchorA: Vec2
anchorB: Vec2
@@ -563,7 +563,7 @@ motorSpeed: number
upperTranslation: number
```
-## RaycastHit — interface
+## RaycastHit — interface @experimental
```
entity: number
fraction: number
@@ -571,12 +571,12 @@ normal: Vec2
point: Vec2
```
-## RevoluteJoint — const
+## RevoluteJoint — const @experimental
```
ComponentDef<RevoluteJointData>
```
-## RevoluteJointData — interface
+## RevoluteJointData — interface @experimental
```
anchorA: Vec2
anchorB: Vec2
@@ -591,12 +591,12 @@ motorSpeed: number
upperAngle: number
```
-## RigidBody — const
+## RigidBody — const @experimental
```
BuiltinComponentDef<RigidBodyData>
```
-## RigidBodyData — interface
+## RigidBodyData — interface @experimental
```
angularDamping: number
bodyType: number
@@ -607,12 +607,12 @@ gravityScale: number
linearDamping: number
```
-## SegmentCollider — const
+## SegmentCollider — const @experimental
```
BuiltinComponentDef<SegmentColliderData>
```
-## SegmentColliderData — interface
+## SegmentColliderData — interface @experimental
```
categoryBits: number
density: number
@@ -625,35 +625,35 @@ point2: Vec2
restitution: number
```
-## SensorEvent — interface
+## SensorEvent — interface @experimental
```
sensorEntity: number
visitorEntity: number
```
-## ShapeCastHit — type
+## ShapeCastHit — type @experimental
```
RaycastHit
```
-## SlideCast — type
+## SlideCast — type @experimental
```
(ox: number, oy: number, dx: number, dy: number) => SlideHit | null
```
-## SlideHit — interface
+## SlideHit — interface @experimental
```
fraction: number
nx: number
ny: number
```
-## WeldJoint — const
+## WeldJoint — const @experimental
```
ComponentDef<WeldJointData>
```
-## WeldJointData — interface
+## WeldJointData — interface @experimental
```
anchorA: Vec2
anchorB: Vec2
@@ -666,12 +666,12 @@ linearDampingRatio: number
linearHertz: number
```
-## WheelJoint — const
+## WheelJoint — const @experimental
```
ComponentDef<WheelJointData>
```
-## WheelJointData — interface
+## WheelJointData — interface @experimental
```
anchorA: Vec2
anchorB: Vec2
@@ -690,57 +690,57 @@ motorSpeed: number
upperTranslation: number
```
-## colliderShapeOutline — function
+## colliderShapeOutline — function @experimental
```
(shape: ColliderShape, center: Vec2, angle: number, ppu: number): ColliderOutline
```
-## drawPhysicsDebug — function
+## drawPhysicsDebug — function @experimental
```
(app: App, physicsApiRes: ResourceDef<VelocityProvider>, physicsEventsRes: ResourceDef<PhysicsEventsData>): void
```
-## loadPhysicsModule — function
+## loadPhysicsModule — function @experimental
```
(wasmUrl: string, factory?: PhysicsModuleFactory): Promise<PhysicsWasmModule>
```
-## moveAndSlide — function
+## moveAndSlide — function @experimental
```
(p: MoveAndSlideParams, cast: SlideCast): MoveAndSlideResult
```
-## physicsPlugin — function
+## physicsPlugin — function @experimental
```
(wasmUrl: string, config?: PhysicsPluginConfig, factory?: PhysicsModuleFactory): PhysicsPlugin
```
-## readColliderShapes — function
+## readColliderShapes — function @experimental
```
(world: World, entity: number): ColliderInstance[]
```
-## registerCharacterControllerSystem — function
+## registerCharacterControllerSystem — function @experimental
```
(app: App): void
```
-## registerPhysicsEventBridge — function
+## registerPhysicsEventBridge — function @experimental
```
(app: App): void
```
-## setupPhysicsDebugDraw — function
+## setupPhysicsDebugDraw — function @experimental
```
(app: App, physicsApiRes: ResourceDef<VelocityProvider>, physicsEventsRes: ResourceDef<PhysicsEventsData>): void
```
-## shapeCenter — function
+## shapeCenter — function @experimental
```
(shape: ColliderShape, worldPos: Vec2, angle: number, ppu: number): Vec2
```
-## shapeOffset — function
+## shapeOffset — function @experimental
```
(shape: ColliderShape): Vec2
```
diff --git a/sdk/etc/spine.api.md b/sdk/etc/spine.api.md
index 83fef0853..062084adb 100644
--- a/sdk/etc/spine.api.md
+++ b/sdk/etc/spine.api.md
@@ -1,16 +1,16 @@
# API surface — esengine/spine
<!-- Generated by tools/api-surface.mjs — do not edit. Run --update to accept changes. -->
-Symbols: 22 stable · 0 beta · 0 deprecated
+Symbols: 0 public · 0 beta · 22 experimental · 0 deprecated
-## ConstraintList — interface
+## ConstraintList — interface @experimental
```
ik: string[]
path: string[]
transform: string[]
```
-## ModuleBackend — class
+## ModuleBackend — class @experimental
```
collectAllEvents: () => { entity: Entity; raw: RawSpineEvent; }[]
controller: SpineModuleController
@@ -43,7 +43,7 @@ static new (controller: SpineModuleController): ModuleBackend
static prototype: ModuleBackend
```
-## PathMixData — interface
+## PathMixData — interface @experimental
```
mixRotate: number
mixX: number
@@ -52,7 +52,7 @@ position: number
spacing: number
```
-## RuntimeAssetSource — interface
+## RuntimeAssetSource — interface @experimental
```
backend: Backend
decodePixels: (path: string, flip: boolean) => Promise<{ width: number; height: number; pixels: Uint8Array; }>
@@ -62,12 +62,12 @@ resolveRef: ((ref: string) => string) | undefined
textureImportSettings: ((ref: string) => ParsedTextureImportSettings | undefined) | undefined
```
-## Spine — const
+## Spine — const @experimental
```
ResourceDef<SpineManager>
```
-## SpineEvent — interface
+## SpineEvent — interface @experimental
```
animationName: string
entity: number
@@ -79,27 +79,27 @@ track: number
type: SpineEventType
```
-## SpineEventCallback — type
+## SpineEventCallback — type @experimental
```
(event: SpineEvent) => void
```
-## SpineEventType — type
+## SpineEventType — type @experimental
```
'start' | 'interrupt' | 'end' | 'complete' | 'event'
```
-## SpineEvents — const
+## SpineEvents — const @experimental
```
ResourceDef<SpineEventsData>
```
-## SpineEventsData — interface
+## SpineEventsData — interface @experimental
```
events: readonly SpineEvent[]
```
-## SpineManager — class
+## SpineManager — class @experimental
```
boundEntities: () => Iterable<Entity>
collectAllEvents: () => { entity: Entity; raw: RawSpineEvent; }[]
@@ -138,7 +138,7 @@ static new (coreModule: NonNullable<EngineApi>, moduleFactories: Map<SpineVersio
static prototype: SpineManager
```
-## SpineModuleController — class
+## SpineModuleController — class @experimental
```
addAnimation: (instanceId: number, animation: string, loop?: boolean, delay?: number, track?: number) => boolean
collectEvents: (instanceId: number) => RawSpineEvent[]
@@ -180,12 +180,12 @@ static new (raw: SpineWasmModule, api: SpineWrappedAPI): SpineModuleController
static prototype: SpineModuleController
```
-## SpineModuleFactory — type
+## SpineModuleFactory — type @experimental
```
(config?: Record<string, unknown>) => Promise<SpineWasmModule>
```
-## SpinePlugin — class
+## SpinePlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -197,12 +197,12 @@ static new (manager?: SpineManager): SpinePlugin
static prototype: SpinePlugin
```
-## SpineVersion — type
+## SpineVersion — type @experimental
```
'2.1' | '3.8' | '4.1' | '4.2' | '4.3'
```
-## TransformMixData — interface
+## TransformMixData — interface @experimental
```
mixRotate: number
mixScaleX: number
@@ -212,32 +212,32 @@ mixX: number
mixY: number
```
-## applySpineEntities — function
+## applySpineEntities — function @experimental
```
(opts: { spineManager: SpineManager; sceneData: SceneData; entityMap: Map<number, Entity>; registry: CppRegistry; assetInfo: Map<string, SpineAssetInfo>; }): Promise<void>
```
-## loadSpineAssets — function
+## loadSpineAssets — function @experimental
```
(module: ESEngineModule | null, source: RuntimeAssetSource, spineManager: SpineManager | null | undefined, spinePairs: ReadonlyArray<{ skeleton: string; atlas: string; }>, transcoderProvider?: TranscoderProvider): Promise<Map<string, SpineAssetInfo>>
```
-## loadSpineSceneEntities — function
+## loadSpineSceneEntities — function @experimental
```
(opts: { module: ESEngineModule | null; source: RuntimeAssetSource; spineManager: SpineManager; sceneData: SceneData; entityMap: Map<number, Entity>; registry: CppRegistry; transcoderProvider?: TranscoderProvider; }): Promise<void>
```
-## spineEntityProps — function
+## spineEntityProps — function @experimental
```
(d: Record<string, unknown>): { skeletonScale: number; flipX: boolean; flipY: boolean; layer: number; timeScale: number; playing: boolean; color?: { r: number; g: number; b: number; a: number; }; }
```
-## spinePlugin — function
+## spinePlugin — function @experimental
```
(manager?: SpineManager): SpinePlugin
```
-## wrapSpineModule — function
+## wrapSpineModule — function @experimental
```
(raw: SpineWasmModule): SpineWrappedAPI
```
diff --git a/sdk/etc/wasm.api.md b/sdk/etc/wasm.api.md
index 6b44422cc..8396da0ea 100644
--- a/sdk/etc/wasm.api.md
+++ b/sdk/etc/wasm.api.md
@@ -1,9 +1,9 @@
# API surface — esengine/wasm
<!-- Generated by tools/api-surface.mjs — do not edit. Run --update to accept changes. -->
-Symbols: 6 stable · 0 beta · 0 deprecated
+Symbols: 0 public · 0 beta · 6 experimental · 0 deprecated
-## CppEngineContext — interface
+## CppEngineContext — interface @experimental
```
delete: () => void
init: (webglContextHandle: number) => boolean
@@ -11,7 +11,7 @@ isInitialized: () => boolean
shutdown: () => void
```
-## CppRegistry — interface
+## CppRegistry — interface @experimental
```
addBitmapText: (entity: Entity, component: BitmapText) => void
addBoxCollider: (entity: Entity, component: BoxCollider) => void
@@ -141,7 +141,7 @@ setParent: (child: Entity, parent: Entity) => void
valid: (entity: Entity) => boolean
```
-## CppResourceManager — interface
+## CppResourceManager — interface @experimental
```
acquireTextureByPath: (path: string) => number
createLabelAtlasFont: (textureHandle: number, texWidth: number, texHeight: number, chars: string, charWidth: number, charHeight: number) => number
@@ -173,7 +173,7 @@ updateTextureSubregion: (handle: number, x: number, y: number, width: number, he
updateTextureSubregionFromBytes: ((handle: number, x: number, y: number, width: number, height: number, pixels: Uint8Array) => void) | undefined
```
-## ESEngineModule — interface
+## ESEngineModule — interface @experimental
```
EstellaContext: new () => CppEngineContext
FS: EmscriptenFS
@@ -395,7 +395,7 @@ ui_getCullBit: ((registry: CppRegistry, entity: number) => number) | undefined
ui_getRenderOrder: ((registry: CppRegistry, entity: number) => number) | undefined
```
-## EmscriptenFS — interface
+## EmscriptenFS — interface @experimental
```
analyzePath: (path: string) => { exists: boolean; parentExists: boolean; }
isDir: (mode: number) => boolean
@@ -408,7 +408,7 @@ unlink: (path: string) => void
writeFile: (path: string, data: string | Uint8Array) => void
```
-## GfxLiveObjects — interface
+## GfxLiveObjects — interface @experimental
```
buffers: number
layouts: number
diff --git a/sdk/etc/wechat.api.md b/sdk/etc/wechat.api.md
index a3044a158..1c153f9f2 100644
--- a/sdk/etc/wechat.api.md
+++ b/sdk/etc/wechat.api.md
@@ -1,24 +1,24 @@
# API surface — esengine/wechat
<!-- Generated by tools/api-surface.mjs — do not edit. Run --update to accept changes. -->
-Symbols: 1497 stable · 17 beta · 1 deprecated
+Symbols: 0 public · 17 beta · 1498 experimental · 1 deprecated
-## ANCHOR_AXES — const
+## ANCHOR_AXES — const @experimental
```
readonly AnchorAxis[]
```
-## ANIM_CLIP_FORMAT_VERSION — const
+## ANIM_CLIP_FORMAT_VERSION — const @experimental
```
"1.4"
```
-## ASSET_GROUP_MODES — const
+## ASSET_GROUP_MODES — const @experimental
```
readonly ["local", "subpackage", "remote"]
```
-## AchievementProvider — interface
+## AchievementProvider — interface @experimental
```
getStat: (name: string) => number
platformBacked: boolean
@@ -29,12 +29,12 @@ unlock: (id: string) => Promise<void>
unlocked: (id: string) => boolean
```
-## Achievements — const
+## Achievements — const @experimental
```
ResourceDef<AchievementsAPI>
```
-## AchievementsAPI — class
+## AchievementsAPI — class @experimental
```
available: boolean
getStat: (name: string) => number
@@ -49,18 +49,18 @@ static new (): AchievementsAPI
static prototype: AchievementsAPI
```
-## ActionDef — interface
+## ActionDef — interface @experimental
```
bindings: Binding[]
type: ActionType
```
-## ActionType — type
+## ActionType — type @experimental
```
'button' | 'axis' | 'axis2d'
```
-## ActivationTrack — interface
+## ActivationTrack — interface @experimental
```
childPath: string
name: string
@@ -68,18 +68,18 @@ ranges: ActivationRange[]
type: "activation"
```
-## AdProvider — interface
+## AdProvider — interface @experimental
```
createInterstitialAd: (adUnitId: string) => PlatformInterstitialAd
createRewardedAd: (adUnitId: string) => PlatformRewardedAd
```
-## Added — function
+## Added — function @experimental
```
<T extends AnyComponentDef>(component: T): AddedWrapper<T>
```
-## AddedEntity — interface
+## AddedEntity — interface @experimental
```
components: ComponentData[]
name: string
@@ -88,26 +88,26 @@ prefabEntityId: string
visible: boolean
```
-## AddedWrapper — interface
+## AddedWrapper — interface @experimental
```
_component: T
_filterType: "added"
```
-## AddressableAssetType — type
+## AddressableAssetType — type @experimental
```
| 'texture' | 'material' | 'spine' | 'bitmap-font' | 'font'
| 'prefab' | 'json' | 'text' | 'binary' | 'audio'
```
-## AddressableManifest — interface
+## AddressableManifest — interface @experimental
```
groups: Record<string, AddressableManifestGroup>
revision: string | undefined
version: "2.0"
```
-## AddressableManifestAsset — interface
+## AddressableManifestAsset — interface @experimental
```
address: string | undefined
compressedFormats: string[] | undefined
@@ -120,19 +120,19 @@ textureImport: ParsedTextureImportSettings | undefined
type: AddressableAssetType
```
-## AddressableManifestGroup — interface
+## AddressableManifestGroup — interface @experimental
```
assets: Record<string, AddressableManifestAsset>
bundleMode: string
labels: string[]
```
-## Ads — const
+## Ads — const @experimental
```
ResourceDef<AdsAPI>
```
-## AdsAPI — class
+## AdsAPI — class @experimental
```
available: boolean
preloadRewarded: (adUnitId: string) => Promise<void>
@@ -144,7 +144,7 @@ static new (takeover: Takeover): AdsAPI
static prototype: AdsAPI
```
-## AiAction — type
+## AiAction — type @experimental
```
(
ctx: Ctx,
@@ -154,30 +154,30 @@ static prototype: AdsAPI
) => void | Status
```
-## AiActionInput — interface
+## AiActionInput — interface @experimental
```
arg: string | undefined
params: Readonly<Record<string, AiParamValue>> | undefined
```
-## AiActionSpec — interface
+## AiActionSpec — interface @experimental
```
params: readonly AiParamDef[] | undefined
run: AiAction<Ctx>
separator: string | undefined
```
-## AiBt — const
+## AiBt — const @experimental
```
ResourceDef<BehaviorTrees>
```
-## AiCondition — type
+## AiCondition — type @experimental
```
(ctx: Ctx, bb: Blackboard) => boolean
```
-## AiContext — interface
+## AiContext — interface @experimental
```
blackboard: Blackboard
commands: CommandsInstance
@@ -189,12 +189,12 @@ set: <C extends AnyComponentDef>(component: C, data: ComponentData<C>) => void
world: World
```
-## AiFsm — const
+## AiFsm — const @experimental
```
ResourceDef<StateMachines>
```
-## AiParamDef — interface
+## AiParamDef — interface @experimental
```
label: string | undefined
max: number | undefined
@@ -207,17 +207,17 @@ tooltip: string | undefined
type: "string" | "number" | "bool" | "enum"
```
-## AiParamValue — type
+## AiParamValue — type @experimental
```
string | number | boolean
```
-## AiParams — type
+## AiParams — type @experimental
```
Readonly<Record<string, AiParamValue>>
```
-## AiRegistry — class
+## AiRegistry — class @experimental
```
actionNames: () => string[]
clear: () => void
@@ -234,17 +234,17 @@ static new <Ctx = unknown>(): AiRegistry<Ctx>
static prototype: AiRegistry<any>
```
-## AlignContent — type
+## AlignContent — type @experimental
```
(typeof AlignContent)[keyof typeof AlignContent]
```
-## AlignItems — type
+## AlignItems — type @experimental
```
(typeof AlignItems)[keyof typeof AlignItems]
```
-## AlignSelf — enum
+## AlignSelf — enum @experimental
```
Auto = 0
Center = 2
@@ -253,7 +253,7 @@ Start = 1
Stretch = 4
```
-## AnchorAxis — enum
+## AnchorAxis — enum @experimental
```
Center = 1
End = 2
@@ -261,7 +261,7 @@ Start = 0
Stretch = 3
```
-## AnchorFields — interface
+## AnchorFields — interface @experimental
```
height: Dimension | undefined
insetBottom: Dimension
@@ -276,18 +276,18 @@ position: number
width: Dimension | undefined
```
-## AnchorPreset — interface
+## AnchorPreset — interface @experimental
```
h: AnchorAxis
v: AnchorAxis
```
-## And — function
+## And — function @experimental
```
(...filters: FilterExpr[]): FilterExpr
```
-## AnimClipAssetData — interface
+## AnimClipAssetData — interface @experimental
```
events: AnimClipEventData[] | undefined
fps: number | undefined
@@ -299,14 +299,14 @@ type: "animation-clip"
version: string
```
-## AnimClipEventData — interface
+## AnimClipEventData — interface @experimental
```
data: unknown
frame: number
name: string
```
-## AnimClipFrameData — interface
+## AnimClipFrameData — interface @experimental
```
atlasFrame: { x: number; y: number; width: number; height: number; pageWidth: number; pageHeight: number; } | undefined
cell: number | undefined
@@ -315,13 +315,13 @@ pivot: AnimClipPivotData | undefined
texture: string | undefined
```
-## AnimClipPivotData — interface
+## AnimClipPivotData — interface @experimental
```
x: number
y: number
```
-## AnimClipSheetData — interface
+## AnimClipSheetData — interface @experimental
```
cellHeight: number
cellWidth: number
@@ -332,7 +332,7 @@ spacing: number
texture: string
```
-## AnimFramesTrack — interface
+## AnimFramesTrack — interface @experimental
```
childPath: string
frames: AnimFrame[]
@@ -340,7 +340,7 @@ name: string
type: "animFrames"
```
-## AnimationPlugin — class
+## AnimationPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -349,18 +349,18 @@ static new (): AnimationPlugin
static prototype: AnimationPlugin
```
-## Animator — const
+## Animator — const @experimental
```
ComponentDef<AnimatorData>
```
-## AnimatorBlend1D — interface
+## AnimatorBlend1D — interface @experimental
```
parameter: string
thresholds: AnimatorBlendThreshold[]
```
-## AnimatorBlendThreshold — interface
+## AnimatorBlendThreshold — interface @experimental
```
clip: string
loop: boolean | undefined
@@ -368,18 +368,18 @@ speed: number | undefined
value: number
```
-## AnimatorCondition — type
+## AnimatorCondition — type @experimental
```
| { param: string; op: 'gt' | 'lt' | 'eq' | 'neq'; value: number }
| { param: string; op: 'true' | 'false' | 'trigger' }
```
-## AnimatorController — const
+## AnimatorController — const @experimental
```
ResourceDef<AnimatorControllerAPI>
```
-## AnimatorControllerAPI — class
+## AnimatorControllerAPI — class @experimental
```
clearControllers: () => void
getBool: (entity: Entity, name: string) => boolean
@@ -398,7 +398,7 @@ static new (): AnimatorControllerAPI
static prototype: AnimatorControllerAPI
```
-## AnimatorControllerDef — interface
+## AnimatorControllerDef — interface @experimental
```
anyStateTransitions: AnimatorTransition[] | undefined
initialState: string
@@ -406,59 +406,59 @@ parameters: AnimatorParam[]
states: AnimatorState[]
```
-## AnimatorData — interface
+## AnimatorData — interface @experimental
```
controller: string
currentState: string
enabled: boolean
```
-## AnimatorEdge — type
+## AnimatorEdge — type @experimental
```
GraphEdge<AnimatorTransition>
```
-## AnimatorEvalResult — interface
+## AnimatorEvalResult — interface @experimental
```
consumedTriggers: string[]
next: string | null
```
-## AnimatorParam — interface
+## AnimatorParam — interface @experimental
```
default: number | boolean | undefined
name: string
type: AnimatorParamType
```
-## AnimatorParamType — type
+## AnimatorParamType — type @experimental
```
'float' | 'bool' | 'trigger'
```
-## AnimatorParamValues — type
+## AnimatorParamValues — type @experimental
```
Readonly<Record<string, number | boolean>>
```
-## AnimatorPathEvalResult — interface
+## AnimatorPathEvalResult — interface @experimental
```
consumedTriggers: string[]
nextPath: string | null
```
-## AnimatorScope — type
+## AnimatorScope — type @experimental
```
Pick<AnimatorControllerDef, 'states' | 'initialState' | 'anyStateTransitions'>
```
-## AnimatorSpineMotion — interface
+## AnimatorSpineMotion — interface @experimental
```
animation: string
loop: boolean | undefined
```
-## AnimatorState — interface
+## AnimatorState — interface @experimental
```
blend: AnimatorBlend1D | undefined
clip: string | undefined
@@ -472,26 +472,26 @@ x: number | undefined
y: number | undefined
```
-## AnimatorSubMachine — interface
+## AnimatorSubMachine — interface @experimental
```
anyStateTransitions: AnimatorTransition[] | undefined
initialState: string
states: AnimatorState[]
```
-## AnimatorTransition — interface
+## AnimatorTransition — interface @experimental
```
conditions: AnimatorCondition[]
hasExitTime: boolean | undefined
to: string
```
-## AnyComponentDef — type
+## AnyComponentDef — type @experimental
```
ComponentDef<any> | BuiltinComponentDef<any>
```
-## App — class
+## App — class @experimental
```
addBundleSystems: (entries: ReadonlyArray<{ schedule: number; system: SystemDef | SystemSet; }>) => App
addEvent: <T>(event: EventDef<T>) => App
@@ -553,7 +553,7 @@ static new: () => App
static prototype: App
```
-## AppContext — class
+## AppContext — class @experimental
```
componentRegistry: Map<string, any>
drainPendingSystems: () => PendingSystemEntry[]
@@ -567,12 +567,12 @@ static new (): AppContext
static prototype: AppContext
```
-## ApplyTilesetRefs — type
+## ApplyTilesetRefs — type @experimental
```
(entity: number, refs: readonly string[]) => void
```
-## ArrayDataSource — class
+## ArrayDataSource — class @experimental
```
append: (items: readonly T[]) => void
getCount: () => number
@@ -586,34 +586,34 @@ static new <T>(items?: readonly T[]): ArrayDataSource<T>
static prototype: ArrayDataSource<any>
```
-## AssetBuildTransform — type
+## AssetBuildTransform — type @experimental
```
(content: string, context: unknown) => string
```
-## AssetContentType — type
+## AssetContentType — type @experimental
```
'json' | 'text' | 'binary' | 'image' | 'audio'
```
-## AssetFieldType — type
+## AssetFieldType — type @experimental
```
'texture' | 'material' | 'font' | 'anim-clip' | 'audio' | 'video' | 'tilemap' | 'tileset' | 'timeline' | 'statemachine' | 'behaviortree' | 'animatorcontroller'
```
-## AssetGroupDef — interface
+## AssetGroupDef — interface @experimental
```
alwaysInclude: boolean | undefined
folder: string
mode: "local" | "subpackage" | "remote"
```
-## AssetGroupMode — type
+## AssetGroupMode — type @experimental
```
typeof ASSET_GROUP_MODES[number]
```
-## AssetGroupsConfig — interface
+## AssetGroupsConfig — interface @experimental
```
activeProfile: string | undefined
atlases: Record<string, AtlasDef> | undefined
@@ -622,7 +622,7 @@ profiles: Record<string, BuildProfile> | undefined
version: string
```
-## AssetPlugin — class
+## AssetPlugin — class @experimental
```
build: (app: App) => void
name: string
@@ -630,7 +630,7 @@ static new (): AssetPlugin
static prototype: AssetPlugin
```
-## AssetRefCounter — class
+## AssetRefCounter — class @experimental
```
addFontRef: (path: string, entity: number) => void
addMaterialRef: (path: string, entity: number) => void
@@ -655,14 +655,14 @@ static new (): AssetRefCounter
static prototype: AssetRefCounter
```
-## AssetRefInfo — interface
+## AssetRefInfo — interface @experimental
```
assetPath: string
entities: number[]
refCount: number
```
-## AssetTypeEntry — interface
+## AssetTypeEntry — interface @experimental
```
addressableType: AddressableAssetType | null
buildTransform: AssetBuildTransform | undefined
@@ -674,17 +674,17 @@ suffixes: string[] | undefined
wechatPackInclude: boolean
```
-## Assets — const
+## Assets — const @experimental
```
ResourceDef<AssetsClass>
```
-## AssetsData — type
+## AssetsData — type @experimental
```
AssetsClass
```
-## AsyncCache — class
+## AsyncCache — class @experimental
```
clear: () => void
clearAll: () => void
@@ -701,24 +701,24 @@ static new <T>(dispose_?: ((value: T) => void) | undefined): AsyncCache<T>
static prototype: AsyncCache<any>
```
-## AtlasDef — interface
+## AtlasDef — interface @experimental
```
folder: string
```
-## AttenuationModel — enum
+## AttenuationModel — enum @experimental
```
Exponential = 2
Inverse = 1
Linear = 0
```
-## Audio — const
+## Audio — const @experimental
```
ResourceDef<AudioAPI>
```
-## AudioAPI — class
+## AudioAPI — class @experimental
```
baseUrl: string
bufferBudget: number
@@ -766,20 +766,20 @@ static new (backend: PlatformAudioBackend, mixer?: AudioMixer | null): AudioAPI
static prototype: AudioAPI
```
-## AudioBackendInitOptions — interface
+## AudioBackendInitOptions — interface @experimental
```
initialPoolSize: number | undefined
mixerConfig: AudioMixerConfig | undefined
```
-## AudioBufferHandle — interface
+## AudioBufferHandle — interface @experimental
```
bytes: number | undefined
duration: number
id: number
```
-## AudioBufferStats — interface
+## AudioBufferStats — interface @experimental
```
bufferBudget: number
bufferBytes: number
@@ -787,7 +787,7 @@ bufferCount: number
evictableCount: number
```
-## AudioBus — class
+## AudioBus — class @experimental
```
addChild: (child: AudioBus) => void
connect: (destination: AudioBus | AudioNode) => void
@@ -803,7 +803,7 @@ static new (context: AudioContext, config: AudioBusConfig): AudioBus
static prototype: AudioBus
```
-## AudioBusConfig — interface
+## AudioBusConfig — interface @experimental
```
muted: boolean | undefined
name: string
@@ -811,7 +811,7 @@ parent: string | undefined
volume: number | undefined
```
-## AudioBusDecl — interface
+## AudioBusDecl — interface @experimental
```
duck: BusDuckRule | undefined
effects: BusEffectDef[] | undefined
@@ -821,7 +821,7 @@ parent: string | undefined
volume: number | undefined
```
-## AudioHandle — interface
+## AudioHandle — interface @experimental
```
currentTime: number
duration: number
@@ -837,17 +837,17 @@ setVolume: (volume: number) => void
stop: () => void
```
-## AudioListener — const
+## AudioListener — const @experimental
```
ComponentDef<AudioListenerData>
```
-## AudioListenerData — interface
+## AudioListenerData — interface @experimental
```
enabled: boolean
```
-## AudioMixer — class
+## AudioMixer — class @experimental
```
busNames: () => string[]
createBus: (config: AudioBusConfig) => AudioBus
@@ -864,7 +864,7 @@ static new (context: AudioContext, config?: AudioMixerConfig): AudioMixer
static prototype: AudioMixer
```
-## AudioMixerConfig — interface
+## AudioMixerConfig — interface @experimental
```
masterVolume: number | undefined
musicVolume: number | undefined
@@ -873,7 +873,7 @@ uiVolume: number | undefined
voiceVolume: number | undefined
```
-## AudioPlugin — class
+## AudioPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -883,7 +883,7 @@ static new (config?: AudioPluginConfig): AudioPlugin
static prototype: AudioPlugin
```
-## AudioPluginConfig — interface
+## AudioPluginConfig — interface @experimental
```
initialPoolSize: number | undefined
masterVolume: number | undefined
@@ -891,7 +891,7 @@ musicVolume: number | undefined
sfxVolume: number | undefined
```
-## AudioPool — class
+## AudioPool — class @experimental
```
acquire: () => PooledAudioNode
activeCount: number
@@ -901,17 +901,17 @@ static new (context: AudioContext, initialSize?: number): AudioPool
static prototype: AudioPool
```
-## AudioProjectConfig — interface
+## AudioProjectConfig — interface @experimental
```
buses: AudioBusDecl[] | undefined
```
-## AudioSource — const
+## AudioSource — const @experimental
```
ComponentDef<AudioSourceData>
```
-## AudioSourceData — interface
+## AudioSourceData — interface @experimental
```
attenuationModel: number
bus: string
@@ -928,7 +928,7 @@ spatial: boolean
volume: number
```
-## AudioTrack — interface
+## AudioTrack — interface @experimental
```
childPath: string
events: AudioEvent[]
@@ -936,37 +936,37 @@ name: string
type: "audio"
```
-## Axis1D — const
+## Axis1D — const @experimental
```
(...bindings: Binding[]) => ActionDef
```
-## Axis2D — const
+## Axis2D — const @experimental
```
(...bindings: Binding[]) => ActionDef
```
-## BUILTIN_SHADER_TEMPLATES — const
+## BUILTIN_SHADER_TEMPLATES — const @experimental
```
readonly BuiltinShaderTemplate[]
```
-## BUILTIN_UI_PREFABS — const
+## BUILTIN_UI_PREFABS — const @experimental
```
Record<string, PrefabData>
```
-## BUILTIN_UI_WIDGET_NAMES — const
+## BUILTIN_UI_WIDGET_NAMES — const @experimental
```
readonly ["Button", "Toggle", "Slider", "Dialog", "TextInput", "Progress", "Dropdown", "ListView", "ScrollView"]
```
-## BUNDLE_MODES — const
+## BUNDLE_MODES — const @experimental
```
readonly BundleMode[]
```
-## Backend — interface
+## Backend — interface @experimental
```
fetchBinary: (path: string) => Promise<ArrayBuffer>
fetchText: (path: string) => Promise<string>
@@ -974,7 +974,7 @@ resolveUrl: (path: string) => string
setBaseUrl: ((url: string) => void) | undefined
```
-## BehaviorContext — interface
+## BehaviorContext — interface @experimental
```
commands: CommandsInstance
entity: number
@@ -987,7 +987,7 @@ time: TimeData
world: World
```
-## BehaviorDef — interface
+## BehaviorDef — interface @experimental
```
destroy: ((ctx: BehaviorContext<S>) => void) | undefined
metadata: ComponentMetadata | undefined
@@ -997,18 +997,18 @@ state: S | undefined
update: ((ctx: BehaviorContext<S>, dt: number) => void) | undefined
```
-## BehaviorTreeAgent — const
+## BehaviorTreeAgent — const @experimental
```
ComponentDef<BehaviorTreeAgentData>
```
-## BehaviorTreeAgentData — interface
+## BehaviorTreeAgentData — interface @experimental
```
bt: string
status: string
```
-## BehaviorTrees — class
+## BehaviorTrees — class @experimental
```
blackboard: (entity: Entity) => Blackboard
status: (entity: Entity) => string | null
@@ -1016,7 +1016,7 @@ static new (states: Map<Entity, BtAgentState>): BehaviorTrees
static prototype: BehaviorTrees
```
-## BezierPoints — interface
+## BezierPoints — interface @experimental
```
p1x: number
p1y: number
@@ -1024,12 +1024,12 @@ p2x: number
p2y: number
```
-## BinaryHandler — type
+## BinaryHandler — type @experimental
```
(payload: Uint8Array) => void
```
-## Binding — type
+## Binding — type @experimental
```
| { kind: 'key'; code: string }
| { kind: 'mouse'; button: number }
@@ -1041,7 +1041,7 @@ p2y: number
| { kind: 'virtual'; id: string }
```
-## BitmapCache — interface
+## BitmapCache — interface @experimental
```
_rt: RenderTextureHandle | null
height: number
@@ -1050,12 +1050,12 @@ valid: boolean
width: number
```
-## BitmapText — const
+## BitmapText — const @experimental
```
BuiltinComponentDef<BitmapTextData>
```
-## BitmapTextData — interface
+## BitmapTextData — interface @experimental
```
align: number
color: Color
@@ -1068,7 +1068,7 @@ spacing: number
text: string
```
-## Blackboard — class
+## Blackboard — class @experimental
```
clearTriggers: () => void
consume: (trigger: string) => void
@@ -1082,19 +1082,19 @@ static new (): Blackboard
static prototype: Blackboard
```
-## BlackboardGuard — interface
+## BlackboardGuard — interface @experimental
```
key: string
op: CompareOp
value: string | number | boolean | undefined
```
-## BlendCurve — type
+## BlendCurve — type @experimental
```
(typeof BlendCurve)[keyof typeof BlendCurve]
```
-## BlendMode — enum
+## BlendMode — enum @experimental
```
Additive = 1
Darken = 7
@@ -1108,19 +1108,19 @@ PremultipliedAlpha = 4
Screen = 3
```
-## BodyType — enum
+## BodyType — enum @experimental
```
Dynamic = 2
Kinematic = 1
Static = 0
```
-## BoxCollider — const
+## BoxCollider — const @experimental
```
BuiltinComponentDef<BoxColliderData>
```
-## BoxColliderData — interface
+## BoxColliderData — interface @experimental
```
categoryBits: number
density: number
@@ -1134,20 +1134,20 @@ radius: number
restitution: number
```
-## BtDefinition — interface
+## BtDefinition — interface @experimental
```
orphans: BtNode[] | undefined
root: BtNode
```
-## BtEdge — interface
+## BtEdge — interface @experimental
```
from: string
id: string
to: string
```
-## BtNode — interface
+## BtNode — interface @experimental
```
arg: string | undefined
children: BtNode[] | undefined
@@ -1162,7 +1162,7 @@ x: number | undefined
y: number | undefined
```
-## BtNodeType — type
+## BtNodeType — type @experimental
```
| 'sequence' | 'selector' | 'parallel'
// decorators (one child)
@@ -1171,7 +1171,7 @@ y: number | undefined
| 'action' | 'condition'
```
-## BtPlugin — class
+## BtPlugin — class @experimental
```
build: (app: App) => void
name: string
@@ -1179,12 +1179,12 @@ static new (): BtPlugin
static prototype: BtPlugin
```
-## BtRunState — type
+## BtRunState — type @experimental
```
Map<string, NodeState>
```
-## BuildNavGridOptions — interface
+## BuildNavGridOptions — interface @experimental
```
blockedTileIds: Iterable<number> | undefined
cellSize: number
@@ -1194,12 +1194,12 @@ origin: Vec2 | undefined
width: number
```
-## BuildProfile — interface
+## BuildProfile — interface @experimental
```
remoteRoot: string | undefined
```
-## BuiltinBridge — class
+## BuiltinBridge — class @experimental
```
connect: (cppRegistry: CppRegistry, module?: ESEngineModule, options?: BridgeConnectOptions) => void
deleteFromEntitySets: (entity: Entity) => string[]
@@ -1224,7 +1224,7 @@ static new (): BuiltinBridge
static prototype: BuiltinBridge
```
-## BuiltinComponentDef — interface
+## BuiltinComponentDef — interface @experimental
```
_builtin: true
_cppName: string
@@ -1244,7 +1244,7 @@ skeletalFields: SkeletalFieldMeta | undefined
transient: boolean
```
-## BuiltinShaderTemplate — interface
+## BuiltinShaderTemplate — interface @experimental
```
defaults: Record<string, unknown>
description: string
@@ -1253,17 +1253,17 @@ label: string
source: string
```
-## BuiltinSideModuleId — type
+## BuiltinSideModuleId — type @experimental
```
'physics' | 'basis' | 'videodec' | 'dragonbones' | `spine:${SpineVersion}`
```
-## BundleMode — type
+## BundleMode — type @experimental
```
'local' | 'lazy' | 'remote'
```
-## BusDuckRule — interface
+## BusDuckRule — interface @experimental
```
amount: number
attack: number | undefined
@@ -1272,24 +1272,24 @@ threshold: number | undefined
trigger: string
```
-## BusEffectDef — type
+## BusEffectDef — type @experimental
```
FilterEffectDef | ReverbEffectDef | CompressorEffectDef
```
-## Button — const
+## Button — const @experimental
```
(...bindings: Binding[]) => ActionDef
```
-## ButtonHandle — interface
+## ButtonHandle — interface @experimental
```
dispose: () => void
entity: number
setDisabled: (disabled: boolean) => void
```
-## ButtonOptions — interface
+## ButtonOptions — interface @experimental
```
background: UIVisualInit | undefined
disabled: boolean | undefined
@@ -1305,39 +1305,39 @@ text: string | TextInit | undefined
world: World
```
-## ButtonStateVisual — interface
+## ButtonStateVisual — interface @experimental
```
color: Color | undefined
scale: number | undefined
sprite: number | undefined
```
-## CAPSULE_ARC_SEGMENTS — const
+## CAPSULE_ARC_SEGMENTS — const @experimental
```
16
```
-## CHUNK_SIZE — const
+## CHUNK_SIZE — const @experimental
```
16
```
-## COLLISION_BRUSHES — const
+## COLLISION_BRUSHES — const @experimental
```
CollisionBrush[]
```
-## COLLISION_PALETTE_REF — const
+## COLLISION_PALETTE_REF — const @experimental
```
"builtin:collision"
```
-## CacheAsBitmap — const
+## CacheAsBitmap — const @experimental
```
ComponentDef<CacheAsBitmapData>
```
-## CacheAsBitmapData — interface
+## CacheAsBitmapData — interface @experimental
```
dirty: boolean
enabled: boolean
@@ -1345,22 +1345,22 @@ height: number
width: number
```
-## CacheBitmap — const
+## CacheBitmap — const @experimental
```
{ create(width: number, height: number): BitmapCache; release(cache: BitmapCache): void; beginDraw(cache: BitmapCache, viewProjection: Float32Array): void; endDraw(): void; resize(cache: BitmapCache, width: number, height: number): void; }
```
-## Camera — const
+## Camera — const @experimental
```
BuiltinComponentDef<CameraData>
```
-## CameraBounds — const
+## CameraBounds — const @experimental
```
ComponentDef<CameraBoundsData>
```
-## CameraBoundsData — interface
+## CameraBoundsData — interface @experimental
```
maxX: number
maxY: number
@@ -1368,7 +1368,7 @@ minX: number
minY: number
```
-## CameraData — interface
+## CameraData — interface @experimental
```
aspectRatio: number
clearFlags: number
@@ -1385,12 +1385,12 @@ showFrustum: boolean
viewport: Vec4
```
-## CameraDirector — const
+## CameraDirector — const @experimental
```
ResourceDef<CameraDirectorState>
```
-## CameraDirectorState — interface
+## CameraDirectorState — interface @experimental
```
blending: boolean
currentMain: CameraPOV | null
@@ -1407,7 +1407,7 @@ startTime: number
target: number
```
-## CameraExtents — interface
+## CameraExtents — interface @experimental
```
cameraX: number
cameraY: number
@@ -1416,7 +1416,7 @@ halfH: number
halfW: number
```
-## CameraPOV — interface
+## CameraPOV — interface @experimental
```
clearFlags: number
cullingMask: number
@@ -1436,7 +1436,7 @@ y: number
z: number
```
-## CameraRenderParams — interface
+## CameraRenderParams — interface @experimental
```
cameraEntity: number | undefined
clearColor: { x: number; y: number; z: number; w: number; } | undefined
@@ -1448,12 +1448,12 @@ viewProjection: Float32Array<ArrayBufferLike>
viewportPixels: Viewport
```
-## CameraView — const
+## CameraView — const @experimental
```
ResourceDef<CameraViewAPI>
```
-## CameraViewAPI — class
+## CameraViewAPI — class @experimental
```
getWorldBounds: () => { left: number; right: number; bottom: number; top: number; } | null
getWorldMousePosition: () => { x: number; y: number; } | null
@@ -1463,12 +1463,12 @@ static new (app_: App): CameraViewAPI
static prototype: CameraViewAPI
```
-## Canvas — const
+## Canvas — const @experimental
```
BuiltinComponentDef<CanvasData>
```
-## CanvasData — interface
+## CanvasData — interface @experimental
```
backgroundColor: Color
designResolution: Vec2
@@ -1478,19 +1478,19 @@ pixelsPerUnit: number
scaleMode: number
```
-## CanvasScale — interface
+## CanvasScale — interface @experimental
```
designResolution: { x: number; y: number; }
matchWidthOrHeight: number
scaleMode: number
```
-## CapsuleCollider — const
+## CapsuleCollider — const @experimental
```
BuiltinComponentDef<CapsuleColliderData>
```
-## CapsuleColliderData — interface
+## CapsuleColliderData — interface @experimental
```
categoryBits: number
density: number
@@ -1504,7 +1504,7 @@ radius: number
restitution: number
```
-## Catalog — class
+## Catalog — class @experimental
```
getAllLabels: () => string[]
getAtlasFrame: (path: string) => AtlasFrameInfo | null
@@ -1522,7 +1522,7 @@ static new (entries: Map<string, CatalogEntry>, addresses: Map<string, string>,
static prototype: Catalog
```
-## CatalogData — interface
+## CatalogData — interface @experimental
```
addresses: Record<string, string> | undefined
entries: Record<string, CatalogEntry>
@@ -1530,7 +1530,7 @@ labels: Record<string, string[]> | undefined
version: number
```
-## CatalogEntry — interface
+## CatalogEntry — interface @experimental
```
atlas: string | undefined
buildPath: string | undefined
@@ -1541,27 +1541,27 @@ type: string
uv: { offset: [number, number]; scale: [number, number]; } | undefined
```
-## Cell — interface
+## Cell — interface @experimental
```
x: number
y: number
```
-## Census — interface
+## Census — interface @experimental
```
atMs: number
entries: ReadonlyMap<string, CensusEntry>
failedProbes: readonly string[]
```
-## CensusContext — interface
+## CensusContext — interface @experimental
```
app: App | undefined
module: ESEngineModule | null | undefined
world: World | undefined
```
-## CensusDelta — interface
+## CensusDelta — interface @experimental
```
after: number
before: number
@@ -1571,7 +1571,7 @@ tier: CensusTier
unit: "count" | "bytes"
```
-## CensusEntry — interface
+## CensusEntry — interface @experimental
```
key: string
tier: CensusTier
@@ -1579,13 +1579,13 @@ unit: "count" | "bytes"
value: number
```
-## CensusProbe — interface
+## CensusProbe — interface @experimental
```
id: string
read: (ctx: CensusContext) => readonly CensusEntry[] | undefined
```
-## CensusReport — interface
+## CensusReport — interface @experimental
```
cycles: number
failedProbes: readonly string[]
@@ -1595,7 +1595,7 @@ projectCycles: number
verdicts: readonly CensusVerdict[]
```
-## CensusSeriesOptions — interface
+## CensusSeriesOptions — interface @experimental
```
boundedSlopeTolerance: number | undefined
projectCycles: number | undefined
@@ -1603,12 +1603,12 @@ trendByteBudgetPerCycle: number | undefined
warmupCycles: number | undefined
```
-## CensusTier — type
+## CensusTier — type @experimental
```
'conserved' | 'bounded' | 'trend' | 'info'
```
-## CensusVerdict — interface
+## CensusVerdict — interface @experimental
```
confidentSlopePerCycle: number
first: number
@@ -1623,28 +1623,28 @@ tier: CensusTier
unit: "count" | "bytes"
```
-## ChainCollider — const
+## ChainCollider — const @experimental
```
ComponentDef<ChainColliderData>
```
-## Changed — function
+## Changed — function @experimental
```
<T extends AnyComponentDef>(component: T): ChangedWrapper<T>
```
-## ChangedWrapper — interface
+## ChangedWrapper — interface @experimental
```
_component: T
_filterType: "changed"
```
-## CharacterController — const
+## CharacterController — const @experimental
```
ComponentDef<CharacterControllerData>
```
-## CharacterControllerData — interface
+## CharacterControllerData — interface @experimental
```
floorMaxAngle: number
floorNormal: Vec2
@@ -1661,22 +1661,22 @@ up: Vec2
velocity: Vec2
```
-## Children — const
+## Children — const @experimental
```
BuiltinComponentDef<ChildrenData>
```
-## ChildrenData — interface
+## ChildrenData — interface @experimental
```
entities: number[]
```
-## CircleCollider — const
+## CircleCollider — const @experimental
```
BuiltinComponentDef<CircleColliderData>
```
-## CircleColliderData — interface
+## CircleColliderData — interface @experimental
```
categoryBits: number
density: number
@@ -1689,7 +1689,7 @@ radius: number
restitution: number
```
-## ClearFlags — enum
+## ClearFlags — enum @experimental
```
Color = 1
ColorAndDepth = 3
@@ -1697,20 +1697,20 @@ Depth = 2
Nothing = 0
```
-## ColliderInstance — interface
+## ColliderInstance — interface @experimental
```
enabled: boolean
isSensor: boolean
shape: ColliderShape
```
-## ColliderOutline — interface
+## ColliderOutline — interface @experimental
```
circles: { c: Vec2; r: number; }[]
polylines: Vec2[][]
```
-## ColliderShape — type
+## ColliderShape — type @experimental
```
| { kind: 'box'; halfExtents: Vec2; offset: Vec2 }
| { kind: 'circle'; radius: number; offset: Vec2 }
@@ -1720,14 +1720,14 @@ polylines: Vec2[][]
| { kind: 'chain'; points: Vec2[]; isLoop: boolean }
```
-## CollisionBrush — interface
+## CollisionBrush — interface @experimental
```
collision: ResolvedTileCollision
id: number
key: string
```
-## CollisionEnterEvent — interface
+## CollisionEnterEvent — interface @experimental
```
contactX: number
contactY: number
@@ -1737,7 +1737,7 @@ normalX: number
normalY: number
```
-## CollisionHitEvent — interface
+## CollisionHitEvent — interface @experimental
```
approachSpeed: number
entityA: number
@@ -1748,14 +1748,14 @@ pointX: number
pointY: number
```
-## CollisionMaterial — interface
+## CollisionMaterial — interface @experimental
```
density: number | undefined
friction: number | undefined
restitution: number | undefined
```
-## Color — interface
+## Color — interface @experimental
```
a: number
b: number
@@ -1763,22 +1763,22 @@ g: number
r: number
```
-## ColorRole — type
+## ColorRole — type @experimental
```
keyof ThemeColors
```
-## Commands — function
+## Commands — function @experimental
```
(): CommandsDescriptor
```
-## CommandsDescriptor — interface
+## CommandsDescriptor — interface @experimental
```
_type: "commands"
```
-## CommandsInstance — class
+## CommandsInstance — class @experimental
```
despawn: (entity: Entity) => CommandsInstance
entity: (entity: Entity) => EntityCommands
@@ -1792,18 +1792,18 @@ static new (world: World, resources: ResourceStorage): CommandsInstance
static prototype: CommandsInstance
```
-## CompareOp — type
+## CompareOp — type @experimental
```
'==' | '!=' | '<' | '<=' | '>' | '>=' | 'truthy' | 'falsy'
```
-## CompiledFsm — interface
+## CompiledFsm — interface @experimental
```
initial: string
states: Map<string, FsmState>
```
-## Completable — interface
+## Completable — interface @experimental
```
cancel: () => void
pause: () => void
@@ -1811,14 +1811,14 @@ resume: () => void
state: TweenState
```
-## ComponentData — type
+## ComponentData — type @experimental
```
C extends BuiltinComponentDef<infer T> ? T :
C extends ComponentDef<infer T> ? T :
never
```
-## ComponentDef — interface
+## ComponentDef — interface @experimental
```
_builtin: false
_default: T
@@ -1838,7 +1838,7 @@ skeletalFields: SkeletalFieldMeta | undefined
transient: boolean
```
-## ComponentMetadata — interface
+## ComponentMetadata — interface @experimental
```
animatableFields: string[] | undefined
assetFields: AssetFieldMeta[] | undefined
@@ -1852,7 +1852,7 @@ skeletalFields: SkeletalFieldMeta | undefined
transient: boolean | undefined
```
-## CompressorEffectDef — interface
+## CompressorEffectDef — interface @experimental
```
attack: number | undefined
kneeDb: number | undefined
@@ -1862,14 +1862,14 @@ thresholdDb: number | undefined
type: "compressor"
```
-## ControllerState — interface
+## ControllerState — interface @experimental
```
current: string
name: string
pages: string[]
```
-## CookedAtlasInfo — interface
+## CookedAtlasInfo — interface @experimental
```
frame: { x: number; y: number; width: number; height: number; }
page: number | undefined
@@ -1877,7 +1877,7 @@ pageHeight: number
pageWidth: number
```
-## CppRegistry — interface
+## CppRegistry — interface @experimental
```
addBitmapText: (entity: Entity, component: BitmapText) => void
addBoxCollider: (entity: Entity, component: BoxCollider) => void
@@ -2007,7 +2007,7 @@ setParent: (child: Entity, parent: Entity) => void
valid: (entity: Entity) => boolean
```
-## CppResourceManager — interface
+## CppResourceManager — interface @experimental
```
acquireTextureByPath: (path: string) => number
createLabelAtlasFont: (textureHandle: number, texWidth: number, texHeight: number, chars: string, charWidth: number, charHeight: number) => number
@@ -2039,7 +2039,7 @@ updateTextureSubregion: (handle: number, x: number, y: number, width: number, he
updateTextureSubregionFromBytes: ((handle: number, x: number, y: number, width: number, height: number, pixels: Uint8Array) => void) | undefined
```
-## CreateListViewOptions — interface
+## CreateListViewOptions — interface @experimental
```
background: UIVisualInit | undefined
data: DataSource<T> | readonly T[]
@@ -2058,7 +2058,7 @@ wheelSpeed: number | undefined
world: World
```
-## CreateWebAppOptions — interface
+## CreateWebAppOptions — interface @experimental
```
colorSpace: "gamma" | "linear" | undefined
depthLayers: number | undefined
@@ -2072,109 +2072,109 @@ wasmBaseUrl: string | undefined
ySortLayers: number | undefined
```
-## CullMode — enum
+## CullMode — enum @experimental
```
Back = 1
Front = 2
None = 0
```
-## DARK_TOKENS — const
+## DARK_TOKENS — const @experimental
```
ThemeTokens
```
-## DEFAULT_ANIM_CLIP_PIVOT — const
+## DEFAULT_ANIM_CLIP_PIVOT — const @experimental
```
AnimClipPivotData
```
-## DEFAULT_DESIGN_HEIGHT — const
+## DEFAULT_DESIGN_HEIGHT — const @experimental
```
number
```
-## DEFAULT_DESIGN_WIDTH — const
+## DEFAULT_DESIGN_WIDTH — const @experimental
```
number
```
-## DEFAULT_EDITOR_GRID — const
+## DEFAULT_EDITOR_GRID — const @experimental
```
EditorGridData
```
-## DEFAULT_EDITOR_VIEW — const
+## DEFAULT_EDITOR_VIEW — const @experimental
```
EditorViewData
```
-## DEFAULT_FALLBACK_DT — const
+## DEFAULT_FALLBACK_DT — const @experimental
```
number
```
-## DEFAULT_FIXED_TIMESTEP — const
+## DEFAULT_FIXED_TIMESTEP — const @experimental
```
number
```
-## DEFAULT_FONT_FAMILY — const
+## DEFAULT_FONT_FAMILY — const @experimental
```
"Arial"
```
-## DEFAULT_FONT_SIZE — const
+## DEFAULT_FONT_SIZE — const @experimental
```
24
```
-## DEFAULT_GRAVITY — const
+## DEFAULT_GRAVITY — const @experimental
```
{ x: number; y: number; }
```
-## DEFAULT_LINE_HEIGHT — const
+## DEFAULT_LINE_HEIGHT — const @experimental
```
1.2
```
-## DEFAULT_MAX_DELTA_TIME — const
+## DEFAULT_MAX_DELTA_TIME — const @experimental
```
0.5
```
-## DEFAULT_PIXELS_PER_UNIT — const
+## DEFAULT_PIXELS_PER_UNIT — const @experimental
```
number
```
-## DEFAULT_SCREEN_SCALING — const
+## DEFAULT_SCREEN_SCALING — const @experimental
```
ScreenScalingData
```
-## DEFAULT_SPINE_SKIN — const
+## DEFAULT_SPINE_SKIN — const @experimental
```
"default"
```
-## DEFAULT_SPRITE_SIZE — const
+## DEFAULT_SPRITE_SIZE — const @experimental
```
{ x: number; y: number; }
```
-## DEFAULT_TEXT_CANVAS_SIZE — const
+## DEFAULT_TEXT_CANVAS_SIZE — const @experimental
```
512
```
-## DEFAULT_UI_CAMERA_INFO — const
+## DEFAULT_UI_CAMERA_INFO — const @experimental
```
{ readonly viewProjection: Float32Array<ArrayBuffer>; readonly vpX: 0; readonly vpY: 0; readonly vpW: 0; readonly vpH: 0; readonly screenW: 0; readonly screenH: 0; readonly worldLeft: 0; readonly worldBottom: 0; readonly worldRight: 0; readonly worldTop: 0; readonly worldMouseX: 0; readonly worldMouseY: 0; readonly valid: false; }
```
-## DataSource — interface
+## DataSource — interface @experimental
```
getCount: () => number
getItem: (index: number) => T
@@ -2183,7 +2183,7 @@ getItemType: ((index: number) => string) | undefined
subscribe: ((listener: (change: DataSourceChange) => void) => Unsubscribe) | undefined
```
-## DataSourceChange — type
+## DataSourceChange — type @experimental
```
| { type: 'insert'; index: number; count: number }
| { type: 'remove'; index: number; count: number }
@@ -2191,7 +2191,7 @@ subscribe: ((listener: (change: DataSourceChange) => void) => Unsubscribe) | und
| { type: 'reset' }
```
-## DataType — enum
+## DataType — enum @experimental
```
Float = 1
Float2 = 2
@@ -2203,21 +2203,21 @@ Int3 = 7
Int4 = 8
```
-## DecodedChunk — interface
+## DecodedChunk — interface @experimental
```
tiles: Uint16Array<ArrayBufferLike>
x: number
y: number
```
-## DecodedPixels — interface
+## DecodedPixels — interface @experimental
```
height: number
pixels: Uint8Array<ArrayBufferLike>
width: number
```
-## DeviceIdentity — interface
+## DeviceIdentity — interface @experimental
```
backend: string
renderer: string
@@ -2225,17 +2225,17 @@ vendor: string
version: string
```
-## DeviceLostReason — const
+## DeviceLostReason — const @experimental
```
{ readonly Unknown: 0; readonly ContextLost: 1; readonly OutOfMemory: 2; readonly Reset: 3; readonly Removed: 4; readonly Destroyed: 5; readonly Validation: 6; readonly Internal: 7; }
```
-## DeviceStatus — const
+## DeviceStatus — const @experimental
```
{ readonly Live: 0; readonly Lost: 1; readonly Recovering: 2; readonly Dead: 3; }
```
-## DiagnosticEvent — interface
+## DiagnosticEvent — interface @experimental
```
context: Record<string, unknown> | undefined
count: number
@@ -2248,7 +2248,7 @@ source: string | undefined
stack: string | undefined
```
-## DiagnosticKind — type
+## DiagnosticKind — type @experimental
```
| 'engine'
/** Reached the host with nobody catching it: `window.onerror`,
@@ -2267,7 +2267,7 @@ stack: string | undefined
| 'game'
```
-## DiagnosticReport — interface
+## DiagnosticReport — interface @experimental
```
context: Record<string, unknown> | undefined
error: unknown
@@ -2276,12 +2276,12 @@ message: string
source: string | undefined
```
-## Diagnostics — const
+## Diagnostics — const @experimental
```
ResourceDef<DiagnosticsAPI>
```
-## DiagnosticsAPI — class
+## DiagnosticsAPI — class @experimental
```
clear: () => void
dropped: number
@@ -2295,13 +2295,13 @@ static new (options?: DiagnosticsOptions): DiagnosticsAPI
static prototype: DiagnosticsAPI
```
-## DiagnosticsOptions — interface
+## DiagnosticsOptions — interface @experimental
```
flushIntervalSec: number | undefined
maxDistinct: number | undefined
```
-## DiagnosticsPlugin — class
+## DiagnosticsPlugin — class @experimental
```
build: (app: App) => void
cleanup: (app: App) => void
@@ -2310,19 +2310,19 @@ static new (options_?: DiagnosticsPluginOptions): DiagnosticsPlugin
static prototype: DiagnosticsPlugin
```
-## DiagnosticsPluginOptions — interface
+## DiagnosticsPluginOptions — interface @experimental
```
captureLevel: LogLevel | undefined
flushIntervalSec: number | undefined
maxDistinct: number | undefined
```
-## DiagnosticsSink — type
+## DiagnosticsSink — type @experimental
```
(events: readonly DiagnosticEvent[]) => void
```
-## DialogHandle — interface
+## DialogHandle — interface @experimental
```
close: () => void
dispose: () => void
@@ -2332,7 +2332,7 @@ open: () => void
panelEntity: number
```
-## DialogOptions — interface
+## DialogOptions — interface @experimental
```
backdropNode: UINodeInit | undefined
backdropVisual: UIVisualInit | undefined
@@ -2347,35 +2347,35 @@ startHidden: boolean | undefined
world: World
```
-## DiffOptions — interface
+## DiffOptions — interface @experimental
```
floatEpsilon: number | undefined
ignoreEntityNames: readonly string[] | undefined
ignoreMetadataKeys: readonly string[] | undefined
```
-## Dimension — interface
+## Dimension — interface @experimental
```
unit: number
value: number
```
-## DimensionUnit — type
+## DimensionUnit — type @experimental
```
(typeof DimensionUnit)[keyof typeof DimensionUnit]
```
-## Disabled — const
+## Disabled — const @experimental
```
ComponentDef<{}>
```
-## DistanceJoint — const
+## DistanceJoint — const @experimental
```
ComponentDef<DistanceJointData>
```
-## DragPlugin — class
+## DragPlugin — class @experimental
```
build: (app: App) => void
dependencies: "uiInteraction"[]
@@ -2384,12 +2384,12 @@ static new (): DragPlugin
static prototype: DragPlugin
```
-## DragState — const
+## DragState — const @experimental
```
ComponentDef<DragStateData>
```
-## DragStateData — interface
+## DragStateData — interface @experimental
```
currentWorldPos: { x: number; y: number; }
deltaWorld: { x: number; y: number; }
@@ -2399,12 +2399,12 @@ startWorldPos: { x: number; y: number; }
totalDeltaWorld: { x: number; y: number; }
```
-## Draggable — const
+## Draggable — const @experimental
```
ComponentDef<DraggableData>
```
-## DraggableData — interface
+## DraggableData — interface @experimental
```
constraintMax: { x: number; y: number; } | null
constraintMin: { x: number; y: number; } | null
@@ -2414,17 +2414,17 @@ lockX: boolean
lockY: boolean
```
-## DragonBones — const
+## DragonBones — const @experimental
```
ResourceDef<DragonBonesManager | null>
```
-## DragonBonesAnimation — const
+## DragonBonesAnimation — const @experimental
```
BuiltinComponentDef<DragonBonesAnimationData>
```
-## DragonBonesAnimationData — interface
+## DragonBonesAnimationData — interface @experimental
```
animation: string
armature: string
@@ -2443,7 +2443,7 @@ skeletonScale: number
timeScale: number
```
-## DragonBonesPlugin — class
+## DragonBonesPlugin — class @experimental
```
acquire: () => Promise<DragonBonesManager | null>
build: (app: App) => void
@@ -2454,12 +2454,12 @@ static new (manager?: DragonBonesManager): DragonBonesPlugin
static prototype: DragonBonesPlugin
```
-## Draw — const
+## Draw — const @experimental
```
DrawAPI
```
-## DrawAPI — interface
+## DrawAPI — interface @experimental
```
begin: (viewProjection: Float32Array) => void
circle: (center: Vec2, radius: number, color: Color, filled?: boolean, segments?: number) => void
@@ -2480,7 +2480,7 @@ texture: (position: Vec2, size: Vec2, textureHandle: number, tint?: Color) => vo
textureRotated: (position: Vec2, size: Vec2, rotation: number, textureHandle: number, tint?: Color) => void
```
-## DrawCallInfo — interface
+## DrawCallInfo — interface @experimental
```
blendMode: number
cameraIndex: number
@@ -2508,12 +2508,12 @@ type: RenderType
vertexCount: number
```
-## DrawCallback — type
+## DrawCallback — type @experimental
```
(elapsed: number) => void
```
-## DrawRank — interface
+## DrawRank — interface @experimental
```
layer: number
order: LayerOrder
@@ -2521,7 +2521,7 @@ worldY: number
worldZ: number
```
-## DropShadowFilterOptions — interface
+## DropShadowFilterOptions — interface @experimental
```
blur: number | undefined
color: { r: number; g: number; b: number; a: number; } | undefined
@@ -2530,7 +2530,7 @@ offsetY: number | undefined
texelSize: { x: number; y: number; } | undefined
```
-## DropdownHandle — interface
+## DropdownHandle — interface @experimental
```
close: () => void
dispose: () => void
@@ -2543,7 +2543,7 @@ open: () => void
setSelectedIndex: (index: number) => void
```
-## DropdownOptions — interface
+## DropdownOptions — interface @experimental
```
buttonStates: { normal?: Color; hover?: Color; pressed?: Color; } | undefined
disabled: boolean | undefined
@@ -2560,17 +2560,17 @@ tabIndex: number | undefined
world: World
```
-## EDITOR_UI_ANCHOR — const
+## EDITOR_UI_ANCHOR — const @experimental
```
{ readonly x: 0; readonly y: 0; }
```
-## EDITOR_VIEW_ENTITY — const
+## EDITOR_VIEW_ENTITY — const @experimental
```
-1
```
-## ESEngineModule — interface
+## ESEngineModule — interface @experimental
```
EstellaContext: new () => CppEngineContext
FS: EmscriptenFS
@@ -2792,12 +2792,12 @@ ui_getCullBit: ((registry: CppRegistry, entity: number) => number) | undefined
ui_getRenderOrder: ((registry: CppRegistry, entity: number) => number) | undefined
```
-## EasingType — type
+## EasingType — type @experimental
```
(typeof EasingType)[keyof typeof EasingType]
```
-## EditorAssetType — type
+## EditorAssetType — type @experimental
```
| 'texture' | 'material' | 'shader' | 'spine-atlas' | 'spine-skeleton'
| 'dragonbones-atlas' | 'dragonbones-skeleton'
@@ -2806,7 +2806,7 @@ ui_getRenderOrder: ((registry: CppRegistry, entity: number) => number) | undefin
| 'unknown'
```
-## EditorBridge — interface
+## EditorBridge — interface @experimental
```
onComponentAdded: ((entity: number, component: string) => void) | undefined
onComponentChanged: ((entity: number, component: string) => void) | undefined
@@ -2817,12 +2817,12 @@ onParentChanged: ((child: number, parent: number | null) => void) | undefined
registerComponent: (name: string, defaults: Record<string, unknown>, isTag: boolean) => void
```
-## EditorGrid — const
+## EditorGrid — const @experimental
```
ResourceDef<EditorGridData>
```
-## EditorGridData — interface
+## EditorGridData — interface @experimental
```
axisX: GridColor
axisY: GridColor
@@ -2833,12 +2833,12 @@ majorEvery: number
spacing: number
```
-## EditorView — const
+## EditorView — const @experimental
```
ResourceDef<EditorViewData>
```
-## EditorViewData — interface
+## EditorViewData — interface @experimental
```
active: boolean
distance: number
@@ -2850,7 +2850,7 @@ x: number
y: number
```
-## EffectDef — interface
+## EffectDef — interface @experimental
```
factory: () => ShaderHandle
label: string
@@ -2860,7 +2860,7 @@ type: string
uniforms: EffectUniformDef[]
```
-## EffectUniformDef — interface
+## EffectUniformDef — interface @experimental
```
defaultValue: number
label: string
@@ -2871,18 +2871,18 @@ neutralValue: number | undefined
step: number
```
-## EmbeddedSideModuleEntry — interface
+## EmbeddedSideModuleEntry — interface @experimental
```
glueBase64: string
wasmBase64: string
```
-## EmbeddedSideModuleRegistry — type
+## EmbeddedSideModuleRegistry — type @experimental
```
Partial<Record<SideModuleId, EmbeddedSideModuleEntry>>
```
-## EmitterShape — enum
+## EmitterShape — enum @experimental
```
Circle = 1
Cone = 3
@@ -2890,17 +2890,17 @@ Point = 0
Rectangle = 2
```
-## EngineApi — type
+## EngineApi — type @experimental
```
NativeEngineApi & Partial<NativeHeap>
```
-## Entity — type
+## Entity — type @experimental
```
number
```
-## EntityCommands — class
+## EntityCommands — class @experimental
```
finalize: () => void
id: () => Entity
@@ -2910,7 +2910,7 @@ static new (commands: CommandsInstance, entity: Entity | null, name?: string): E
static prototype: EntityCommands
```
-## EntityEvent — interface
+## EntityEvent — interface @experimental
```
currentTarget: number
data: TData
@@ -2922,12 +2922,12 @@ target: number
type: string
```
-## EntityEventHandler — type
+## EntityEventHandler — type @experimental
```
(event: EntityEvent<TData>) => void
```
-## EntityEventQueue — class
+## EntityEventQueue — class @experimental
```
clear: () => void
drain: () => readonly EntityEvent[]
@@ -2941,22 +2941,22 @@ static new (): EntityEventQueue
static prototype: EntityEventQueue
```
-## EntityEvents — const
+## EntityEvents — const @experimental
```
ResourceDef<EntityEventQueue>
```
-## EventBinding — const
+## EventBinding — const @experimental
```
ComponentDef<EventBindingData>
```
-## EventBindingData — interface
+## EventBindingData — interface @experimental
```
rows: EventBindingRow[]
```
-## EventBindingPlugin — class
+## EventBindingPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -2965,7 +2965,7 @@ static new (): EventBindingPlugin
static prototype: EventBindingPlugin
```
-## EventBindingRow — interface
+## EventBindingRow — interface @experimental
```
action: string
arg: string | undefined
@@ -2977,25 +2977,25 @@ params: Record<string, AiParamValue> | undefined
target: string | undefined
```
-## EventDef — interface
+## EventDef — interface @experimental
```
_id: symbol
_name: string
_phantom: T | undefined
```
-## EventReader — function
+## EventReader — function @experimental
```
<T>(event: EventDef<T>): EventReaderDescriptor<T>
```
-## EventReaderDescriptor — interface
+## EventReaderDescriptor — interface @experimental
```
_event: EventDef<T>
_type: "event_reader"
```
-## EventReaderInstance — class
+## EventReaderInstance — class @experimental
```
isEmpty: () => boolean
toArray: () => T[]
@@ -3003,7 +3003,7 @@ static new <T>(bus: EventBus<T>): EventReaderInstance<T>
static prototype: EventReaderInstance<any>
```
-## EventRegistry — class
+## EventRegistry — class @experimental
```
getBus: <T>(event: EventDef<T>) => EventBus<T>
register: <T>(event: EventDef<T>) => void
@@ -3012,25 +3012,25 @@ static new (): EventRegistry
static prototype: EventRegistry
```
-## EventWriter — function
+## EventWriter — function @experimental
```
<T>(event: EventDef<T>): EventWriterDescriptor<T>
```
-## EventWriterDescriptor — interface
+## EventWriterDescriptor — interface @experimental
```
_event: EventDef<T>
_type: "event_writer"
```
-## EventWriterInstance — class
+## EventWriterInstance — class @experimental
```
send: (event: T) => void
static new <T>(bus: EventBus<T>): EventWriterInstance<T>
static prototype: EventWriterInstance<any>
```
-## ExternalEntityRef — interface
+## ExternalEntityRef — interface @experimental
```
componentType: string
entityId: number
@@ -3038,7 +3038,7 @@ field: string
target: number
```
-## ExtractEntity — interface
+## ExtractEntity — interface @experimental
```
children: number[]
components: ComponentData[]
@@ -3048,12 +3048,12 @@ parent: number | null
visible: boolean | undefined
```
-## FILL_AXIS — const
+## FILL_AXIS — const @experimental
```
Record<LinearFillDirection, readonly [FillMethod, FillOrigin]>
```
-## FieldMeta — interface
+## FieldMeta — interface @experimental
```
advanced: boolean | undefined
bitmask: { bits?: number; source?: string; } | undefined
@@ -3073,7 +3073,7 @@ tooltip: string | undefined
unit: string | undefined
```
-## FillMethod — enum
+## FillMethod — enum @experimental
```
Horizontal = 0
Radial180 = 4
@@ -3082,7 +3082,7 @@ Radial90 = 3
Vertical = 1
```
-## FillOrigin — enum
+## FillOrigin — enum @experimental
```
Bottom = 2
Left = 0
@@ -3090,7 +3090,7 @@ Right = 1
Top = 3
```
-## FilterEffectDef — interface
+## FilterEffectDef — interface @experimental
```
filter: "lowpass" | "highpass" | "bandpass" | "lowshelf" | "highshelf" | "peaking" | "notch"
frequency: number
@@ -3099,7 +3099,7 @@ q: number | undefined
type: "filter"
```
-## FilterExpr — type
+## FilterExpr — type @experimental
```
| { readonly kind: 'with'; readonly component: AnyComponentDef }
| { readonly kind: 'without'; readonly component: AnyComponentDef }
@@ -3108,12 +3108,12 @@ type: "filter"
| { readonly kind: 'not'; readonly filter: FilterExpr }
```
-## Filters — const
+## Filters — const @experimental
```
{ identityMatrix(): number[]; grayscaleMatrix(): number[]; sepiaMatrix(): number[]; brightnessMatrix(value: number): number[]; contrastMatrix(value: number): number[]; saturationMatrix(value: number): number[]; invertMatrix(): number[]; getColorMatrixShader: () => ShaderHandle; colorMatrixUniforms(matrix: number[]): Record<string, number[]>; }
```
-## FlattenContext — interface
+## FlattenContext — interface @experimental
```
allocateId: () => number
depth: number | undefined
@@ -3121,18 +3121,18 @@ loadPrefab: (path: string) => PrefabData | null
visited: Set<string> | undefined
```
-## FlattenResult — interface
+## FlattenResult — interface @experimental
```
entities: ProcessedEntity[]
rootId: number
```
-## FlexContainer — const
+## FlexContainer — const @experimental
```
BuiltinComponentDef<FlexContainerData>
```
-## FlexContainerData — interface
+## FlexContainerData — interface @experimental
```
alignContent: AlignContent
alignItems: AlignItems
@@ -3143,17 +3143,17 @@ padding: Padding
wrap: FlexWrap
```
-## FlexDirection — type
+## FlexDirection — type @experimental
```
(typeof FlexDirection)[keyof typeof FlexDirection]
```
-## FlexWrap — type
+## FlexWrap — type @experimental
```
(typeof FlexWrap)[keyof typeof FlexWrap]
```
-## FlushReason — enum
+## FlushReason — enum @experimental
```
BatchFull = 0
BlendModeChange = 5
@@ -3166,12 +3166,12 @@ TextureSlotsFull = 1
TypeChange = 7
```
-## FocusManager — const
+## FocusManager — const @experimental
```
ResourceDef<FocusManagerState>
```
-## FocusManagerState — class
+## FocusManagerState — class @experimental
```
blur: () => Entity | null
focus: (entity: Entity, visible?: boolean) => Entity | null
@@ -3182,7 +3182,7 @@ static new (): FocusManagerState
static prototype: FocusManagerState
```
-## FocusPlugin — class
+## FocusPlugin — class @experimental
```
build: (app: App) => void
dependencies: "uiInteraction"[]
@@ -3191,23 +3191,23 @@ static new (): FocusPlugin
static prototype: FocusPlugin
```
-## Focusable — const
+## Focusable — const @experimental
```
ComponentDef<FocusableData>
```
-## FocusableData — interface
+## FocusableData — interface @experimental
```
isFocused: boolean
tabIndex: number
```
-## FollowTarget — const
+## FollowTarget — const @experimental
```
ComponentDef<FollowTargetData>
```
-## FollowTargetData — interface
+## FollowTargetData — interface @experimental
```
damping: number
deadzone: number
@@ -3216,12 +3216,12 @@ offsetY: number
target: number
```
-## FontHandle — type
+## FontHandle — type @experimental
```
number
```
-## ForceFieldType — enum
+## ForceFieldType — enum @experimental
```
Directional = 0
Drag = 3
@@ -3229,13 +3229,13 @@ Point = 1
Vortex = 2
```
-## FrameCaptureData — interface
+## FrameCaptureData — interface @experimental
```
cameraCount: number
drawCalls: DrawCallInfo[]
```
-## FrameHistory — class
+## FrameHistory — class @experimental
```
count: number
getAll: () => FrameSnapshot[]
@@ -3246,14 +3246,14 @@ static new (capacity?: number): FrameHistory
static prototype: FrameHistory
```
-## FrameSnapshot — interface
+## FrameSnapshot — interface @experimental
```
frameTimeMs: number
phaseTimings: Map<string, number>
systemTimings: Map<string, number>
```
-## FrameStats — interface
+## FrameStats — interface @experimental
```
culled: number
drawCalls: number
@@ -3269,23 +3269,23 @@ text: number
triangles: number
```
-## FsmActionRef — type
+## FsmActionRef — type @experimental
```
string | { name: string; arg?: string; params?: Record<string, AiParamValue> }
```
-## FsmDefinition — interface
+## FsmDefinition — interface @experimental
```
initial: string
states: FsmState[]
```
-## FsmEdge — type
+## FsmEdge — type @experimental
```
GraphEdge<FsmTransition>
```
-## FsmPlugin — class
+## FsmPlugin — class @experimental
```
build: (app: App) => void
name: string
@@ -3293,14 +3293,14 @@ static new (): FsmPlugin
static prototype: FsmPlugin
```
-## FsmRunState — interface
+## FsmRunState — interface @experimental
```
current: string
entered: boolean
previous: string | null
```
-## FsmState — interface
+## FsmState — interface @experimental
```
name: string
onEnter: FsmActionRef | undefined
@@ -3311,7 +3311,7 @@ x: number | undefined
y: number | undefined
```
-## FsmTransition — interface
+## FsmTransition — interface @experimental
```
condition: string | undefined
guard: BlackboardGuard | BlackboardGuard[] | undefined
@@ -3319,12 +3319,12 @@ to: string
trigger: string | undefined
```
-## GLDebug — const
+## GLDebug — const @experimental
```
{ enable(): void; disable(): void; check(context: string): number; diagnose(): void; }
```
-## GameSocket — class
+## GameSocket — class @experimental
```
close: (code?: number, reason?: string) => void
connect: () => void
@@ -3335,12 +3335,12 @@ static new (options: GameSocketOptions): GameSocket
static prototype: GameSocket
```
-## GameSocketOptions — type
+## GameSocketOptions — type @experimental
```
PlatformSocketOptions
```
-## GamepadAxis — enum
+## GamepadAxis — enum @experimental
```
LeftX = 0
LeftY = 1
@@ -3348,7 +3348,7 @@ RightX = 2
RightY = 3
```
-## GamepadButton — enum
+## GamepadButton — enum @experimental
```
Back = 8
DpadDown = 13
@@ -3369,7 +3369,7 @@ Start = 9
West = 2
```
-## GamepadSnapshot — interface
+## GamepadSnapshot — interface @experimental
```
axes: number[]
buttons: number[]
@@ -3378,7 +3378,7 @@ index: number
mapping: string
```
-## GearBinding — interface
+## GearBinding — interface @experimental
```
component: string
controller: string
@@ -3387,28 +3387,28 @@ property: string
tween: GearTween | undefined
```
-## GearTween — interface
+## GearTween — interface @experimental
```
duration: number
easing: EasingType
```
-## GearValue — type
+## GearValue — type @experimental
```
number | boolean | string | Color | Vec2 | Vec3
```
-## Geometry — const
+## Geometry — const @experimental
```
{ create(options: GeometryOptions): GeometryHandle; updateVertices(handle: GeometryHandle, vertices: Float32Array, offset?: number): void; release(handle: GeometryHandle): void; isValid(handle: GeometryHandle): boolean; createQuad(width?: number, height?: number): GeometryHandle; createCircle(radius?: number, segments?: number): GeometryHandle; createPolygon(points: Array<{ x: number; y: number; }>): GeometryHandle; }
```
-## GeometryHandle — type
+## GeometryHandle — type @experimental
```
number
```
-## GeometryOptions — interface
+## GeometryOptions — interface @experimental
```
dynamic: boolean | undefined
indices: Uint16Array<ArrayBufferLike> | Uint32Array<ArrayBufferLike> | undefined
@@ -3416,7 +3416,7 @@ layout: VertexAttributeDescriptor[]
vertices: Float32Array<ArrayBufferLike>
```
-## GestureDetector — class
+## GestureDetector — class @experimental
```
onLongPress: ((x: number, y: number) => void) | null
onPinch: ((scale: number, centerX: number, centerY: number) => void) | null
@@ -3428,22 +3428,22 @@ static new (input: InputState): GestureDetector
static prototype: GestureDetector
```
-## GetWorld — function
+## GetWorld — function @experimental
```
(): GetWorldDescriptor
```
-## GetWorldDescriptor — interface
+## GetWorldDescriptor — interface @experimental
```
_type: "get_world"
```
-## GpAxis — const
+## GpAxis — const @experimental
```
(axis: number, pad?: number, scale?: number) => Binding
```
-## GpButton — const
+## GpButton — const @experimental
```
(button: number, pad?: number) => Binding
```
@@ -3474,7 +3474,7 @@ _type: "get_world"
'float' | 'vec2' | 'vec3' | 'vec4'
```
-## Graphics — class
+## Graphics — class @experimental
```
arc: (cx: number, cy: number, radius: number, startAngle: number, endAngle: number, anticlockwise?: boolean, segments?: number) => void
beginFill: (color: Color) => void
@@ -3498,12 +3498,12 @@ static new (): Graphics
static prototype: Graphics
```
-## GridColor — type
+## GridColor — type @experimental
```
[number, number, number, number]
```
-## GridLayoutProvider — class
+## GridLayoutProvider — class @experimental
```
getContentSize: (count: number) => Vec2
getItemRect: (index: number) => Rect
@@ -3512,20 +3512,20 @@ static new (opts: GridLayoutOptions): GridLayoutProvider
static prototype: GridLayoutProvider
```
-## HeadlessAppOptions — interface
+## HeadlessAppOptions — interface @experimental
```
plugins: Plugin[] | undefined
sideModules: SideModuleHost | undefined
```
-## HitAreaShape — type
+## HitAreaShape — type @experimental
```
| { type: 'rect'; x: number; y: number; width: number; height: number }
| { type: 'circle'; cx: number; cy: number; radius: number }
| { type: 'polygon'; points: number[] }
```
-## HttpBackend — class
+## HttpBackend — class @experimental
```
fetchBinary: (path: string) => Promise<ArrayBuffer>
fetchText: (path: string) => Promise<string>
@@ -3535,42 +3535,42 @@ static new (options: HttpBackendOptions): HttpBackend
static prototype: HttpBackend
```
-## INTERACTION_CONTROLLER — const
+## INTERACTION_CONTROLLER — const @experimental
```
"$interaction"
```
-## INTERACTION_PAGES — const
+## INTERACTION_PAGES — const @experimental
```
readonly ["normal", "hover", "pressed", "disabled", "focused"]
```
-## INVALID_ENTITY — const
+## INVALID_ENTITY — const @experimental
```
number
```
-## INVALID_FONT — const
+## INVALID_FONT — const @experimental
```
number
```
-## INVALID_MATERIAL — const
+## INVALID_MATERIAL — const @experimental
```
0
```
-## INVALID_TEXTURE — const
+## INVALID_TEXTURE — const @experimental
```
number
```
-## Identity — const
+## Identity — const @experimental
```
ResourceDef<IdentityAPI>
```
-## IdentityAPI — class
+## IdentityAPI — class @experimental
```
available: boolean
login: () => Promise<LoginResult>
@@ -3579,14 +3579,14 @@ static new (): IdentityAPI
static prototype: IdentityAPI
```
-## ImageLoadResult — interface
+## ImageLoadResult — interface @experimental
```
height: number
pixels: Uint8Array<ArrayBufferLike>
width: number
```
-## ImageSegment — interface
+## ImageSegment — interface @experimental
```
height: number
offsetX: number
@@ -3599,7 +3599,7 @@ valign: ImageValign
width: number
```
-## InferParam — type
+## InferParam — type @experimental
```
P extends QueryDescriptor<infer C> ? QueryInstance<C> :
P extends ResDescriptor<infer T> ? T :
@@ -3612,19 +3612,19 @@ P extends QueryDescriptor<infer C> ? QueryInstance<C> :
never
```
-## InferParams — type
+## InferParams — type @experimental
```
{
[K in keyof P]: InferParam<P[K]>;
}
```
-## Input — const
+## Input — const @experimental
```
ResourceDef<InputState>
```
-## InputHandler — interface
+## InputHandler — interface @experimental
```
onKeyDown: ((code: string, mods: Modifiers) => boolean | void) | undefined
onKeyUp: ((code: string, mods: Modifiers) => boolean | void) | undefined
@@ -3638,7 +3638,7 @@ onTouchStart: ((id: number, x: number, y: number) => boolean | void) | undefined
onWheel: ((deltaX: number, deltaY: number, mods: Modifiers) => boolean | void) | undefined
```
-## InputMap — class
+## InputMap — class @experimental
```
actions: () => string[]
axis2d: (name: string) => Vec2
@@ -3662,13 +3662,13 @@ static new (actions: Record<string, ActionDef>): InputMap
static prototype: InputMap
```
-## InputMapAsset — interface
+## InputMapAsset — interface @experimental
```
actions: Record<string, ActionDef>
version: number
```
-## InputPlugin — class
+## InputPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -3677,7 +3677,7 @@ static new (target?: unknown): InputPlugin
static prototype: InputPlugin
```
-## InputRouter — class
+## InputRouter — class @experimental
```
currentMods: Modifiers
dispatchKeyDown: (code: string) => boolean
@@ -3696,7 +3696,7 @@ static new (): InputRouter
static prototype: InputRouter
```
-## InputState — class
+## InputState — class @experimental
```
beginFixedStep: () => void
clearFrameState: () => void
@@ -3755,7 +3755,7 @@ static new (): InputState
static prototype: InputState
```
-## InstantiatePrefabOptions — interface
+## InstantiatePrefabOptions — interface @experimental
```
assetBaseUrl: string | undefined
assets: Assets | undefined
@@ -3763,57 +3763,57 @@ overrides: PrefabOverride[] | undefined
parent: number | undefined
```
-## InstantiatePrefabResult — interface
+## InstantiatePrefabResult — interface @experimental
```
entities: Map<number, number>
root: number
```
-## Interactable — const
+## Interactable — const @experimental
```
BuiltinComponentDef<InteractableData>
```
-## InteractableData — interface
+## InteractableData — interface @experimental
```
blockRaycast: boolean
enabled: boolean
raycastTarget: boolean
```
-## InterestPolicy — type
+## InterestPolicy — type @experimental
```
(view: InterestView) => ReadonlySet<Entity> | 'all'
```
-## InterestView — interface
+## InterestView — interface @experimental
```
candidates: readonly number[]
connectionId: number
world: World
```
-## InterpType — type
+## InterpType — type @experimental
```
(typeof InterpType)[keyof typeof InterpType]
```
-## JsonResult — interface
+## JsonResult — interface @experimental
```
data: T
```
-## JustifyContent — type
+## JustifyContent — type @experimental
```
(typeof JustifyContent)[keyof typeof JustifyContent]
```
-## Key — const
+## Key — const @experimental
```
(code: string) => Binding
```
-## Keyframe — interface
+## Keyframe — interface @experimental
```
inTangent: number
interpolation: InterpType | undefined
@@ -3822,17 +3822,17 @@ time: number
value: number
```
-## Keys1D — const
+## Keys1D — const @experimental
```
(neg: string, pos: string) => Binding
```
-## Keys2D — const
+## Keys2D — const @experimental
```
(up: string, down: string, left: string, right: string) => Binding
```
-## KineticScroll — class
+## KineticScroll — class @experimental
```
beginDrag: () => void
endDrag: () => void
@@ -3847,31 +3847,31 @@ static new (opts?: KineticScrollOptions): KineticScroll
static prototype: KineticScroll
```
-## LIGHT_TOKENS — const
+## LIGHT_TOKENS — const @experimental
```
ThemeTokens
```
-## LayerOrder — enum
+## LayerOrder — enum @experimental
```
Depth = 2
Painter = 0
YSort = 1
```
-## LayoutProvider — interface
+## LayoutProvider — interface @experimental
```
getContentSize: (count: number) => Vec2
getItemRect: (index: number) => Rect
getVisibleRange: (viewport: Rect, count: number) => [start: number, end: number]
```
-## Leaderboard — const
+## Leaderboard — const @experimental
```
ResourceDef<LeaderboardAPI>
```
-## LeaderboardAPI — class
+## LeaderboardAPI — class @experimental
```
available: boolean
dispose: () => void
@@ -3886,7 +3886,7 @@ static new (module_: () => ESEngineModule | null): LeaderboardAPI
static prototype: LeaderboardAPI
```
-## LeaderboardOptions — interface
+## LeaderboardOptions — interface @experimental
```
key: string | undefined
limit: number | undefined
@@ -3895,18 +3895,18 @@ scope: LeaderboardScope | undefined
style: LeaderboardStyle | undefined
```
-## LeaderboardProvider — interface
+## LeaderboardProvider — interface @experimental
```
canvas: () => PlatformCanvas | null
post: (message: Record<string, unknown>) => void
```
-## LeaderboardScope — type
+## LeaderboardScope — type @experimental
```
'friends' | 'group'
```
-## LeaderboardStyle — interface
+## LeaderboardStyle — interface @experimental
```
avatars: boolean | undefined
background: string | undefined
@@ -3918,22 +3918,22 @@ rowHeight: number | undefined
selfColor: string | undefined
```
-## Lifecycle — const
+## Lifecycle — const @experimental
```
ResourceDef<LifecycleManager>
```
-## LifecycleEvent — type
+## LifecycleEvent — type @experimental
```
'show' | 'hide' | 'pause' | 'resume'
```
-## LifecycleListener — type
+## LifecycleListener — type @experimental
```
(event: LifecycleEvent) => void
```
-## LifecycleManager — class
+## LifecycleManager — class @experimental
```
autoPause: boolean
emit_: (event: LifecycleEvent) => void
@@ -3948,7 +3948,7 @@ static new (autoPause?: boolean): LifecycleManager
static prototype: LifecycleManager
```
-## LifecyclePlugin — class
+## LifecyclePlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -3957,17 +3957,17 @@ static new (options_?: LifecyclePluginOptions | undefined): LifecyclePlugin
static prototype: LifecyclePlugin
```
-## LifecyclePluginOptions — interface
+## LifecyclePluginOptions — interface @experimental
```
autoPause: boolean | undefined
```
-## Light2D — const
+## Light2D — const @experimental
```
BuiltinComponentDef<Light2DData>
```
-## Light2DData — interface
+## Light2DData — interface @experimental
```
color: Color
direction: Vec2
@@ -3981,7 +3981,7 @@ shadowSoftness: number
type: number
```
-## Light2DType — enum
+## Light2DType — enum @experimental
```
Ambient = 2
Directional = 1
@@ -3989,12 +3989,12 @@ Point = 0
Spot = 3
```
-## LinearFillDirection — type
+## LinearFillDirection — type @experimental
```
'right' | 'left' | 'up' | 'down'
```
-## LinearLayoutProvider — class
+## LinearLayoutProvider — class @experimental
```
getContentSize: (count: number) => Vec2
getItemRect: (index: number) => Rect
@@ -4003,20 +4003,20 @@ static new (opts: LinearLayoutOptions): LinearLayoutProvider
static prototype: LinearLayoutProvider
```
-## ListItemTemplate — interface
+## ListItemTemplate — interface @experimental
```
bind: (entity: Entity, data: T, index: number) => void
create: (world: World, parent: Entity) => Entity
```
-## ListLayoutSpec — type
+## ListLayoutSpec — type @experimental
```
| { itemHeight: number | ((index: number) => number); spacing?: number; direction?: 'column' }
| { itemWidth: number; spacing?: number; direction: 'row' }
| { columns: number; itemSize: Vec2; spacing?: Vec2 }
```
-## ListView — class
+## ListView — class @experimental
```
dispose: () => void
getContentSize: () => Vec2
@@ -4031,7 +4031,7 @@ static new <T = unknown>(opts: ListViewOptions<T>): ListView<T>
static prototype: ListView<any>
```
-## ListViewHandle — interface
+## ListViewHandle — interface @experimental
```
content: number
data: DataSource<T>
@@ -4044,7 +4044,7 @@ scrollToIndex: (index: number) => void
view: ListView<T>
```
-## ListViewHost — interface
+## ListViewHost — interface @experimental
```
attachScrollContainer: (entity: Entity, container: ScrollContainer) => void
detachScrollContainer: (entity: Entity) => void
@@ -4052,7 +4052,7 @@ registerListView: (list: ListView<unknown>) => void
unregisterListView: (list: ListView<unknown>) => void
```
-## ListViewOptions — interface
+## ListViewOptions — interface @experimental
```
dataSource: DataSource<T>
layout: LayoutProvider
@@ -4066,14 +4066,14 @@ viewportSize: Vec2
world: World
```
-## ListenOptions — interface
+## ListenOptions — interface @experimental
```
gamepad: boolean | undefined
keyboard: boolean | undefined
mouse: boolean | undefined
```
-## LoadRuntimeSceneOptions — interface
+## LoadRuntimeSceneOptions — interface @experimental
```
app: App
module: ESEngineModule | null
@@ -4089,7 +4089,7 @@ uiTheme: "dark" | "light" | undefined
uiThemeOverrides: ThemeOverrides | undefined
```
-## LoadedTilemapLayer — interface
+## LoadedTilemapLayer — interface @experimental
```
chunks: LoadedTilemapChunk[]
height: number
@@ -4099,7 +4099,7 @@ tiles: Uint16Array<ArrayBufferLike>
width: number
```
-## LoadedTilemapSource — interface
+## LoadedTilemapSource — interface @experimental
```
collisionTileIds: number[] | undefined
hexSideLength: number | undefined
@@ -4116,7 +4116,7 @@ tileWidth: number
tilesets: LoadedTilemapTileset[]
```
-## LoadedTilemapTileset — interface
+## LoadedTilemapTileset — interface @experimental
```
columns: number
firstId: number
@@ -4126,52 +4126,52 @@ spacing: number
textureHandle: number
```
-## LocalLeaderboardOptions — interface
+## LocalLeaderboardOptions — interface @experimental
```
friends: readonly CloudPlayer[] | undefined
height: number | undefined
width: number | undefined
```
-## LocalTransform — const
+## LocalTransform — const @experimental
```
BuiltinComponentDef<TransformData>
```
-## LocalTransformData — type
+## LocalTransformData — type @experimental
```
TransformData
```
-## LocaleCatalog — type
+## LocaleCatalog — type @experimental
```
Record<string, LocaleEntry>
```
-## LocaleEntry — type
+## LocaleEntry — type @experimental
```
string | PluralForms
```
-## LocaleResult — interface
+## LocaleResult — interface @experimental
```
keyCount: number
locale: string
```
-## LocaleTableAsset — interface
+## LocaleTableAsset — interface @experimental
```
entries: LocaleCatalog
locale: string
version: number
```
-## Localization — const
+## Localization — const @experimental
```
ResourceDef<LocalizationAPI>
```
-## LocalizationAPI — class
+## LocalizationAPI — class @experimental
```
addCatalog: (locale: string, entries: LocaleCatalog) => void
availableLocales: () => string[]
@@ -4186,7 +4186,7 @@ static new (locale?: string, fallback?: string): LocalizationAPI
static prototype: LocalizationAPI
```
-## LocalizationOptions — interface
+## LocalizationOptions — interface @experimental
```
catalogs: Record<string, LocaleCatalog> | undefined
fallback: string | undefined
@@ -4194,7 +4194,7 @@ locale: string | undefined
tables: string[] | undefined
```
-## LocalizationPlugin — class
+## LocalizationPlugin — class @experimental
```
build: (app: App) => void
name: string
@@ -4202,7 +4202,7 @@ static new (opts?: LocalizationOptions): LocalizationPlugin
static prototype: LocalizationPlugin
```
-## LogEntry — interface
+## LogEntry — interface @experimental
```
category: string
data: unknown
@@ -4211,12 +4211,12 @@ message: string
timestamp: number
```
-## LogHandler — interface
+## LogHandler — interface @experimental
```
handle: (entry: LogEntry) => void
```
-## LogLevel — enum
+## LogLevel — enum @experimental
```
Debug = 0
Error = 3
@@ -4224,7 +4224,7 @@ Info = 1
Warn = 2
```
-## Logger — class
+## Logger — class @experimental
```
addHandler: (handler: LogHandler) => void
clearHandlers: () => void
@@ -4238,17 +4238,17 @@ static new (): Logger
static prototype: Logger
```
-## LoginResult — interface
+## LoginResult — interface @experimental
```
code: string
```
-## LoopMode — type
+## LoopMode — type @experimental
```
(typeof LoopMode)[keyof typeof LoopMode]
```
-## ManifestModel — class
+## ManifestModel — class @experimental
```
allAssets: () => AddressableManifestAsset[]
assetByKey: (key: string) => AddressableManifestAsset | null
@@ -4272,28 +4272,28 @@ static new (manifest: AddressableManifest): ManifestModel
static prototype: ManifestModel
```
-## Marker — const
+## Marker — const @experimental
```
ComponentDef<MarkerData>
```
-## MarkerData — interface
+## MarkerData — interface @experimental
```
properties: Record<string, string>
type: string
```
-## MaskMode — type
+## MaskMode — type @experimental
```
(typeof MaskMode)[keyof typeof MaskMode]
```
-## Material — const
+## Material — const @experimental
```
{ createShader(vertexSrc: string, fragmentSrc: string): ShaderHandle; releaseShader(shader: ShaderHandle): void; create(options: MaterialOptions): MaterialHandle; compileShader(esshaderSource: string, features?: string[]): ShaderHandle; getSwitch(material: MaterialHandle, name: string): boolean; setSwitch(material: MaterialHandle, name: string, on: boolean): void; get(material: MaterialHandle): MaterialData | undefined; setUniform(material: MaterialHandle, name: string, value: UniformValue): void; getUniform(material: MaterialHandle, name: string): UniformValue | undefined; setBlendMode(material: MaterialHandle, mode: BlendMode): void; getBlendMode(material: MaterialHandle): BlendMode; setDepthTest(material: MaterialHandle, enabled: boolean): void; setDepthWrite(material: MaterialHandle, enabled: boolean): void; setCull(material: MaterialHandle, cull: CullMode): void; getShader(material: MaterialHandle): ShaderHandle; release(material: MaterialHandle): void; isValid(material: MaterialHandle): boolean; renderPreview(material: MaterialHandle, w: number, h: number): Promise<ImageData | null>; releaseAll(): void; createFromAsset(data: MaterialAssetData, shaderHandle: ShaderHandle, parentHandle?: MaterialHandle): MaterialHandle; createInstance(source: MaterialHandle): MaterialHandle; toAssetData(material: MaterialHandle, shaderPath: string, parentPath?: string): MaterialAssetData | null; getUniforms(material: MaterialHandle): Map<string, UniformValue>; tex(textureId: number, slot?: number): TextureRef; }
```
-## MaterialAssetData — interface
+## MaterialAssetData — interface @experimental
```
blendMode: number | undefined
cull: number | undefined
@@ -4307,7 +4307,7 @@ type: "material"
version: string
```
-## MaterialData — interface
+## MaterialData — interface @experimental
```
blendMode: BlendMode
cachedBuffer_: Float32Array<ArrayBufferLike> | null
@@ -4341,12 +4341,12 @@ x: number | undefined
y: number | undefined
```
-## MaterialHandle — type
+## MaterialHandle — type @experimental
```
number
```
-## MaterialOptions — interface
+## MaterialOptions — interface @experimental
```
blendMode: BlendMode | undefined
cull: CullMode | undefined
@@ -4357,7 +4357,7 @@ switches: Record<string, boolean> | undefined
uniforms: Record<string, UniformValue> | undefined
```
-## MeasureTextOptions — interface
+## MeasureTextOptions — interface @experimental
```
bold: boolean | undefined
fontFamily: string | undefined
@@ -4368,7 +4368,7 @@ lineHeight: number | undefined
maxWidth: number | undefined
```
-## MeasuredLinearLayoutProvider — class
+## MeasuredLinearLayoutProvider — class @experimental
```
getContentSize: (count: number) => Vec2
getItemRect: (index: number) => Rect
@@ -4378,7 +4378,7 @@ static new (opts: MeasuredLinearLayoutOptions): MeasuredLinearLayoutProvider
static prototype: MeasuredLinearLayoutProvider
```
-## MemoryTransport — class
+## MemoryTransport — class @experimental
```
dropPending: () => void
flush: (limit?: number) => void
@@ -4390,12 +4390,12 @@ static pair: (options?: MemoryTransportOptions) => [MemoryTransport, MemoryTrans
static prototype: MemoryTransport
```
-## Mesh2D — const
+## Mesh2D — const @experimental
```
BuiltinComponentDef<Mesh2DData>
```
-## Mesh2DAPI — class
+## Mesh2DAPI — class @experimental
```
clearGeometry: (entity: Entity) => void
getGeometry: (entity: Entity) => Mesh2DGeometry | undefined
@@ -4404,7 +4404,7 @@ static new (module_: NonNullable<EngineApi>, registry_: CppRegistry): Mesh2DAPI
static prototype: Mesh2DAPI
```
-## Mesh2DData — interface
+## Mesh2DData — interface @experimental
```
color: Color
enabled: boolean
@@ -4416,7 +4416,7 @@ parallax: Vec2
texture: number
```
-## Mesh2DGeometry — interface
+## Mesh2DGeometry — interface @experimental
```
colors: number[] | undefined
indices: number[]
@@ -4424,7 +4424,7 @@ positions: number[]
uvs: number[] | undefined
```
-## Mesh2DPlugin — class
+## Mesh2DPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -4433,24 +4433,24 @@ static new (): Mesh2DPlugin
static prototype: Mesh2DPlugin
```
-## Meshes2D — const
+## Meshes2D — const @experimental
```
ResourceDef<Mesh2DAPI>
```
-## MessageHandler — type
+## MessageHandler — type @experimental
```
(payload: T) => void
```
-## MessagePortLike — interface
+## MessagePortLike — interface @experimental
```
close: (() => void) | undefined
onmessage: ((event: { data: unknown; }) => void) | null
postMessage: (data: unknown) => void
```
-## MessagePortTransport — class
+## MessagePortTransport — class @experimental
```
close: () => void
on: (event: "message", handler: (data: string | ArrayBuffer) => void) => () => void
@@ -4459,7 +4459,7 @@ static new (port: MessagePortLike | MessagePort): MessagePortTransport
static prototype: MessagePortTransport
```
-## MigrationResult — interface
+## MigrationResult — interface @experimental
```
data: PrefabData
fromVersion: string
@@ -4467,7 +4467,7 @@ migrated: boolean
toVersion: string
```
-## MiniGameSocket — class
+## MiniGameSocket — class @experimental
```
close: (code?: number, reason?: string) => void
connect: () => void
@@ -4478,25 +4478,25 @@ static new (options: GameSocketOptions, global: MiniGameGlobal): MiniGameSocket
static prototype: MiniGameSocket
```
-## MissingAssetCallback — type
+## MissingAssetCallback — type @experimental
```
(missing: MissingAsset[]) => void
```
-## MissingAssetsError — class
+## MissingAssetsError — class @experimental
```
missing: MissingAsset[]
static new (missing: MissingAsset[]): MissingAssetsError
static prototype: MissingAssetsError
```
-## MockAdProviderOptions — interface
+## MockAdProviderOptions — interface @experimental
```
completed: boolean | undefined
durationMs: number | undefined
```
-## Modifiers — interface
+## Modifiers — interface @experimental
```
alt: boolean
ctrl: boolean
@@ -4504,22 +4504,22 @@ meta: boolean
shift: boolean
```
-## MotorJoint — const
+## MotorJoint — const @experimental
```
ComponentDef<MotorJointData>
```
-## MouseButton — const
+## MouseButton — const @experimental
```
(button: number) => Binding
```
-## Mut — function
+## Mut — function @experimental
```
<T extends AnyComponentDef>(component: T): MutWrapper<T>
```
-## MutWrapper — interface
+## MutWrapper — interface @experimental
```
_component: T
_type: "mut"
@@ -4530,27 +4530,27 @@ _type: "mut"
Record<GraphNodeType, NodeSpec>
```
-## Name — const
+## Name — const @experimental
```
ComponentDef<NameData>
```
-## NameData — interface
+## NameData — interface @experimental
```
value: string
```
-## Nav — const
+## Nav — const @experimental
```
ResourceDef<Navigation>
```
-## NavAgent — const
+## NavAgent — const @experimental
```
ComponentDef<NavAgentData>
```
-## NavAgentData — interface
+## NavAgentData — interface @experimental
```
arriveRadius: number
arrived: boolean
@@ -4562,7 +4562,7 @@ targetX: number
targetY: number
```
-## NavGrid — class
+## NavGrid — class @experimental
```
cellSize: number
cellToWorld: (gx: number, gy: number) => Vec2
@@ -4582,7 +4582,7 @@ static new (opts: NavGridOptions): NavGrid
static prototype: NavGrid
```
-## NavGridOptions — interface
+## NavGridOptions — interface @experimental
```
cellSize: number
height: number
@@ -4591,7 +4591,7 @@ walkable: ArrayLike<number> | undefined
width: number
```
-## NavPlugin — class
+## NavPlugin — class @experimental
```
build: (app: App) => void
name: string
@@ -4599,7 +4599,7 @@ static new (): NavPlugin
static prototype: NavPlugin
```
-## Navigation — class
+## Navigation — class @experimental
```
findWorldPath: (from: Vec2, to: Vec2, opts?: PathfindOptions & { radius?: number; }) => Vec2[] | null
grid: NavGrid | null
@@ -4609,18 +4609,18 @@ static new (): Navigation
static prototype: Navigation
```
-## NestedPrefabRef — interface
+## NestedPrefabRef — interface @experimental
```
overrides: PrefabOverride[]
prefabPath: string
```
-## Net — const
+## Net — const @experimental
```
ResourceDef<NetSession>
```
-## NetChannel — class
+## NetChannel — class @experimental
```
dispose: (reason?: string) => void
handle: <Req = unknown, Res = unknown>(type: string, handler: RequestHandler<Req, Res>) => () => void
@@ -4633,22 +4633,22 @@ static new (transport: NetTransport, opts?: NetChannelOptions): NetChannel
static prototype: NetChannel
```
-## NetChannelOptions — interface
+## NetChannelOptions — interface @experimental
```
requestTimeoutMs: number | undefined
```
-## NetGhost — const
+## NetGhost — const @experimental
```
ComponentDef<{}>
```
-## NetRoleKind — type
+## NetRoleKind — type @experimental
```
'offline' | 'server' | 'client'
```
-## NetSession — class
+## NetSession — class @experimental
```
client: ReplicationClient | null
connect: (transport: NetTransport, options?: ReplicationClientOptions) => Promise<ReplicationClient>
@@ -4660,7 +4660,7 @@ static new (app_: App): NetSession
static prototype: NetSession
```
-## NetTransport — interface
+## NetTransport — interface @experimental
```
on: (event: "message", handler: (data: string | ArrayBuffer) => void) => () => void
send: (data: string | ArrayBuffer) => void
@@ -4688,39 +4688,39 @@ output: GraphType | null
params: NodeParamSpec[]
```
-## Not — function
+## Not — function @experimental
```
(filter: FilterExpr): FilterExpr
```
-## OneWayPlatform — const
+## OneWayPlatform — const @experimental
```
ComponentDef<OneWayPlatformData>
```
-## Or — function
+## Or — function @experimental
```
(...filters: FilterExpr[]): FilterExpr
```
-## OutlineFilterOptions — interface
+## OutlineFilterOptions — interface @experimental
```
color: { r: number; g: number; b: number; a: number; } | undefined
texelSize: { x: number; y: number; } | undefined
width: number | undefined
```
-## PREFAB_FORMAT_VERSION — const
+## PREFAB_FORMAT_VERSION — const @experimental
```
"2"
```
-## PTR_LAYOUTS — const
+## PTR_LAYOUTS — const @experimental
```
Record<string, PtrLayout>
```
-## PackagedAssetIndex — interface
+## PackagedAssetIndex — interface @experimental
```
addressOf: (ref: string) => string | null
assetPaths: () => string[]
@@ -4731,13 +4731,13 @@ resolvePath: (ref: string) => string
textureImport: (ref: string) => ParsedTextureImportSettings | undefined
```
-## PackagedAssetSourceOptions — interface
+## PackagedAssetSourceOptions — interface @experimental
```
backend: Backend | undefined
decodePixels: ((path: string, flip: boolean) => Promise<{ width: number; height: number; pixels: Uint8Array; }>) | undefined
```
-## PackagedGameConfig — interface
+## PackagedGameConfig — interface @experimental
```
achievements: string[] | undefined
audioConfig: AudioProjectConfig | undefined
@@ -4756,17 +4756,17 @@ uiThemeColors: Record<string, string> | undefined
ySortLayers: number | undefined
```
-## Parent — const
+## Parent — const @experimental
```
BuiltinComponentDef<ParentData>
```
-## ParentData — interface
+## ParentData — interface @experimental
```
entity: number
```
-## ParsedTextureImportSettings — interface
+## ParsedTextureImportSettings — interface @experimental
```
filter: "linear" | "nearest" | undefined
sliceBorder: { left: number; right: number; top: number; bottom: number; } | undefined
@@ -4774,12 +4774,12 @@ srgb: boolean | undefined
wrap: "repeat" | "clamp" | "mirror" | undefined
```
-## Particle — const
+## Particle — const @experimental
```
ResourceDef<ParticleAPI>
```
-## ParticleAPI — class
+## ParticleAPI — class @experimental
```
getAliveCount: (entity: Entity) => number
play: (entity: Entity) => void
@@ -4792,7 +4792,7 @@ static new (module: NonNullable<EngineApi>, registry: CppRegistry): ParticleAPI
static prototype: ParticleAPI
```
-## ParticleEasing — enum
+## ParticleEasing — enum @experimental
```
EaseIn = 1
EaseInOut = 3
@@ -4800,12 +4800,12 @@ EaseOut = 2
Linear = 0
```
-## ParticleEmitter — const
+## ParticleEmitter — const @experimental
```
BuiltinComponentDef<ParticleEmitterData>
```
-## ParticleEmitterData — interface
+## ParticleEmitterData — interface @experimental
```
angleSpreadMax: number
angleSpreadMin: number
@@ -4869,12 +4869,12 @@ trailPoints: number
trailWidth: number
```
-## ParticleForceField — const
+## ParticleForceField — const @experimental
```
BuiltinComponentDef<ParticleForceFieldData>
```
-## ParticleForceFieldData — interface
+## ParticleForceFieldData — interface @experimental
```
direction: Vec2
enabled: boolean
@@ -4884,7 +4884,7 @@ strength: number
type: number
```
-## ParticlePlugin — class
+## ParticlePlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -4893,19 +4893,19 @@ static new (): ParticlePlugin
static prototype: ParticlePlugin
```
-## PathfindOptions — interface
+## PathfindOptions — interface @experimental
```
clearance: number | undefined
diagonal: boolean | undefined
snapRadius: number | undefined
```
-## Payment — const
+## Payment — const @experimental
```
ResourceDef<PaymentAPI>
```
-## PaymentAPI — class
+## PaymentAPI — class @experimental
```
available: boolean
request: (request: PaymentRequest) => Promise<void>
@@ -4913,33 +4913,33 @@ static new (): PaymentAPI
static prototype: PaymentAPI
```
-## PaymentFailure — interface
+## PaymentFailure — interface @experimental
```
code: number | undefined
```
-## PaymentRequest — type
+## PaymentRequest — type @experimental
```
PlatformPaymentRequest
```
-## Perceiver — const
+## Perceiver — const @experimental
```
ComponentDef<PerceiverData>
```
-## PerceiverData — interface
+## PerceiverData — interface @experimental
```
fovDegrees: number
range: number
```
-## Perception — const
+## Perception — const @experimental
```
ComponentDef<PerceptionData>
```
-## PerceptionData — interface
+## PerceptionData — interface @experimental
```
dirX: number
dirY: number
@@ -4949,7 +4949,7 @@ targetY: number
visible: boolean
```
-## PerceptionPlugin — class
+## PerceptionPlugin — class @experimental
```
build: (app: App) => void
name: string
@@ -4957,34 +4957,34 @@ static new (): PerceptionPlugin
static prototype: PerceptionPlugin
```
-## PerceptionTarget — const
+## PerceptionTarget — const @experimental
```
ComponentDef<{}>
```
-## Physics — const
+## Physics — const @experimental
```
ResourceDef<PhysicsAPI>
```
-## PhysicsContactEventData — interface
+## PhysicsContactEventData — interface @experimental
```
approachSpeed: number | undefined
isSensor: boolean | undefined
other: number
```
-## PhysicsEventType — type
+## PhysicsEventType — type @experimental
```
typeof PhysicsEventType[keyof typeof PhysicsEventType]
```
-## PhysicsEvents — const
+## PhysicsEvents — const @experimental
```
ResourceDef<PhysicsEventsData>
```
-## PhysicsEventsData — interface
+## PhysicsEventsData — interface @experimental
```
collisionEnters: CollisionEnterEvent[]
collisionExits: { entityA: Entity; entityB: Entity; }[]
@@ -4993,12 +4993,12 @@ sensorEnters: SensorEvent[]
sensorExits: SensorEvent[]
```
-## PhysicsModuleFactory — type
+## PhysicsModuleFactory — type @experimental
```
(config?: Record<string, unknown>) => Promise<PhysicsWasmModule>
```
-## PhysicsPlugin — class
+## PhysicsPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -5007,7 +5007,7 @@ static new (wasmUrl: string, config?: PhysicsPluginConfig, factory?: PhysicsModu
static prototype: PhysicsPlugin
```
-## PhysicsPluginConfig — interface
+## PhysicsPluginConfig — interface @experimental
```
collisionLayerMasks: number[] | undefined
contactDampingRatio: number | undefined
@@ -5022,7 +5022,7 @@ restitutionThreshold: number | undefined
subStepCount: number | undefined
```
-## PhysicsWasmModule — interface
+## PhysicsWasmModule — interface @experimental
```
HEAPF32: Float32Array<ArrayBufferLike>
HEAPU32: Uint32Array<ArrayBufferLike>
@@ -5145,7 +5145,7 @@ _physics_step: (dt: number) => void
_physics_updateBodyProperties: (entityId: number, bodyType: number, gravityScale: number, linearDamping: number, angularDamping: number, fixedRotation: number, bullet: number) => void
```
-## PlatformAdapter — interface
+## PlatformAdapter — interface @experimental
```
bindInputEvents: (callbacks: InputEventCallbacks, target?: unknown) => void
canPay: (() => boolean) | undefined
@@ -5200,7 +5200,7 @@ unbindInputEvents: (() => void) | undefined
writeCacheFile: ((key: string, bytes: ArrayBuffer) => Promise<void>) | undefined
```
-## PlatformAudioBackend — interface
+## PlatformAudioBackend — interface @experimental
```
dispose: () => void
ensureResumed: () => Promise<void>
@@ -5217,14 +5217,14 @@ suspend: () => void
unloadBuffer: (handle: AudioBufferHandle) => void
```
-## PlatformCanvas — interface
+## PlatformCanvas — interface @experimental
```
getContext: (contextId: "2d", options?: PlatformCanvasContextAttributes) => PlatformCanvas2DContext | null
height: number
width: number
```
-## PlatformCanvas2DContext — interface
+## PlatformCanvas2DContext — interface @experimental
```
clearRect: (x: number, y: number, w: number, h: number) => void
drawImage: (image: PlatformImageSource, dx: number, dy: number) => void
@@ -5237,7 +5237,7 @@ textAlign: string
textBaseline: string
```
-## PlatformImage — interface
+## PlatformImage — interface @experimental
```
crossOrigin: string | null | undefined
height: number
@@ -5247,7 +5247,7 @@ src: string
width: number
```
-## PlatformRequestOptions — interface
+## PlatformRequestOptions — interface @experimental
```
body: string | ArrayBuffer | undefined
headers: Record<string, string> | undefined
@@ -5256,7 +5256,7 @@ responseType: "json" | "text" | "arraybuffer" | undefined
timeout: number | undefined
```
-## PlatformResponse — interface
+## PlatformResponse — interface @experimental
```
arrayBuffer: () => Promise<ArrayBuffer>
headers: Record<string, string>
@@ -5267,7 +5267,7 @@ statusText: string
text: () => Promise<string>
```
-## PlatformSocket — interface
+## PlatformSocket — interface @experimental
```
close: (code?: number, reason?: string) => void
connect: () => void
@@ -5276,7 +5276,7 @@ readyState: PlatformSocketReadyState
send: (data: string | ArrayBuffer) => void
```
-## PlatformSocketEvents — interface
+## PlatformSocketEvents — interface @experimental
```
close: [code: number, reason: string]
error: [error: unknown]
@@ -5284,30 +5284,30 @@ message: [data: string | ArrayBuffer]
open: []
```
-## PlatformSocketOptions — interface
+## PlatformSocketOptions — interface @experimental
```
protocols: string | string[] | undefined
url: string
```
-## PlatformSocketReadyState — type
+## PlatformSocketReadyState — type @experimental
```
'connecting' | 'open' | 'closing' | 'closed'
```
-## PlatformType — type @deprecated
+## PlatformType — type @experimental @deprecated
```
PlatformName
```
-## PlatformVideoBackend — interface
+## PlatformVideoBackend — interface @experimental
```
createStream: (url: string, options: VideoStreamOptions) => VideoStreamHandle
dispose: () => void
name: string
```
-## PlayConfig — interface
+## PlayConfig — interface @experimental
```
bus: string | undefined
loop: boolean | undefined
@@ -5318,7 +5318,7 @@ startOffset: number | undefined
volume: number | undefined
```
-## PlayRealmRuntimeConfig — interface
+## PlayRealmRuntimeConfig — interface @experimental
```
achievements: string[] | undefined
app: App
@@ -5343,12 +5343,12 @@ uiThemeOverrides: ThemeOverrides | undefined
wasmBaseUrl: string | undefined
```
-## PlayableAdBridge — interface
+## PlayableAdBridge — interface @experimental
```
cta: (() => void) | undefined
```
-## PlayableRuntimeConfig — interface
+## PlayableRuntimeConfig — interface @experimental
```
app: App
assetPathMap: Record<string, string> | undefined
@@ -5367,7 +5367,7 @@ uiThemeOverrides: ThemeOverrides | undefined
ySortLayers: number | undefined
```
-## Plugin — interface
+## Plugin — interface @experimental
```
after: string[] | undefined
before: string[] | undefined
@@ -5378,17 +5378,17 @@ finish: ((app: App) => void) | undefined
name: string | undefined
```
-## PluginDependency — type
+## PluginDependency — type @experimental
```
string | ResourceDef<any>
```
-## PluralCategory — type
+## PluralCategory — type @experimental
```
'zero' | 'one' | 'two' | 'few' | 'many' | 'other'
```
-## PluralForms — interface
+## PluralForms — interface @experimental
```
few: string | undefined
many: string | undefined
@@ -5398,17 +5398,17 @@ two: string | undefined
zero: string | undefined
```
-## PluralSelector — type
+## PluralSelector — type @experimental
```
(count: number) => PluralCategory
```
-## PolygonCollider — const
+## PolygonCollider — const @experimental
```
ComponentDef<PolygonColliderData>
```
-## PooledAudioNode — interface
+## PooledAudioNode — interface @experimental
```
gain: GainNode
inUse: boolean
@@ -5417,12 +5417,12 @@ source: AudioBufferSourceNode | null
startTime: number
```
-## PostProcess — const
+## PostProcess — const @experimental
```
ResourceDef<PostProcessAPI>
```
-## PostProcessAPI — class
+## PostProcessAPI — class @experimental
```
_applyForCamera: (camera: Entity) => void
_applyScreenStack: () => void
@@ -5451,7 +5451,7 @@ static new (): PostProcessAPI
static prototype: PostProcessAPI
```
-## PostProcessPlugin — class
+## PostProcessPlugin — class @experimental
```
build: (app: App) => void
cleanup: (app?: App) => void
@@ -5460,7 +5460,7 @@ static new (): PostProcessPlugin
static prototype: PostProcessPlugin
```
-## PostProcessStack — class
+## PostProcessStack — class @experimental
```
addPass: (name: string, shader: ShaderHandle) => PostProcessStack
clearDirty: () => void
@@ -5482,12 +5482,12 @@ static new (state: PostProcessState): PostProcessStack
static prototype: PostProcessStack
```
-## PostProcessVolume — const
+## PostProcessVolume — const @experimental
```
ComponentDef<PostProcessVolumeData>
```
-## PostProcessVolumeData — interface
+## PostProcessVolumeData — interface @experimental
```
blendDistance: number
effects: { type: string; enabled: boolean; uniforms: Record<string, number>; textures?: Record<string, string>; }[]
@@ -5498,38 +5498,38 @@ size: { x: number; y: number; }
weight: number
```
-## PreSceneDrawCallback — type
+## PreSceneDrawCallback — type @experimental
```
(info: PreSceneDrawInfo) => void
```
-## PreSceneDrawInfo — interface
+## PreSceneDrawInfo — interface @experimental
```
elapsed: number
height: number
width: number
```
-## PredictionOptions — interface
+## PredictionOptions — interface @experimental
```
apply: (world: World, entity: Entity, actions: Record<string, unknown>, dt: number) => void
maxPendingInputs: number | undefined
smoothing: PredictionSmoothing | undefined
```
-## PredictionSmoothing — interface
+## PredictionSmoothing — interface @experimental
```
halfLife: number
maxError: number | undefined
```
-## PrefabComponentData — interface
+## PrefabComponentData — interface @experimental
```
data: Record<string, unknown>
type: string
```
-## PrefabData — interface
+## PrefabData — interface @experimental
```
basePrefab: string | undefined
entities: PrefabEntityData[]
@@ -5539,7 +5539,7 @@ rootEntityId: string
version: string
```
-## PrefabDiagnostic — interface
+## PrefabDiagnostic — interface @experimental
```
code: string
entityId: string | undefined
@@ -5548,12 +5548,12 @@ message: string
severity: PrefabDiagnosticSeverity
```
-## PrefabDiagnosticSeverity — type
+## PrefabDiagnosticSeverity — type @experimental
```
'error' | 'warning'
```
-## PrefabEntityData — interface
+## PrefabEntityData — interface @experimental
```
children: string[]
components: ComponentData[]
@@ -5565,12 +5565,12 @@ prefabEntityId: string
visible: boolean
```
-## PrefabEntityId — type
+## PrefabEntityId — type @experimental
```
string
```
-## PrefabInstanceDelta — interface
+## PrefabInstanceDelta — interface @experimental
```
added: AddedEntity[]
overrides: PrefabOverride[]
@@ -5578,7 +5578,7 @@ prefab: string
removed: string[]
```
-## PrefabInstanceEntry — interface
+## PrefabInstanceEntry — interface @experimental
```
added: AddedEntity[]
id: number
@@ -5588,7 +5588,7 @@ prefab: string
removed: string[]
```
-## PrefabOverride — interface
+## PrefabOverride — interface @experimental
```
componentData: ComponentData | undefined
componentType: string | undefined
@@ -5599,19 +5599,19 @@ type: "property" | "component_added" | "component_replaced" | "component_removed
value: unknown
```
-## PrefabServer — class
+## PrefabServer — class @experimental
```
instantiate: (pathOrAddress: string, options?: { baseUrl?: string; parent?: Entity; overrides?: SpawnOverride[]; scene?: boolean; }) => Promise<InstantiatePrefabResult>
static new (world: World, getAssets: () => AssetsClass, getScenes?: () => SceneManagerState | null): PrefabServer
static prototype: PrefabServer
```
-## Prefabs — const
+## Prefabs — const @experimental
```
ResourceDef<PrefabServer>
```
-## PrefabsPlugin — class
+## PrefabsPlugin — class @experimental
```
build: (app: App) => void
dependencies: ResourceDef<AssetsClass>[]
@@ -5620,7 +5620,7 @@ static new (): PrefabsPlugin
static prototype: PrefabsPlugin
```
-## PreviewPlugin — class
+## PreviewPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -5630,18 +5630,18 @@ static new (sceneUrl: string, baseUrl?: string): PreviewPlugin
static prototype: PreviewPlugin
```
-## PrismaticJoint — const
+## PrismaticJoint — const @experimental
```
ComponentDef<PrismaticJointData>
```
-## ProbedRegistrations — interface
+## ProbedRegistrations — interface @experimental
```
fingerprint: string
pending: PendingSystemEntry[]
```
-## ProcessedEntity — interface
+## ProcessedEntity — interface @experimental
```
children: number[]
components: ComponentData[]
@@ -5653,7 +5653,7 @@ prefabEntityId: string
visible: boolean
```
-## ProgressHandle — interface
+## ProgressHandle — interface @experimental
```
dispose: () => void
entity: number
@@ -5662,7 +5662,7 @@ getValue: () => number
setValue: (v: number) => void
```
-## ProgressOptions — interface
+## ProgressOptions — interface @experimental
```
background: UIVisualInit | undefined
direction: LinearFillDirection | undefined
@@ -5674,19 +5674,19 @@ value: number | undefined
world: World
```
-## ProjectionType — enum
+## ProjectionType — enum @experimental
```
Orthographic = 1
Perspective = 0
```
-## PropertyChannel — interface
+## PropertyChannel — interface @experimental
```
keyframes: Keyframe[]
property: string
```
-## PropertyTrack — interface
+## PropertyTrack — interface @experimental
```
channels: PropertyChannel[]
childPath: string
@@ -5695,13 +5695,13 @@ name: string
type: "property"
```
-## PtrLayout — interface
+## PtrLayout — interface @experimental
```
fields: readonly PtrFieldDesc[]
ptrFn: string
```
-## Quat — interface
+## Quat — interface @experimental
```
w: number
x: number
@@ -5709,12 +5709,12 @@ y: number
z: number
```
-## Query — function
+## Query — function @experimental
```
<C extends QueryArg[]>(...components: C): QueryBuilder<C>
```
-## QueryBuilder — interface
+## QueryBuilder — interface @experimental
```
_addedFilters: { index: number; component: AnyComponentDef; }[]
_changedFilters: { index: number; component: AnyComponentDef; }[]
@@ -5729,7 +5729,7 @@ with: (...components: AnyComponentDef[]) => QueryBuilder<C>
without: (...components: AnyComponentDef[]) => QueryBuilder<C>
```
-## QueryDescriptor — interface
+## QueryDescriptor — interface @experimental
```
_addedFilters: { index: number; component: AnyComponentDef; }[]
_changedFilters: { index: number; component: AnyComponentDef; }[]
@@ -5741,7 +5741,7 @@ _with: AnyComponentDef[]
_without: AnyComponentDef[]
```
-## QueryInstance — class
+## QueryInstance — class @experimental
```
count: () => number
forEach: (callback: (entity: Entity, ...components: ComponentsData<C>) => void) => void
@@ -5753,7 +5753,7 @@ static new <C extends readonly QueryArg[]>(world: World, descriptor: QueryDescri
static prototype: QueryInstance<any>
```
-## QueryResult — type
+## QueryResult — type @experimental
```
[
Entity,
@@ -5761,44 +5761,44 @@ static prototype: QueryInstance<any>
]
```
-## REPLICATION_CHANNEL — const
+## REPLICATION_CHANNEL — const @experimental
```
1
```
-## REPLICATION_PROTOCOL_VERSION — const
+## REPLICATION_PROTOCOL_VERSION — const @experimental
```
2
```
-## RETIRED_COMPONENT_TYPES — const
+## RETIRED_COMPONENT_TYPES — const @experimental
```
ReadonlySet<string>
```
-## RadiusInterestOptions — interface
+## RadiusInterestOptions — interface @experimental
```
position: ((world: World, entity: Entity) => { x: number; y: number; } | null) | undefined
```
-## ReadonlySignal — interface
+## ReadonlySignal — interface @experimental
```
get: () => T
subscribe: (fn: (value: T) => void) => () => void
```
-## Removed — function
+## Removed — function @experimental
```
<T extends AnyComponentDef>(component: T): RemovedQueryDescriptor<T>
```
-## RemovedQueryDescriptor — interface
+## RemovedQueryDescriptor — interface @experimental
```
_component: T
_type: "removed"
```
-## RemovedQueryInstance — class
+## RemovedQueryInstance — class @experimental
```
isEmpty: () => boolean
resetTick: (tick: number) => void
@@ -5807,7 +5807,7 @@ static new <T extends AnyComponentDef>(world: World, component: T, lastRunTick:
static prototype: RemovedQueryInstance<any>
```
-## RenderParams — interface
+## RenderParams — interface @experimental
```
clearColor: { x: number; y: number; z: number; w: number; } | undefined
elapsed: number
@@ -5817,7 +5817,7 @@ viewProjection: Float32Array<ArrayBufferLike>
width: number
```
-## RenderPipeline — class
+## RenderPipeline — class @experimental
```
addPreFlushCallback: (cb: (registry: { _cpp: CppRegistry; }) => void) => void
beginFrame: (elapsedSec?: number) => void
@@ -5833,7 +5833,7 @@ static new (): RenderPipeline
static prototype: RenderPipeline
```
-## RenderStage — enum
+## RenderStage — enum @experimental
```
Background = 0
Opaque = 1
@@ -5841,7 +5841,7 @@ Overlay = 3
Transparent = 2
```
-## RenderStats — interface
+## RenderStats — interface @experimental
```
culled: number
drawCalls: number
@@ -5852,24 +5852,24 @@ text: number
triangles: number
```
-## RenderSurfaceSource — type
+## RenderSurfaceSource — type @experimental
```
| { readonly kind: 'gl-context'; readonly handle: number }
| { readonly kind: 'webgpu'; readonly canvasSelector?: string }
| { readonly kind: 'default' }
```
-## RenderTargetHandle — type
+## RenderTargetHandle — type @experimental
```
number
```
-## RenderTexture — const
+## RenderTexture — const @experimental
```
{ create(options: RenderTextureOptions): RenderTextureHandle; release(rt: RenderTextureHandle): void; resize(rt: RenderTextureHandle, width: number, height: number): RenderTextureHandle; begin(rt: RenderTextureHandle, viewProjection: Float32Array): void; end(): void; getDepthTexture(rt: RenderTextureHandle): number; }
```
-## RenderTextureHandle — interface
+## RenderTextureHandle — interface @experimental
```
_depth: boolean
_filter: "linear" | "nearest"
@@ -5880,7 +5880,7 @@ textureId: number
width: number
```
-## RenderTextureOptions — interface
+## RenderTextureOptions — interface @experimental
```
depth: boolean | undefined
filter: "linear" | "nearest" | undefined
@@ -5888,7 +5888,7 @@ height: number
width: number
```
-## RenderType — enum
+## RenderType — enum @experimental
```
ExternalMesh = 3
Mesh = 2
@@ -5900,23 +5900,23 @@ Text = 4
UIElement = 7
```
-## Renderer — const
+## Renderer — const @experimental
```
{ init(width: number, height: number): void; resize(width: number, height: number): void; beginFrame(elapsedSec?: number): void; updateTransforms(registry: { _cpp: CppRegistry; }): void; begin(viewProjection: Float32Array, target?: RenderTargetHandle, clearFlags?: number, clearColor?: { x: number; y: number; z: number; w: number; }, clearRect?: { x: number; y: number; w: number; h: number; }): void; flush(): void; end(): void; submitAll(registry: { _cpp: CppRegistry; }, skipFlags: number, vpX: number, vpY: number, vpW: number, vpH: number): void; setStage(stage: RenderStage): void; createRenderTarget(width: number, height: number, flags?: number): RenderTargetHandle; releaseRenderTarget(handle: RenderTargetHandle): void; getTargetTexture(handle: RenderTargetHandle): number; getTargetDepthTexture(handle: RenderTargetHandle): number; setClearColor(r: number, g: number, b: number, a: number): void; setViewport(x: number, y: number, w: number, h: number): void; setYSortLayers(mask: number): void; setDepthLayers(mask: number): void; setCullingMask(mask: number): void; setTextureParams(textureId: number, minFilter: number, magFilter: number, wrapS: number, wrapT: number): void; measureBitmapText(fontHandle: number, text: string, fontSize: number, spacing: number): { width: number; height: number; }; getStats(): RenderStats; captureNextFrame(): void; getCapturedData(): FrameCaptureData | null; hasCapturedData(): boolean; replayToDrawCall(drawCallIndex: number): void; getSnapshotImageData(): Promise<ImageData | null>; }
```
-## Replicated — const
+## Replicated — const @experimental
```
ComponentDef<ReplicatedData>
```
-## ReplicatedData — interface
+## ReplicatedData — interface @experimental
```
netId: number
owner: number
```
-## ReplicationClient — class
+## ReplicationClient — class @experimental
```
applyPending: () => void
connect: (transport: NetTransport) => Promise<void>
@@ -5936,7 +5936,7 @@ static new (world: World, options?: ReplicationClientOptions): ReplicationClient
static prototype: ReplicationClient
```
-## ReplicationPlugin — class
+## ReplicationPlugin — class @experimental
```
build: (app: App) => void
name: string
@@ -5944,7 +5944,7 @@ static new (): ReplicationPlugin
static prototype: ReplicationPlugin
```
-## ReplicationServer — class
+## ReplicationServer — class @experimental
```
attachConnection: (transport: NetTransport) => number
beginTick: (fixedDelta: number) => void
@@ -5961,34 +5961,34 @@ static new (world: World): ReplicationServer
static prototype: ReplicationServer
```
-## RequestHandler — type
+## RequestHandler — type @experimental
```
(payload: Req) => Res | Promise<Res>
```
-## Res — function
+## Res — function @experimental
```
<T>(resource: ResourceDef<T>): ResDescriptor<T>
```
-## ResDescriptor — interface
+## ResDescriptor — interface @experimental
```
_resource: ResourceDef<T>
_type: "res"
```
-## ResMut — function
+## ResMut — function @experimental
```
<T>(resource: ResourceDef<T>): ResMutDescriptor<T>
```
-## ResMutDescriptor — interface
+## ResMutDescriptor — interface @experimental
```
_resource: ResourceDef<T>
_type: "res_mut"
```
-## ResMutInstance — class
+## ResMutInstance — class @experimental
```
get: () => T
modify: (fn: (value: T) => void) => void
@@ -5998,20 +5998,20 @@ static new <T>(value: T, setter: (v: T) => void): ResMutInstance<T>
static prototype: ResMutInstance<any>
```
-## ResolvedAssetGroup — interface
+## ResolvedAssetGroup — interface @experimental
```
alwaysInclude: boolean
delivery: BundleMode
name: string
```
-## ResolvedAtlas — interface
+## ResolvedAtlas — interface @experimental
```
folder: string
name: string
```
-## ResolvedTileCollision — interface
+## ResolvedTileCollision — interface @experimental
```
density: number | undefined
friction: number | undefined
@@ -6021,7 +6021,7 @@ sensor: boolean | undefined
shape: { type: "box"; } | { type: "polygon"; points: [number, number][]; } | { type: "circle"; cx: number; cy: number; r: number; }
```
-## ResolvedTileset — interface
+## ResolvedTileset — interface @experimental
```
asset: TilesetAsset
textureHandle: number
@@ -6029,14 +6029,14 @@ textureHeight: number | undefined
textureWidth: number | undefined
```
-## ResourceDef — interface
+## ResourceDef — interface @experimental
```
_default: T
_id: symbol
_name: string
```
-## ResourceStats — interface
+## ResourceStats — interface @experimental
```
cacheHits: number
cacheMisses: number
@@ -6049,7 +6049,7 @@ textureEvictableCount: number
vertexBufferCount: number
```
-## ReverbEffectDef — interface
+## ReverbEffectDef — interface @experimental
```
decay: number | undefined
seconds: number | undefined
@@ -6057,22 +6057,22 @@ type: "reverb"
wet: number | undefined
```
-## RevoluteJoint — const
+## RevoluteJoint — const @experimental
```
ComponentDef<RevoluteJointData>
```
-## RichTextRun — type
+## RichTextRun — type @experimental
```
TextSegment | ImageSegment
```
-## RigidBody — const
+## RigidBody — const @experimental
```
BuiltinComponentDef<RigidBodyData>
```
-## RigidBodyData — interface
+## RigidBodyData — interface @experimental
```
angularDamping: number
bodyType: number
@@ -6083,12 +6083,12 @@ gravityScale: number
linearDamping: number
```
-## RunCondition — type
+## RunCondition — type @experimental
```
() => boolean
```
-## RuntimeAssetSource — interface
+## RuntimeAssetSource — interface @experimental
```
backend: Backend
decodePixels: (path: string, flip: boolean) => Promise<{ width: number; height: number; pixels: Uint8Array; }>
@@ -6098,7 +6098,7 @@ resolveRef: ((ref: string) => string) | undefined
textureImportSettings: ((ref: string) => ParsedTextureImportSettings | undefined) | undefined
```
-## RuntimeBuildConfig — interface
+## RuntimeBuildConfig — interface @experimental
```
assetFailureCooldown: number | undefined
assetLoadTimeout: number | undefined
@@ -6114,12 +6114,12 @@ textCanvasSize: number | undefined
textureCacheBudget: number | undefined
```
-## RuntimeConfig — const
+## RuntimeConfig — const @experimental
```
{ sceneTransitionDuration: number; sceneTransitionColor: { r: number; g: number; b: number; a: number; }; defaultFontFamily: string; canvasScaleMode: number; canvasMatchWidthOrHeight: number; maxDeltaTime: number; maxFixedSteps: number; textCanvasSize: number; assetLoadTimeout: number; assetFailureCooldown: number; textureCacheBudget: number; audioCacheBudget: number; }
```
-## RuntimeInitConfig — interface
+## RuntimeInitConfig — interface @experimental
```
achievements: string[] | undefined
app: App
@@ -6144,42 +6144,42 @@ uiTheme: "dark" | "light" | undefined
uiThemeOverrides: ThemeOverrides | undefined
```
-## RuntimeOnly — const
+## RuntimeOnly — const @experimental
```
ComponentDef<{}>
```
-## SCENE_FORMAT_VERSION — const
+## SCENE_FORMAT_VERSION — const @experimental
```
1
```
-## SCREEN_FIT_OFF — const
+## SCREEN_FIT_OFF — const @experimental
```
-1
```
-## SIDE_MODULES — const
+## SIDE_MODULES — const @experimental
```
Record<BuiltinSideModuleId, SideModuleDescriptor>
```
-## SPINE_VERSIONS — const
+## SPINE_VERSIONS — const @experimental
```
readonly SpineVersion[]
```
-## STATE_PATH_SEP — const
+## STATE_PATH_SEP — const @experimental
```
"/"
```
-## SafeArea — const
+## SafeArea — const @experimental
```
ComponentDef<SafeAreaData>
```
-## SafeAreaData — interface
+## SafeAreaData — interface @experimental
```
applyBottom: boolean
applyLeft: boolean
@@ -6187,7 +6187,7 @@ applyRight: boolean
applyTop: boolean
```
-## SafeAreaPlugin — class
+## SafeAreaPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -6197,33 +6197,33 @@ static new (): SafeAreaPlugin
static prototype: SafeAreaPlugin
```
-## SampleDeps — interface
+## SampleDeps — interface @experimental
```
getComponent: (name: string) => AnyComponentDef | undefined
resolveChild: (root: Entity, childPath: string) => Entity | null
world: SampleWorld
```
-## SampleOptions — interface
+## SampleOptions — interface @experimental
```
skipChannel: ((childPath: string, component: string, property: string) => boolean) | undefined
```
-## SampleWorld — interface
+## SampleWorld — interface @experimental
```
get: (entity: Entity, def: AnyComponentDef) => Record<string, unknown>
has: (entity: Entity, def: AnyComponentDef) => boolean
set: (entity: Entity, def: AnyComponentDef, data: Record<string, unknown>) => void
```
-## SaveEnvelope — interface
+## SaveEnvelope — interface @experimental
```
data: T
savedAt: number
version: number
```
-## SaveManager — class
+## SaveManager — class @experimental
```
has: (slot: string) => boolean
load: <T>(slot: string) => T | null
@@ -6234,7 +6234,7 @@ static new (opts: SaveManagerOptions): SaveManager
static prototype: SaveManager
```
-## SaveManagerOptions — interface
+## SaveManagerOptions — interface @experimental
```
keyPrefix: string | undefined
migrations: Record<number, SaveMigration> | undefined
@@ -6243,12 +6243,12 @@ storage: SaveStorage | undefined
version: number
```
-## SaveMigration — type
+## SaveMigration — type @experimental
```
(data: unknown) => unknown
```
-## SaveStorage — interface
+## SaveStorage — interface @experimental
```
getJSON: <T>(key: string, defaultValue?: T) => T | undefined
has: (key: string) => boolean
@@ -6256,12 +6256,12 @@ remove: (key: string) => void
setJSON: <T>(key: string, value: T) => void
```
-## ScaleMode — type
+## ScaleMode — type @experimental
```
(typeof ScaleMode)[keyof typeof ScaleMode]
```
-## SceneAssetRefs — interface
+## SceneAssetRefs — interface @experimental
```
byType: Map<string, Set<string>>
dragonBones: SpineAssetRef[]
@@ -6271,20 +6271,20 @@ spines: SpineAssetRef[]
unresolved: string[]
```
-## SceneComponentCodec — interface
+## SceneComponentCodec — interface @experimental
```
exportData: ((entity: number, data: Record<string, unknown>) => void) | undefined
importData: ((entity: number, outOfBand: Record<string, unknown>) => void) | undefined
outOfBandFields: readonly string[] | undefined
```
-## SceneComponentData — interface
+## SceneComponentData — interface @experimental
```
data: Record<string, unknown>
type: string
```
-## SceneConfig — interface
+## SceneConfig — interface @experimental
```
cleanup: ((ctx: SceneContext) => void) | undefined
data: SceneData | undefined
@@ -6294,7 +6294,7 @@ setup: ((ctx: SceneContext) => void | Promise<void>) | undefined
systems: { schedule: Schedule; system: SystemDef; }[] | undefined
```
-## SceneContext — interface
+## SceneContext — interface @experimental
```
adopt: (entity: Entity) => void
bindPostProcess: (camera: Entity, stack: PostProcessStack) => void
@@ -6308,7 +6308,7 @@ trackAssets: (byType: ReadonlyMap<string, ReadonlySet<string>>) => void
unbindPostProcess: (camera: Entity) => void
```
-## SceneData — interface
+## SceneData — interface @experimental
```
entities: SceneEntityData[]
generator: string | undefined
@@ -6317,7 +6317,7 @@ textureMetadata: Record<string, TextureMetadata> | undefined
version: string | number
```
-## SceneEntityData — interface
+## SceneEntityData — interface @experimental
```
children: number[]
components: SceneComponentData[]
@@ -6327,13 +6327,13 @@ parent: number | null
visible: boolean | undefined
```
-## SceneLoadCancelled — class
+## SceneLoadCancelled — class @experimental
```
static new (name: string): SceneLoadCancelled
static prototype: SceneLoadCancelled
```
-## SceneLoadOptions — interface
+## SceneLoadOptions — interface @experimental
```
abortOnMissingAssets: boolean | undefined
assetBaseUrl: string | undefined
@@ -6343,17 +6343,17 @@ onMissingAssets: MissingAssetCallback | undefined
onProgress: SceneLoadProgressCallback | undefined
```
-## SceneLoadProgressCallback — type
+## SceneLoadProgressCallback — type @experimental
```
(loaded: number, total: number) => void
```
-## SceneManager — const
+## SceneManager — const @experimental
```
ResourceDef<SceneManagerState>
```
-## SceneManagerState — class
+## SceneManagerState — class @experimental
```
bringToTop: (name: string) => void
getActive: () => string | null
@@ -6385,7 +6385,7 @@ static new (app: App): SceneManagerState
static prototype: SceneManagerState
```
-## SceneMigrationResult — interface
+## SceneMigrationResult — interface @experimental
```
data: SceneData
fromVersion: number
@@ -6393,23 +6393,23 @@ migrated: boolean
toVersion: number
```
-## SceneOwner — const
+## SceneOwner — const @experimental
```
ComponentDef<SceneOwnerData>
```
-## SceneOwnerData — interface
+## SceneOwnerData — interface @experimental
```
persistent: boolean
scene: string
```
-## SceneStatus — type
+## SceneStatus — type @experimental
```
'loading' | 'running' | 'paused' | 'sleeping' | 'unloading'
```
-## SceneStreamHost — interface
+## SceneStreamHost — interface @experimental
```
isLoaded: (name: string) => boolean
isSleeping: (name: string) => boolean
@@ -6419,19 +6419,19 @@ unload: (name: string) => Promise<void>
wake: (name: string) => void
```
-## SceneStreaming — const
+## SceneStreaming — const @experimental
```
ResourceDef<SceneStreamingController>
```
-## SceneStreamingConfig — interface
+## SceneStreamingConfig — interface @experimental
```
loadRadius: number
policy: StreamPolicy | undefined
unloadRadius: number
```
-## SceneStreamingController — class
+## SceneStreamingController — class @experimental
```
clear: () => void
configure: (config: SceneStreamingConfig) => void
@@ -6446,7 +6446,7 @@ static new (host: SceneStreamHost, config?: SceneStreamingConfig): SceneStreamin
static prototype: SceneStreamingController
```
-## Schedule — enum
+## Schedule — enum @experimental
```
First = 1
FixedPostUpdate = 12
@@ -6459,7 +6459,7 @@ Startup = 0
Update = 3
```
-## ScreenInfo — class
+## ScreenInfo — class @experimental
```
dpr: number
height: number
@@ -6471,19 +6471,19 @@ static new (): ScreenInfo
static prototype: ScreenInfo
```
-## ScreenInfoEvents — interface
+## ScreenInfoEvents — interface @experimental
```
orientationchange: [orientation: ScreenOrientation]
resize: [width: number, height: number]
```
-## ScreenOrientation — enum
+## ScreenOrientation — enum @experimental
```
Landscape = "landscape"
Portrait = "portrait"
```
-## ScreenRect — interface
+## ScreenRect — interface @experimental
```
h: number
w: number
@@ -6491,12 +6491,12 @@ x: number
y: number
```
-## ScreenScaling — const
+## ScreenScaling — const @experimental
```
ResourceDef<ScreenScalingData>
```
-## ScreenScalingData — interface
+## ScreenScalingData — interface @experimental
```
designHeight: number
designWidth: number
@@ -6504,7 +6504,7 @@ matchWidthOrHeight: number
scaleMode: number
```
-## ScrollContainer — class
+## ScrollContainer — class @experimental
```
dispose: () => void
getContentSize: () => Vec2
@@ -6524,7 +6524,7 @@ static new (opts: ScrollContainerOptions): ScrollContainer
static prototype: ScrollContainer
```
-## ScrollViewHandle — interface
+## ScrollViewHandle — interface @experimental
```
content: number
dispose: () => void
@@ -6534,7 +6534,7 @@ scrollTo: (offset: Vec2) => void
setContentSize: (size: Vec2) => void
```
-## ScrollViewOptions — interface
+## ScrollViewOptions — interface @experimental
```
background: UIVisualInit | undefined
contentSize: Vec2
@@ -6550,12 +6550,12 @@ wheelSpeed: number | undefined
world: World
```
-## SegmentCollider — const
+## SegmentCollider — const @experimental
```
BuiltinComponentDef<SegmentColliderData>
```
-## SenseResult — interface
+## SenseResult — interface @experimental
```
dirX: number
dirY: number
@@ -6563,13 +6563,13 @@ distance: number
visible: boolean
```
-## SensorEvent — interface
+## SensorEvent — interface @experimental
```
sensorEntity: number
visitorEntity: number
```
-## ServicesPlugin — class
+## ServicesPlugin — class @experimental
```
build: (app: App) => void
name: string
@@ -6577,12 +6577,12 @@ static new (): ServicesPlugin
static prototype: ServicesPlugin
```
-## ShaderHandle — type
+## ShaderHandle — type @experimental
```
number
```
-## ShaderParam — interface
+## ShaderParam — interface @experimental
```
default: number[]
defaultTexture: string | undefined
@@ -6593,39 +6593,39 @@ type: ShaderParamType
ui: string | undefined
```
-## ShaderParamType — type
+## ShaderParamType — type @experimental
```
'float' | 'vec2' | 'vec3' | 'vec4' | 'color' | 'int' | 'texture'
```
-## ShaderReflection — interface
+## ShaderReflection — interface @experimental
```
domain: string
params: ShaderParam[]
```
-## ShaderSources — const
+## ShaderSources — const @experimental
```
{ SPRITE_VERTEX: string; SPRITE_FRAGMENT: string; COLOR_VERTEX: string; COLOR_FRAGMENT: string; }
```
-## ShadowCaster2D — const
+## ShadowCaster2D — const @experimental
```
BuiltinComponentDef<ShadowCaster2DData>
```
-## ShadowCaster2DData — interface
+## ShadowCaster2DData — interface @experimental
```
enabled: boolean
size: Vec2
```
-## ShapeRenderer — const
+## ShapeRenderer — const @experimental
```
BuiltinComponentDef<ShapeRendererData>
```
-## ShapeRendererData — interface
+## ShapeRendererData — interface @experimental
```
color: Color
cornerRadius: number
@@ -6636,19 +6636,19 @@ shapeType: number
size: Vec2
```
-## ShapeType — enum
+## ShapeType — enum @experimental
```
Capsule = 1
Circle = 0
RoundedRect = 2
```
-## Share — const
+## Share — const @experimental
```
ResourceDef<ShareAPI>
```
-## ShareAPI — class
+## ShareAPI — class @experimental
```
available: boolean
setShareCard: (card: ShareCard | (() => ShareCard)) => void
@@ -6657,28 +6657,28 @@ static new (): ShareAPI
static prototype: ShareAPI
```
-## ShareCard — type
+## ShareCard — type @experimental
```
PlatformShareOptions
```
-## SideModuleDescriptor — interface
+## SideModuleDescriptor — interface @experimental
```
file: string
globalName: string | undefined
```
-## SideModuleHost — interface
+## SideModuleHost — interface @experimental
```
acquire: (id: SideModuleId) => Promise<SideModule | null>
```
-## SideModuleId — type
+## SideModuleId — type @experimental
```
BuiltinSideModuleId | (string & {})
```
-## Signal — interface
+## Signal — interface @experimental
```
get: () => T
set: (value: T) => void
@@ -6686,13 +6686,13 @@ subscribe: (fn: (value: T) => void) => () => void
update: (fn: (prev: T) => T) => void
```
-## SimulationSpace — enum
+## SimulationSpace — enum @experimental
```
Local = 1
World = 0
```
-## SliceBorder — interface
+## SliceBorder — interface @experimental
```
bottom: number
left: number
@@ -6700,7 +6700,7 @@ right: number
top: number
```
-## SliderHandle — interface
+## SliderHandle — interface @experimental
```
dispose: () => void
entity: number
@@ -6711,7 +6711,7 @@ setValue: (value: number) => void
trackEntity: number
```
-## SliderOptions — interface
+## SliderOptions — interface @experimental
```
disabled: boolean | undefined
events: UIEventQueue
@@ -6731,19 +6731,19 @@ value: number | undefined
world: World
```
-## SocketReadyState — type
+## SocketReadyState — type @experimental
```
PlatformSocketReadyState
```
-## SourceDelta — interface
+## SourceDelta — interface @experimental
```
added: readonly AddedEntity[]
overrides: readonly PrefabOverride[]
removed: readonly string[]
```
-## SpatialAudioConfig — interface
+## SpatialAudioConfig — interface @experimental
```
maxDistance: number
model: AttenuationModel
@@ -6751,22 +6751,22 @@ refDistance: number
rolloff: number
```
-## SpawnOverride — type
+## SpawnOverride — type @experimental
```
Omit<PrefabOverride, 'prefabEntityId'> & { prefabEntityId?: string }
```
-## Spine — const
+## Spine — const @experimental
```
ResourceDef<SpineManager>
```
-## SpineAnimation — const
+## SpineAnimation — const @experimental
```
BuiltinComponentDef<SpineAnimationData>
```
-## SpineAnimationData — interface
+## SpineAnimationData — interface @experimental
```
animation: string
atlasPath: string
@@ -6784,23 +6784,23 @@ skin: string
timeScale: number
```
-## SpineAnimationDriver — interface
+## SpineAnimationDriver — interface @experimental
```
setAnimation: (entity: Entity, animation: string, loop: boolean) => void
```
-## SpineEvents — const
+## SpineEvents — const @experimental
```
ResourceDef<SpineEventsData>
```
-## SpineLoadResult — interface
+## SpineLoadResult — interface @experimental
```
error: string | undefined
success: boolean
```
-## SpinePlugin — class
+## SpinePlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -6812,7 +6812,7 @@ static new (manager?: SpineManager): SpinePlugin
static prototype: SpinePlugin
```
-## SpineTrack — interface
+## SpineTrack — interface @experimental
```
blendIn: number
childPath: string
@@ -6821,12 +6821,12 @@ name: string
type: "spine"
```
-## Sprite — const
+## Sprite — const @experimental
```
BuiltinComponentDef<SpriteData>
```
-## SpriteAnimClip — interface
+## SpriteAnimClip — interface @experimental
```
events: SpriteAnimEvent[] | undefined
fps: number
@@ -6836,19 +6836,19 @@ loop: boolean
name: string
```
-## SpriteAnimEvent — interface
+## SpriteAnimEvent — interface @experimental
```
data: unknown
frame: number
name: string
```
-## SpriteAnimEventHandler — type
+## SpriteAnimEventHandler — type @experimental
```
(event: SpriteAnimEvent, entity: Entity) => void
```
-## SpriteAnimFrame — interface
+## SpriteAnimFrame — interface @experimental
```
duration: number | undefined
pivot: { x: number; y: number; } | undefined
@@ -6857,7 +6857,7 @@ uvOffset: { x: number; y: number; } | undefined
uvScale: { x: number; y: number; } | undefined
```
-## SpriteAnimTrack — interface
+## SpriteAnimTrack — interface @experimental
```
childPath: string
clip: string
@@ -6866,12 +6866,12 @@ startTime: number
type: "spriteAnim"
```
-## SpriteAnimation — const
+## SpriteAnimation — const @experimental
```
ResourceDef<SpriteAnimationAPI>
```
-## SpriteAnimationAPI — class
+## SpriteAnimationAPI — class @experimental
```
aliasClip: (name: string, clip: SpriteAnimClip) => void
clearClips: () => void
@@ -6888,12 +6888,12 @@ static new (): SpriteAnimationAPI
static prototype: SpriteAnimationAPI
```
-## SpriteAnimator — const
+## SpriteAnimator — const @experimental
```
ComponentDef<SpriteAnimatorData>
```
-## SpriteAnimatorData — interface
+## SpriteAnimatorData — interface @experimental
```
clip: string
currentFrame: number
@@ -6905,7 +6905,7 @@ playing: boolean
speed: number
```
-## SpriteData — interface
+## SpriteData — interface @experimental
```
color: Color
enabled: boolean
@@ -6924,12 +6924,12 @@ uvOffset: Vec2
uvScale: Vec2
```
-## SpriteFilter — const
+## SpriteFilter — const @experimental
```
{ createOutline(options?: OutlineFilterOptions): MaterialHandle; createGlow(options?: OutlineFilterOptions): MaterialHandle; createDropShadow(options?: DropShadowFilterOptions): MaterialHandle; setOutlineColor(material: MaterialHandle, color: { r: number; g: number; b: number; a: number; }): void; setOutlineWidth(material: MaterialHandle, width: number): void; setShadowOffset(material: MaterialHandle, x: number, y: number): void; setShadowBlur(material: MaterialHandle, blur: number): void; }
```
-## StaleOverride — interface
+## StaleOverride — interface @experimental
```
nestedAt: string | undefined
override: PrefabOverride
@@ -6937,18 +6937,18 @@ reason: string
site: "variant" | "nested" | "instance"
```
-## StateMachineAgent — const
+## StateMachineAgent — const @experimental
```
ComponentDef<StateMachineAgentData>
```
-## StateMachineAgentData — interface
+## StateMachineAgentData — interface @experimental
```
current: string
fsm: string
```
-## StateMachines — class
+## StateMachines — class @experimental
```
blackboard: (entity: Entity) => Blackboard
fire: (entity: Entity, trigger: string) => void
@@ -6957,12 +6957,12 @@ static new (states: Map<Entity, AgentState>): StateMachines
static prototype: StateMachines
```
-## Stats — const
+## Stats — const @experimental
```
ResourceDef<FrameStats>
```
-## StatsCollector — class
+## StatsCollector — class @experimental
```
getFps: () => number
getFrameTimeMs: () => number
@@ -6972,7 +6972,7 @@ static new (): StatsCollector
static prototype: StatsCollector
```
-## StatsOverlay — class
+## StatsOverlay — class @experimental
```
dispose: () => void
hide: () => void
@@ -6982,7 +6982,7 @@ static new (container: HTMLElement, position?: StatsPosition): StatsOverlay
static prototype: StatsOverlay
```
-## StatsPlugin — class
+## StatsPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -6991,36 +6991,36 @@ static new (options?: StatsPluginOptions): StatsPlugin
static prototype: StatsPlugin
```
-## StatsPluginOptions — interface
+## StatsPluginOptions — interface @experimental
```
container: HTMLElement | undefined
overlay: boolean | undefined
position: StatsPosition | undefined
```
-## StatsPosition — type
+## StatsPosition — type @experimental
```
'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'
```
-## Status — enum
+## Status — enum @experimental
```
Failure = "failure"
Running = "running"
Success = "success"
```
-## Stick — const
+## Stick — const @experimental
```
(stick: "left" | "right", pad?: number) => Binding
```
-## Storage — const
+## Storage — const @experimental
```
{ getString(key: string, defaultValue?: string): string | undefined; setString(key: string, value: string): void; getNumber(key: string, defaultValue?: number): number | undefined; setNumber(key: string, value: number): void; getBoolean(key: string, defaultValue?: boolean): boolean | undefined; setBoolean(key: string, value: boolean): void; getJSON<T>(key: string, defaultValue?: T): T | undefined; setJSON<T>(key: string, value: T): void; remove(key: string): void; has(key: string): boolean; clear(): void; }
```
-## StreamCell — interface
+## StreamCell — interface @experimental
```
radius: number
scene: string
@@ -7028,34 +7028,34 @@ x: number
y: number
```
-## StreamDecision — interface
+## StreamDecision — interface @experimental
```
toActivate: string[]
toDeactivate: string[]
```
-## StreamPolicy — type
+## StreamPolicy — type @experimental
```
'unload' | 'sleep'
```
-## SubEmitterTrigger — enum
+## SubEmitterTrigger — enum @experimental
```
Birth = 1
Death = 0
```
-## SubmitSkipFlags — const
+## SubmitSkipFlags — const @experimental
```
{ readonly None: 0; readonly Spine: 1; readonly Particles: 2; }
```
-## SubsystemActivity — type
+## SubsystemActivity — type @experimental
```
'stepping' | 'idle' | 'inactive'
```
-## SubsystemEvent — interface
+## SubsystemEvent — interface @experimental
```
atMs: number
detail: string | undefined
@@ -7064,12 +7064,12 @@ phase: SubsystemPhase
seq: number
```
-## SubsystemPhase — type
+## SubsystemPhase — type @experimental
```
'registered' | 'initializing' | 'ready' | 'error'
```
-## SubsystemRegistry — class
+## SubsystemRegistry — class @experimental
```
getStatuses: () => SubsystemStatus[]
markError: (id: string, reason?: string) => void
@@ -7083,7 +7083,7 @@ static new (): SubsystemRegistry
static prototype: SubsystemRegistry
```
-## SubsystemStatus — interface
+## SubsystemStatus — interface @experimental
```
activity: SubsystemActivity
dependsOn: readonly string[]
@@ -7095,17 +7095,17 @@ phase: SubsystemPhase
phaseAgeMs: number
```
-## SwipeDirection — type
+## SwipeDirection — type @experimental
```
'left' | 'right' | 'up' | 'down'
```
-## SyncPrefabResolver — type
+## SyncPrefabResolver — type @experimental
```
(path: string) => PrefabData | null
```
-## SystemDef — interface
+## SystemDef — interface @experimental
```
_fn: (...args: never[]) => void | Promise<void>
_id: symbol
@@ -7115,14 +7115,14 @@ _runAfter: readonly string[] | undefined
_runBefore: readonly string[] | undefined
```
-## SystemOptions — interface
+## SystemOptions — interface @experimental
```
name: string | undefined
runAfter: string[] | undefined
runBefore: string[] | undefined
```
-## SystemParam — type
+## SystemParam — type @experimental
```
| QueryDescriptor<readonly QueryArg[]>
| ResDescriptor<unknown>
@@ -7134,7 +7134,7 @@ runBefore: string[] | undefined
| GetWorldDescriptor
```
-## SystemRunner — class
+## SystemRunner — class @experimental
```
clearTimings: () => void
evict: (systemId: symbol) => void
@@ -7146,7 +7146,7 @@ static new (world: World, resources: ResourceStorage, eventRegistry?: EventRegis
static prototype: SystemRunner
```
-## SystemSet — interface
+## SystemSet — interface @experimental
```
_kind: "set"
_name: string
@@ -7156,7 +7156,7 @@ _runIf: RunCondition | undefined
_systems: readonly SystemDef[]
```
-## SystemSetOptions — interface
+## SystemSetOptions — interface @experimental
```
runAfter: string[] | undefined
runBefore: string[] | undefined
@@ -7164,92 +7164,92 @@ runIf: RunCondition | undefined
systems: SystemDef[]
```
-## TB_E — const
+## TB_E — const @experimental
```
2
```
-## TB_N — const
+## TB_N — const @experimental
```
1
```
-## TB_NE — const
+## TB_NE — const @experimental
```
16
```
-## TB_NW — const
+## TB_NW — const @experimental
```
128
```
-## TB_S — const
+## TB_S — const @experimental
```
4
```
-## TB_SE — const
+## TB_SE — const @experimental
```
32
```
-## TB_SW — const
+## TB_SW — const @experimental
```
64
```
-## TB_W — const
+## TB_W — const @experimental
```
8
```
-## TERRAIN_NEIGHBORS — const
+## TERRAIN_NEIGHBORS — const @experimental
```
readonly { dx: number; dy: number; bit: number; }[]
```
-## THEME_COLOR_ROLES — const
+## THEME_COLOR_ROLES — const @experimental
```
readonly (keyof ThemeColors)[]
```
-## TILESET_FORMAT_VERSION — const
+## TILESET_FORMAT_VERSION — const @experimental
```
"1"
```
-## TILE_FLAGS_MASK — const
+## TILE_FLAGS_MASK — const @experimental
```
number
```
-## TILE_FLIP_D — const
+## TILE_FLIP_D — const @experimental
```
32768
```
-## TILE_FLIP_H — const
+## TILE_FLIP_H — const @experimental
```
8192
```
-## TILE_FLIP_V — const
+## TILE_FLIP_V — const @experimental
```
16384
```
-## TILE_ID_MASK — const
+## TILE_ID_MASK — const @experimental
```
8191
```
-## TParams — type
+## TParams — type @experimental
```
Record<string, string | number>
```
-## Takeover — interface
+## Takeover — interface @experimental
```
active: boolean
around: <T>(show: () => Promise<T>) => Promise<T>
@@ -7257,7 +7257,7 @@ begin: () => void
end: () => void
```
-## TakeoverHost — interface
+## TakeoverHost — interface @experimental
```
isPaused: () => boolean
resumeAudio: () => void
@@ -7265,40 +7265,40 @@ setPaused: (paused: boolean) => void
suspendAudio: () => void
```
-## TerrainColor — interface
+## TerrainColor — interface @experimental
```
color: string
name: string
```
-## TerrainIndex — interface
+## TerrainIndex — interface @experimental
```
byMask: Map<number, number>
mode: TerrainMode
```
-## TerrainIndices — interface
+## TerrainIndices — interface @experimental
```
sets: Map<number, TerrainIndex>
tileTerrain: Map<number, number>
```
-## TerrainMode — type
+## TerrainMode — type @experimental
```
'edge' | 'corner' | 'wang'
```
-## Text — const
+## Text — const @experimental
```
ComponentDef<TextData>
```
-## TextAlign — type
+## TextAlign — type @experimental
```
(typeof TextAlign)[keyof typeof TextAlign]
```
-## TextData — interface
+## TextData — interface @experimental
```
align: TextAlign
bold: boolean
@@ -7325,7 +7325,7 @@ verticalAlign: TextVerticalAlign
wordWrap: boolean
```
-## TextInit — interface
+## TextInit — interface @experimental
```
align: TextAlign | undefined
bold: boolean | undefined
@@ -7352,12 +7352,12 @@ verticalAlign: TextVerticalAlign | undefined
wordWrap: boolean | undefined
```
-## TextInput — const
+## TextInput — const @experimental
```
ComponentDef<TextInputData>
```
-## TextInputData — interface
+## TextInputData — interface @experimental
```
backgroundColor: Color
color: Color
@@ -7379,7 +7379,7 @@ textAlign: TextAlign
value: string
```
-## TextInputHandle — interface
+## TextInputHandle — interface @experimental
```
dispose: () => void
entity: number
@@ -7387,7 +7387,7 @@ getValue: () => string
setValue: (value: string) => void
```
-## TextInputOptions — interface
+## TextInputOptions — interface @experimental
```
backgroundColor: Color | undefined
color: Color | undefined
@@ -7412,7 +7412,7 @@ value: string | undefined
world: World
```
-## TextInputPlugin — class
+## TextInputPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -7422,19 +7422,19 @@ static new (): TextInputPlugin
static prototype: TextInputPlugin
```
-## TextMetrics — interface
+## TextMetrics — interface @experimental
```
height: number
lineCount: number
width: number
```
-## TextOverflow — type
+## TextOverflow — type @experimental
```
(typeof TextOverflow)[keyof typeof TextOverflow]
```
-## TextPlugin — class
+## TextPlugin — class @experimental
```
build: (app: App) => void
name: string
@@ -7442,12 +7442,12 @@ static new (): TextPlugin
static prototype: TextPlugin
```
-## TextRenderMode — type
+## TextRenderMode — type @experimental
```
(typeof TextRenderMode)[keyof typeof TextRenderMode]
```
-## TextSegment — interface
+## TextSegment — interface @experimental
```
bold: boolean
color: Color | null
@@ -7457,46 +7457,46 @@ text: string
type: "text"
```
-## TextVerticalAlign — type
+## TextVerticalAlign — type @experimental
```
(typeof TextVerticalAlign)[keyof typeof TextVerticalAlign]
```
-## TextureDimensions — interface
+## TextureDimensions — interface @experimental
```
height: number
width: number
```
-## TextureFilter — type
+## TextureFilter — type @experimental
```
(typeof TextureFilter)[keyof typeof TextureFilter]
```
-## TextureHandle — type
+## TextureHandle — type @experimental
```
number
```
-## TextureInfo — interface
+## TextureInfo — interface @experimental
```
handle: number
height: number
width: number
```
-## TextureRef — interface
+## TextureRef — interface @experimental
```
slot: number | undefined
textureId: number
```
-## TextureWrap — type
+## TextureWrap — type @experimental
```
(typeof TextureWrap)[keyof typeof TextureWrap]
```
-## ThemeColors — interface
+## ThemeColors — interface @experimental
```
backdrop: Color
control: Color
@@ -7513,18 +7513,18 @@ text: Color
track: Color
```
-## ThemeOverrides — interface
+## ThemeOverrides — interface @experimental
```
colors: Partial<ThemeColors> | undefined
type: Partial<ThemeType> | undefined
```
-## ThemeStyle — const
+## ThemeStyle — const @experimental
```
ComponentDef<ThemeStyleData>
```
-## ThemeStyleData — interface
+## ThemeStyleData — interface @experimental
```
input: { background?: ColorRole; text?: ColorRole; placeholder?: ColorRole; } | undefined
states: Record<string, keyof ThemeColors> | undefined
@@ -7532,20 +7532,20 @@ text: keyof ThemeColors | undefined
visual: keyof ThemeColors | undefined
```
-## ThemeTokens — interface
+## ThemeTokens — interface @experimental
```
colors: ThemeColors
type: ThemeType
```
-## ThemeType — interface
+## ThemeType — interface @experimental
```
body: number
label: number
title: number
```
-## TileCollisionPiece — interface
+## TileCollisionPiece — interface @experimental
```
center: Vec2
circles: { c: Vec2; r: number; }[]
@@ -7554,21 +7554,21 @@ polylines: Vec2[][]
sensor: boolean
```
-## TileCollisionShape — type
+## TileCollisionShape — type @experimental
```
| { type: 'box' }
| { type: 'polygon'; points: [number, number][] }
| { type: 'circle'; cx: number; cy: number; r: number }
```
-## TileFlags — interface
+## TileFlags — interface @experimental
```
flipD: boolean
flipH: boolean
flipV: boolean
```
-## TileGridParams — interface
+## TileGridParams — interface @experimental
```
hexSideLength: number | undefined
orientation: number
@@ -7578,7 +7578,7 @@ tileHeight: number
tileWidth: number
```
-## TileOrientation — enum
+## TileOrientation — enum @experimental
```
Hexagonal = 3
Isometric = 1
@@ -7586,14 +7586,14 @@ Orthogonal = 0
Staggered = 2
```
-## TileStamp — interface
+## TileStamp — interface @experimental
```
cells: number[]
h: number
w: number
```
-## TiledLayerData — interface
+## TiledLayerData — interface @experimental
```
chunks: TiledChunkData[]
height: number
@@ -7608,7 +7608,7 @@ visible: boolean
width: number
```
-## TiledMapData — interface
+## TiledMapData — interface @experimental
```
collisionTileIds: number[]
height: number
@@ -7627,7 +7627,7 @@ tilesets: TiledTilesetData[]
width: number
```
-## TiledTilesetData — interface
+## TiledTilesetData — interface @experimental
```
collectionTiles: TiledCollectionTile[] | undefined
columns: number
@@ -7641,27 +7641,27 @@ tileHeight: number
tileWidth: number
```
-## Tilemap — const
+## Tilemap — const @experimental
```
ComponentDef<TilemapData>
```
-## TilemapAPI — const
+## TilemapAPI — const @experimental
```
{ initLayer(entity: number, width: number, height: number, tileWidth: number, tileHeight: number): void; destroyLayer(entity: number): void; setTile(entity: number, x: number, y: number, tileId: number): void; getTile(entity: number, x: number, y: number): number; fillRect(entity: number, x: number, y: number, w: number, h: number, tileId: number): void; setTiles(entity: number, tiles: Uint16Array): void; setTilesets(entity: number, slots: { firstId: number; textureHandle: number; columns: number; margin?: number; spacing?: number; }[]): void; hasLayer(entity: number): boolean; setRenderProps(entity: number, textureHandle: number, tilesetColumns: number, uvTileW: number, uvTileH: number, sortLayer: number, depth: number, parallaxX: number, parallaxY: number): void; setTint(entity: number, r: number, g: number, b: number, a: number, opacity: number): void; setVisible(entity: number, visible: boolean): void; setOriginEntity(layerKey: number, originEntity: number): void; setTileAnimation(entity: number, tileId: number, frames: { tileId: number; duration: number; }[]): void; clearTileAnimations(entity: number): void; advanceAnimations(entity: number, dtMs: number): void; setTileProperty(entity: number, tileId: number, key: string, value: string): void; getTileProperty(entity: number, x: number, y: number, key: string): string; flipTile(entity: number, x: number, y: number, flipH: boolean, flipV: boolean, flipD: boolean): void; rotateTile(entity: number, x: number, y: number, degrees: number): void; initInfiniteLayer(entity: number, tileWidth: number, tileHeight: number): void; setChunkTiles(entity: number, chunkX: number, chunkY: number, tiles: Uint16Array, width: number, height: number): void; setGridType(entity: number, type: number): void; setHexParams(entity: number, sideLength: number, staggerAxisX: boolean, staggerIndexEven: boolean): void; tileToWorld(entity: number, tx: number, ty: number, originX: number, originY: number): { x: number; y: number; }; worldToTile(entity: number, wx: number, wy: number, originX: number, originY: number): { x: number; y: number; }; exportChunks(entity: number): string; importChunks(entity: number, encoded: string): boolean; }
```
-## TilemapData — interface
+## TilemapData — interface @experimental
```
source: string
```
-## TilemapLayer — const
+## TilemapLayer — const @experimental
```
BuiltinComponentDef<TilemapLayerData>
```
-## TilemapLayerData — interface
+## TilemapLayerData — interface @experimental
```
cellSize: Vec2
hexSideLength: number
@@ -7679,12 +7679,12 @@ tintColor: Color
visible: boolean
```
-## TilemapLiveSync — const
+## TilemapLiveSync — const @experimental
```
{ _bind(fn: ApplyTilesetRefs | null): void; setLayerTilesets(entity: number, refs: readonly string[]): void; }
```
-## TilemapPlugin — class
+## TilemapPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -7694,18 +7694,18 @@ static new (): TilemapPlugin
static prototype: TilemapPlugin
```
-## Tilemaps — const
+## Tilemaps — const @experimental
```
ResourceDef<{ initLayer(entity: number, width: number, height: number, tileWidth: number, tileHeight: number): void; destroyLayer(entity: number): void; setTile(entity: number, x: number, y: number, tileId: number): void; getTile(entity: number, x: number, y: number): number; fillRect(entity: number, x: number, y: number, w: number, h: number, tileId: number): void; setTiles(entity: number, tiles: Uint16Array): void; setTilesets(entity: number, slots: { firstId: number; textureHandle: number; columns: number; margin?: number; spacing?: number; }[]): void; hasLayer(entity: number): boolean; setRenderProps(entity: number, textureHandle: number, tilesetColumns: number, uvTileW: number, uvTileH: number, sortLayer: number, depth: number, parallaxX: number, parallaxY: number): void; setTint(entity: number, r: number, g: number, b: number, a: number, opacity: number): void; setVisible(entity: number, visible: boolean): void; setOriginEntity(layerKey: number, originEntity: number): void; setTileAnimation(entity: number, tileId: number, frames: { tileId: number; duration: number; }[]): void; clearTileAnimations(entity: number): void; advanceAnimations(entity: number, dtMs: number): void; setTileProperty(entity: number, tileId: number, key: string, value: string): void; getTileProperty(entity: number, x: number, y: number, key: string): string; flipTile(entity: number, x: number, y: number, flipH: boolean, flipV: boolean, flipD: boolean): void; rotateTile(entity: number, x: number, y: number, degrees: number): void; initInfiniteLayer(entity: number, tileWidth: number, tileHeight: number): void; setChunkTiles(entity: number, chunkX: number, chunkY: number, tiles: Uint16Array, width: number, height: number): void; setGridType(entity: number, type: number): void; setHexParams(entity: number, sideLength: number, staggerAxisX: boolean, staggerIndexEven: boolean): void; tileToWorld(entity: number, tx: number, ty: number, originX: number, originY: number): { x: number; y: number; }; worldToTile(entity: number, wx: number, wy: number, originX: number, originY: number): { x: number; y: number; }; exportChunks(entity: number): string; importChunks(entity: number, encoded: string): boolean; }>
```
-## TilesetAnimFrame — interface
+## TilesetAnimFrame — interface @experimental
```
durationMs: number
tile: number
```
-## TilesetAsset — interface
+## TilesetAsset — interface @experimental
```
columns: number
margin: number
@@ -7719,7 +7719,7 @@ tiles: Record<number, TilesetTile>
version: string
```
-## TilesetCollision — type
+## TilesetCollision — type @experimental
```
TileCollisionShape & {
/** One-way (jump-through) platform: contacts from behind this normal pass through. */
@@ -7733,7 +7733,7 @@ TileCollisionShape & {
}
```
-## TilesetModel — interface
+## TilesetModel — interface @experimental
```
animations: Map<number, { tileId: number; duration: number; }[]>
collidableTileIds: number[]
@@ -7741,7 +7741,7 @@ slots: TilesetModelSlot[]
tileShapes: Map<number, ResolvedTileCollision>
```
-## TilesetTerrain — interface
+## TilesetTerrain — interface @experimental
```
color: string | undefined
colors: TerrainColor[] | undefined
@@ -7749,7 +7749,7 @@ mode: TerrainMode
name: string
```
-## TilesetTile — interface
+## TilesetTile — interface @experimental
```
animation: TilesetAnimFrame[] | undefined
collision: TilesetCollision | undefined
@@ -7758,19 +7758,19 @@ properties: Record<string, string> | undefined
terrain: TilesetTileTerrain | undefined
```
-## TilesetTileTerrain — interface
+## TilesetTileTerrain — interface @experimental
```
corners: number[] | undefined
mask: number | undefined
set: number
```
-## Time — const
+## Time — const @experimental
```
ResourceDef<TimeData>
```
-## TimeData — interface
+## TimeData — interface @experimental
```
delta: number
elapsed: number
@@ -7782,12 +7782,12 @@ scale: number
unscaledDelta: number
```
-## Timeline — const
+## Timeline — const @experimental
```
ResourceDef<TimelineAPI>
```
-## TimelineAPI — class
+## TimelineAPI — class @experimental
```
clearStates: () => void
ensureState: (entity: Entity, wrapMode: WrapMode, speed: number) => TimelineState
@@ -7803,7 +7803,7 @@ static new (flags_?: PlayerFlagChannel | null): TimelineAPI
static prototype: TimelineAPI
```
-## TimelineAsset — interface
+## TimelineAsset — interface @experimental
```
duration: number
tracks: Track[]
@@ -7812,12 +7812,12 @@ version: string
wrapMode: WrapMode
```
-## TimelinePlayer — const
+## TimelinePlayer — const @experimental
```
ComponentDef<TimelinePlayerData>
```
-## TimelinePlayerData — interface
+## TimelinePlayerData — interface @experimental
```
finished: boolean
playing: boolean
@@ -7826,7 +7826,7 @@ timeline: string
wrapMode: string
```
-## TimelinePlugin — class
+## TimelinePlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -7840,7 +7840,7 @@ static new (): TimelinePlugin
static prototype: TimelinePlugin
```
-## TimerHandle — class
+## TimerHandle — class @experimental
```
cancel: () => void
elapsed: number
@@ -7854,7 +7854,7 @@ static new (manager: TimerManager, id: number): TimerHandle
static prototype: TimerHandle
```
-## TimerManager — class
+## TimerManager — class @experimental
```
activeCount: number
cancel: (id: number) => void
@@ -7873,12 +7873,12 @@ static new (): TimerManager
static prototype: TimerManager
```
-## TimerRes — const
+## TimerRes — const @experimental
```
ResourceDef<TimerManager>
```
-## ToggleHandle — interface
+## ToggleHandle — interface @experimental
```
dispose: () => void
entity: number
@@ -7887,7 +7887,7 @@ setDisabled: (disabled: boolean) => void
setValue: (value: boolean) => void
```
-## ToggleOptions — interface
+## ToggleOptions — interface @experimental
```
background: UIVisualInit | undefined
check: { node?: UINodeInit; color?: Color; sprite?: number; } | undefined
@@ -7903,29 +7903,29 @@ tabIndex: number | undefined
world: World
```
-## TouchPoint — interface
+## TouchPoint — interface @experimental
```
id: number
x: number
y: number
```
-## Track — type
+## Track — type @experimental
```
PropertyTrack | SpineTrack | SpriteAnimTrack | AudioTrack | ActivationTrack | MarkerTrack | CustomEventTrack | AnimFramesTrack
```
-## TrackType — type
+## TrackType — type @experimental
```
(typeof TrackType)[keyof typeof TrackType]
```
-## Trail — const
+## Trail — const @experimental
```
ResourceDef<TrailAPI>
```
-## TrailAPI — class
+## TrailAPI — class @experimental
```
clear: (entity: Entity) => void
update: (dt: number) => void
@@ -7933,7 +7933,7 @@ static new (module: NonNullable<EngineApi>, registry: CppRegistry): TrailAPI
static prototype: TrailAPI
```
-## TrailPlugin — class
+## TrailPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -7942,12 +7942,12 @@ static new (): TrailPlugin
static prototype: TrailPlugin
```
-## TrailRenderer — const
+## TrailRenderer — const @experimental
```
BuiltinComponentDef<TrailRendererData>
```
-## TrailRendererData — interface
+## TrailRendererData — interface @experimental
```
blendMode: number
emitting: boolean
@@ -7963,7 +7963,7 @@ texture: number
time: number
```
-## Transaction — class
+## Transaction — class @experimental
```
add: (op: TransactionOp) => void
addDeferred: (op: TransactionOp) => void
@@ -7977,7 +7977,7 @@ static new (label: string, id?: string): Transaction
static prototype: Transaction
```
-## TransactionManager — class
+## TransactionManager — class @experimental
```
begin: (label: string) => Transaction
canRedo: () => boolean
@@ -7993,23 +7993,23 @@ static new (options?: TransactionManagerOptions): TransactionManager
static prototype: TransactionManager
```
-## TransactionManagerOptions — interface
+## TransactionManagerOptions — interface @experimental
```
historyLimit: number | undefined
```
-## TransactionOp — interface
+## TransactionOp — interface @experimental
```
forward: () => void
reverse: () => void
```
-## Transform — const
+## Transform — const @experimental
```
BuiltinComponentDef<TransformData>
```
-## TransformData — interface
+## TransformData — interface @experimental
```
position: Vec3
rotation: Quat
@@ -8019,14 +8019,14 @@ worldRotation: Quat
worldScale: Vec3
```
-## TransitionConfig — interface
+## TransitionConfig — interface @experimental
```
color: Color | undefined
duration: number
type: "fade"
```
-## TransitionOptions — interface
+## TransitionOptions — interface @experimental
```
color: Color | undefined
duration: number | undefined
@@ -8036,12 +8036,12 @@ onStart: (() => void) | undefined
transition: "fade" | "none" | undefined
```
-## Tween — const
+## Tween — const @experimental
```
ResourceDef<TweenAPI>
```
-## TweenAPI — class
+## TweenAPI — class @experimental
```
activeCompositionCount: number
cancel: (tweenHandle: TweenHandle) => void
@@ -8057,12 +8057,12 @@ static new (module: AnimCore, registry: CppRegistry): TweenAPI
static prototype: TweenAPI
```
-## TweenFactory — type
+## TweenFactory — type @experimental
```
() => Completable
```
-## TweenGroup — class
+## TweenGroup — class @experimental
```
cancel: () => void
checkComplete: () => boolean
@@ -8074,7 +8074,7 @@ static new (tweens: Completable[]): TweenGroup
static prototype: TweenGroup
```
-## TweenHandle — class
+## TweenHandle — class @experimental
```
bezier: (p1x: number, p1y: number, p2x: number, p2y: number) => TweenHandle
cancel: () => void
@@ -8087,7 +8087,7 @@ static new (module: AnimCore, registry: CppRegistry, valueManager: ValueTweenMan
static prototype: TweenHandle
```
-## TweenOptions — interface
+## TweenOptions — interface @experimental
```
delay: number | undefined
easing: EasingType | undefined
@@ -8095,7 +8095,7 @@ loop: LoopMode | undefined
loopCount: number | undefined
```
-## TweenSequence — class
+## TweenSequence — class @experimental
```
cancel: () => void
checkComplete: () => boolean
@@ -8107,17 +8107,17 @@ static new (factories: TweenFactory[]): TweenSequence
static prototype: TweenSequence
```
-## TweenState — type
+## TweenState — type @experimental
```
(typeof TweenState)[keyof typeof TweenState]
```
-## TweenTarget — type
+## TweenTarget — type @experimental
```
(typeof TweenTarget)[keyof typeof TweenTarget]
```
-## UICameraData — interface
+## UICameraData — interface @experimental
```
screenH: number
screenW: number
@@ -8135,44 +8135,44 @@ worldRight: number
worldTop: number
```
-## UICameraInfo — const
+## UICameraInfo — const @experimental
```
ResourceDef<UICameraData>
```
-## UIController — const
+## UIController — const @experimental
```
ComponentDef<UIControllerData>
```
-## UIControllerData — interface
+## UIControllerData — interface @experimental
```
controllers: ControllerState[]
```
-## UIDialog — const
+## UIDialog — const @experimental
```
ComponentDef<UIDialogData>
```
-## UIDialogData — interface
+## UIDialogData — interface @experimental
```
closeOnBackdrop: boolean
closeOnEscape: boolean
```
-## UIDisplay — enum
+## UIDisplay — enum @experimental
```
Flex = 0
None = 1
```
-## UIDropdown — const
+## UIDropdown — const @experimental
```
ComponentDef<UIDropdownData>
```
-## UIDropdownData — interface
+## UIDropdownData — interface @experimental
```
label: number
optionHeight: number
@@ -8180,7 +8180,7 @@ options: string[]
selectedIndex: number
```
-## UIEntityInit — interface
+## UIEntityInit — interface @experimental
```
node: UINodeInit | undefined
parent: number | undefined
@@ -8189,7 +8189,7 @@ visual: UIVisualInit | undefined
world: World
```
-## UIEvent — interface
+## UIEvent — interface @experimental
```
currentTarget: number
data: TData
@@ -8201,12 +8201,12 @@ target: number
type: string
```
-## UIEventHandler — type
+## UIEventHandler — type @experimental
```
(event: EntityEvent<TData>) => void
```
-## UIEventQueue — class
+## UIEventQueue — class @experimental
```
clear: () => void
drain: () => readonly EntityEvent[]
@@ -8220,32 +8220,32 @@ static new (): EntityEventQueue
static prototype: EntityEventQueue
```
-## UIEventType — type
+## UIEventType — type @experimental
```
typeof UIEventType[keyof typeof UIEventType]
```
-## UIEvents — const
+## UIEvents — const @experimental
```
ResourceDef<EntityEventQueue>
```
-## UIGear — const
+## UIGear — const @experimental
```
ComponentDef<UIGearData>
```
-## UIGearData — interface
+## UIGearData — interface @experimental
```
bindings: GearBinding[]
```
-## UIInteraction — const
+## UIInteraction — const @experimental
```
BuiltinComponentDef<UIInteractionData>
```
-## UIInteractionData — interface
+## UIInteractionData — interface @experimental
```
hovered: boolean
justPressed: boolean
@@ -8253,7 +8253,7 @@ justReleased: boolean
pressed: boolean
```
-## UIInteractionPlugin — class
+## UIInteractionPlugin — class @experimental
```
build: (app: App) => void
dependencies: "uiLayout"[]
@@ -8262,17 +8262,17 @@ static new (): UIInteractionPlugin
static prototype: UIInteractionPlugin
```
-## UILayoutGeneration — const
+## UILayoutGeneration — const @experimental
```
ResourceDef<UILayoutGenerationData>
```
-## UILayoutGenerationData — interface
+## UILayoutGenerationData — interface @experimental
```
generation: number
```
-## UILayoutPlugin — class
+## UILayoutPlugin — class @experimental
```
build: (app: App) => void
name: string
@@ -8280,19 +8280,19 @@ static new (): UILayoutPlugin
static prototype: UILayoutPlugin
```
-## UIMask — const
+## UIMask — const @experimental
```
BuiltinComponentDef<UIMaskData>
```
-## UIMaskData — interface
+## UIMaskData — interface @experimental
```
alphaCutoff: number
enabled: boolean
mode: MaskMode
```
-## UIMaskPlugin — class
+## UIMaskPlugin — class @experimental
```
build: (app: App) => void
name: "uiMask"
@@ -8300,12 +8300,12 @@ static new (): UIMaskPlugin
static prototype: UIMaskPlugin
```
-## UINode — const
+## UINode — const @experimental
```
BuiltinComponentDef<UINodeData>
```
-## UINodeInit — interface
+## UINodeInit — interface @experimental
```
fill: boolean | undefined
flexGrow: number | undefined
@@ -8325,7 +8325,7 @@ position: number | undefined
width: Dimension | undefined
```
-## UIPlugin — class
+## UIPlugin — class @experimental
```
attachScrollContainer: (entity: Entity, container: ScrollContainer) => void
build: (app: App) => void
@@ -8339,19 +8339,19 @@ static new (): UIPlugin
static prototype: UIPlugin
```
-## UIPointerEvents — enum
+## UIPointerEvents — enum @experimental
```
Auto = 0
None = 1
```
-## UIPositionType — enum
+## UIPositionType — enum @experimental
```
Absolute = 1
Relative = 0
```
-## UIRenderOrderPlugin — class
+## UIRenderOrderPlugin — class @experimental
```
after: ("text" | "uiInteraction" | "uiMask")[]
build: (app: App) => void
@@ -8361,12 +8361,12 @@ static new (): UIRenderOrderPlugin
static prototype: UIRenderOrderPlugin
```
-## UISlider — const
+## UISlider — const @experimental
```
ComponentDef<UISliderData>
```
-## UISliderData — interface
+## UISliderData — interface @experimental
```
fill: number
handle: number
@@ -8376,18 +8376,18 @@ step: number
value: number
```
-## UIToggle — const
+## UIToggle — const @experimental
```
ComponentDef<UIToggleData>
```
-## UIToggleData — interface
+## UIToggleData — interface @experimental
```
check: number
isOn: boolean
```
-## UIVisibilityPlugin — class
+## UIVisibilityPlugin — class @experimental
```
build: (app: App) => void
dependencies: "uiInteraction"[]
@@ -8396,12 +8396,12 @@ static new (): UIVisibilityPlugin
static prototype: UIVisibilityPlugin
```
-## UIVisual — const
+## UIVisual — const @experimental
```
BuiltinComponentDef<UIVisualData>
```
-## UIVisualData — interface
+## UIVisualData — interface @experimental
```
color: Color
enabled: boolean
@@ -8418,7 +8418,7 @@ uvScale: Vec2
visualType: UIVisualType
```
-## UIVisualInit — interface
+## UIVisualInit — interface @experimental
```
color: { r: number; g: number; b: number; a: number; } | undefined
enabled: boolean | undefined
@@ -8435,7 +8435,7 @@ uvScale: Vec2 | undefined
visualType: UIVisualType | undefined
```
-## UIVisualType — enum
+## UIVisualType — enum @experimental
```
Filled = 5
Image = 2
@@ -8445,23 +8445,23 @@ SolidColor = 1
Tiled = 4
```
-## UniformValue — type
+## UniformValue — type @experimental
```
number | Vec2 | Vec3 | Vec4 | number[] | TextureRef
```
-## Unsubscribe — type
+## Unsubscribe — type @experimental
```
() => void
```
-## ValidatePrefabOptions — interface
+## ValidatePrefabOptions — interface @experimental
```
instanceOverrides: readonly PrefabOverride[] | undefined
loadPrefab: ((path: string) => PrefabData | null) | undefined
```
-## ValidateResult — interface
+## ValidateResult — interface @experimental
```
duplicateIds: string[]
invalidIds: string[]
@@ -8469,7 +8469,7 @@ orphanedChildren: string[]
stale: StaleOverride[]
```
-## ValueTweenHandle — class
+## ValueTweenHandle — class @experimental
```
bezier: (p1x: number, p1y: number, p2x: number, p2y: number) => ValueTweenHandle
cancel: () => void
@@ -8483,26 +8483,26 @@ static new (manager: ValueTweenManager, id: number): ValueTweenHandle
static prototype: ValueTweenHandle
```
-## Vec2 — interface
+## Vec2 — interface @experimental
```
x: number
y: number
```
-## Vec2Like — interface
+## Vec2Like — interface @experimental
```
x: number
y: number
```
-## Vec3 — interface
+## Vec3 — interface @experimental
```
x: number
y: number
z: number
```
-## Vec4 — interface
+## Vec4 — interface @experimental
```
w: number
x: number
@@ -8510,29 +8510,29 @@ y: number
z: number
```
-## Velocity — const
+## Velocity — const @experimental
```
BuiltinComponentDef<VelocityData>
```
-## VelocityData — interface
+## VelocityData — interface @experimental
```
angular: Vec3
linear: Vec3
```
-## VertexAttributeDescriptor — interface
+## VertexAttributeDescriptor — interface @experimental
```
name: string
type: DataType
```
-## Video — const
+## Video — const @experimental
```
ComponentDef<VideoData>
```
-## VideoAPI — class
+## VideoAPI — class @experimental
```
backendName: string
baseUrl: string
@@ -8546,7 +8546,7 @@ static new (backend: PlatformVideoBackend): VideoAPI
static prototype: VideoAPI
```
-## VideoData — interface
+## VideoData — interface @experimental
```
autoplay: boolean
enabled: boolean
@@ -8558,22 +8558,22 @@ source: string
volume: number
```
-## VideoHandle — type
+## VideoHandle — type @experimental
```
VideoStreamHandle
```
-## VideoPlayOptions — type
+## VideoPlayOptions — type @experimental
```
VideoStreamOptions
```
-## VideoPlayer — const
+## VideoPlayer — const @experimental
```
ResourceDef<VideoAPI>
```
-## VideoPlugin — class
+## VideoPlugin — class @experimental
```
build: (app: App) => void
cleanup: () => void
@@ -8583,7 +8583,7 @@ static new (): VideoPlugin
static prototype: VideoPlugin
```
-## VideoStreamHandle — interface
+## VideoStreamHandle — interface @experimental
```
bytes: number | undefined
currentTime: number
@@ -8608,7 +8608,7 @@ textureHandle: number
width: number
```
-## VideoStreamOptions — interface
+## VideoStreamOptions — interface @experimental
```
audioTrackUrl: string | undefined
autoplay: boolean | undefined
@@ -8618,7 +8618,7 @@ playbackRate: number | undefined
volume: number | undefined
```
-## Viewport — interface
+## Viewport — interface @experimental
```
h: number
w: number
@@ -8626,23 +8626,23 @@ x: number
y: number
```
-## Virtual — const
+## Virtual — const @experimental
```
(id: string) => Binding
```
-## WangIndex — interface
+## WangIndex — interface @experimental
```
byKey: Map<number, number>
```
-## WangIndices — interface
+## WangIndices — interface @experimental
```
sets: Map<number, WangIndex>
tileTerrain: Map<number, number>
```
-## WeChatRuntimeConfig — interface
+## WeChatRuntimeConfig — interface @experimental
```
audioConfig: AudioProjectConfig | undefined
colorSpace: "gamma" | "linear" | undefined
@@ -8662,12 +8662,12 @@ uiThemeOverrides: ThemeOverrides | undefined
ySortLayers: number | undefined
```
-## WeChatSideModuleFactories — type
+## WeChatSideModuleFactories — type @experimental
```
Partial<Record<SideModuleId, EmscriptenFactory>>
```
-## WeChatSocket — class
+## WeChatSocket — class @experimental
```
close: (code?: number, reason?: string) => void
connect: () => void
@@ -8678,7 +8678,7 @@ static new (options: GameSocketOptions): WeChatSocket
static prototype: WeChatSocket
```
-## WebAppOptions — interface
+## WebAppOptions — interface @experimental
```
colorSpace: "gamma" | "linear" | undefined
depthLayers: number | undefined
@@ -8691,34 +8691,34 @@ sideModules: SideModuleHost | undefined
ySortLayers: number | undefined
```
-## WeldJoint — const
+## WeldJoint — const @experimental
```
ComponentDef<WeldJointData>
```
-## WheelJoint — const
+## WheelJoint — const @experimental
```
ComponentDef<WheelJointData>
```
-## WidgetInteractionInit — interface
+## WidgetInteractionInit — interface @experimental
```
disabled: boolean | undefined
focusable: boolean | undefined
tabIndex: number | undefined
```
-## With — function
+## With — function @experimental
```
(component: AnyComponentDef): FilterExpr
```
-## Without — function
+## Without — function @experimental
```
(component: AnyComponentDef): FilterExpr
```
-## World — class
+## World — class @experimental
```
advanceTick: () => void
anyChangedSince: (component: AnyComponentDef, sinceTick: number) => boolean
@@ -8773,7 +8773,7 @@ static new (): World
static prototype: World
```
-## WorldRect — interface
+## WorldRect — interface @experimental
```
bottom: number
left: number
@@ -8781,62 +8781,62 @@ right: number
top: number
```
-## WorldTransform — const
+## WorldTransform — const @experimental
```
BuiltinComponentDef<TransformData>
```
-## WorldTransformData — type
+## WorldTransformData — type @experimental
```
TransformData
```
-## WrapMode — type
+## WrapMode — type @experimental
```
(typeof WrapMode)[keyof typeof WrapMode]
```
-## actionRefArg — function
+## actionRefArg — function @experimental
```
(ref: FsmActionRef | undefined): string | undefined
```
-## actionRefName — function
+## actionRefName — function @experimental
```
(ref: FsmActionRef | undefined): string
```
-## actionRefParams — function
+## actionRefParams — function @experimental
```
(ref: FsmActionRef | undefined): Record<string, AiParamValue> | undefined
```
-## activeRemoteRoot — function
+## activeRemoteRoot — function @experimental
```
(config: AssetGroupsConfig | null | undefined): string | undefined
```
-## addAnimatorParam — function
+## addAnimatorParam — function @experimental
```
(def: AnimatorControllerDef, name: string, type: AnimatorParamType): AnimatorControllerDef
```
-## addAnimatorState — function
+## addAnimatorState — function @experimental
```
(def: AnimatorControllerDef, name: string, x?: number, y?: number): AnimatorControllerDef
```
-## addAnimatorTransition — function
+## addAnimatorTransition — function @experimental
```
(def: AnimatorControllerDef, from: string, to: string): AnimatorControllerDef
```
-## addBtChild — function
+## addBtChild — function @experimental
```
(def: BtDefinition, parentId: string, type: BtNodeType, x?: number, y?: number): BtDefinition
```
-## addBtOrphan — function
+## addBtOrphan — function @experimental
```
(def: BtDefinition, type: BtNodeType, x?: number, y?: number): BtDefinition
```
@@ -8846,397 +8846,397 @@ TransformData
(g: MaterialGraph, type: GraphNodeType, x: number, y: number): { graph: MaterialGraph; id: string; }
```
-## addStartupSystem — function
+## addStartupSystem — function @experimental
```
(system: SystemDef): void
```
-## addState — function
+## addState — function @experimental
```
(def: FsmDefinition, name: string, x?: number, y?: number): FsmDefinition
```
-## addSystem — function
+## addSystem — function @experimental
```
(system: SystemDef): void
```
-## addSystemSetToSchedule — function
+## addSystemSetToSchedule — function @experimental
```
(schedule: Schedule, set: SystemSet): void
```
-## addSystemToSchedule — function
+## addSystemToSchedule — function @experimental
```
(schedule: Schedule, system: SystemDef): void
```
-## addTransition — function
+## addTransition — function @experimental
```
(def: FsmDefinition, from: string, to: string): FsmDefinition
```
-## agentBlackboard — function
+## agentBlackboard — function @experimental
```
(states: Map<Entity, AgentState>, entity: Entity): Blackboard
```
-## agentBtBlackboard — function
+## agentBtBlackboard — function @experimental
```
(states: Map<Entity, BtAgentState>, entity: Entity): Blackboard
```
-## aiRegistry — const
+## aiRegistry — const @experimental
```
AiRegistry<AiContext>
```
-## analyzeCensusSeries — function
+## analyzeCensusSeries — function @experimental
```
(samples: readonly Census[], opts?: CensusSeriesOptions): CensusReport
```
-## anchorPresetFields — function
+## anchorPresetFields — function @experimental
```
(preset: AnchorPreset): AnchorFields
```
-## animClipCellRect — function
+## animClipCellRect — function @experimental
```
(sheet: AnimClipSheetData, cell: number): { x: number; y: number; width: number; height: number; }
```
-## animClipCellUv — function
+## animClipCellUv — function @experimental
```
(sheet: AnimClipSheetData, cell: number): { uvOffset: { x: number; y: number; }; uvScale: { x: number; y: number; }; }
```
-## animClipDrivesPivot — function
+## animClipDrivesPivot — function @experimental
```
(data: AnimClipAssetData): boolean
```
-## animClipFramePivot — function
+## animClipFramePivot — function @experimental
```
(data: AnimClipAssetData, frame: AnimClipFrameData): AnimClipPivotData | null
```
-## animClipSheetCols — function
+## animClipSheetCols — function @experimental
```
(sheet: AnimClipSheetData): number
```
-## animClipSheetRows — function
+## animClipSheetRows — function @experimental
```
(sheet: AnimClipSheetData): number
```
-## animationPlugin — const
+## animationPlugin — const @experimental
```
AnimationPlugin
```
-## animatorEdges — function
+## animatorEdges — function @experimental
```
(def: AnimatorControllerDef): AnimatorEdge[]
```
-## applyAssetRefResolvers — function
+## applyAssetRefResolvers — function @experimental
```
(app: App, resolveRef: (ref: string) => string): void
```
-## applyAudioProjectConfig — function
+## applyAudioProjectConfig — function @experimental
```
(audio: AudioAPI, config: AudioProjectConfig | undefined): void
```
-## applyBuildRuntimeConfig — function
+## applyBuildRuntimeConfig — function @experimental
```
(app: { setMaxDeltaTime(v: number): void; setMaxFixedSteps(v: number): void; }, config: RuntimeBuildConfig): void
```
-## applyDeltaToSource — function
+## applyDeltaToSource — function @experimental
```
(source: PrefabData, delta: SourceDelta): PrefabData
```
-## applyOverrides — function
+## applyOverrides — function @experimental
```
(entity: OverrideTarget, overrides: readonly PrefabOverride[] | undefined): void
```
-## applyOverridesToSource — function
+## applyOverridesToSource — function @experimental
```
(source: PrefabData, overrides: readonly PrefabOverride[]): PrefabData
```
-## applyRuntimeConfig — function
+## applyRuntimeConfig — function @experimental
```
(components: { Text?: { _default: Record<string, unknown>; }; TextInput?: { _default: Record<string, unknown>; }; Canvas?: { _default: Record<string, unknown>; }; }): void
```
-## applyThemeToWorld — function
+## applyThemeToWorld — function @experimental
```
(world: World): void
```
-## applyWrapMode — function
+## applyWrapMode — function @experimental
```
(time: number, duration: number, mode: WrapMode): { time: number; stopped: boolean; }
```
-## arrayDataSource — function
+## arrayDataSource — function @experimental
```
<T>(items: readonly T[]): ArrayDataSource<T>
```
-## assetPlugin — const
+## assetPlugin — const @experimental
```
AssetPlugin
```
-## atlasCatalogFields — function
+## atlasCatalogFields — function @experimental
```
(atlas: CookedAtlasInfo, pagePath: string): Pick<CatalogEntry, "atlas" | "frame" | "uv">
```
-## audioPlugin — const
+## audioPlugin — const @experimental
```
AudioPlugin
```
-## auto — const
+## auto — const @experimental
```
() => Dimension
```
-## bind — function
+## bind — function @experimental
```
<C extends object, K extends keyof C>(world: World, entity: Entity, component: ComponentDef<C>, field: K, source: ReadonlySignal<C[K]>): () => void
```
-## bindControllerPage — function
+## bindControllerPage — function @experimental
```
(world: World, entity: Entity, controller: string, source: ReadonlySignal<string>): () => void
```
-## bindWidgetValue — function
+## bindWidgetValue — function @experimental
```
<C extends object, K extends keyof C>(world: World, events: UIEventQueue, entity: Entity, component: ComponentDef<C>, field: K, signal: Signal<C[K]>, payloadKey?: string): () => void
```
-## btEdges — function
+## btEdges — function @experimental
```
(def: BtDefinition): BtEdge[]
```
-## btNodes — function
+## btNodes — function @experimental
```
(def: BtDefinition): BtNode[]
```
-## btPlugin — const
+## btPlugin — const @experimental
```
BtPlugin
```
-## bucketOverridesByEntity — function
+## bucketOverridesByEntity — function @experimental
```
(overrides: readonly PrefabOverride[]): Map<PrefabEntityId, PrefabOverride[]>
```
-## buildCollisionPaletteModel — function
+## buildCollisionPaletteModel — function @experimental
```
(material?: CollisionMaterial): TilesetModel
```
-## buildTerrainIndices — function
+## buildTerrainIndices — function @experimental
```
(asset: TilesetAsset): TerrainIndices
```
-## buildText — function
+## buildText — function @experimental
```
(init?: TextInit): TextData
```
-## buildUINode — function
+## buildUINode — function @experimental
```
(init?: UINodeInit): UINodeData
```
-## buildUIVisual — function
+## buildUIVisual — function @experimental
```
(init?: UIVisualInit): UIVisualData
```
-## buildVariant — function
+## buildVariant — function @experimental
```
(base: PrefabData, baseRef: string, name: string, delta: { overrides: readonly PrefabOverride[]; added: readonly AddedEntity[]; }): PrefabData
```
-## buildWangIndices — function
+## buildWangIndices — function @experimental
```
(asset: TilesetAsset): WangIndices
```
-## builtinShaderTemplate — function
+## builtinShaderTemplate — function @experimental
```
(id: string): BuiltinShaderTemplate | undefined
```
-## calculateAttenuation — function
+## calculateAttenuation — function @experimental
```
(distance: number, config?: SpatialAudioConfig): number
```
-## calculatePanning — function
+## calculatePanning — function @experimental
```
(sourceX: number, sourceY: number, listenerX: number, listenerY: number, maxDistance: number): number
```
-## canHaveChildren — function
+## canHaveChildren — function @experimental
```
(type: BtNodeType): boolean
```
-## canonicalMask — function
+## canonicalMask — function @experimental
```
(mode: TerrainMode, mask: number): number
```
-## catalogFromManifest — function
+## catalogFromManifest — function @experimental
```
(manifest: AddressableManifest): Catalog | undefined
```
-## censusProbeIds — function
+## censusProbeIds — function @experimental
```
(): string[]
```
-## clearAllCaches — function
+## clearAllCaches — function @experimental
```
(): void
```
-## clearAnimatorControllerStore — function
+## clearAnimatorControllerStore — function @experimental
```
(): void
```
-## clearBtStore — function
+## clearBtStore — function @experimental
```
(): void
```
-## clearDrawCallbacks — function
+## clearDrawCallbacks — function @experimental
```
(): void
```
-## clearFsmStore — function
+## clearFsmStore — function @experimental
```
(): void
```
-## clearProjectSideModules — function
+## clearProjectSideModules — function @experimental
```
(): void
```
-## clearTilemapSourceCache — function
+## clearTilemapSourceCache — function @experimental
```
(): void
```
-## clearUserComponents — function
+## clearUserComponents — function @experimental
```
(): void
```
-## cloneComponentData — function
+## cloneComponentData — function @experimental
```
(data: Record<string, unknown>): Record<string, unknown>
```
-## cloneComponents — function
+## cloneComponents — function @experimental
```
(components: ComponentData[]): ComponentData[]
```
-## cloneMetadata — function
+## cloneMetadata — function @experimental
```
(metadata: Record<string, unknown>): Record<string, unknown>
```
-## closeDialog — function
+## closeDialog — function @experimental
```
(world: World, events: UIEventQueue, root: Entity): void
```
-## closeDropdown — function
+## closeDropdown — function @experimental
```
(world: World, e: Entity): void
```
-## col — const
+## col — const @experimental
```
{ readonly create: (r?: number, g?: number, b?: number, a?: number) => Color; readonly rgb: (r: number, g: number, b: number) => Color; readonly from255: (r: number, g: number, b: number, a?: number) => Color; readonly clone: (c: Color) => Color; readonly lerp: (a: Color, b: Color, t: number) => Color; readonly withAlpha: (c: Color, a: number) => Color; readonly multiply: (a: Color, b: Color) => Color; readonly scaleRgb: (c: Color, s: number) => Color; readonly fromHex: (hex: string) => Color; readonly toHex: (c: Color, withAlpha?: boolean) => string; readonly equals: (a: Color, b: Color, epsilon?: number) => boolean; }
```
-## collapseEntry — function
+## collapseEntry — function @experimental
```
(prefab: PrefabData, prefabRef: string, expanded: readonly ProcessedEntity[], rootId: number, sceneParent: number | null, loadPrefab?: SyncPrefabResolver): PrefabInstanceEntry
```
-## collapseInstance — function
+## collapseInstance — function @experimental
```
(prefab: PrefabData, prefabRef: string, expanded: readonly ProcessedEntity[], loadPrefab?: SyncPrefabResolver): PrefabInstanceDelta
```
-## collectExternalEntityRefs — function
+## collectExternalEntityRefs — function @experimental
```
(entities: readonly ExtractEntity[]): ExternalEntityRef[]
```
-## collectGarbage — function
+## collectGarbage — function @experimental
```
(): boolean
```
-## collectNestedPrefabPaths — function
+## collectNestedPrefabPaths — function @experimental
```
(prefab: PrefabData, loadPrefab: (path: string) => PrefabData | null, visited?: Set<string>): string[]
```
-## collidableTileIds — function
+## collidableTileIds — function @experimental
```
(asset: TilesetAsset): number[]
```
-## colliderShapeOutline — function
+## colliderShapeOutline — function @experimental
```
(shape: ColliderShape, center: Vec2, angle: number, ppu: number): ColliderOutline
```
-## collisionRefWithMaterial — function
+## collisionRefWithMaterial — function @experimental
```
(material: CollisionMaterial): string
```
-## color — const
+## color — const @experimental
```
(r?: number, g?: number, b?: number, a?: number) => Color
```
-## compareDrawRank — function
+## compareDrawRank — function @experimental
```
(a: DrawRank, b: DrawRank): number
```
-## compileFsm — function
+## compileFsm — function @experimental
```
(def: FsmDefinition): CompiledFsm
```
@@ -9246,12 +9246,12 @@ BtPlugin
(graph: MaterialGraph): string
```
-## computeEffectiveOrthoSize — function
+## computeEffectiveOrthoSize — function @experimental
```
(baseOrthoSize: number, designAspect: number, actualAspect: number, scaleMode: number, matchWidthOrHeight: number): number
```
-## computeStreaming — function
+## computeStreaming — function @experimental
```
(cells: readonly StreamCell[], focusX: number, focusY: number, loadRadius: number, unloadRadius: number, active: ReadonlySet<string>): StreamDecision
```
@@ -9261,62 +9261,62 @@ BtPlugin
(g: MaterialGraph, fromId: string, toId: string, toSlot: string): MaterialGraph
```
-## contentHashHex — function
+## contentHashHex — function @experimental
```
(data: Uint8Array): string
```
-## contentHashOf — function
+## contentHashOf — function @experimental
```
(data: Uint8Array | string): string
```
-## controllerState — function
+## controllerState — function @experimental
```
(name: string, pages: string[], current?: string): ControllerState
```
-## corePlugin — const
+## corePlugin — const @experimental
```
Plugin
```
-## createAnimClip — function
+## createAnimClip — function @experimental
```
(texture: string, cellWidth: number, cellHeight: number, pageWidth: number, pageHeight: number): AnimClipAssetData
```
-## createBtRunState — function
+## createBtRunState — function @experimental
```
(): BtRunState
```
-## createButton — function
+## createButton — function @experimental
```
(opts: ButtonOptions): ButtonHandle
```
-## createDialog — function
+## createDialog — function @experimental
```
(opts: DialogOptions): DialogHandle
```
-## createDropdown — function
+## createDropdown — function @experimental
```
<T>(opts: DropdownOptions<T>): DropdownHandle<T>
```
-## createEmbeddedSideModuleHost — function
+## createEmbeddedSideModuleHost — function @experimental
```
(registry: EmbeddedSideModuleRegistry): SideModuleHost
```
-## createFetchSideModuleHost — function
+## createFetchSideModuleHost — function @experimental
```
(baseUrl: string): SideModuleHost
```
-## createFsmRunState — function
+## createFsmRunState — function @experimental
```
(fsm: CompiledFsm): FsmRunState
```
@@ -9326,187 +9326,187 @@ Plugin
(module: ESEngineModule, options?: HeadlessAppOptions): App
```
-## createListView — function
+## createListView — function @experimental
```
<T>(opts: CreateListViewOptions<T>): ListViewHandle<T>
```
-## createLocalAchievements — function
+## createLocalAchievements — function @experimental
```
(): AchievementProvider
```
-## createLocalLeaderboard — function
+## createLocalLeaderboard — function @experimental
```
(options?: LocalLeaderboardOptions): LeaderboardProvider
```
-## createMemoryTransportPair — function
+## createMemoryTransportPair — function @experimental
```
(options?: MemoryTransportOptions): [MemoryTransport, MemoryTransport]
```
-## createMockAdProvider — function
+## createMockAdProvider — function @experimental
```
(options?: MockAdProviderOptions): AdProvider
```
-## createPackagedAssetSource — function
+## createPackagedAssetSource — function @experimental
```
(index: PackagedAssetIndex, options?: PackagedAssetSourceOptions): RuntimeAssetSource
```
-## createProgress — function
+## createProgress — function @experimental
```
(opts: ProgressOptions): ProgressHandle
```
-## createRuntimeSceneConfig — function
+## createRuntimeSceneConfig — function @experimental
```
(name: string, sceneData: SceneData | undefined, options: Omit<LoadRuntimeSceneOptions, "sceneData" | "sceneName">, scenePath?: string): SceneConfig
```
-## createScrollView — function
+## createScrollView — function @experimental
```
(opts: ScrollViewOptions): ScrollViewHandle
```
-## createSlider — function
+## createSlider — function @experimental
```
(opts: SliderOptions): SliderHandle
```
-## createSocket — function
+## createSocket — function @experimental
```
(options: GameSocketOptions): PlatformSocket
```
-## createTakeover — function
+## createTakeover — function @experimental
```
(host: TakeoverHost): Takeover
```
-## createTextInput — function
+## createTextInput — function @experimental
```
(opts: TextInputOptions): TextInputHandle
```
-## createTileset — function
+## createTileset — function @experimental
```
(texture: string, tileWidth?: number, tileHeight?: number, columns?: number): TilesetAsset
```
-## createToggle — function
+## createToggle — function @experimental
```
(opts: ToggleOptions): ToggleHandle
```
-## createWeChatSideModuleHost — function
+## createWeChatSideModuleHost — function @experimental
```
(factories: MiniGameSideModuleFactories): SideModuleHost
```
-## createWebApp — function
+## createWebApp — function @experimental
```
(module: ESEngineModule, options?: CreateWebAppOptions): App
```
-## debug — function
+## debug — function @experimental
```
(category: string, message: string, data?: unknown): void
```
-## decodeImageBitmap — function
+## decodeImageBitmap — function @experimental
```
(src: ImageBitmapSource | PlatformImage, flip: boolean): Promise<ImageBitmap>
```
-## decodeImagePixels — function
+## decodeImagePixels — function @experimental
```
(src: ImageBitmapSource): Promise<DecodedPixels>
```
-## decodeTilemapChunks — function
+## decodeTilemapChunks — function @experimental
```
(blob: string): DecodedChunk[]
```
-## defaultFrameStats — function
+## defaultFrameStats — function @experimental
```
(): FrameStats
```
-## defaultPluralSelector — const
+## defaultPluralSelector — const @experimental
```
PluralSelector
```
-## defineBehavior — function
+## defineBehavior — function @experimental
```
<S extends object>(name: string, def: BehaviorDef<S>): ComponentDef<S>
```
-## defineComponent — function
+## defineComponent — function @experimental
```
<T extends object>(name: string, defaults: T, metadata?: ComponentMetadata): ComponentDef<T>
```
-## defineEvent — function
+## defineEvent — function @experimental
```
<T>(name: string): EventDef<T>
```
-## defineInputMap — function
+## defineInputMap — function @experimental
```
(actions: Record<string, ActionDef>): InputMap
```
-## defineResource — function
+## defineResource — function @experimental
```
<T>(defaultValue: T, name?: string): ResourceDef<T>
```
-## defineSystem — function
+## defineSystem — function @experimental
```
<P extends readonly SystemParam[]>(params: [...P], fn: (...args: InferParams<P>) => void | Promise<void>, options?: SystemOptions): SystemDef
```
-## defineSystemSet — function
+## defineSystemSet — function @experimental
```
(name: string, options: SystemSetOptions): SystemSet
```
-## defineTag — function
+## defineTag — function @experimental
```
(name: string): ComponentDef<{}>
```
-## derived — function
+## derived — function @experimental
```
<T>(sources: ReadonlySignal<unknown>[], compute: () => T): ReadonlySignal<T>
```
-## detectAnchor — function
+## detectAnchor — function @experimental
```
(node: UINodeData): AnchorPreset | null
```
-## detectAnchorAxes — function
+## detectAnchorAxes — function @experimental
```
(node: UINodeData): { h: AnchorAxis | null; v: AnchorAxis | null; }
```
-## diagnosticsPlugin — const
+## diagnosticsPlugin — const @experimental
```
DiagnosticsPlugin
```
-## diffAgainstSource — function
+## diffAgainstSource — function @experimental
```
(source: PrefabData, instance: readonly ProcessedEntity[], options?: DiffOptions): { overrides: PrefabOverride[]; untracked: ProcessedEntity[]; orphanedSourceIds: PrefabEntityId[]; }
```
-## diffCensus — function
+## diffCensus — function @experimental
```
(before: Census, after: Census): CensusDelta[]
```
@@ -9516,792 +9516,792 @@ DiagnosticsPlugin
(g: MaterialGraph, toId: string, toSlot: string): MaterialGraph
```
-## discoverSceneAssets — function
+## discoverSceneAssets — function @experimental
```
(sceneData: SceneData, refResolver?: RefResolver): SceneAssetRefs
```
-## dragPlugin — const
+## dragPlugin — const @experimental
```
DragPlugin
```
-## dragonBonesPlugin — const
+## dragonBonesPlugin — const @experimental
```
() => DragonBonesPlugin
```
-## editorViewHalfExtent — function
+## editorViewHalfExtent — function @experimental
```
(view: EditorViewData, aspect: number): { halfW: number; halfH: number; }
```
-## editorViewHalfHeight — function
+## editorViewHalfHeight — function @experimental
```
(view: EditorViewData): number
```
-## emptyAnimatorController — function
+## emptyAnimatorController — function @experimental
```
(): AnimatorControllerDef
```
-## emptyBt — function
+## emptyBt — function @experimental
```
(): BtDefinition
```
-## emptyFsm — function
+## emptyFsm — function @experimental
```
(): FsmDefinition
```
-## encodeTile — function
+## encodeTile — function @experimental
```
(id: number, flags?: TileFlags): number
```
-## ensureBtIds — function
+## ensureBtIds — function @experimental
```
(def: BtDefinition): BtDefinition
```
-## enterStatePath — function
+## enterStatePath — function @experimental
```
(scope: AnimatorScope, name: string): string[]
```
-## enumOptions — function
+## enumOptions — function @experimental
```
(obj: Record<string, unknown>, only?: readonly string[]): ReadonlyArray<{ label: string; value: number; }>
```
-## error — function
+## error — function @experimental
```
(category: string, message: string, data?: unknown): void
```
-## evalGuard — function
+## evalGuard — function @experimental
```
(bb: Blackboard, guard: BlackboardGuard): boolean
```
-## evalGuards — function
+## evalGuards — function @experimental
```
(bb: Blackboard, guards: BlackboardGuard | BlackboardGuard[]): boolean
```
-## evaluateAnimatorPath — function
+## evaluateAnimatorPath — function @experimental
```
(def: AnimatorControllerDef, currentPath: string, params: AnimatorParamValues, triggers: ReadonlySet<string>, clipFinished?: boolean): AnimatorPathEvalResult
```
-## evaluateAnimatorTransitions — function
+## evaluateAnimatorTransitions — function @experimental
```
(def: AnimatorControllerDef, currentState: string, params: AnimatorParamValues, triggers: ReadonlySet<string>, clipFinished?: boolean): AnimatorEvalResult
```
-## evaluateChannel — function
+## evaluateChannel — function @experimental
```
(channel: PropertyChannel, time: number): number
```
-## eventBindingPlugin — const
+## eventBindingPlugin — const @experimental
```
EventBindingPlugin
```
-## evictTextureDimensions — function
+## evictTextureDimensions — function @experimental
```
(handle: number): void
```
-## expandEntry — function
+## expandEntry — function @experimental
```
(prefab: PrefabData, entry: PrefabInstanceEntry, allocateId: () => number, loadPrefab?: SyncPrefabResolver): { entities: ProcessedEntity[]; rootId: number; }
```
-## expandInstance — function
+## expandInstance — function @experimental
```
(prefab: PrefabData, delta: PrefabInstanceDelta, allocateId: () => number, loadPrefab?: SyncPrefabResolver): { entities: ProcessedEntity[]; rootId: number; }
```
-## extractAnimClipTexturePaths — function
+## extractAnimClipTexturePaths — function @experimental
```
(data: AnimClipAssetData): string[]
```
-## extractPrefab — function
+## extractPrefab — function @experimental
```
(entities: readonly ExtractEntity[], rootId: number, name: string, makeId?: (sourceId: number) => PrefabEntityId): PrefabData
```
-## facingFromQuat — function
+## facingFromQuat — function @experimental
```
(z: number, w: number): number
```
-## fetchDecodePixels — function
+## fetchDecodePixels — function @experimental
```
(url: string): Promise<DecodedPixels>
```
-## findControllerOwner — function
+## findControllerOwner — function @experimental
```
(world: World, entity: Entity, name: string): Entity | null
```
-## findEntityByName — function
+## findEntityByName — function @experimental
```
(world: World, name: string): Entity | null
```
-## findPath — function
+## findPath — function @experimental
```
(grid: NavGrid, start: Cell, goal: Cell, opts?: PathfindOptions): Cell[] | null
```
-## fingerprint — function
+## fingerprint — function @experimental
```
(report: DiagnosticReport): string
```
-## finishDeviceRecovery — function
+## finishDeviceRecovery — function @experimental
```
(): void
```
-## flattenPrefab — function
+## flattenPrefab — function @experimental
```
(prefab: PrefabData, overrides: PrefabOverride[], ctx: FlattenContext): FlattenResult
```
-## flipFlagsH — function
+## flipFlagsH — function @experimental
```
(flags: TileFlags): TileFlags
```
-## flipFlagsV — function
+## flipFlagsV — function @experimental
```
(flags: TileFlags): TileFlags
```
-## flipStampH — function
+## flipStampH — function @experimental
```
(s: TileStamp): TileStamp
```
-## flipStampV — function
+## flipStampV — function @experimental
```
(s: TileStamp): TileStamp
```
-## flushPendingSystems — function
+## flushPendingSystems — function @experimental
```
(app: App): void
```
-## focusPlugin — const
+## focusPlugin — const @experimental
```
FocusPlugin
```
-## folderAlwaysInclude — function
+## folderAlwaysInclude — function @experimental
```
(config: AssetGroupsConfig | null | undefined, folder: string): boolean
```
-## folderGroupMode — function
+## folderGroupMode — function @experimental
```
(config: AssetGroupsConfig | null | undefined, folder: string): AssetGroupMode
```
-## formatActionArg — function
+## formatActionArg — function @experimental
```
(params: Readonly<Record<string, AiParamValue>> | undefined, defs: readonly AiParamDef[], separator?: string): string | undefined
```
-## formatCensusDiff — function
+## formatCensusDiff — function @experimental
```
(before: Census, after: Census, all?: boolean): string
```
-## formatCensusReport — function
+## formatCensusReport — function @experimental
```
(report: CensusReport): string
```
-## fsmEdges — function
+## fsmEdges — function @experimental
```
(def: FsmDefinition): FsmEdge[]
```
-## fsmPlugin — const
+## fsmPlugin — const @experimental
```
FsmPlugin
```
-## fxPreviewOrPlayMode — function
+## fxPreviewOrPlayMode — function @experimental
```
(): boolean
```
-## gearBinding — function
+## gearBinding — function @experimental
```
(controller: string, component: string, property: string, pages: Record<string, GearValue>, tween?: GearTween): GearBinding
```
-## getAddressableType — function
+## getAddressableType — function @experimental
```
(path: string): AddressableAssetType | null
```
-## getAddressableTypeByEditorType — function
+## getAddressableTypeByEditorType — function @experimental
```
(editorType: string): AddressableAssetType | null
```
-## getAllAssetExtensions — function
+## getAllAssetExtensions — function @experimental
```
(): Set<string>
```
-## getAllEffectDefs — function
+## getAllEffectDefs — function @experimental
```
(): EffectDef[]
```
-## getAssetBuildTransform — function
+## getAssetBuildTransform — function @experimental
```
(extensionOrPath: string): AssetBuildTransform | undefined
```
-## getAssetMimeType — function
+## getAssetMimeType — function @experimental
```
(ext: string): string | undefined
```
-## getAssetTypeEntry — function
+## getAssetTypeEntry — function @experimental
```
(extensionOrPath: string): AssetTypeEntry | undefined
```
-## getBt — function
+## getBt — function @experimental
```
(key: string): BtDefinition | undefined
```
-## getCacheForEntity — function
+## getCacheForEntity — function @experimental
```
(entityId: number): BitmapCache | undefined
```
-## getComponent — function
+## getComponent — function @experimental
```
(name: string): AnyComponentDef | undefined
```
-## getComponentAssetFieldDescriptors — function
+## getComponentAssetFieldDescriptors — function @experimental
```
(componentType: string): readonly { field: string; type: AssetFieldType; }[]
```
-## getComponentAssetFields — function
+## getComponentAssetFields — function @experimental
```
(componentType: string): string[]
```
-## getComponentDefaults — function
+## getComponentDefaults — function @experimental
```
(typeName: string): Record<string, unknown> | null
```
-## getComponentFieldMeta — function
+## getComponentFieldMeta — function @experimental
```
(name: string): Readonly<Record<string, FieldMeta>>
```
-## getComponentRegistry — function
+## getComponentRegistry — function @experimental
```
(): Map<string, AnyComponentDef>
```
-## getComponentSkeletalFieldDescriptor — function
+## getComponentSkeletalFieldDescriptor — function @experimental
```
(componentType: string): { skeletonField: string; atlasField: string; runtime: string; } | null
```
-## getContextLossGuardInfo — function
+## getContextLossGuardInfo — function @experimental
```
(): { target: string; lostEventsSeen: number; }
```
-## getControllerPage — function
+## getControllerPage — function @experimental
```
(world: World, entity: Entity, name: string): string | null
```
-## getCustomExtensions — function
+## getCustomExtensions — function @experimental
```
(): string[]
```
-## getDefaultContext — function
+## getDefaultContext — function @experimental
```
(): AppContext
```
-## getDeviceIdentity — function
+## getDeviceIdentity — function @experimental
```
(): DeviceIdentity | null
```
-## getDeviceLostReport — function
+## getDeviceLostReport — function @experimental
```
(): string
```
-## getDeviceStatus — function
+## getDeviceStatus — function @experimental
```
(): number
```
-## getEditorType — function
+## getEditorType — function @experimental
```
(path: string): EditorAssetType
```
-## getEffectDef — function
+## getEffectDef — function @experimental
```
(type: string): EffectDef | undefined
```
-## getEffectTypes — function
+## getEffectTypes — function @experimental
```
(): string[]
```
-## getFsm — function
+## getFsm — function @experimental
```
(key: string): CompiledFsm | undefined
```
-## getLogger — function
+## getLogger — function @experimental
```
(): Logger
```
-## getPlatform — function
+## getPlatform — function @experimental
```
(): PlatformAdapter
```
-## getPlatformType — function
+## getPlatformType — function @experimental
```
(): PlatformAdapter["name"] | null
```
-## getRegisteredAnimatorController — function
+## getRegisteredAnimatorController — function @experimental
```
(key: string): AnimatorControllerDef | undefined
```
-## getReplicatedFields — function
+## getReplicatedFields — function @experimental
```
(name: string): readonly string[]
```
-## getResourceManager — function
+## getResourceManager — function @experimental
```
(): CppResourceManager | null
```
-## getResourceStats — function
+## getResourceStats — function @experimental
```
(): ResourceStats | null
```
-## getTextureDimensions — function
+## getTextureDimensions — function @experimental
```
(handle: number): TextureDimensions | null
```
-## getTheme — function
+## getTheme — function @experimental
```
(): ThemeTokens
```
-## getTilemapSource — function
+## getTilemapSource — function @experimental
```
(path: string): LoadedTilemapSource | undefined
```
-## getUserComponent — function
+## getUserComponent — function @experimental
```
(name: string): ComponentDef<any> | undefined
```
-## getUserComponentFingerprint — function
+## getUserComponentFingerprint — function @experimental
```
(): string
```
-## getUserComponents — function
+## getUserComponents — function @experimental
```
(): Map<string, AnyComponentDef>
```
-## getWeChatPackOptions — function
+## getWeChatPackOptions — function @experimental
```
(): Array<{ type: string; value: string; }>
```
-## hasPlayableCta — function
+## hasPlayableCta — function @experimental
```
(): boolean
```
-## hasVisibility — function
+## hasVisibility — function @experimental
```
(world: World, entity: Entity): boolean
```
-## headlessBasePlugins — const
+## headlessBasePlugins — const @experimental
```
() => Plugin[]
```
-## imageBitmapOptions — function
+## imageBitmapOptions — function @experimental
```
(flip: boolean): ImageBitmapOptions
```
-## indexPackagedManifest — function
+## indexPackagedManifest — function @experimental
```
(manifest: AddressableManifest): PackagedAssetIndex
```
-## info — function
+## info — function @experimental
```
(category: string, message: string, data?: unknown): void
```
-## initPlayRealmRuntime — function
+## initPlayRealmRuntime — function @experimental
```
(config: PlayRealmRuntimeConfig): Promise<void>
```
-## initPlayableRuntime — function
+## initPlayableRuntime — function @experimental
```
(config: PlayableRuntimeConfig): Promise<void>
```
-## initRuntime — function
+## initRuntime — function @experimental
```
(config: RuntimeInitConfig): Promise<void>
```
-## initWeChatRuntime — function
+## initWeChatRuntime — function @experimental
```
(config: WeChatRuntimeConfig): Promise<void>
```
-## inputEventCallbacks — function
+## inputEventCallbacks — function @experimental
```
(state: InputState): InputEventCallbacks
```
-## inputPlugin — const
+## inputPlugin — const @experimental
```
InputPlugin
```
-## inputRouter — const
+## inputRouter — const @experimental
```
InputRouter
```
-## installEditorGrid — function
+## installEditorGrid — function @experimental
```
(app: App): void
```
-## instantiatePrefab — function
+## instantiatePrefab — function @experimental
```
(world: World, prefab: PrefabData, options?: InstantiatePrefabOptions): Promise<InstantiatePrefabResult>
```
-## interactionController — function
+## interactionController — function @experimental
```
(pages?: string[]): ControllerState
```
-## interpolate — function
+## interpolate — function @experimental
```
(template: string, params?: TParams): string
```
-## intersectRects — function
+## intersectRects — function @experimental
```
(a: ScreenRect, b: ScreenRect): ScreenRect
```
-## invertMatrix4 — function
+## invertMatrix4 — function @experimental
```
(m: Float32Array, result?: Float32Array): Float32Array
```
-## invokeAction — function
+## invokeAction — function @experimental
```
<Ctx>(registry: AiRegistry<Ctx>, name: string, ctx: Ctx, bb: Blackboard, input?: AiActionInput): void | Status
```
-## isAuto — const
+## isAuto — const @experimental
```
(d: Dimension) => boolean
```
-## isBuiltinComponent — function
+## isBuiltinComponent — function @experimental
```
(comp: AnyComponentDef): comp is BuiltinComponentDef<any>
```
-## isCollisionPaletteRef — function
+## isCollisionPaletteRef — function @experimental
```
(refs: readonly string[]): boolean
```
-## isCustomExtension — function
+## isCustomExtension — function @experimental
```
(path: string): boolean
```
-## isDialogOpen — function
+## isDialogOpen — function @experimental
```
(world: World, root: Entity): boolean
```
-## isDropdownOpen — function
+## isDropdownOpen — function @experimental
```
(world: World, e: Entity): boolean
```
-## isEditor — function
+## isEditor — function @experimental
```
(): boolean
```
-## isEmptyStamp — function
+## isEmptyStamp — function @experimental
```
(s: TileStamp): boolean
```
-## isEntityActive — function
+## isEntityActive — function @experimental
```
(world: World, entity: Entity): boolean
```
-## isEntityVisible — function
+## isEntityVisible — function @experimental
```
(world: World, entity: Entity): boolean
```
-## isFxEditPreview — function
+## isFxEditPreview — function @experimental
```
(): boolean
```
-## isHexOrientation — function
+## isHexOrientation — function @experimental
```
(orientation: number): boolean
```
-## isKnownAssetExtension — function
+## isKnownAssetExtension — function @experimental
```
(ext: string): boolean
```
-## isNative — function
+## isNative — function @experimental
```
(): boolean
```
-## isNonOrthogonal — function
+## isNonOrthogonal — function @experimental
```
(orientation: number): boolean
```
-## isPlatformInitialized — function
+## isPlatformInitialized — function @experimental
```
(): boolean
```
-## isPlayMode — function
+## isPlayMode — function @experimental
```
(): boolean
```
-## isRuntime — function
+## isRuntime — function @experimental
```
(): boolean
```
-## isTextureRef — function
+## isTextureRef — function @experimental
```
(v: UniformValue): v is TextureRef
```
-## isWeChat — function
+## isWeChat — function @experimental
```
(): boolean
```
-## isWeb — function
+## isWeb — function @experimental
```
(): boolean
```
-## layerFrontness — function
+## layerFrontness — function @experimental
```
(order: LayerOrder, worldY: number, worldZ: number): number
```
-## layerOrderOf — function
+## layerOrderOf — function @experimental
```
(layer: number, ySortMask: number, depthMask: number): LayerOrder
```
-## leafStateOf — function
+## leafStateOf — function @experimental
```
(def: AnimatorControllerDef, path: string): AnimatorState | null
```
-## lifecyclePlugin — const
+## lifecyclePlugin — const @experimental
```
LifecyclePlugin
```
-## loadComponent — function
+## loadComponent — function @experimental
```
(world: World, entity: Entity, compData: SceneComponentData, entityName?: string): void
```
-## loadInputMapAsset — function
+## loadInputMapAsset — function @experimental
```
(asset: InputMapAsset): InputMap
```
-## loadPackagedAssetIndex — function
+## loadPackagedAssetIndex — function @experimental
```
(manifestPath?: string): Promise<PackagedAssetIndex>
```
-## loadPhysicsModule — function
+## loadPhysicsModule — function @experimental
```
(wasmUrl: string, factory?: PhysicsModuleFactory): Promise<PhysicsWasmModule>
```
-## loadRuntimeScene — function
+## loadRuntimeScene — function @experimental
```
(options: LoadRuntimeSceneOptions): Promise<void>
```
-## loadSceneData — function
+## loadSceneData — function @experimental
```
(world: World, sceneData: SceneData): Map<number, Entity>
```
-## loadSceneWithAssets — function
+## loadSceneWithAssets — function @experimental
```
(world: World, sceneData: SceneData, options?: SceneLoadOptions): Promise<Map<number, Entity>>
```
-## loadTiledMap — function
+## loadTiledMap — function @experimental
```
(world: World, mapData: TiledMapData, textureHandles: Map<string, number>, options?: TilemapLoadOptions): Entity[]
```
-## localizationPlugin — const
+## localizationPlugin — const @experimental
```
LocalizationPlugin
```
-## log — const
+## log — const @experimental
```
Logger
```
-## looksLikeAssetPath — function
+## looksLikeAssetPath — function @experimental
```
(value: unknown): value is string
```
-## makeLosCheck — function
+## makeLosCheck — function @experimental
```
(physics: PhysicsAPI): LosCheck
```
-## makeWidgetInteractable — function
+## makeWidgetInteractable — function @experimental
```
(world: World, entity: Entity, init?: WidgetInteractionInit): void
```
-## markThemed — function
+## markThemed — function @experimental
```
(world: World, entity: Entity, style: ThemeStyleData): void
```
-## matchLocale — function
+## matchLocale — function @experimental
```
(tag: string, available: readonly string[]): string | null
```
-## maxChildren — function
+## maxChildren — function @experimental
```
(type: BtNodeType): number
```
-## measureText — function
+## measureText — function @experimental
```
(text: string, opts: MeasureTextOptions): TextMetrics
```
-## mesh2dPlugin — const
+## mesh2dPlugin — const @experimental
```
Mesh2DPlugin
```
-## messageOf — function
+## messageOf — function @experimental
```
(error: unknown): string
```
-## migratePrefabData — function
+## migratePrefabData — function @experimental
```
(raw: unknown): MigrationResult
```
-## migrateSaveData — function
+## migrateSaveData — function @experimental
```
(version: number, data: unknown, currentVersion: number, migrations: Record<number, SaveMigration>): unknown
```
-## migrateSceneData — function
+## migrateSceneData — function @experimental
```
(raw: SceneData): SceneMigrationResult
```
-## modeToDelivery — function
+## modeToDelivery — function @experimental
```
(mode: AssetGroupMode): BundleMode
```
-## moveAnimatorState — function
+## moveAnimatorState — function @experimental
```
(def: AnimatorControllerDef, name: string, x: number, y: number): AnimatorControllerDef
```
-## moveBtNode — function
+## moveBtNode — function @experimental
```
(def: BtDefinition, id: string, x: number, y: number): BtDefinition
```
@@ -10311,22 +10311,22 @@ Mesh2DPlugin
(g: MaterialGraph, id: string, x: number, y: number): MaterialGraph
```
-## moveState — function
+## moveState — function @experimental
```
(def: FsmDefinition, name: string, x: number, y: number): FsmDefinition
```
-## navGridFromTilemapLayer — function
+## navGridFromTilemapLayer — function @experimental
```
(entity: Entity, opts: BuildNavGridOptions): NavGrid
```
-## navGridFromTiles — function
+## navGridFromTiles — function @experimental
```
(getTile: (x: number, y: number) => number, opts: BuildNavGridOptions): NavGrid
```
-## navPlugin — const
+## navPlugin — const @experimental
```
NavPlugin
```
@@ -10336,382 +10336,382 @@ NavPlugin
(): MaterialGraph
```
-## normalizeAngle — function
+## normalizeAngle — function @experimental
```
(a: number): number
```
-## normalizeBundleMode — function
+## normalizeBundleMode — function @experimental
```
(mode: string | undefined | null): BundleMode
```
-## normalizeCornerMask — function
+## normalizeCornerMask — function @experimental
```
(mask: number): number
```
-## openDialog — function
+## openDialog — function @experimental
```
(world: World, events: UIEventQueue, root: Entity): void
```
-## openDropdown — function
+## openDropdown — function @experimental
```
(world: World, events: UIEventQueue, e: Entity): void
```
-## orientationPerm — function
+## orientationPerm — function @experimental
```
(flags: TileFlags): Perm
```
-## packCorners — function
+## packCorners — function @experimental
```
(tl: number, tr: number, br: number, bl: number): number
```
-## packagedAppOptions — function
+## packagedAppOptions — function @experimental
```
(config: Pick<PackagedGameConfig, "ySortLayers" | "depthLayers" | "colorSpace" | "screenFit">): { ySortLayers?: number; depthLayers?: number; colorSpace?: "gamma" | "linear"; screenFit?: PackagedGameConfig["screenFit"]; }
```
-## packagedRuntimeInit — function
+## packagedRuntimeInit — function @experimental
```
(config: Pick<PackagedGameConfig, "physicsEnabled" | "physicsConfig" | "audioConfig" | "uiTheme" | "uiThemeColors" | "achievements" | "steamAppId" | "screenFit">): { physicsEnabled?: boolean; physicsConfig?: PhysicsPluginConfig; audioConfig?: AudioProjectConfig; uiTheme?: "light"; uiThemeOverrides?: ThemeOverrides; achievements?: string[]; steamAppId?: number; screenFit?: PackagedGameConfig["screenFit"]; }
```
-## paramDefaultValue — function
+## paramDefaultValue — function @experimental
```
(param: ShaderParam): unknown
```
-## parseActionArg — function
+## parseActionArg — function @experimental
```
(arg: string | undefined, params: readonly AiParamDef[], separator?: string): Record<string, AiParamValue>
```
-## parseAnimClipAsset — function
+## parseAnimClipAsset — function @experimental
```
(rawJson: unknown): AnimClipAssetData
```
-## parseAnimClipData — function
+## parseAnimClipData — function @experimental
```
(clipPath: string, data: AnimClipAssetData, textureHandles: Map<string, number>): SpriteAnimClip
```
-## parseAnimationClip — function
+## parseAnimationClip — function @experimental
```
(rawJson: unknown): TimelineAsset
```
-## parseAudioProjectConfig — function
+## parseAudioProjectConfig — function @experimental
```
(raw: unknown): AudioProjectConfig
```
-## parseBusEffects — function
+## parseBusEffects — function @experimental
```
(raw: unknown): BusEffectDef[]
```
-## parseCollisionMaterial — function
+## parseCollisionMaterial — function @experimental
```
(refs: readonly string[]): CollisionMaterial
```
-## parseLocaleTable — function
+## parseLocaleTable — function @experimental
```
(text: string, path: string): LocaleTableAsset
```
-## parseRichText — function
+## parseRichText — function @experimental
```
(input: string): RichTextRun[]
```
-## parseThemeOverrides — function
+## parseThemeOverrides — function @experimental
```
(colors?: Record<string, string>): ThemeOverrides | undefined
```
-## parseTileset — function
+## parseTileset — function @experimental
```
(rawJson: unknown): TilesetAsset
```
-## parseTimelineAsset — function
+## parseTimelineAsset — function @experimental
```
(rawJson: unknown): TimelineAsset
```
-## parseTmjJson — function
+## parseTmjJson — function @experimental
```
(json: Record<string, unknown>): TiledMapData | null
```
-## parseTmjWithExternals — function
+## parseTmjWithExternals — function @experimental
```
(json: Record<string, unknown>, resolveExternal: (source: string) => Promise<string>): Promise<TiledMapData | null>
```
-## particlePlugin — const
+## particlePlugin — const @experimental
```
ParticlePlugin
```
-## pathToWorld — function
+## pathToWorld — function @experimental
```
(grid: NavGrid, path: Cell[]): Vec2[]
```
-## percent — const
+## percent — const @experimental
```
(n: number) => Dimension
```
-## perceptionPlugin — const
+## perceptionPlugin — const @experimental
```
PerceptionPlugin
```
-## platformFetch — function
+## platformFetch — function @experimental
```
(url: string, options?: PlatformRequestOptions): Promise<PlatformResponse>
```
-## platformFileExists — function
+## platformFileExists — function @experimental
```
(path: string): Promise<boolean>
```
-## platformInstantiateWasm — function
+## platformInstantiateWasm — function @experimental
```
(pathOrBuffer: string | ArrayBuffer, imports: WebAssembly.Imports): Promise<WasmInstantiateResult>
```
-## platformReadFile — function
+## platformReadFile — function @experimental
```
(path: string): Promise<ArrayBuffer>
```
-## platformReadTextFile — function
+## platformReadTextFile — function @experimental
```
(path: string): Promise<string>
```
-## playModeOnly — function
+## playModeOnly — function @experimental
```
(): boolean
```
-## playableCta — function
+## playableCta — function @experimental
```
(): void
```
-## pointInHitArea — function
+## pointInHitArea — function @experimental
```
(px: number, py: number, area: HitAreaShape): boolean
```
-## pointInOBB — function
+## pointInOBB — function @experimental
```
(px: number, py: number, worldX: number, worldY: number, worldW: number, worldH: number, pivotX: number, pivotY: number, rotationZ: number, rotationW: number): boolean
```
-## pointInWorldRect — function
+## pointInWorldRect — function @experimental
```
(px: number, py: number, worldX: number, worldY: number, worldW: number, worldH: number, pivotX: number, pivotY: number): boolean
```
-## postProcessPlugin — const
+## postProcessPlugin — const @experimental
```
PostProcessPlugin
```
-## prefabsPlugin — const
+## prefabsPlugin — const @experimental
```
PrefabsPlugin
```
-## preloadNestedPrefabs — function
+## preloadNestedPrefabs — function @experimental
```
(prefab: PrefabData, loadPrefab: (path: string) => Promise<PrefabData>, cache: Map<string, PrefabData>, visited?: Set<string>, depth?: number): Promise<void>
```
-## previewPlugin — function
+## previewPlugin — function @experimental
```
(sceneUrl: string, baseUrl?: string): PreviewPlugin
```
-## probeRegistrations — function
+## probeRegistrations — function @experimental
```
(register: () => Promise<void>): Promise<ProbedRegistrations>
```
-## projectSideModuleIds — function
+## projectSideModuleIds — function @experimental
```
(): string[]
```
-## px — const
+## px — const @experimental
```
(n: number) => Dimension
```
-## quat — const
+## quat — const @experimental
```
(w?: number, x?: number, y?: number, z?: number) => Quat
```
-## quaternionToAngle2D — function
+## quaternionToAngle2D — function @experimental
```
(rz: number, rw: number): number
```
-## radiusInterest — function
+## radiusInterest — function @experimental
```
(radius: number, options?: RadiusInterestOptions): InterestPolicy
```
-## readColliderShapes — function
+## readColliderShapes — function @experimental
```
(world: World, entity: number): ColliderInstance[]
```
-## readFieldPath — function
+## readFieldPath — function @experimental
```
(data: Record<string, unknown>, path: string): unknown
```
-## readPtrField — function
+## readPtrField — function @experimental
```
(f32: Float32Array, u32: Uint32Array, u8: Uint8Array, ptr: number, field: PtrFieldDesc): unknown
```
-## rebuildChildren — function
+## rebuildChildren — function @experimental
```
(entities: ProcessedEntity[]): void
```
-## recoverDevice — function
+## recoverDevice — function @experimental
```
(): boolean
```
-## reflectEsshader — function
+## reflectEsshader — function @experimental
```
(source: string): ShaderReflection
```
-## registerAction — function
+## registerAction — function @experimental
```
(name: string, fn: AiAction<AiContext>): void
```
-## registerAnimatorController — function
+## registerAnimatorController — function @experimental
```
(key: string, def: AnimatorControllerDef): void
```
-## registerAssetBuildTransform — function
+## registerAssetBuildTransform — function @experimental
```
(editorType: EditorAssetType, transform: AssetBuildTransform): void
```
-## registerBt — function
+## registerBt — function @experimental
```
(key: string, def: BtDefinition): BtDefinition
```
-## registerCensusProbe — function
+## registerCensusProbe — function @experimental
```
(probe: CensusProbe): () => void
```
-## registerComponent — function
+## registerComponent — function @experimental
```
(name: string, def: AnyComponentDef): void
```
-## registerCondition — function
+## registerCondition — function @experimental
```
(name: string, fn: AiCondition<AiContext>): void
```
-## registerDrawCallback — function
+## registerDrawCallback — function @experimental
```
(id: string, fn: DrawCallback, scene?: string): void
```
-## registerFsm — function
+## registerFsm — function @experimental
```
(key: string, def: FsmDefinition): CompiledFsm
```
-## registerPackagedSideModules — function
+## registerPackagedSideModules — function @experimental
```
(config: Pick<PackagedGameConfig, "sideModules">): void
```
-## registerPreSceneDrawCallback — function
+## registerPreSceneDrawCallback — function @experimental
```
(id: string, fn: PreSceneDrawCallback): void
```
-## registerSceneComponentCodec — function
+## registerSceneComponentCodec — function @experimental
```
(type: string, codec: SceneComponentCodec): void
```
-## registerSideModule — function
+## registerSideModule — function @experimental
```
(id: string, descriptor: SideModuleDescriptor): void
```
-## registerTilemapSource — function
+## registerTilemapSource — function @experimental
```
(path: string, data: LoadedTilemapSource): void
```
-## registerTimelineAsset — function
+## registerTimelineAsset — function @experimental
```
(path: string, asset: TimelineAsset): void
```
-## remapComponentEntityRefs — function
+## remapComponentEntityRefs — function @experimental
```
(components: ComponentData[], idMapping: Map<PrefabEntityId, number>): void
```
-## remapEntityFields — function
+## remapEntityFields — function @experimental
```
(compData: SceneComponentData, entityMap: Map<number, Entity>): void
```
-## removeAnimatorParam — function
+## removeAnimatorParam — function @experimental
```
(def: AnimatorControllerDef, name: string): AnimatorControllerDef
```
-## removeAnimatorState — function
+## removeAnimatorState — function @experimental
```
(def: AnimatorControllerDef, name: string): AnimatorControllerDef
```
-## removeAnimatorTransition — function
+## removeAnimatorTransition — function @experimental
```
(def: AnimatorControllerDef, from: string, index: number): AnimatorControllerDef
```
-## removeBtNode — function
+## removeBtNode — function @experimental
```
(def: BtDefinition, id: string): BtDefinition
```
-## removeCacheForEntity — function
+## removeCacheForEntity — function @experimental
```
(entityId: number): BitmapCache | undefined
```
@@ -10721,107 +10721,107 @@ PrefabsPlugin
(g: MaterialGraph, id: string): MaterialGraph
```
-## removeState — function
+## removeState — function @experimental
```
(def: FsmDefinition, name: string): FsmDefinition
```
-## removeTransition — function
+## removeTransition — function @experimental
```
(def: FsmDefinition, from: string, index: number): FsmDefinition
```
-## renameAnimatorState — function
+## renameAnimatorState — function @experimental
```
(def: AnimatorControllerDef, oldName: string, newName: string): AnimatorControllerDef
```
-## renameState — function
+## renameState — function @experimental
```
(def: FsmDefinition, oldName: string, newName: string): FsmDefinition
```
-## reparentBtNode — function
+## reparentBtNode — function @experimental
```
(def: BtDefinition, id: string, newParentId: string): BtDefinition
```
-## replicationPlugin — const
+## replicationPlugin — const @experimental
```
ReplicationPlugin
```
-## reportDeviceLost — function
+## reportDeviceLost — function @experimental
```
(reason: number, message: string): void
```
-## requireResourceManager — function
+## requireResourceManager — function @experimental
```
(): CppResourceManager
```
-## resetWorldTo — function
+## resetWorldTo — function @experimental
```
(world: World, sceneData: SceneData): Map<number, Entity>
```
-## resolveAssetGroup — function
+## resolveAssetGroup — function @experimental
```
(projectRelPath: string, config: AssetGroupsConfig | null | undefined): ResolvedAssetGroup
```
-## resolveAtlas — function
+## resolveAtlas — function @experimental
```
(projectRelPath: string, config: AssetGroupsConfig | null | undefined): ResolvedAtlas | null
```
-## resolveAutotile — function
+## resolveAutotile — function @experimental
```
(index: TerrainIndex, neighbors: readonly boolean[]): number
```
-## resolveBindingTarget — function
+## resolveBindingTarget — function @experimental
```
(world: World, from: Entity, name: string): Entity | null
```
-## resolveChildEntity — function
+## resolveChildEntity — function @experimental
```
(world: Pick<World, "tryGet">, rootEntity: Entity, childPath: string): Entity | null
```
-## resolveParams — function
+## resolveParams — function @experimental
```
(def: AnimatorControllerDef, overrides: ReadonlyMap<string, number | boolean>): Record<string, number | boolean>
```
-## resolveRelativePath — function
+## resolveRelativePath — function @experimental
```
(basePath: string, relativePath: string): string
```
-## resolveThemeTokens — function
+## resolveThemeTokens — function @experimental
```
(base: "dark" | "light", overrides?: ThemeOverrides): ThemeTokens
```
-## resolveTilesetModel — function
+## resolveTilesetModel — function @experimental
```
(tilesets: ResolvedTileset[]): TilesetModel
```
-## resolveWang — function
+## resolveWang — function @experimental
```
(index: WangIndex, corners: readonly number[]): number
```
-## rotateFlagsCW — function
+## rotateFlagsCW — function @experimental
```
(flags: TileFlags): TileFlags
```
-## rotateStampCW — function
+## rotateStampCW — function @experimental
```
(s: TileStamp): TileStamp
```
@@ -10831,657 +10831,657 @@ ReplicationPlugin
(app: App, options?: { fps?: number; }): () => void
```
-## safeAreaPlugin — const
+## safeAreaPlugin — const @experimental
```
SafeAreaPlugin
```
-## sampleTimeline — function
+## sampleTimeline — function @experimental
```
(asset: TimelineAsset, time: number, rootEntity: Entity, deps: SampleDeps, opts?: SampleOptions): void
```
-## sampleTimelineInWorld — function
+## sampleTimelineInWorld — function @experimental
```
(asset: TimelineAsset, time: number, world: SampleWorld & Pick<World, "tryGet">, rootEntity: Entity, opts?: SampleOptions): void
```
-## scalar — const
+## scalar — const @experimental
```
{ readonly clamp: (x: number, min: number, max: number) => number; readonly clamp01: (x: number) => number; readonly lerp: (a: number, b: number, t: number) => number; readonly inverseLerp: (a: number, b: number, value: number) => number; readonly remap: (value: number, inMin: number, inMax: number, outMin: number, outMax: number) => number; readonly deg2rad: (deg: number) => number; readonly rad2deg: (rad: number) => number; readonly approximately: (a: number, b: number, epsilon?: number) => boolean; readonly smoothstep: (edge0: number, edge1: number, x: number) => number; readonly mod: (x: number, n: number) => number; readonly sign: (x: number) => number; }
```
-## sceneManagerPlugin — const
+## sceneManagerPlugin — const @experimental
```
Plugin
```
-## sceneUsesI18n — function
+## sceneUsesI18n — function @experimental
```
(sceneData: SceneData): boolean
```
-## screenToUiWorld — function
+## screenToUiWorld — function @experimental
```
(camera: UICameraData, screenGLX: number, screenGLY: number): { x: number; y: number; }
```
-## screenToWorld — function
+## screenToWorld — function @experimental
```
(screenX: number, screenY: number, inverseVP: Float32Array, vpX: number, vpY: number, vpW: number, vpH: number, planeZ?: number): { x: number; y: number; }
```
-## selectBlendClip — function
+## selectBlendClip — function @experimental
```
(blend: AnimatorBlend1D, value: number): AnimatorBlendThreshold
```
-## selectPluralForm — function
+## selectPluralForm — function @experimental
```
(forms: PluralForms, count: number, selector: PluralSelector): string
```
-## senseTarget — function
+## senseTarget — function @experimental
```
(ox: number, oy: number, facing: number, tx: number, ty: number, range: number, halfFov: number, isBlocked?: (ox: number, oy: number, tx: number, ty: number) => boolean): SenseResult
```
-## serializeAnimClip — function
+## serializeAnimClip — function @experimental
```
(asset: AnimClipAssetData): Record<string, unknown>
```
-## serializeScene — function
+## serializeScene — function @experimental
```
(world: World, sceneName?: string): SceneData
```
-## serializeTileset — function
+## serializeTileset — function @experimental
```
(asset: TilesetAsset): Record<string, unknown>
```
-## serializeTimelineAsset — function
+## serializeTimelineAsset — function @experimental
```
(asset: TimelineAsset): Record<string, unknown>
```
-## serializeTimelineToJson — function
+## serializeTimelineToJson — function @experimental
```
(asset: TimelineAsset, indent?: number): string
```
-## servicesPlugin — const
+## servicesPlugin — const @experimental
```
ServicesPlugin
```
-## setAnimatorConditions — function
+## setAnimatorConditions — function @experimental
```
(def: AnimatorControllerDef, from: string, index: number, conditions: AnimatorCondition[]): AnimatorControllerDef
```
-## setAnimatorInitial — function
+## setAnimatorInitial — function @experimental
```
(def: AnimatorControllerDef, name: string): AnimatorControllerDef
```
-## setAnimatorStateClip — function
+## setAnimatorStateClip — function @experimental
```
(def: AnimatorControllerDef, name: string, clip: string): AnimatorControllerDef
```
-## setAnimatorStateProps — function
+## setAnimatorStateProps — function @experimental
```
(def: AnimatorControllerDef, name: string, patch: { speed?: number; loop?: boolean; }): AnimatorControllerDef
```
-## setBtNodeField — function
+## setBtNodeField — function @experimental
```
(def: BtDefinition, id: string, patch: Partial<BtNode>): BtDefinition
```
-## setButtonState — function
+## setButtonState — function @experimental
```
(world: World, entity: Entity, state: string): void
```
-## setCacheForEntity — function
+## setCacheForEntity — function @experimental
```
(entityId: number, cache: BitmapCache): void
```
-## setControllerPage — function
+## setControllerPage — function @experimental
```
(world: World, entity: Entity, name: string, page: string): boolean
```
-## setDefaultContext — function
+## setDefaultContext — function @experimental
```
(ctx: AppContext): void
```
-## setEditorMode — function
+## setEditorMode — function @experimental
```
(active: boolean): void
```
-## setEditorViewHalfHeight — function
+## setEditorViewHalfHeight — function @experimental
```
(view: EditorViewData, halfH: number): void
```
-## setEntityActive — function
+## setEntityActive — function @experimental
```
(world: World, entity: Entity, active: boolean): void
```
-## setEntityVisible — function
+## setEntityVisible — function @experimental
```
(world: World, entity: Entity, visible: boolean): void
```
-## setFxEditPreview — function
+## setFxEditPreview — function @experimental
```
(enabled: boolean): void
```
-## setInitial — function
+## setInitial — function @experimental
```
(def: FsmDefinition, name: string): FsmDefinition
```
-## setLogLevel — function
+## setLogLevel — function @experimental
```
(level: LogLevel): void
```
-## setNavDestination — function
+## setNavDestination — function @experimental
```
(world: World, entity: Entity, target: Vec2): void
```
-## setPlayMode — function
+## setPlayMode — function @experimental
```
(active: boolean): void
```
-## setStateHook — function
+## setStateHook — function @experimental
```
(def: FsmDefinition, name: string, hook: "onEnter" | "onUpdate" | "onExit", action: string, arg?: string, params?: Record<string, AiParamValue>): FsmDefinition
```
-## setTextureBudget — function
+## setTextureBudget — function @experimental
```
(bytes: number): void
```
-## setTextureFilter — function
+## setTextureFilter — function @experimental
```
(textureId: number, filter: TextureFilter): void
```
-## setTextureParams — function
+## setTextureParams — function @experimental
```
(textureId: number, minFilter: TextureFilter, magFilter: TextureFilter, wrapS: TextureWrap, wrapT: TextureWrap): void
```
-## setTextureSliceBorder — function
+## setTextureSliceBorder — function @experimental
```
(textureId: number, left: number, right: number, top: number, bottom: number): void
```
-## setTextureWrap — function
+## setTextureWrap — function @experimental
```
(textureId: number, wrap: TextureWrap): void
```
-## setTheme — function
+## setTheme — function @experimental
```
(tokens: ThemeTokens): void
```
-## setUIVisible — function
+## setUIVisible — function @experimental
```
(world: World, entity: Entity, visible: boolean): void
```
-## setViewTarget — function
+## setViewTarget — function @experimental
```
(host: CameraDirectorHost, entity: number, opts?: { time?: number; curve?: number; }): void
```
-## setWasmErrorHandler — function
+## setWasmErrorHandler — function @experimental
```
(handler: WasmErrorHandler | null): void
```
-## shakeCamera — function
+## shakeCamera — function @experimental
```
(host: CameraDirectorHost, opts?: { amplitude?: number; rotation?: number; frequency?: number; duration?: number; }): void
```
-## shapeCenter — function
+## shapeCenter — function @experimental
```
(shape: ColliderShape, worldPos: Vec2, angle: number, ppu: number): Vec2
```
-## shapeOffset — function
+## shapeOffset — function @experimental
```
(shape: ColliderShape): Vec2
```
-## shutdownDrawAPI — function
+## shutdownDrawAPI — function @experimental
```
(): void
```
-## shutdownGLDebugAPI — function
+## shutdownGLDebugAPI — function @experimental
```
(): void
```
-## shutdownGeometryAPI — function
+## shutdownGeometryAPI — function @experimental
```
(): void
```
-## shutdownMaterialAPI — function
+## shutdownMaterialAPI — function @experimental
```
(): void
```
-## shutdownRendererAPI — function
+## shutdownRendererAPI — function @experimental
```
(): void
```
-## shutdownResourceManager — function
+## shutdownResourceManager — function @experimental
```
(): void
```
-## sideModuleDescriptor — function
+## sideModuleDescriptor — function @experimental
```
(id: SideModuleId): SideModuleDescriptor | undefined
```
-## signal — function
+## signal — function @experimental
```
<T>(initial: T): Signal<T>
```
-## singleStamp — function
+## singleStamp — function @experimental
```
(raw: number): TileStamp
```
-## spawnUIEntity — function
+## spawnUIEntity — function @experimental
```
(init: UIEntityInit): Entity
```
-## spineModuleId — function
+## spineModuleId — function @experimental
```
(version: SpineVersion): SideModuleId
```
-## stackOf — function
+## stackOf — function @experimental
```
(error: unknown): string | undefined
```
-## statsPlugin — const
+## statsPlugin — const @experimental
```
StatsPlugin
```
-## stepFsm — function
+## stepFsm — function @experimental
```
<Ctx>(fsm: CompiledFsm, run: FsmRunState, ctx: Ctx, bb: Blackboard, registry: AiRegistry<Ctx>): boolean
```
-## stepPerception — function
+## stepPerception — function @experimental
```
(world: PerceptionWorldView, isBlocked?: LosCheck): void
```
-## stopNavAgent — function
+## stopNavAgent — function @experimental
```
(world: World, entity: Entity): void
```
-## switchTheme — function
+## switchTheme — function @experimental
```
(world: World, tokens: ThemeTokens): void
```
-## takeCensus — function
+## takeCensus — function @experimental
```
(ctx?: CensusContext): Census
```
-## textInputPlugin — const
+## textInputPlugin — const @experimental
```
TextInputPlugin
```
-## textPlugin — const
+## textPlugin — const @experimental
```
TextPlugin
```
-## textureImportSettingsFrom — function
+## textureImportSettingsFrom — function @experimental
```
(importer: Record<string, unknown> | undefined | null): ParsedTextureImportSettings | undefined
```
-## themeButtonStates — function
+## themeButtonStates — function @experimental
```
(): Record<string, ButtonStateVisual>
```
-## themeColors — function
+## themeColors — function @experimental
```
(): ThemeColors
```
-## themeType — function
+## themeType — function @experimental
```
(): ThemeType
```
-## tickBt — function
+## tickBt — function @experimental
```
<Ctx>(def: BtDefinition, ctx: Ctx, bb: Blackboard, registry: AiRegistry<Ctx>, rs: BtRunState, dt: number): Status
```
-## tileCellCenter — function
+## tileCellCenter — function @experimental
```
(p: TileGridParams, tx: number, ty: number): Vec2Like
```
-## tileCellOutline — function
+## tileCellOutline — function @experimental
```
(p: TileGridParams): Vec2Like[]
```
-## tileCollisionOutlines — function
+## tileCollisionOutlines — function @experimental
```
(chunks: DecodedChunk[], model: TilesetModel, tileW: number, tileH: number, originX: number, originY: number): TileCollisionPiece[]
```
-## tileFlagsOf — function
+## tileFlagsOf — function @experimental
```
(raw: number): TileFlags
```
-## tileIdOf — function
+## tileIdOf — function @experimental
```
(raw: number): number
```
-## tilemapPlugin — const
+## tilemapPlugin — const @experimental
```
TilemapPlugin
```
-## timelinePlugin — const
+## timelinePlugin — const @experimental
```
TimelinePlugin
```
-## timerPlugin — const
+## timerPlugin — const @experimental
```
Plugin
```
-## toBuildPath — function
+## toBuildPath — function @experimental
```
(path: string): string
```
-## trailPlugin — const
+## trailPlugin — const @experimental
```
TrailPlugin
```
-## transitionTo — function
+## transitionTo — function @experimental
```
(host: App | SceneManagerState, targetScene: string, config: TransitionConfig): Promise<void>
```
-## trimTextureCache — function
+## trimTextureCache — function @experimental
```
(): number
```
-## uiHitTestWorld — function
+## uiHitTestWorld — function @experimental
```
(engine: EngineApi | null, registry: CppRegistry, worldX: number, worldY: number, mouseDown?: boolean, mousePressed?: boolean, mouseReleased?: boolean): Entity | null
```
-## uiInteractionPlugin — const
+## uiInteractionPlugin — const @experimental
```
UIInteractionPlugin
```
-## uiLayoutPlugin — const
+## uiLayoutPlugin — const @experimental
```
UILayoutPlugin
```
-## uiLayoutRect — function
+## uiLayoutRect — function @experimental
```
(cam: CameraExtents, fit: CanvasScale | null, width: number, height: number, previewAspect?: number): WorldRect
```
-## uiMaskPlugin — const
+## uiMaskPlugin — const @experimental
```
UIMaskPlugin
```
-## uiPickAllWorld — function
+## uiPickAllWorld — function @experimental
```
(engine: EngineApi | null, registry: CppRegistry, worldX: number, worldY: number): Entity[]
```
-## uiPickWorld — function
+## uiPickWorld — function @experimental
```
(engine: EngineApi | null, registry: CppRegistry, worldX: number, worldY: number): Entity | null
```
-## uiPlugin — const
+## uiPlugin — const @experimental
```
UIPlugin
```
-## uiPlugins — const
+## uiPlugins — const @experimental
```
Plugin[]
```
-## uiRenderOrderPlugin — const
+## uiRenderOrderPlugin — const @experimental
```
UIRenderOrderPlugin
```
-## uiVisibilityPlugin — const
+## uiVisibilityPlugin — const @experimental
```
UIVisibilityPlugin
```
-## uiWorldToScreen — function
+## uiWorldToScreen — function @experimental
```
(camera: UICameraData, worldX: number, worldY: number): { x: number; y: number; }
```
-## unregisterComponent — function
+## unregisterComponent — function @experimental
```
(name: string): void
```
-## unregisterDrawCallback — function
+## unregisterDrawCallback — function @experimental
```
(id: string): void
```
-## unregisterPreSceneDrawCallback — function
+## unregisterPreSceneDrawCallback — function @experimental
```
(id: string): void
```
-## updateAnimatorParam — function
+## updateAnimatorParam — function @experimental
```
(def: AnimatorControllerDef, name: string, patch: Partial<AnimatorParam>): AnimatorControllerDef
```
-## updateAnimatorTransition — function
+## updateAnimatorTransition — function @experimental
```
(def: AnimatorControllerDef, from: string, index: number, patch: Partial<AnimatorTransition>): AnimatorControllerDef
```
-## updateCameraAspectRatio — function
+## updateCameraAspectRatio — function @experimental
```
(world: World, aspectRatio: number): void
```
-## updateTransition — function
+## updateTransition — function @experimental
```
(def: FsmDefinition, from: string, index: number, patch: Partial<FsmTransition>): FsmDefinition
```
-## usesStagger — function
+## usesStagger — function @experimental
```
(orientation: number): boolean
```
-## v2 — const
+## v2 — const @experimental
```
{ readonly create: (x?: number, y?: number) => Vec2; readonly clone: (a: Vec2) => Vec2; readonly add: (a: Vec2, b: Vec2) => Vec2; readonly sub: (a: Vec2, b: Vec2) => Vec2; readonly scale: (a: Vec2, s: number) => Vec2; readonly mul: (a: Vec2, b: Vec2) => Vec2; readonly neg: (a: Vec2) => Vec2; readonly dot: (a: Vec2, b: Vec2) => number; readonly cross: (a: Vec2, b: Vec2) => number; readonly len: (a: Vec2) => number; readonly len2: (a: Vec2) => number; readonly dist: (a: Vec2, b: Vec2) => number; readonly dist2: (a: Vec2, b: Vec2) => number; readonly normalize: (a: Vec2) => Vec2; readonly lerp: (a: Vec2, b: Vec2, t: number) => Vec2; readonly angle: (a: Vec2) => number; readonly fromAngle: (radians: number, length?: number) => Vec2; readonly rotate: (a: Vec2, radians: number) => Vec2; readonly perp: (a: Vec2) => Vec2; readonly equals: (a: Vec2, b: Vec2, epsilon?: number) => boolean; }
```
-## v3 — const
+## v3 — const @experimental
```
{ readonly create: (x?: number, y?: number, z?: number) => Vec3; readonly clone: (a: Vec3) => Vec3; readonly add: (a: Vec3, b: Vec3) => Vec3; readonly sub: (a: Vec3, b: Vec3) => Vec3; readonly scale: (a: Vec3, s: number) => Vec3; readonly mul: (a: Vec3, b: Vec3) => Vec3; readonly neg: (a: Vec3) => Vec3; readonly dot: (a: Vec3, b: Vec3) => number; readonly cross: (a: Vec3, b: Vec3) => Vec3; readonly len: (a: Vec3) => number; readonly len2: (a: Vec3) => number; readonly dist: (a: Vec3, b: Vec3) => number; readonly normalize: (a: Vec3) => Vec3; readonly lerp: (a: Vec3, b: Vec3, t: number) => Vec3; readonly equals: (a: Vec3, b: Vec3, epsilon?: number) => boolean; }
```
-## validateOverrides — function
+## validateOverrides — function @experimental
```
(prefab: PrefabData, options?: { instanceOverrides?: readonly PrefabOverride[]; loadPrefab?: (path: string) => PrefabData | null; }): ValidateResult
```
-## validatePrefab — function
+## validatePrefab — function @experimental
```
(prefab: PrefabData, options?: ValidatePrefabOptions): PrefabDiagnostic[]
```
-## vec2 — const
+## vec2 — const @experimental
```
(x?: number, y?: number) => Vec2
```
-## vec3 — const
+## vec3 — const @experimental
```
(x?: number, y?: number, z?: number) => Vec3
```
-## vec4 — const
+## vec4 — const @experimental
```
(x?: number, y?: number, z?: number, w?: number) => Vec4
```
-## velocityPlugin — const
+## velocityPlugin — const @experimental
```
Plugin
```
-## velocitySystem — const
+## velocitySystem — const @experimental
```
SystemDef
```
-## videoPlugin — const
+## videoPlugin — const @experimental
```
VideoPlugin
```
-## warn — function
+## warn — function @experimental
```
(category: string, message: string, data?: unknown): void
```
-## widgetToPrefab — function
+## widgetToPrefab — function @experimental
```
(build: (world: World) => Entity, name: string): PrefabData
```
-## withActiveRemoteRoot — function
+## withActiveRemoteRoot — function @experimental
```
(config: AssetGroupsConfig | null | undefined, remoteRoot: string): AssetGroupsConfig
```
-## withFolderAlwaysInclude — function
+## withFolderAlwaysInclude — function @experimental
```
(config: AssetGroupsConfig | null | undefined, folder: string, on: boolean): AssetGroupsConfig
```
-## withFolderGroup — function
+## withFolderGroup — function @experimental
```
(config: AssetGroupsConfig | null | undefined, folder: string, mode: AssetGroupMode): AssetGroupsConfig
```
-## wrapSceneSystem — function
+## wrapSceneSystem — function @experimental
```
(app: App, sceneName: string, system: SystemDef): SystemDef
```
-## writeFieldPath — function
+## writeFieldPath — function @experimental
```
(data: Record<string, unknown>, path: string, value: unknown): boolean
```
-## writePtrField — function
+## writePtrField — function @experimental
```
(f32: Float32Array, u32: Uint32Array, u8: Uint8Array, ptr: number, field: PtrFieldDesc, value: PtrFieldValue | unknown): void
```
-## wxFileExists — function
+## wxFileExists — function @experimental
```
(path: string): Promise<boolean>
```
-## wxFileExistsSync — function
+## wxFileExistsSync — function @experimental
```
(path: string): boolean
```
-## wxGetImagePixels — function
+## wxGetImagePixels — function @experimental
```
(img: MiniGameImage): ImageLoadResult
```
-## wxLoadImage — function
+## wxLoadImage — function @experimental
```
(path: string): Promise<MiniGameImage>
```
-## wxLoadImagePixels — function
+## wxLoadImagePixels — function @experimental
```
(path: string): Promise<ImageLoadResult>
```
-## wxReadFile — function
+## wxReadFile — function @experimental
```
(path: string): Promise<ArrayBuffer>
```
-## wxReadTextFile — function
+## wxReadTextFile — function @experimental
```
(path: string, encoding?: "utf8" | "utf-8"): Promise<string>
```
-## wxWriteFile — function
+## wxWriteFile — function @experimental
```
(path: string, data: string | ArrayBuffer): Promise<void>
```
diff --git a/tools/api-surface.mjs b/tools/api-surface.mjs
index f4fbf03fc..74e7265c0 100644
--- a/tools/api-surface.mjs
+++ b/tools/api-surface.mjs
@@ -1,50 +1,113 @@
#!/usr/bin/env node
// SPDX-License-Identifier: Apache-2.0
// SPDX-FileCopyrightText: Copyright (c) 2024-present ESEngine Team
-// =============================================================================
-// API surface guard (1.0 governance)
-//
-// The SDK's public surface is a promise: every exported symbol's signature is
-// snapshotted into sdk/etc/<entry>.api.md. Any surface change must ship with a
-// regenerated snapshot, making API drift a reviewed diff instead of an
-// accident. Release tags at the declaration are the single authority for
-// stability: untagged = stable, @beta = experimental, @internal = must not be
-// exported from a public entry (policy error).
-//
-// Run: node tools/api-surface.mjs --check (CI: exit 1 on drift/violation)
-// node tools/api-surface.mjs --update (accept surface changes)
-// node tools/api-surface.mjs --check-dts (built .d.ts still carries it)
-// =============================================================================
+/**
+ * @file api-surface.mjs — the SDK's public surface, snapshotted and governed.
+ *
+ * Every exported symbol's signature is snapshotted into sdk/etc/<entry>.api.md,
+ * so a surface change is a reviewed diff rather than an accident.
+ *
+ * A declaration's release tag is the single authority for stability, and there
+ * is no stable-by-default: an untagged symbol is @experimental, so freezing is
+ * something a maintainer DOES rather than something they forget to prevent.
+ *
+ * @public frozen — 1.0 is expected not to break it
+ * @beta may still adjust
+ * @experimental no compatibility claim (the default)
+ * @internal must not be exported from a public entry
+ *
+ * --check exit 1 on drift or policy violation
+ * --update accept surface changes
+ * --check-dts the built .d.ts still carries the documented surface
+ * --check-baseline the last release's @public promises still hold
+ */
import { readFileSync, writeFileSync, mkdirSync, existsSync } from 'node:fs';
-import { resolve, dirname, join } from 'node:path';
-import { fileURLToPath } from 'node:url';
-import { createRequire } from 'node:module';
-
-const ROOT = resolve(dirname(fileURLToPath(import.meta.url)), '..');
-const SDK = join(ROOT, 'sdk');
-const ETC = join(SDK, 'etc');
-const ts = createRequire(join(SDK, '/'))('typescript');
-
-// Typed public entries (mirrors package.json "exports" + rollup dtsBuilds).
-const ENTRIES = {
- 'index': 'src/index.ts',
- 'index.node': 'src/index.node.ts',
- 'index.native': 'src/index.native.ts',
- 'physics': 'src/physics/index.ts',
- 'spine': 'src/spine/index.ts',
- 'dragonbones': 'src/dragonbones/index.ts',
- 'wasm': 'src/wasm.ts',
- 'wechat': 'src/index.wechat.ts',
- 'minigame': 'src/index.minigame.ts',
-};
+import { execFileSync } from 'node:child_process';
+import { join, relative } from 'node:path';
+import { ROOT, SDK, ETC, ts, ENTRIES, createSdkProgram } from './lib/sdkProgram.mjs';
+import { TIERS, parseSnapshot, baselineFindings } from './lib/apiSnapshot.mjs';
+const MODES = ['--check', '--update', '--check-dts', '--check-baseline'];
const mode = process.argv[2];
-if (mode !== '--check' && mode !== '--update' && mode !== '--check-dts') {
- console.error('usage: node tools/api-surface.mjs --check | --update | --check-dts');
+if (!MODES.includes(mode)) {
+ console.error(`usage: node tools/api-surface.mjs ${MODES.join(' | ')}`);
process.exit(2);
}
+const errors = [];
+
+// ---------------------------------------------------------------------------
+// Baseline — what the last release promised, and whether it still holds
+// ---------------------------------------------------------------------------
+
+/**
+ * The snapshots as of the last release tag. Git rather than a committed copy:
+ * the tag is already the authority for what shipped, and a second copy would
+ * need its own guard to stay honest.
+ */
+function baselineSnapshots(ref) {
+ const out = new Map();
+ for (const entryName of Object.keys(ENTRIES)) {
+ const spec = `${ref}:sdk/etc/${entryName}.api.md`;
+ try {
+ const text = execFileSync('git', ['show', spec], {
+ cwd: ROOT, encoding: 'utf8', maxBuffer: 64 * 1024 * 1024, stdio: ['ignore', 'pipe', 'ignore'],
+ });
+ out.set(entryName, parseSnapshot(text));
+ } catch {
+ // An entry that did not exist at the tag promised nothing.
+ }
+ }
+ return out;
+}
+
+function lastReleaseRef() {
+ const flag = process.argv.find((a) => a.startsWith('--baseline='));
+ if (flag) return flag.slice('--baseline='.length);
+ try {
+ return execFileSync('git', ['describe', '--tags', '--abbrev=0', '--match', 'v[0-9]*'], {
+ cwd: ROOT, encoding: 'utf8', stdio: ['ignore', 'pipe', 'ignore'],
+ }).trim();
+ } catch {
+ return null;
+ }
+}
+
+if (mode === '--check-baseline') {
+ const ref = lastReleaseRef();
+ if (!ref) {
+ console.log('api-surface: no release tag to compare against — nothing was promised yet.');
+ process.exit(0);
+ }
+ const baseline = baselineSnapshots(ref);
+ let failed = 0;
+ let claims = 0;
+ for (const [entryName, was] of baseline) {
+ const file = join(ETC, `${entryName}.api.md`);
+ if (!existsSync(file)) continue;
+ const now = parseSnapshot(readFileSync(file, 'utf8'));
+ claims += [...was.values()].filter((s) => s.tier === 'public').length;
+ const { failures, notes } = baselineFindings(was, now);
+ for (const n of notes) console.log(` note ${entryName}: ${n}`);
+ if (!failures.length) continue;
+ failed += failures.length;
+ console.error(`BROKEN PROMISE: ${entryName} — ${ref} froze these and this tree does not keep them.`);
+ for (const f of failures) console.error(` ${f}`);
+ }
+ if (failed) {
+ console.error(`\napi-surface: ${failed} broken promise(s) against ${ref}.`);
+ console.error('Deprecate for a release before removing, or restore the signature.');
+ process.exit(1);
+ }
+ console.log(`api-surface: ${claims} @public symbol(s) promised at ${ref}, all kept.`);
+ process.exit(0);
+}
+
+// ---------------------------------------------------------------------------
+// Program setup
+// ---------------------------------------------------------------------------
+
// `--check-dts` reads the same entries out of the BUILT declarations. The
// snapshot stays the one authority for what the surface is; this only asks
// whether the `.d.ts` a consumer installs still carries it, which is the one
@@ -58,42 +121,10 @@ const entryPaths = fromDts
.map(([name, p]) => [name, p.replace(/^src\//, 'dist/').replace(/\.ts$/, '.d.ts')]))
: ENTRIES;
-// ---------------------------------------------------------------------------
-// Program setup
-// ---------------------------------------------------------------------------
-
-const configPath = join(SDK, 'tsconfig.json');
-const configFile = ts.readConfigFile(configPath, ts.sys.readFile);
-const parsed = ts.parseJsonConfigFileContent(configFile.config, ts.sys, SDK);
-const rootNames = Object.values(entryPaths).map((p) => join(SDK, p));
-const absent = rootNames.filter((p) => !existsSync(p));
-if (absent.length) {
- console.error('api-surface: the SDK is not built — run `pnpm --filter ./sdk build` first.');
- for (const p of absent) console.error(` missing ${p.replace(SDK + '/', '')}`);
- process.exit(2);
-}
-// `rootDir` is src, and in --check-dts the roots live under dist; nothing is
-// emitted here, so drop it rather than let TS reject the roots as out of scope.
-// `skipLibCheck` has to go with it: it skips checking .d.ts files, which in this
-// mode is every file we came to check — left on, a declaration referring to a
-// type that did not survive the bundle passes silently.
-const options = {
- ...parsed.options,
- noEmit: true,
- rootDir: undefined,
- ...(fromDts ? { skipLibCheck: false } : {}),
-};
-// typeToString relativizes import("...") type paths against the host cwd — pin
-// it so the report is byte-identical no matter where the tool is invoked from.
-const host = ts.createCompilerHost(options);
-host.getCurrentDirectory = () => SDK;
-const program = ts.createProgram({ rootNames, options, host });
-const checker = program.getTypeChecker();
+const { program, checker } = createSdkProgram(entryPaths, { strictLibCheck: fromDts });
const FMT = ts.TypeFormatFlags.NoTruncation | ts.TypeFormatFlags.UseAliasDefinedOutsideCurrentScope;
-const errors = [];
-
// ---------------------------------------------------------------------------
// Helpers
// ---------------------------------------------------------------------------
@@ -111,36 +142,53 @@ function normalizeType(text) {
const fileTagCache = new Map();
-/** Release tag from a file's leading `@file` JSDoc header (module-wide fallback). */
-function fileLevelTag(sourceFile) {
+/**
+ * Tier from a file's leading `@file` JSDoc header, as a module-wide fallback.
+ * A header cannot confer @public: declaration bundlers drop it, so the freeze
+ * would be invisible in the `.d.ts` a creator actually reads.
+ */
+function fileLevelTier(sourceFile) {
if (fileTagCache.has(sourceFile.fileName)) return fileTagCache.get(sourceFile.fileName);
- let tag = null;
+ let tier = null;
const text = sourceFile.getFullText();
for (const range of ts.getLeadingCommentRanges(text, 0) ?? []) {
const comment = text.slice(range.pos, range.end);
if (!comment.startsWith('/**')) continue;
- if (/^\s*\*\s*@beta\b/m.test(comment)) tag = 'beta';
- else if (/^\s*\*\s*@internal\b/m.test(comment)) tag = 'internal';
+ if (/^\s*\*\s*@public\b/m.test(comment)) {
+ const where = relative(ROOT, sourceFile.fileName).replace(/\\/g, '/');
+ errors.push(`R4: '${where}' claims @public in its @file header — tag the declaration, a header does not reach the .d.ts`);
+ }
+ for (const t of ['internal', 'beta', 'experimental']) {
+ if (new RegExp(`^\\s*\\*\\s*@${t}\\b`, 'm').test(comment)) { tier = t; break; }
+ }
}
- fileTagCache.set(sourceFile.fileName, tag);
- return tag;
+ fileTagCache.set(sourceFile.fileName, tier);
+ return tier;
}
-/** Declaration-site tag wins; else the declaring file's header tag; else stable. */
-function releaseTag(symbol) {
+/** Every JSDoc tag name on a symbol's declarations. */
+function tagNames(symbol) {
+ const out = new Set();
for (const decl of symbol.declarations ?? []) {
- for (const tag of ts.getJSDocTags(decl)) {
- const name = tag.tagName.text;
- if (name === 'beta') return 'beta';
- if (name === 'internal') return 'internal';
- if (name === 'deprecated') return 'deprecated';
- }
+ for (const tag of ts.getJSDocTags(decl)) out.add(tag.tagName.text);
}
+ return out;
+}
+
+/**
+ * Tier and deprecation, as separate axes: a symbol can be frozen AND on its way
+ * out, and the baseline rule needs to read the second without losing the first.
+ * Declaration-site tag wins; else the declaring file's header; else experimental.
+ */
+function releaseTag(symbol) {
+ const tags = tagNames(symbol);
+ const deprecated = tags.has('deprecated');
+ for (const t of TIERS) if (tags.has(t)) return { tier: t, deprecated };
for (const decl of symbol.declarations ?? []) {
- const tag = fileLevelTag(decl.getSourceFile());
- if (tag) return tag;
+ const tier = fileLevelTier(decl.getSourceFile());
+ if (tier) return { tier, deprecated };
}
- return 'stable';
+ return { tier: 'experimental', deprecated };
}
/** A member inherited from an ambient built-in (the TS lib or @types/node) — e.g. an
@@ -167,7 +215,7 @@ function isPrivateMember(member) {
return false;
}
-function memberLines(type, location) {
+function memberLines(type, location, owner) {
const lines = [];
for (const sig of type.getCallSignatures()) {
lines.push(`call ${normalizeType(checker.signatureToString(sig, location, FMT))}`);
@@ -178,6 +226,11 @@ function memberLines(type, location) {
for (const member of type.getProperties()) {
if (isPrivateMember(member)) continue;
if (isAmbientMember(member)) continue;
+ // R1 only ever saw top-level exports, so an @internal member rode out in the
+ // public .d.ts with nothing to stop a creator autocompleting it.
+ if (owner.tier === 'public' && tagNames(member).has('internal')) {
+ errors.push(`R3: '${owner.name}' is @public but its member '${member.name}' is @internal`);
+ }
const memberType = checker.getTypeOfSymbolAtLocation(member, location);
lines.push(`${member.name}: ${normalizeType(checker.typeToString(memberType, location, FMT))}`);
}
@@ -191,7 +244,8 @@ function describeSymbol(name, symbol) {
errors.push(`R2: export '${name}' does not resolve to a declaration`);
return null;
}
- const tag = releaseTag(resolved);
+ const { tier, deprecated } = releaseTag(resolved);
+ const owner = { name, tier };
const flags = resolved.flags;
const body = [];
let kind = 'value';
@@ -200,11 +254,11 @@ function describeSymbol(name, symbol) {
kind = 'class';
const instance = checker.getDeclaredTypeOfSymbol(resolved);
const statics = checker.getTypeOfSymbolAtLocation(resolved, decl);
- body.push(...memberLines(instance, decl));
- body.push(...memberLines(statics, decl).map((l) => `static ${l}`));
+ body.push(...memberLines(instance, decl, owner));
+ body.push(...memberLines(statics, decl, owner).map((l) => `static ${l}`));
} else if (flags & ts.SymbolFlags.Interface) {
kind = 'interface';
- body.push(...memberLines(checker.getDeclaredTypeOfSymbol(resolved), decl));
+ body.push(...memberLines(checker.getDeclaredTypeOfSymbol(resolved), decl, owner));
} else if (flags & ts.SymbolFlags.TypeAlias) {
kind = 'type';
const aliasDecl = resolved.declarations.find(ts.isTypeAliasDeclaration);
@@ -231,7 +285,7 @@ function describeSymbol(name, symbol) {
for (const m of checker.getExportsOfModule(resolved)) body.push(m.name);
body.sort();
}
- return { name, kind, tag, body };
+ return { name, kind, tier, deprecated, body };
}
// ---------------------------------------------------------------------------
@@ -253,17 +307,18 @@ function buildReport(entryName, entryPath) {
out.push('');
out.push('<!-- Generated by tools/api-surface.mjs — do not edit. Run --update to accept changes. -->');
out.push('');
- const counts = { stable: 0, beta: 0, deprecated: 0 };
+ const counts = { public: 0, beta: 0, experimental: 0, deprecated: 0 };
for (const symbol of exports) {
const desc = describeSymbol(symbol.name, symbol);
if (!desc) continue;
- if (desc.tag === 'internal') {
+ if (desc.tier === 'internal') {
errors.push(`R1: '${entryName}' exports @internal symbol '${symbol.name}'`);
continue;
}
- counts[desc.tag] = (counts[desc.tag] ?? 0) + 1;
- const tagSuffix = desc.tag === 'stable' ? '' : ` @${desc.tag}`;
- out.push(`## ${desc.name} — ${desc.kind}${tagSuffix}`);
+ counts[desc.tier]++;
+ if (desc.deprecated) counts.deprecated++;
+ const suffix = ` @${desc.tier}${desc.deprecated ? ' @deprecated' : ''}`;
+ out.push(`## ${desc.name} — ${desc.kind}${suffix}`);
if (desc.body.length) {
out.push('```');
out.push(...desc.body);
@@ -271,7 +326,7 @@ function buildReport(entryName, entryPath) {
}
out.push('');
}
- out.splice(3, 0, `Symbols: ${counts.stable} stable · ${counts.beta} beta · ${counts.deprecated} deprecated`);
+ out.splice(3, 0, `Symbols: ${counts.public} public · ${counts.beta} beta · ${counts.experimental} experimental · ${counts.deprecated} deprecated`);
// Multi-line declaration bodies are extracted verbatim from source text, so
// on a CRLF checkout they carry \r — normalize so the snapshot (and the
// drift compare below) is byte-identical across platforms.
@@ -309,22 +364,20 @@ if (fromDts) {
if (desc) emitted.set(desc.name, desc.kind);
}
- // The snapshot's headings are `## <name> — <kind>[ @tag]`; the tag comes
- // from a `@file` header as often as a declaration, and a header cannot
- // survive into a bundled .d.ts, so only name and kind are compared.
- const snapshot = readFileSync(join(ETC, `${entryName}.api.md`), 'utf8');
- const expected = new Map([...snapshot.matchAll(/^## (\S+) — (\S+)/gm)].map((m) => [m[1], m[2]]));
+ // Only name and kind are compared: a tier can come from a `@file` header,
+ // and a header cannot survive into a bundled .d.ts.
+ const snapshot = parseSnapshot(readFileSync(join(ETC, `${entryName}.api.md`), 'utf8'));
- const dropped = [...expected.keys()].filter((n) => !emitted.has(n));
- const extra = [...emitted.keys()].filter((n) => !expected.has(n));
- const rekinded = [...expected].filter(([n, k]) => emitted.has(n) && emitted.get(n) !== k);
+ const dropped = [...snapshot.keys()].filter((n) => !emitted.has(n));
+ const extra = [...emitted.keys()].filter((n) => !snapshot.has(n));
+ const rekinded = [...snapshot].filter(([n, s]) => emitted.has(n) && emitted.get(n) !== s.kind);
if (!dropped.length && !extra.length && !rekinded.length) continue;
broken++;
console.error(`DIVERGED: ${entryName} — the built .d.ts does not carry the documented surface.`);
for (const n of dropped.slice(0, 15)) console.error(` missing from .d.ts: ${n}`);
for (const n of extra.slice(0, 15)) console.error(` only in .d.ts: ${n}`);
- for (const [n, k] of rekinded.slice(0, 15)) console.error(` ${n}: ${k} became ${emitted.get(n)}`);
+ for (const [n, s] of rekinded.slice(0, 15)) console.error(` ${n}: ${s.kind} became ${emitted.get(n)}`);
}
for (const e of errors) console.error(`POLICY ${e}`);
diff --git a/tools/gates.mjs b/tools/gates.mjs
index f6a680ca8..bc2ea76ef 100644
--- a/tools/gates.mjs
+++ b/tools/gates.mjs
@@ -34,6 +34,9 @@ export const GATES = [
why: 'the EHT generator shells out to `python`, which macOS does not ship a runnable one of; run it by hand where you have one',
},
{ id: 'api-surface', run: 'node tools/api-surface.mjs --check' },
+ // Reads the snapshot the gate above just proved current, against the one the
+ // last release tag shipped — drift says the surface moved, this says a promise did.
+ { id: 'api-surface-baseline', run: 'node tools/api-surface.mjs --check-baseline' },
// Everything below reads what this emits: the declaration snapshot, the
// editor's own type-check and the examples all resolve `esengine` from dist.
{ id: 'sdk-build', run: 'pnpm --filter ./sdk build' },
diff --git a/tools/lib/apiSnapshot.mjs b/tools/lib/apiSnapshot.mjs
new file mode 100644
index 000000000..37b0098a7
--- /dev/null
+++ b/tools/lib/apiSnapshot.mjs
@@ -0,0 +1,68 @@
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-FileCopyrightText: Copyright (c) 2024-present ESEngine Team
+/**
+ * @file apiSnapshot.mjs — reading sdk/etc/*.api.md, and what a release promised.
+ *
+ * Pure text in, findings out: no compiler and no filesystem, so the rule that
+ * decides whether a promise was broken can be tested directly instead of only
+ * being observable the release after it was needed.
+ */
+
+/** Stability tiers, most-frozen first. A symbol carries exactly one. */
+export const TIERS = ['public', 'beta', 'experimental', 'internal'];
+
+/** What a snapshot heading says when no release named a tier for the symbol. */
+export const UNCLAIMED = 'unclaimed';
+
+/**
+ * Parse a `<entry>.api.md` into `name -> { kind, tier, deprecated, body }`.
+ * Snapshots written before the tiers existed carry no tag; those read as
+ * {@link UNCLAIMED}, which is the truth about them — nothing was promised.
+ */
+export function parseSnapshot(text) {
+ const out = new Map();
+ for (const section of text.replace(/\r\n?/g, '\n').split(/^## /m).slice(1)) {
+ const nl = section.indexOf('\n');
+ const heading = nl < 0 ? section : section.slice(0, nl);
+ const m = /^(\S+) — (\S+)(.*)$/.exec(heading);
+ if (!m) continue;
+ const [, name, kind, tags] = m;
+ out.set(name, {
+ kind,
+ tier: new RegExp(`@(${TIERS.join('|')})\\b`).exec(tags)?.[1] ?? UNCLAIMED,
+ deprecated: /@deprecated\b/.test(tags),
+ body: (nl < 0 ? '' : section.slice(nl + 1)).trim(),
+ });
+ }
+ return out;
+}
+
+/**
+ * Compare one entry against its released self. Only @public carries a promise,
+ * so only @public produces a failure; @beta is noted because "may adjust" should
+ * still read as a decision someone made rather than a silent edit.
+ */
+export function baselineFindings(was, now) {
+ const failures = [];
+ const notes = [];
+ for (const [name, before] of was) {
+ const after = now.get(name);
+ if (before.tier === 'public') {
+ if (!after) {
+ // Deprecated for a release first is exactly what earns a removal.
+ if (before.deprecated) continue;
+ failures.push(`${name} — removed while @public and never @deprecated`);
+ } else if (after.tier !== 'public') {
+ failures.push(`${name} — @public at baseline, now @${after.tier}; a freeze does not thaw`);
+ } else if (after.kind !== before.kind) {
+ failures.push(`${name} — @public ${before.kind} became a ${after.kind}`);
+ } else if (after.body !== before.body) {
+ failures.push(`${name} — @public signature changed`);
+ }
+ } else if (before.tier === 'beta') {
+ if (!after) notes.push(`${name} — @beta removed`);
+ else if (after.body !== before.body) notes.push(`${name} — @beta signature changed`);
+ }
+ }
+ return { failures, notes };
+}
diff --git a/tools/lib/sdkProgram.mjs b/tools/lib/sdkProgram.mjs
new file mode 100644
index 000000000..d89fe6459
--- /dev/null
+++ b/tools/lib/sdkProgram.mjs
@@ -0,0 +1,62 @@
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-FileCopyrightText: Copyright (c) 2024-present ESEngine Team
+/**
+ * @file sdkProgram.mjs — the SDK's typed public entries, and a program over them.
+ *
+ * Two gates ask the same question of the same files: api-surface reports what the
+ * surface IS, check-freeze-bar asks whether a symbol has earned @public. Both need
+ * the entry list and a checker pinned the same way, and a second copy of either is
+ * a second answer waiting to disagree.
+ */
+import { existsSync } from 'node:fs';
+import { resolve, dirname, join } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { createRequire } from 'node:module';
+
+export const ROOT = resolve(dirname(fileURLToPath(import.meta.url)), '..', '..');
+export const SDK = join(ROOT, 'sdk');
+export const ETC = join(SDK, 'etc');
+
+export const ts = createRequire(join(SDK, '/'))('typescript');
+
+/** Typed public entries (mirrors package.json "exports" + rollup dtsBuilds). */
+export const ENTRIES = {
+ 'index': 'src/index.ts',
+ 'index.node': 'src/index.node.ts',
+ 'index.native': 'src/index.native.ts',
+ 'physics': 'src/physics/index.ts',
+ 'spine': 'src/spine/index.ts',
+ 'dragonbones': 'src/dragonbones/index.ts',
+ 'wasm': 'src/wasm.ts',
+ 'wechat': 'src/index.wechat.ts',
+ 'minigame': 'src/index.minigame.ts',
+};
+
+/**
+ * A program over `entryPaths`. `strictLibCheck` is for callers reading built
+ * declarations: skipLibCheck would skip every file they came to check.
+ */
+export function createSdkProgram(entryPaths = ENTRIES, { strictLibCheck = false } = {}) {
+ const configFile = ts.readConfigFile(join(SDK, 'tsconfig.json'), ts.sys.readFile);
+ const parsed = ts.parseJsonConfigFileContent(configFile.config, ts.sys, SDK);
+ const rootNames = Object.values(entryPaths).map((p) => join(SDK, p));
+ const absent = rootNames.filter((p) => !existsSync(p));
+ if (absent.length) {
+ console.error('sdkProgram: the SDK is not built — run `pnpm --filter ./sdk build` first.');
+ for (const p of absent) console.error(` missing ${p.replace(SDK + '/', '')}`);
+ process.exit(2);
+ }
+ // rootDir is src and a caller may root under dist; nothing is emitted here.
+ const options = {
+ ...parsed.options,
+ noEmit: true,
+ rootDir: undefined,
+ ...(strictLibCheck ? { skipLibCheck: false } : {}),
+ };
+ // typeToString relativizes import("...") paths against the host cwd — pin it
+ // so a report is byte-identical no matter where the tool is invoked from.
+ const host = ts.createCompilerHost(options);
+ host.getCurrentDirectory = () => SDK;
+ const program = ts.createProgram({ rootNames, options, host });
+ return { program, checker: program.getTypeChecker(), options };
+}