Skip to content
Estella
Search
Ctrl
K
Cancel
GitHub
Discord
Select theme
Dark
Light
Auto
Select language
English
简体中文
Get Started
Introduction
Installation
Quick Start
Editor
Overview
Viewport & Editing Modes
Building a Scene
Content Browser
Play in the Editor
Asset Editors
Project Settings
Keyboard Shortcuts
AI Agents
The Built-in Agent
External Agents (MCP)
Core Concepts
ECS Architecture
Components
Systems
Plugins & Resources
Transforms, Units & Coordinates
Screen & Design Resolution
App Setup & Lifecycle
Scripting
Overview
Input
Event Binding
Saving & Loading
Networking
Math Helpers
Graphics
Sprites & Rendering
Camera
Materials & Shaders
2D Lighting & Shadows
Post-processing
Custom Drawing
Video
Animation
Overview
Timeline
Spine Animation
DragonBones Animation
Gameplay
Physics
3D Physics
Markers & Trigger Areas
Gameplay AI
Overview
Perception
Navigation
State Machines
Behavior Trees
The Blackboard
Authoring in the Editor
Below the Components
UI
Overview
Layout
Text
Widgets
Lists & Scrolling
Interaction
Theming
Data Binding
Controllers
World Building
Scenes
Prefabs
Tilemaps
Particles
Assets
Overview
Textures
Models
Audio
Localization
Publishing
Overview
Android & iOS
Steam
WeChat MiniGame
Mini-Game Platforms
Hot Update
Ads & Sharing
Performance
Profiling & Diagnostics
Extending the Editor
Editor Plugins
Reference
Component Reference
Core
Graphics
UI
Physics
Animation
World
Gameplay
API Stability
TypeScript API
dragonbones
Classes
DragonBonesManager
DragonBonesModuleController
Interfaces
DragonBonesArmatureNames
DragonBonesAssetInfo
DragonBonesEntityOptions
DragonBonesWasmModule
DragonBonesWrappedAPI
Type Aliases
DragonBonesModuleFactory
Functions
applyDragonBonesEntities
dragonBonesEntityProps
loadDragonBonesAssets
loadDragonBonesSceneEntities
parseDragonBonesNames
wrapDragonBonesModule
References
DragonBones
dragonBonesPlugin
DragonBonesPlugin
RuntimeAssetSource
index
Enumerations
AlignSelf
AnchorAxis
AttenuationModel
BatchBreak
BlendMode
BodyType
ClearFlags
CullMode
DataType
EmitterShape
FillMethod
FillOrigin
ForceFieldType
GamepadAxis
GamepadButton
LayerOrder
Light2DType
LogLevel
ParticleEasing
ProjectionType
RenderStage
RenderType
Schedule
ScreenOrientation
ShapeType
SimulationSpace
Status
SubEmitterTrigger
TileOrientation
UIDisplay
UIPointerEvents
UIPositionType
UIVisualType
Classes
AchievementsAPI
AdsAPI
AiRegistry
AnimationPlugin
AnimatorControllerAPI
App
AppContext
ArrayDataSource
AssetPlugin
AssetRefCounter
AsyncCache
AudioAPI
AudioBus
AudioMixer
AudioPlugin
AudioPool
BehaviorTrees
Blackboard
BtPlugin
CameraViewAPI
Catalog
CommandsInstance
DiagnosticsAPI
DiagnosticsPlugin
DragonBonesPlugin
DragPlugin
EntityCommands
EntityEventQueue
EventBindingPlugin
EventReaderInstance
EventRegistry
EventWriterInstance
FocusManagerState
FocusPlugin
FrameHistory
FsmPlugin
GameSocket
GestureDetector
Graphics
GridLayoutProvider
HttpBackend
IdentityAPI
InputMap
InputPlugin
InputRouter
InputState
KineticScroll
LifecycleManager
LifecyclePlugin
LinearLayoutProvider
ListView
LocalizationAPI
LocalizationPlugin
Logger
ManifestModel
MeasuredLinearLayoutProvider
MemoryTransport
Mesh2DAPI
Mesh2DPlugin
MessagePortTransport
MiniGameSocket
MissingAssetsError
NavGrid
Navigation
NavPlugin
NetChannel
NetSession
ParticleAPI
ParticlePlugin
PerceptionPlugin
PhysicsPlugin
PostProcessAPI
PostProcessPlugin
PostProcessStack
PrefabServer
PrefabsPlugin
PreviewPlugin
ProfileRecorder
ProfileRecorderPlugin
QueryInstance
RemovedQueryInstance
RenderPipeline
ReplicationClient
ReplicationPlugin
ReplicationServer
SafeAreaPlugin
SaveManager
SceneLoadCancelled
SceneManagerState
SceneStreamingController
ScreenInfo
ScrollContainer
ServicesPlugin
SpinePlugin
SpriteAnimationAPI
StateMachines
StatsCollector
StatsOverlay
StatsPlugin
SubsystemRegistry
SystemRunner
TextInputPlugin
TextPlugin
TilemapPlugin
TimelineAPI
TimelinePlugin
TimerHandle
TimerManager
TrailAPI
TrailPlugin
Transaction
TransactionManager
TweenAPI
TweenGroup
TweenHandle
TweenSequence
UIInteractionPlugin
UILayoutPlugin
UIMaskPlugin
UIPlugin
UIRenderOrderPlugin
UIVisibilityPlugin
ValueTweenHandle
VideoAPI
VideoPlugin
WeChatSocket
World
Interfaces
AchievementProvider
ActionDef
ActivationTrack
AddedEntity
AddedWrapper
AddressableManifest
AddressableManifestAsset
AddressableManifestGroup
AdProvider
AiActionInput
AiActionSpec
AiContext
AiParamDef
Ambiguity
AnchorFields
AnchorPreset
AnimatorBlend1D
AnimatorBlendThreshold
AnimatorControllerDef
AnimatorData
AnimatorEvalResult
AnimatorParam
AnimatorPathEvalResult
AnimatorSpineMotion
AnimatorState
AnimatorSubMachine
AnimatorTransition
AnimClipAssetData
AnimClipEventData
AnimClipFrameData
AnimClipPivotData
AnimClipSheetData
AnimFramesTrack
AssetFieldMeta
AssetGroupDef
AssetGroupsConfig
AssetRef
AssetRefInfo
AssetTypeEntry
AtlasDef
AudioBackendInitOptions
AudioBufferHandle
AudioBufferStats
AudioBusConfig
AudioBusDecl
AudioHandle
AudioListenerData
AudioMixerConfig
AudioPluginConfig
AudioProjectConfig
AudioSourceData
AudioTrack
Backend
BehaviorContext
BehaviorDef
BehaviorTreeAgentData
BezierPoints
BitmapCache
BitmapTextData
BlackboardGuard
BoxCollider3DData
BoxColliderData
BtDefinition
BtEdge
BtNode
BuildNavGridOptions
BuildProfile
BuiltinComponentDef
BuiltinShaderTemplate
BusDuckRule
ButtonHandle
ButtonOptions
ButtonStateVisual
CacheAsBitmapData
CameraBoundsData
CameraData
CameraDirectorState
CameraExtents
CameraFields
CameraPOV
CameraRenderParams
CameraTransformFields
CanvasData
CanvasScale
CanvasTexture
CapsuleCollider3DData
CapsuleColliderData
CapturedFrame
CaptureSource
CaptureSummary
CatalogData
CatalogEntry
Cell
Census
CensusContext
CensusDelta
CensusEntry
CensusProbe
CensusReport
CensusSeriesOptions
CensusVerdict
ChangedWrapper
CharacterController3DData
CharacterControllerData
ChildrenData
CircleColliderData
Collider3DInstance
ColliderInstance
ColliderOutline
CollisionBrush
CollisionEnterEvent
CollisionHitEvent
CollisionMaterial
Color
CommandsDescriptor
CompiledFsm
Completable
ComponentDef
ComponentMetadata
CompressorEffectDef
ControllerState
ConvexCollider3DData
CookedAtlasInfo
CreateListViewOptions
CreateWebAppOptions
DataSource
DecodedChunk
DecodedPixels
DeviceIdentity
DiagnosticEvent
DiagnosticReport
DiagnosticsOptions
DiagnosticsPluginOptions
DialogHandle
DialogOptions
DiffOptions
Dimension
DistanceJoint3DData
DocumentDiagnostic
DocumentNode
DraggableData
DragonBonesAnimationData
DragStateData
DrawAPI
DrawCallInfo
DrawRank
DropdownHandle
DropdownOptions
DropShadowFilterOptions
EditorBridge
EditorGridData
EditorViewData
EffectDef
EffectUniformDef
EmbeddedSideModuleEntry
EntityBox
EntityBoxOptions
EntityEvent
EventBindingData
EventBindingRow
EventDef
EventReaderDescriptor
EventWriterDescriptor
ExternalEntityRef
ExtractEntity
FieldMeta
FilterEffectDef
FixedJoint3DData
FlattenContext
FlattenResult
FlexContainerData
FocusableData
FollowTargetData
FrameCaptureData
FrameCosts
FramePixels
FrameProfile
FrameProfileInput
FrameSnapshot
FrameStats
FsmDefinition
FsmRunState
FsmState
FsmTransition
GamepadSnapshot
GearBinding
GearTween
GeometryOptions
GetWorldDescriptor
HeadlessAppOptions
HingeJoint3DData
ImageSegment
InputHandler
InputMapAsset
InstantiatePrefabOptions
InstantiatePrefabResult
InteractableData
InterestView
Joint3DShape
JsonResult
Keyframe
LayoutProvider
LifecyclePluginOptions
Light2DData
ListenOptions
ListItemTemplate
ListViewHandle
ListViewHost
ListViewOptions
LoadedTilemapLayer
LoadedTilemapSource
LoadedTilemapTileset
LoadRuntimeSceneOptions
LocaleResult
LocaleTableAsset
LocalizationOptions
LogEntry
LogHandler
LoginResult
MarkerData
MaterialAssetData
MaterialData
MaterialGraph
MaterialGraphNode
MaterialOptions
MeasureTextOptions
Mesh2DData
Mesh2DGeometry
MeshChannelDesc
MeshCollider3DData
MeshData
MeshResult
MessagePortLike
MigrationResult
MockAdProviderOptions
Modifiers
MutWrapper
NameData
NavAgentData
NavGridOptions
NestedPrefabRef
NetChannelOptions
NetTransport
NodeParamSpec
NodePort
NodeSpec
OutlineFilterOptions
PackagedAssetIndex
PackagedAssetSourceOptions
PackagedGameConfig
ParentData
ParsedTextureImportSettings
ParticleEmitterData
ParticleForceFieldData
PathfindOptions
PerceiverData
PerceptionData
Physics3DDebugDrawConfig
PhysicsContactEventData
PhysicsEventsData
PhysicsPluginConfig
PhysicsWasmModule
PlatformAdapter
PlatformAudioBackend
PlatformCanvas
PlatformCanvas2DContext
PlatformImage
PlatformPaymentRequest
PlatformRequestOptions
PlatformResponse
PlatformShareOptions
PlatformSocket
PlatformSocketEvents
PlatformSocketOptions
PlatformVideoBackend
PlayableAdBridge
PlayableRuntimeConfig
PlayConfig
PlayRealmRuntimeConfig
Plugin
PluralForms
PointJoint3DData
PooledAudioNode
PostProcessVolumeData
PredictionOptions
PredictionSmoothing
PrefabComponentData
PrefabData
PrefabEntityData
PrefabInstanceDelta
PrefabInstanceEntry
PrefabOverride
PreSceneDrawInfo
ProbedRegistrations
ProcessedEntity
ProfileCapture
ProfileNode
ProfileRecorderOptions
ProgressHandle
ProgressOptions
PropertyChannel
PropertyTrack
PtrLayout
Quat
QueryBuilder
QueryCost
QueryDescriptor
RadiusInterestOptions
ReadonlySignal
RemovedQueryDescriptor
RenderParams
RenderStats
RenderTextureHandle
RenderTextureOptions
ReplicatedData
ResDescriptor
ResMutDescriptor
ResMutInstance
ResolvedAssetGroup
ResolvedAtlas
ResolvedTileCollision
ResolvedTileset
ResourceDef
ResourceStats
ReverbEffectDef
RigidBody3DData
RigidBodyData
RuntimeAssetSource
RuntimeBuildConfig
RuntimeInitConfig
SafeAreaData
SampleDeps
SampleOptions
SampleWorld
SaveEnvelope
SaveManagerOptions
SaveStorage
SceneAssetRefs
SceneComponentCodec
SceneComponentData
SceneConfig
SceneContext
SceneData
SceneEntityData
SceneLoadOptions
SceneMigrationResult
SceneOwnerData
SceneStreamHost
SceneStreamingConfig
ScopeCost
ScreenAxis
ScreenInfoEvents
ScreenRect
ScreenScalingData
ScrollViewHandle
ScrollViewOptions
SenseResult
SensorEvent
ShaderParam
ShaderReflection
ShadowCaster2DData
ShapeRendererData
SideModuleDescriptor
SideModuleHost
Signal
SkeletalFieldMeta
SliceBorder
SliderHandle
SliderJoint3DData
SliderOptions
SourceDelta
SpatialAudioConfig
SphereCollider3DData
SpineAnimationData
SpineAnimationDriver
SpineLoadResult
SpineTrack
SpriteAnimatorData
SpriteAnimClip
SpriteAnimEvent
SpriteAnimFrame
SpriteAnimTrack
SpriteData
StaleOverride
StateMachineAgentData
StatsPluginOptions
StreamCell
StreamDecision
SubsystemEvent
SubsystemStatus
SystemCost
SystemDef
SystemOptions
SystemSet
SystemSetOptions
SystemTouches
Takeover
TakeoverHost
TerrainColor
TerrainIndex
TerrainIndices
TextData
TextInit
TextInputData
TextInputHandle
TextInputOptions
TextMetrics
TextSegment
TextureDimensions
TextureInfo
TextureRef
ThemeColors
ThemeOverrides
ThemeStyleData
ThemeTokens
ThemeType
TileCollisionPiece
TiledLayerData
TiledMapData
TiledTilesetData
TileFlags
TileGridParams
TilemapData
TilemapLayerData
TilesetAnimFrame
TilesetAsset
TilesetModel
TilesetTerrain
TilesetTile
TilesetTileTerrain
TileStamp
TimeData
TimelineAsset
TimelinePlayerData
ToggleHandle
ToggleOptions
TouchPoint
TrailRendererData
TransactionManagerOptions
TransactionOp
TransformData
TransitionConfig
TransitionOptions
TweenOptions
UICameraData
UIControllerData
UIDialogData
UIDropdownData
UIEntityInit
UIGearData
UIInteractionData
UILayoutGenerationData
UIMaskData
UINodeInit
UISliderData
UIToggleData
UIVisualData
UIVisualInit
ValidatePrefabOptions
ValidateResult
Vec2
Vec2Like
Vec3
Vec4
VelocityData
VertexAttributeDescriptor
VideoData
VideoStreamHandle
VideoStreamOptions
Viewport
WangIndex
WangIndices
WebAppOptions
WebGPUAdapterLike
WebGPUBootResult
WidgetInteractionInit
WorldRect
Type Aliases
ActionType
AddressableAssetType
AiAction
AiCondition
AiParams
AiParamValue
AlignContent
AlignItems
AnimatorCondition
AnimatorEdge
AnimatorParamType
AnimatorParamValues
AnimatorScope
AnyComponentDef
ApplyTilesetRefs
AssetBuildTransform
AssetContentType
AssetFieldType
AssetGroupMode
AssetsData
BinaryHandler
Binding
BlendCurve
BtNodeType
BtRunState
BuiltinSideModuleId
BundleMode
BusEffectDef
CensusTier
Collider3DComponent
Collider3DShape
ColliderShape
ColorRole
CompareOp
ComponentData
ComponentsData
DataSourceChange
DiagnosticKind
DiagnosticsSink
DimensionUnit
DocumentDiagnosticSeverity
DocumentEntityId
DrawCallback
EasingType
EditorAssetType
EmbeddedSideModuleRegistry
EngineApi
Entity
EntityEventHandler
FilterExpr
FlexDirection
FlexWrap
FontHandle
FsmActionRef
FsmEdge
GameSocketOptions
GearValue
GeometryHandle
GlImageSource
GraphNodeType
GraphType
GridColor
HitAreaShape
InferParam
InferParams
InterestPolicy
InterpType
JustifyContent
LayoutWorld
LifecycleEvent
LifecycleListener
LinearFillDirection
ListLayoutSpec
LocaleCatalog
LocaleEntry
LocalTransformData
LoopMode
MaskMode
MaskMode
MaterialHandle
MessageHandler
MissingAssetCallback
NetRoleKind
PhysicsEventType
PhysicsModuleFactory
PickableWorld
PlatformSocketReadyState
PlatformType
PluginDependency
PluralCategory
PluralSelector
PrefabDiagnostic
PrefabDiagnosticSeverity
PrefabEntityId
PreSceneDrawCallback
ProfileNodeKind
QueryArg
QueryResult
ReadableWorld
RenderBackendRequest
RenderSurfaceSource
RenderTargetHandle
RequestHandler
RichTextRun
RunCondition
SaveMigration
ScaleMode
SceneLoadProgressCallback
SceneStatus
ScopeRemainder
ShaderHandle
ShaderParamType
SideModuleId
SocketReadyState
SpawnOverride
SpriteAnimEventHandler
StatsPosition
StreamPolicy
SubsystemActivity
SubsystemPhase
SwipeDirection
SyncPrefabResolver
SystemParam
TerrainMode
TextAlign
TextOverflow
TextRenderMode
TextureFilter
TextureHandle
TextureWrap
TextVerticalAlign
TileCollisionShape
TilesetCollision
TParams
Track
TrackType
TweenFactory
TweenState
TweenTarget
UIEventType
UniformValue
Unsubscribe
UnwrapQueryArg
VideoHandle
VideoPlayOptions
WeChatSideModuleFactories
WorldTransformData
WrapMode
Variables
ABI_LAYOUT_HASH
Achievements
Ads
AiBt
AiFsm
aiRegistry
AlignContent
AlignItems
ANCHOR_AXES
ANIM_CLIP_FORMAT_VERSION
animationPlugin
Animator
AnimatorController
ASSET_GROUP_MODES
assetPlugin
Assets
Audio
AudioListener
audioPlugin
AudioSource
BehaviorTreeAgent
BitmapText
BlendCurve
BoxCollider
BoxCollider3D
btPlugin
BUILTIN_SHADER_TEMPLATES
BUILTIN_UI_PREFABS
BUILTIN_UI_WIDGET_NAMES
BUNDLE_MODES
CacheAsBitmap
CacheBitmap
Camera
CameraBounds
CameraDirector
CameraView
Canvas
CAPSULE_ARC_SEGMENTS
CapsuleCollider
CapsuleCollider3D
ChainCollider
CharacterController
CharacterController3D
Children
CHUNK_SIZE
CircleCollider
col
COLLIDER3D_RING_SEGMENTS
COLLISION_BRUSHES
COLLISION_PALETTE_REF
ConvexCollider3D
corePlugin
DARK_TOKENS
DEFAULT_ANIM_CLIP_PIVOT
DEFAULT_DESIGN_HEIGHT
DEFAULT_DESIGN_WIDTH
DEFAULT_EDITOR_GRID
DEFAULT_EDITOR_VIEW
DEFAULT_FALLBACK_DT
DEFAULT_FIXED_TIMESTEP
DEFAULT_FONT_FAMILY
DEFAULT_FONT_SIZE
DEFAULT_GRAVITY
DEFAULT_LINE_HEIGHT
DEFAULT_MAX_DELTA_TIME
DEFAULT_PIXELS_PER_UNIT
DEFAULT_SCREEN_SCALING
DEFAULT_SPINE_SKIN
DEFAULT_SPRITE_SIZE
DEFAULT_TEXT_CANVAS_SIZE
DEFAULT_UI_CAMERA_INFO
defaultPluralSelector
DeviceLostReason
DeviceStatus
Diagnostics
diagnosticsPlugin
DimensionUnit
Disabled
DistanceJoint
DistanceJoint3D
DOMAIN_SCRIPTS
DOMAIN_UNATTRIBUTED
Draggable
DragonBones
DragonBonesAnimation
dragPlugin
DragState
Draw
EasingType
EDITOR_UI_ANCHOR
EDITOR_VIEW_ENTITY
EditorGrid
EditorView
ENGINE_WEBGPU_FEATURES
EntityEvents
EventBinding
eventBindingPlugin
FILL_AXIS
Filters
FixedJoint3D
FlexContainer
FlexDirection
FlexWrap
Focusable
FocusManager
focusPlugin
FollowTarget
fsmPlugin
Geometry
GLDebug
HingeJoint3D
Identity
Input
inputPlugin
inputRouter
Interactable
INTERACTION_CONTROLLER
INTERACTION_PAGES
InterpType
INVALID_ENTITY
INVALID_FONT
INVALID_MATERIAL
INVALID_TEXTURE
JustifyContent
Lifecycle
lifecyclePlugin
LIGHT_TOKENS
Light2D
Localization
localizationPlugin
LocalTransform
log
LoopMode
Marker
Material
MATERIAL_FORMAT_VERSION
Mesh2D
mesh2dPlugin
MeshChannel
MeshChannelType
MeshCollider3D
Meshes2D
MotorJoint
Name
Nav
NavAgent
navPlugin
Net
NetGhost
NODE_SPECS
OneWayPlatform
Parent
Particle
ParticleEmitter
ParticleForceField
particlePlugin
Perceiver
Perception
perceptionPlugin
PerceptionTarget
Physics
Physics3DDebugDraw
PhysicsEvents
PhysicsEventType
PointJoint3D
PolygonCollider
PostProcess
postProcessPlugin
PostProcessVolume
PREFAB_FORMAT_VERSION
Prefabs
prefabsPlugin
PrismaticJoint
PROFILE_CAPTURE_VERSION
PTR_LAYOUTS
q
Renderer
RenderTexture
Replicated
REPLICATION_CHANNEL
REPLICATION_PROTOCOL_VERSION
replicationPlugin
RETIRED_COMPONENT_TYPES
RevoluteJoint
RigidBody
RigidBody3D
RuntimeConfig
RuntimeOnly
SafeArea
safeAreaPlugin
scalar
ScaleMode
SCENE_FORMAT_VERSION
SceneManager
sceneManagerPlugin
SceneOrigins
SceneOwner
SceneStreaming
SCREEN_FIT_OFF
ScreenScaling
SegmentCollider
servicesPlugin
ShaderSources
ShadowCaster2D
ShapeRenderer
SIDE_MODULES
SliderJoint3D
SphereCollider3D
Spine
SPINE_VERSIONS
SpineAnimation
SpineEvents
Sprite
SpriteAnimation
SpriteAnimator
SpriteFilter
STATE_PATH_SEP
StateMachineAgent
Stats
statsPlugin
Storage
SubmitSkipFlags
TB_E
TB_N
TB_NE
TB_NW
TB_S
TB_SE
TB_SW
TB_W
TERRAIN_NEIGHBORS
Text
TextAlign
TextInput
textInputPlugin
TextOverflow
textPlugin
TextRenderMode
TextureFilter
TextureWrap
TextVerticalAlign
THEME_COLOR_ROLES
ThemeStyle
TILE_FLAGS_MASK
TILE_FLIP_D
TILE_FLIP_H
TILE_FLIP_V
TILE_ID_MASK
Tilemap
TilemapAPI
TilemapLayer
TilemapLiveSync
tilemapPlugin
Tilemaps
TILESET_FORMAT_VERSION
Time
Timeline
TIMELINE_FORMAT_VERSION
TimelinePlayer
timelinePlugin
timerPlugin
TimerRes
TrackType
Trail
trailPlugin
TrailRenderer
Transform
Tween
TweenState
TweenTarget
UICameraInfo
UIController
UIDialog
UIDropdown
UIEventType
UIGear
UIInteraction
uiInteractionPlugin
UILayoutGeneration
uiLayoutPlugin
UIMask
uiMaskPlugin
UINode
uiPlugin
uiPlugins
uiRenderOrderPlugin
UISlider
UIToggle
uiVisibilityPlugin
UIVisual
v2
v3
Velocity
velocityPlugin
velocitySystem
Video
VideoPlayer
videoPlugin
WeldJoint
WheelJoint
WorldTransform
WrapMode
Functions
acquireWebGPUDevice
actionRefArg
actionRefName
actionRefParams
activeRemoteRoot
addAnimatorParam
addAnimatorState
addAnimatorTransition
addBtChild
addBtOrphan
Added
addNode
addPlugin
addStartupSystem
addState
addSystem
addSystemSetToSchedule
addSystemToSchedule
addTransition
agentBlackboard
agentBtBlackboard
analyzeCensusSeries
anchorPresetFields
And
animatorEdges
animClipCellRect
animClipCellUv
animClipDrivesPivot
animClipFramePivot
animClipSheetCols
animClipSheetRows
applyAssetRefResolvers
applyAudioProjectConfig
applyBuildRuntimeConfig
applyDeltaToSource
applyOverrides
applyOverridesToSource
applyRuntimeConfig
applyThemeToWorld
applyWrapMode
arrayDataSource
atlasCatalogFields
atlasCells
auto
Axis1D
Axis2D
bind
bindControllerPage
bindWidgetValue
btEdges
btNodes
bucketOverridesByEntity
buildCollisionPaletteModel
buildFrameProfile
buildTerrainIndices
buildText
buildUINode
buildUIVisual
buildVariant
buildWangIndices
builtinShaderTemplate
Button
calculateAttenuation
calculatePanning
cameraFrustumCorners
canCaptureFramePixels
canHaveChildren
canonicalMask
captureFramePixels
catalogFromManifest
censusProbeIds
Changed
clearAllCaches
clearAnimatorControllerStore
clearBtStore
clearDrawCallbacks
clearFsmStore
clearProjectSideModules
clearTilemapSourceCache
clearUserComponents
cloneComponentData
cloneComponents
cloneMetadata
closeDialog
closeDropdown
collapseEntry
collapseInstance
collectExternalEntityRefs
collectGarbage
collectNestedPrefabPaths
collidableTileIds
collider3DWireframe
colliderShapeOutline
collisionRefWithMaterial
color
Commands
compareDrawRank
compileFsm
compileMaterialGraph
computeEffectiveOrthoSize
computeStreaming
connect
contentHashHex
contentHashOf
controllerState
createAnimClip
createBtRunState
createButton
createCanvasTexture
createDialog
createDropdown
createEmbeddedSideModuleHost
createFetchSideModuleHost
createFsmRunState
createHeadlessApp
createListView
createLocalAchievements
createMemoryTransportPair
createMockAdProvider
createPackagedAssetSource
createProgress
createRuntimeSceneConfig
createScrollView
createSlider
createSocket
createTakeover
createTextInput
createTileset
createToggle
createWebApp
createWeChatSideModuleHost
debug
decodeImageBitmap
decodeImagePixels
decodeMesh
decodeTilemapChunks
defaultFrameStats
defineBehavior
defineComponent
defineEvent
defineInputMap
defineResource
defineSystem
defineSystemSet
defineTag
derived
detectAnchor
detectAnchorAxes
diffAgainstSource
diffCensus
disconnect
discoverSceneAssets
dragonBonesPlugin
drawPhysics3DDebug
editorViewAxes
editorViewAxisAngles
editorViewHalfExtent
editorViewHalfHeight
editorViewIsOrbited
emptyAnimatorController
emptyBt
emptyFsm
enableSceneOrigins
encodeChannelTable
encodeMesh
encodeTile
engineWebGPUFeatures
ensureBtIds
enterStatePath
entityBoxCorners
entityWorldBox
enumOptions
error
evalGuard
evalGuards
evaluateAnimatorPath
evaluateAnimatorTransitions
evaluateChannel
EventReader
EventWriter
evictTextureDimensions
expandEntry
expandInstance
extendPlatform
extractAnimClipTexturePaths
extractPrefab
facingFromQuat
fetchDecodePixels
findControllerOwner
findEntityByName
findPath
fingerprint
finishDeviceRecovery
flattenPrefab
flipFlagsH
flipFlagsV
flipStampH
flipStampV
flushPendingRegistrations
folderAlwaysInclude
folderGroupMode
formatActionArg
formatCensusDiff
formatCensusReport
frameProfileOf
fsmEdges
fxPreviewOrPlayMode
gearBinding
getAddressableType
getAddressableTypeByEditorType
getAllAssetExtensions
getAllEffectDefs
getAssetBuildTransform
getAssetMimeType
getAssetTypeEntry
getBt
getCacheForEntity
getComponent
getComponentAssetFieldDescriptors
getComponentAssetFields
getComponentDefaults
getComponentFieldMeta
getComponentRegistry
getComponentSkeletalFieldDescriptor
getContextLossGuardInfo
getControllerPage
getCustomExtensions
getDefaultContext
getDeviceIdentity
getDeviceLostReport
getDeviceStatus
getEditorType
getEffectDef
getEffectTypes
getFsm
getLogger
getPlatform
getPlatformType
getRegisteredAnimatorController
getReplicatedFields
getResourceManager
getResourceStats
getTextureDimensions
getTheme
getTilemapSource
getUserComponent
getUserComponentFingerprint
getUserComponents
getWeChatPackOptions
GetWorld
GpAxis
GpButton
hasPlayableCta
hasVisibility
headlessBasePlugins
imageBitmapOptions
indexPackagedManifest
info
initPlayableRuntime
initPlayRealmRuntime
initRuntime
inputEventCallbacks
installEditorGrid
instantiatePrefab
interactionController
interpolate
intersectRects
invertMatrix4
invokeAction
isAuto
isBuiltinComponent
isCollisionPaletteRef
isCustomExtension
isDialogOpen
isDropdownOpen
isEditor
isEmptyStamp
isEntityActive
isEntityVisible
isFxEditPreview
isHexOrientation
isKnownAssetExtension
isNative
isNonOrthogonal
isPlatformInitialized
isPlayMode
isRuntime
isTextureRef
isWeb
isWeChat
Key
Keys1D
Keys2D
layerFrontness
layerOrderOf
leafStateOf
loadComponent
loadInputMapAsset
loadPackagedAssetIndex
loadPhysicsModule
loadRuntimeScene
loadSceneData
loadSceneWithAssets
loadTiledMap
looksLikeAssetPath
makeLosCheck
makeWidgetInteractable
markThemed
matchLocale
maxChildren
meanFrameProfile
measureText
meshWorldBox
messageOf
migratePrefabData
migrateSaveData
migrateSceneData
modeToDelivery
MouseButton
moveAnimatorState
moveBtNode
moveNode
moveState
Mut
navGridFromTilemapLayer
navGridFromTiles
newMaterialGraph
normalizeAngle
normalizeBundleMode
normalizeCornerMask
Not
openDialog
openDropdown
Or
orientationPerm
packagedAppOptions
packagedRuntimeInit
packChannels
packCorners
paramDefaultValue
parseActionArg
parseAnimationClip
parseAnimClipAsset
parseAnimClipData
parseAudioProjectConfig
parseBusEffects
parseCollisionMaterial
parseLocaleTable
parseProfileCapture
parseRichText
parseThemeOverrides
parseTileset
parseTimelineAsset
parseTmjJson
parseTmjWithExternals
pathToWorld
percent
percentile
placeCollider3DWireframe
platformCanOpenData
platformCanPay
platformCanShare
platformCreateCanvas
platformDevicePixelRatio
platformFetch
platformFileExists
platformInstantiateWasm
platformOnShareRequest
platformOpenDataCanvas
platformOpenDataPostMessage
platformReadFile
platformReadTextFile
platformRequestPayment
platformSetCloudKeyValues
platformShare
playableCta
playModeOnly
pointInHitArea
pointInOBB
pointInWorldRect
preloadNestedPrefabs
previewPlugin
probeRegistrations
projectSideModuleIds
px
quat
quaternionToAngle2D
Query
radiusInterest
readCollider3DShapes
readColliderShapes
readFieldPath
readJoint3D
readPtrField
rebuildChildren
recordSceneOrigins
recoverDevice
reflectEsshader
registerAction
registerAnimatorController
registerAssetBuildTransform
registerBt
registerCensusProbe
registerComponent
registerCondition
registerDrawCallback
registerFsm
registerPackagedSideModules
registerPreSceneDrawCallback
registerSceneComponentCodec
registerSideModule
registerTilemapSource
registerTimelineAsset
remapComponentEntityRefs
remapEntityFields
removeAnimatorParam
removeAnimatorState
removeAnimatorTransition
removeBtNode
removeCacheForEntity
Removed
removeNode
removeState
removeTransition
renameAnimatorState
renameState
renderMeshPreview
reparentBtNode
reportDeviceLost
requireResourceManager
Res
resetWorldTo
ResMut
resolveAssetGroup
resolveAtlas
resolveAutotile
resolveBindingTarget
resolveChildEntity
resolveParams
resolveRelativePath
resolveThemeTokens
resolveTilesetModel
resolveWang
rotateFlagsCW
rotateStampCW
rotateVec3ByQuat
runHeadless
sampleTimeline
sampleTimelineInWorld
sceneErrors
sceneOriginOf
sceneOriginsEnabled
sceneUsesI18n
scopeDomain
screenToUiWorld
screenToWorld
selectBlendClip
selectPluralForm
senseTarget
serializeAnimClip
serializeScene
serializeTileset
serializeTimelineAsset
serializeTimelineToJson
setAnimatorConditions
setAnimatorInitial
setAnimatorStateClip
setAnimatorStateProps
setBtNodeField
setButtonState
setCacheForEntity
setControllerPage
setDefaultContext
setEditorMode
setEditorViewHalfHeight
setEntityActive
setEntityVisible
setFxEditPreview
setInitial
setLogLevel
setNavDestination
setPlayMode
setStateHook
setTextureBudget
setTextureFilter
setTextureParams
setTextureSliceBorder
setTextureWrap
setTheme
setUIVisible
setViewTarget
setWasmErrorHandler
shakeCamera
shapeCenter
shapeOffset
shutdownDrawAPI
shutdownGeometryAPI
shutdownGLDebugAPI
shutdownMaterialAPI
shutdownRendererAPI
shutdownResourceManager
sideModuleDescriptor
signal
singleStamp
spawnUIEntity
spineModuleId
stackOf
stepFsm
stepPerception
Stick
stopNavAgent
summarizeCapture
summarizeFrames
switchTheme
takeCensus
textureImportSettingsFrom
themeButtonStates
themeColors
themeType
tickBt
tileCellCenter
tileCellOutline
tileCollisionOutlines
tileFlagsOf
tileIdOf
toBuildPath
transitionTo
trimTextureCache
uiHitTestWorld
uiLayoutRect
uiNodeWorldBox
uiPickAllWorld
uiPickWorld
uiWorldToScreen
unregisterComponent
unregisterDrawCallback
unregisterPreSceneDrawCallback
updateAnimatorParam
updateAnimatorTransition
updateCameraAspectRatio
updateTransition
usesStagger
validateOverrides
validatePrefab
validateScene
vec2
vec3
vec4
Virtual
warn
widgetToPrefab
With
withActiveRemoteRoot
withFolderAlwaysInclude
withFolderGroup
Without
wrapSceneSystem
writeFieldPath
writePtrField
References
UIEvent
UIEventHandler
UIEventQueue
UIEvents
physics
Classes
PhysicsAPI
Interfaces
ChainColliderData
DistanceJointData
MassData
MotorJointData
MoveAndSlideParams
MoveAndSlideResult
OneWayPlatformData
PhysicsDebugDrawConfig
PolygonColliderData
PrismaticJointData
RaycastHit
RevoluteJointData
SegmentColliderData
SlideHit
WeldJointData
WheelJointData
Type Aliases
ShapeCastHit
SlideCast
Variables
PhysicsDebugDraw
Functions
drawPhysicsDebug
moveAndSlide
physicsPlugin
registerCharacterControllerSystem
registerPhysicsEventBridge
setupPhysicsDebugDraw
References
BodyType
BoxCollider
BoxColliderData
CAPSULE_ARC_SEGMENTS
CapsuleCollider
CapsuleColliderData
ChainCollider
CharacterController
CharacterControllerData
CircleCollider
CircleColliderData
ColliderInstance
ColliderOutline
ColliderShape
colliderShapeOutline
CollisionEnterEvent
CollisionHitEvent
DistanceJoint
loadPhysicsModule
MotorJoint
OneWayPlatform
Physics
PhysicsContactEventData
PhysicsEvents
PhysicsEventsData
PhysicsEventType
PhysicsModuleFactory
PhysicsPlugin
PhysicsPluginConfig
PhysicsWasmModule
PolygonCollider
PrismaticJoint
readColliderShapes
RevoluteJoint
RigidBody
RigidBodyData
SegmentCollider
SensorEvent
shapeCenter
shapeOffset
WeldJoint
WheelJoint
spine
Classes
ModuleBackend
SpineManager
SpineModuleController
Interfaces
ConstraintList
PathMixData
SpineEvent
SpineEventsData
TransformMixData
Type Aliases
SpineEventCallback
SpineEventType
SpineModuleFactory
SpineVersion
Functions
applySpineEntities
loadSpineAssets
loadSpineSceneEntities
spineEntityProps
spinePlugin
wrapSpineModule
References
RuntimeAssetSource
Spine
SpineEvents
SpinePlugin
C++ API (Doxygen)
Architecture
GitHub
Discord
Select theme
Dark
Light
Auto
Select language
English
简体中文
decodeMesh
decodeMesh
(
bytes
):
MeshData
Defined in:
asset/meshFormat.ts:149
Parameters
Section titled “Parameters”
bytes
Section titled “bytes”
Uint8Array
Returns
Section titled “Returns”
MeshData