Skip to content
Estella
Search
Ctrl
K
Cancel
GitHub
Discord
Select theme
Dark
Light
Auto
Select language
English
简体中文
Getting Started
Introduction
Installation
Quick Start
The Editor
Core Concepts
ECS Architecture
Components
Systems
Plugins & Resources
Transforms, Units & Coordinates
Screen & Design Resolution
App Setup & Lifecycle
Gameplay
Scripting
Event Binding
Input
Camera
Physics
Markers & Trigger Areas
Gameplay AI
Animation
Timeline
Spine Animation
Graphics
Sprites & Rendering
Video
Tilemaps
Particles
Post-processing
Materials & Shaders
2D Lighting & Shadows
Custom Drawing
UI
Overview
Layout
Text
Widgets
Lists & Scrolling
Interaction
Theming
Data Binding
Controllers
Content & Flow
Assets
Prefabs
Audio
Scenes
Saving & Loading
Localization
Building & Exporting
Android & iOS
Hot Update
WeChat MiniGame
Mini-Game Platforms
Networking
AI Agents (MCP)
Utilities
Math Helpers
Profiling & Diagnostics
Reference
TypeScript API
index
Enumerations
AlignSelf
AnchorAxis
AttenuationModel
BlendMode
BodyType
ClearFlags
CullMode
DataType
EmitterShape
FillMethod
FillOrigin
FlushReason
ForceFieldType
GamepadAxis
GamepadButton
Light2DType
LogLevel
ParticleEasing
ProjectionType
RenderStage
RenderType
Schedule
ScreenOrientation
ShapeType
SimulationSpace
Status
SubEmitterTrigger
TileOrientation
UIDisplay
UIPositionType
UIVisualType
Classes
AiRegistry
AnimationPlugin
AnimatorControllerAPI
App
AppContext
ArrayDataSource
AssetPlugin
AssetRefCounter
AsyncCache
AudioAPI
AudioBus
AudioMixer
AudioPlugin
AudioPool
BehaviorTrees
Blackboard
BtPlugin
CameraViewAPI
Catalog
CommandsInstance
DragPlugin
EntityCommands
EntityEventQueue
EventBindingPlugin
EventReaderInstance
EventRegistry
EventWriterInstance
FocusManagerState
FocusPlugin
FrameHistory
FsmPlugin
GameSocket
GestureDetector
Graphics
GridLayoutProvider
HttpBackend
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
QueryInstance
RemovedQueryInstance
RenderPipeline
ReplicationClient
ReplicationPlugin
ReplicationServer
SafeAreaPlugin
SaveManager
SceneLoadCancelled
SceneManagerState
SceneStreamingController
ScreenInfo
ScrollContainer
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
ValueTweenHandle
VideoAPI
VideoPlugin
WeChatSocket
World
Interfaces
ActionDef
ActivationTrack
AddedEntity
AddedWrapper
AddressableManifest
AddressableManifestAsset
AddressableManifestGroup
AiActionInput
AiActionSpec
AiContext
AiParamDef
AnchorFields
AnchorPreset
AnimatorBlend1D
AnimatorBlendThreshold
AnimatorControllerDef
AnimatorData
AnimatorEvalResult
AnimatorParam
AnimatorPathEvalResult
AnimatorSpineMotion
AnimatorState
AnimatorSubMachine
AnimatorTransition
AnimClipAssetData
AnimClipEventData
AnimClipFrameData
AnimClipSheetData
AnimFramesTrack
AssetGroupDef
AssetGroupsConfig
AssetRefInfo
AssetTypeEntry
AudioBackendInitOptions
AudioBufferHandle
AudioBufferStats
AudioBusConfig
AudioBusDecl
AudioHandle
AudioListenerData
AudioMixerConfig
AudioPluginConfig
AudioProjectConfig
AudioSourceData
AudioTrack
Backend
BehaviorContext
BehaviorDef
BehaviorTreeAgentData
BezierPoints
BitmapCache
BitmapTextData
BlackboardGuard
BoxColliderData
BtDefinition
BtEdge
BtNode
BuildNavGridOptions
BuildProfile
BuiltinBridge
BuiltinComponentDef
BuiltinShaderTemplate
BusDuckRule
ButtonHandle
ButtonOptions
ButtonStateVisual
CacheAsBitmapData
CameraData
CameraDirectorState
CameraExtents
CameraPOV
CameraRenderParams
CanvasData
CanvasScale
CapsuleColliderData
CatalogData
CatalogEntry
Cell
ChangedWrapper
CharacterControllerData
ChildrenData
CircleColliderData
ColliderInstance
ColliderOutline
CollisionBrush
CollisionEnterEvent
CollisionHitEvent
CollisionMaterial
Color
CommandsDescriptor
CompiledFsm
Completable
ComponentDef
ComponentMetadata
CompressorEffectDef
ControllerState
CookedAtlasInfo
CppRegistry
CppResourceManager
CreateListViewOptions
CreateWebAppOptions
DataSource
DecodedChunk
DecodedPixels
DialogHandle
DialogOptions
DiffOptions
Dimension
DraggableData
DragStateData
DrawAPI
DrawCallInfo
DropdownHandle
DropdownOptions
DropShadowFilterOptions
EditorBridge
EditorGridData
EditorViewData
EffectDef
EffectUniformDef
EmbeddedSideModuleEntry
EntityEvent
ESEngineModule
EventBindingData
EventBindingRow
EventDef
EventReaderDescriptor
EventWriterDescriptor
ExternalEntityRef
ExtractEntity
FieldMeta
FilterEffectDef
FlattenContext
FlattenResult
FlexContainerData
FocusableData
FollowTargetData
FrameCaptureData
FrameSnapshot
FrameStats
FsmDefinition
FsmRunState
FsmState
FsmTransition
GamepadSnapshot
GearBinding
GearTween
GeometryOptions
GetWorldDescriptor
HeadlessAppOptions
ImageSegment
InputHandler
InputMapAsset
InstantiatePrefabOptions
InstantiatePrefabResult
InteractableData
InterestView
Keyframe
LayoutProvider
LifecyclePluginOptions
Light2DData
ListenOptions
ListItemTemplate
ListViewHandle
ListViewHost
ListViewOptions
LoadedTilemapLayer
LoadedTilemapSource
LoadedTilemapTileset
LoadRuntimeSceneOptions
LocaleResult
LocaleTableAsset
LocalizationOptions
LogEntry
LogHandler
MarkerData
MaterialAssetData
MaterialData
MaterialGraph
MaterialGraphNode
MaterialOptions
MeasureTextOptions
Mesh2DData
Mesh2DGeometry
MessagePortLike
MigrationResult
Modifiers
MutWrapper
NameData
NavAgentData
NavGridOptions
NestedPrefabRef
NetChannelOptions
NetTransport
NodeParamSpec
NodePort
NodeSpec
OutlineFilterOptions
PackagedAssetIndex
PackagedAssetSourceOptions
PackagedGameConfig
ParentData
ParticleEmitterData
ParticleForceFieldData
PathfindOptions
PerceiverData
PerceptionData
PhysicsContactEventData
PhysicsEventsData
PhysicsPluginConfig
PhysicsWasmModule
PlatformAdapter
PlatformAudioBackend
PlatformCanvas
PlatformCanvas2DContext
PlatformImage
PlatformRequestOptions
PlatformResponse
PlatformSocket
PlatformSocketEvents
PlatformSocketOptions
PlatformVideoBackend
PlayableAdBridge
PlayableRuntimeConfig
PlayConfig
PlayRealmRuntimeConfig
Plugin
PluralForms
PooledAudioNode
PostProcessVolumeData
PredictionOptions
PredictionSmoothing
PrefabComponentData
PrefabData
PrefabDiagnostic
PrefabEntityData
PrefabInstanceDelta
PrefabInstanceEntry
PrefabOverride
PreSceneDrawInfo
ProbedRegistrations
ProcessedEntity
ProgressHandle
ProgressOptions
PropertyChannel
PropertyTrack
PtrLayout
Quat
QueryBuilder
QueryDescriptor
RadiusInterestOptions
ReadonlySignal
RemovedQueryDescriptor
RenderParams
RenderStats
RenderTextureHandle
RenderTextureOptions
ReplicatedData
ResDescriptor
ResMutDescriptor
ResMutInstance
ResolvedAssetGroup
ResolvedTileCollision
ResolvedTileset
ResourceDef
ResourceStats
ReverbEffectDef
RigidBodyData
RuntimeAssetSource
RuntimeBuildConfig
RuntimeInitConfig
SafeAreaData
SampleDeps
SampleOptions
SampleWorld
SaveEnvelope
SaveManagerOptions
SaveStorage
SceneComponentCodec
SceneComponentData
SceneConfig
SceneContext
SceneData
SceneEntityData
SceneLoadOptions
SceneMigrationResult
SceneOwnerData
SceneStreamHost
SceneStreamingConfig
ScreenInfoEvents
ScreenRect
ScreenScalingData
ScrollViewHandle
ScrollViewOptions
SenseResult
SensorEvent
ShadowCaster2DData
ShapeRendererData
SideModuleHost
Signal
SliceBorder
SliderHandle
SliderOptions
SourceDelta
SpatialAudioConfig
SpineAnimationData
SpineAnimationDriver
SpineLoadResult
SpineTrack
SpriteAnimatorData
SpriteAnimClip
SpriteAnimEvent
SpriteAnimFrame
SpriteAnimTrack
SpriteData
StaleOverride
StateMachineAgentData
StatsPluginOptions
StreamCell
StreamDecision
SubsystemEvent
SubsystemStatus
SystemDef
SystemOptions
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
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
BundleMode
BusEffectDef
ColliderShape
ColorRole
CompareOp
ComponentData
DataSourceChange
DimensionUnit
DrawCallback
EasingType
EditorAssetType
EmbeddedSideModuleRegistry
EngineApi
Entity
EntityEventHandler
FilterExpr
FlexDirection
FlexWrap
FontHandle
FsmActionRef
FsmEdge
GameSocketOptions
GearValue
GeometryHandle
GraphNodeType
GraphType
GridColor
HitAreaShape
InferParam
InferParams
InterestPolicy
InterpType
JustifyContent
LifecycleEvent
LifecycleListener
LinearFillDirection
ListLayoutSpec
LocaleCatalog
LocaleEntry
LocalTransformData
LoopMode
MaskMode
MaskMode
MaterialHandle
MessageHandler
MissingAssetCallback
NetRoleKind
PhysicsEventType
PhysicsModuleFactory
PlatformSocketReadyState
PlatformType
PluginDependency
PluralCategory
PluralSelector
PrefabDiagnosticSeverity
PrefabEntityId
PreSceneDrawCallback
QueryResult
RenderSurfaceSource
RenderTargetHandle
RequestHandler
RichTextRun
RunCondition
SaveMigration
ScaleMode
SceneLoadProgressCallback
SceneStatus
ShaderHandle
SideModuleId
SocketReadyState
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
VideoHandle
VideoPlayOptions
WeChatSideModuleFactories
WorldTransformData
WrapMode
Variables
ABI_LAYOUT_HASH
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
btPlugin
BUILTIN_SHADER_TEMPLATES
BUILTIN_UI_PREFABS
BUILTIN_UI_WIDGET_NAMES
BUNDLE_MODES
CacheAsBitmap
CacheBitmap
Camera
CameraDirector
CameraView
Canvas
CAPSULE_ARC_SEGMENTS
CapsuleCollider
ChainCollider
CharacterController
Children
CHUNK_SIZE
CircleCollider
col
COLLISION_BRUSHES
COLLISION_PALETTE_REF
corePlugin
DARK_TOKENS
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
DimensionUnit
Disabled
DistanceJoint
Draggable
dragPlugin
DragState
Draw
EasingType
EDITOR_VIEW_ENTITY
EditorGrid
EditorView
EntityEvents
EventBinding
eventBindingPlugin
FILL_AXIS
Filters
FlexContainer
FlexDirection
FlexWrap
Focusable
FocusManager
focusPlugin
FollowTarget
fsmPlugin
Geometry
GLDebug
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
Mesh2D
mesh2dPlugin
Meshes2D
MotorJoint
Name
Nav
NavAgent
navPlugin
Net
NetGhost
NODE_SPECS
OneWayPlatform
Parent
Particle
ParticleEmitter
ParticleForceField
particlePlugin
Perceiver
Perception
perceptionPlugin
PerceptionTarget
Physics
PhysicsEvents
PhysicsEventType
PolygonCollider
PostProcess
postProcessPlugin
PostProcessVolume
PREFAB_FORMAT_VERSION
Prefabs
prefabsPlugin
PrismaticJoint
PTR_LAYOUTS
Renderer
RenderTexture
Replicated
REPLICATION_CHANNEL
REPLICATION_PROTOCOL_VERSION
replicationPlugin
RETIRED_COMPONENT_TYPES
RevoluteJoint
RigidBody
RuntimeConfig
RuntimeOnly
SafeArea
safeAreaPlugin
scalar
ScaleMode
SCENE_FORMAT_VERSION
SceneManager
sceneManagerPlugin
SceneOwner
SceneStreaming
SCREEN_FIT_OFF
ScreenScaling
SegmentCollider
ShaderSources
ShadowCaster2D
ShapeRenderer
SIDE_MODULES
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
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
UIVisual
v2
v3
Velocity
velocityPlugin
velocitySystem
Video
VideoPlayer
videoPlugin
WeldJoint
WheelJoint
WorldTransform
WrapMode
Functions
actionRefArg
actionRefName
actionRefParams
activeRemoteRoot
addAnimatorParam
addAnimatorState
addAnimatorTransition
addBtChild
addBtOrphan
Added
addNode
addStartupSystem
addState
addSystem
addSystemToSchedule
addTransition
agentBlackboard
agentBtBlackboard
anchorPresetFields
And
animatorEdges
animClipCellRect
animClipCellUv
animClipSheetCols
animClipSheetRows
applyAssetRefResolvers
applyAudioProjectConfig
applyBuildRuntimeConfig
applyDeltaToSource
applyOverrides
applyOverridesToSource
applyRuntimeConfig
applyThemeToWorld
applyWrapMode
arrayDataSource
atlasCatalogFields
auto
Axis1D
Axis2D
bind
bindControllerPage
bindWidgetValue
btEdges
btNodes
bucketOverridesByEntity
buildCollisionPaletteModel
buildTerrainIndices
buildText
buildUINode
buildUIVisual
buildVariant
buildWangIndices
builtinShaderTemplate
Button
calculateAttenuation
calculatePanning
canHaveChildren
canonicalMask
catalogFromManifest
Changed
clearAllCaches
clearAnimatorControllerStore
clearBtStore
clearDrawCallbacks
clearFsmStore
clearTilemapSourceCache
clearUserComponents
cloneComponentData
cloneComponents
cloneMetadata
closeDialog
closeDropdown
collapseEntry
collapseInstance
collectExternalEntityRefs
collectNestedPrefabPaths
collidableTileIds
colliderShapeOutline
collisionRefWithMaterial
color
Commands
compileFsm
compileMaterialGraph
computeEffectiveOrthoSize
computeStreaming
connect
contentHashHex
contentHashOf
controllerState
createAnimClip
createBtRunState
createButton
createDialog
createDropdown
createEmbeddedSideModuleHost
createFetchSideModuleHost
createFsmRunState
createHeadlessApp
createListView
createMemoryTransportPair
createPackagedAssetSource
createProgress
createRuntimeSceneConfig
createScrollView
createSlider
createSocket
createTextInput
createTileset
createToggle
createWebApp
createWeChatSideModuleHost
debug
decodeImageBitmap
decodeImagePixels
decodeTilemapChunks
defaultFrameStats
defineBehavior
defineComponent
defineEvent
defineInputMap
defineResource
defineSystem
defineTag
derived
detectAnchor
detectAnchorAxes
diffAgainstSource
disconnect
emptyAnimatorController
emptyBt
emptyFsm
encodeTile
ensureBtIds
enterStatePath
enumOptions
error
evalGuard
evalGuards
evaluateAnimatorPath
evaluateAnimatorTransitions
evaluateChannel
EventReader
EventWriter
evictTextureDimensions
expandEntry
expandInstance
extractAnimClipTexturePaths
extractPrefab
facingFromQuat
fetchDecodePixels
findControllerOwner
findEntityByName
findPath
flattenPrefab
flipFlagsH
flipFlagsV
flipStampH
flipStampV
flushPendingSystems
folderAlwaysInclude
folderGroupMode
formatActionArg
fsmEdges
fxPreviewOrPlayMode
gearBinding
getAddressableType
getAddressableTypeByEditorType
getAllAssetExtensions
getAllEffectDefs
getAssetBuildTransform
getAssetMimeType
getAssetTypeEntry
getBt
getCacheForEntity
getComponent
getComponentAssetFieldDescriptors
getComponentAssetFields
getComponentDefaults
getComponentFieldMeta
getComponentRegistry
getComponentSpineFieldDescriptor
getControllerPage
getCustomExtensions
getDefaultContext
getEditorType
getEffectDef
getEffectTypes
getFsm
getLogger
getPlatform
getPlatformType
getRegisteredAnimatorController
getReplicatedFields
getResourceManager
getResourceStats
getTextureDimensions
getTheme
getTilemapSource
getUserComponent
getUserComponentFingerprint
getUserComponents
getWeChatPackOptions
GetWorld
GpAxis
GpButton
hasPlayableCta
headlessBasePlugins
imageBitmapOptions
indexPackagedManifest
info
initPlayableRuntime
initPlayRealmRuntime
initRuntime
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
leafStateOf
loadComponent
loadInputMapAsset
loadPackagedAssetIndex
loadPhysicsModule
loadRuntimeScene
loadSceneData
loadSceneWithAssets
loadTiledMap
looksLikeAssetPath
makeLosCheck
makeWidgetInteractable
markThemed
matchLocale
maxChildren
measureText
migratePrefabData
migrateSaveData
migrateSceneData
modeToDelivery
MouseButton
moveAnimatorState
moveBtNode
moveNode
moveState
Mut
navGridFromTilemapLayer
navGridFromTiles
newMaterialGraph
normalizeAngle
normalizeBundleMode
normalizeCornerMask
Not
openDialog
openDropdown
Or
orientationPerm
packCorners
parseActionArg
parseAnimationClip
parseAnimClipAsset
parseAnimClipData
parseAudioProjectConfig
parseBusEffects
parseCollisionMaterial
parseLocaleTable
parseRichText
parseThemeOverrides
parseTileset
parseTimelineAsset
parseTmjJson
parseTmjWithExternals
pathToWorld
percent
platformFetch
platformFileExists
platformInstantiateWasm
platformReadFile
platformReadTextFile
playableCta
playModeOnly
pointInHitArea
pointInOBB
pointInWorldRect
preloadNestedPrefabs
previewPlugin
probeRegistrations
px
quat
quaternionToAngle2D
Query
radiusInterest
readColliderShapes
readFieldPath
readPtrField
rebuildChildren
registerAction
registerAnimatorController
registerAssetBuildTransform
registerBt
registerComponent
registerCondition
registerDrawCallback
registerFsm
registerPreSceneDrawCallback
registerSceneComponentCodec
registerTilemapSource
registerTimelineAsset
remapComponentEntityRefs
remapEntityFields
removeAnimatorParam
removeAnimatorState
removeAnimatorTransition
removeBtNode
removeCacheForEntity
Removed
removeNode
removeState
removeTransition
renameAnimatorState
renameState
reparentBtNode
requireResourceManager
Res
resetWorldTo
ResMut
resolveAssetGroup
resolveAutotile
resolveBindingTarget
resolveChildEntity
resolveParams
resolveRelativePath
resolveThemeTokens
resolveTilesetModel
resolveWang
rotateFlagsCW
rotateStampCW
runHeadless
sampleTimeline
sampleTimelineInWorld
sceneUsesI18n
screenToUiWorld
screenToWorld
selectBlendClip
selectPluralForm
senseTarget
serializeAnimClip
serializeScene
serializeTileset
serializeTimelineAsset
serializeTimelineToJson
setAnimatorConditions
setAnimatorInitial
setAnimatorStateClip
setAnimatorStateProps
setBtNodeField
setButtonState
setCacheForEntity
setControllerPage
setDefaultContext
setEditorMode
setEntityActive
setEntityVisible
setFxEditPreview
setInitial
setLogLevel
setNavDestination
setPlayMode
setStateHook
setTextureBudget
setTextureFilter
setTextureParams
setTextureWrap
setTheme
setUIVisible
setViewTarget
setWasmErrorHandler
shakeCamera
shapeCenter
shapeOffset
shutdownDrawAPI
shutdownGeometryAPI
shutdownGLDebugAPI
shutdownMaterialAPI
shutdownRendererAPI
shutdownResourceManager
signal
singleStamp
spawnUIEntity
spineModuleId
stepFsm
stepPerception
Stick
stopNavAgent
switchTheme
themeButtonStates
themeColors
themeType
tickBt
tileCellCenter
tileCellOutline
tileCollisionOutlines
tileFlagsOf
tileIdOf
toBuildPath
transitionTo
trimTextureCache
uiHitTestWorld
uiLayoutRect
uiPickAllWorld
uiPickWorld
uiWorldToScreen
unregisterComponent
unregisterDrawCallback
unregisterPreSceneDrawCallback
updateAnimatorParam
updateAnimatorTransition
updateCameraAspectRatio
updateTransition
usesStagger
validateOverrides
validatePrefab
vec2
vec3
vec4
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
简体中文
velocitySystem
const
velocitySystem
:
SystemDef
Defined in:
velocity.ts:17