Skip to content

Main Navigation Guide Reference API

English

English

Appearance

Sidebar Navigation

Runtime API

ECS Core

Essential

EntityAttributes

SYSTEM_PRIORITY

Time

Transform

deleteEntities

deleteEntity

findEntityByGuid

findEntityById

getAllEntities

getCurrentWorld

registerProjection

registerSystem

registerTrait

setCurrentWorld

Interfaces

EntityIndex

EntityInfo

FieldHint

SubscribableStore

SystemOptions

TraitMeta

WorldTransform3D

Types

FieldType

LateUpdateFn

Variables

deactivatedEntities

worldTransforms

Functions

addDirtyListener

buildEntityIndex

buildEntityTree

clampAngle

clearLateUpdates

deriveLayer

findEntity

getAllTraits

getEntityTraits

getParentWorldMatrix3D

getReadSourceNames

getReadValue

getRegisteredSystems

getStructureVersion

getTraitByName

getTraitMeta

getWorldMatrix3D

getWorldTransform3D

hasParent

inferFields

isEntityActiveInHierarchy

markStructureDirty

onStructureDirty

onWorldSwap

readTraitData

readTraitDataFull

registerEntity

registerLateUpdate

registerReadSource

resolveTrackTarget

runLateUpdates

runPipeline

setNameTransform

transformName

transformPropagationSystem

unregisterEntity

unregisterLateUpdate

unregisterProjection

unregisterReadSource

unregisterSystem

worldToLocal3D

writeTraitField

Traits

Essential

Animator

AudioListener

AudioSource

Camera

Canvas2D

CharacterController2D

CharacterController3D

Collider2D

Collider3D

Director

Input

MaterialInstance

ModelSource

ParticleEmitter

Paused

Persistent

Physics2D

Physics3D

PrefabInstance

Renderable2D

Renderable3D

RenderableUI

RigidBody2D

RigidBody3D

SkeletalAnimator

SkinnedModel

SpriteAnimator

Text2D

Text3D

Tint

UIElement

Zone2D

Zone3D

getInput

inputAxis

inputHeld

inputPressed

inputReleased

lastInputDevice

pointerDown

pointerDrag

pointerPos

pointerPressed

pointerReleased

setInputAxis

setInputPointer

Interfaces

MaterialAsset

MaterialParamOverride

MeshAsset

SpriteClip

UIActionBinding

Types

BodyType2D

BodyType3D

ColliderShape2D

ColliderShape3D

JointType2D

JointType3D

MaterialParamSource

UIActionEvent

UIActionKind

Variables

AmbientOcclusionPostFX

AnimationLibrary

Billboard3D

BloomPostFX

Bone

Bone2D

BoneAttachment

CameraFrame

CharacterAnimator2D

DepthOfFieldPostFX

FlameMesh

FlatSprite3D

Joint2D

Joint3D

NPRPostFX

OnCollision2D

OnCollision3D

OnSequence

OnZone2D

OnZone3D

Renderable3DPrimitive

Rotate3D

SkinnedMeshRenderer

SkinnedSprite2D

TextAnimation

Transient

UIAction

UIAnchor

UIBinding

UIFocusable

VignettePostFX

ZoneOccupant

Functions

defaultSpriteClip

getWheelDelta

inputPointer

markPersistent

setInputDigital

Time & Determinism

Essential

getSimDelta

getTimeScale

getVisualDelta

rngFloat

rngInt

rngPick

seedRng

setTimeScale

stepSimulation

Interfaces

StepOptions

Functions

advanceManual

getTime

isManualClock

rawNow

resetTimeBaseline

restoreRealClock

rngBool

rngNext

setManualNow

timeSystem

Animation

Interfaces

AnimationClipDef

AnimationTrack

AnimSetClipDef

AnimSetDef

DeformKey

DeformTrack

Keyframe

ResolvedAnimParams

SpriteAnimDef

SpriteAnimSource

Types

TangentMode

TrackValueType

Variables

ANIMATOR_CLIP_TRAITS

ANIMSET_DEFAULTS

DEFAULT_TANGENT_WEIGHT

STEPPED

Functions

activeSpriteClip

advanceClipTime

animationSystem

applyClipAtTime

applyClipDeform

applyTangentMode

autoTangents

beginDeform2DFrame

characterAnimationSystem

clearAnimationClipCache

clearAnimSetCache

clearDeform2DBuffers

clearSpriteAnimCache

defaultAnimationClip

evalBooleanTrack

evalColorTrack

evalDeformTrack

evalTrack

evalTrackValue

findKeyIndex

getAnimationClip

getAnimSet

getDeform2D

getDeform2DVersion

getSpriteAnim

invalidateAnimationClip

invalidateAnimSet

invalidateSpriteAnim

normalizeAnimationClip

normalizeSpriteAnim

resolveAnimSetParams

resolveSpriteClip

setAnimationClip

setAnimSet

setDeform2D

setSpriteAnim

spriteAnimationSystem

spriteAnimHasClip

switchableClipNames

Physics

Essential

physics2DEvents

physics3DEvents

addForce2D

addForce3D

applyImpulse2D

applyImpulse3D

initRapier2D

initRapier3D

raycast2D

raycast3D

setLinvel2D

setLinvel3D

Interfaces

ContactDetail3D

Euler3

PhysicsLayersConfig

Quat

Vec2

Vec3

Types

CollisionHandler

CollisionPhase

ContactHandler3D

SensorHandler

Variables

disposeAllPhysics2D

disposeAllPhysics3D

disposePhysics2D

disposePhysics3D

physics2DEventsManager

physics3DEventsManager

Functions

addTorque2D

addTorque3D

angEcsToPhys

angPhysToEcs

applyTorqueImpulse2D

applyTorqueImpulse3D

eulerToQuat

getContactState

getPhysicsLayerMatrix

getPhysicsLayerNames

isRapier3DReady

isRapierReady

layersCollide

lenToPhys

lenToPhys3D

packCollisionGroups

parsePointsToPhys

physics2DSystem

physics3DSystem

pointQuery2D

pointQuery3D

quatToEuler

resetForces2D

resetForces3D

resetPhysicsLayers

resolveColliderBits

setAngvel2D

setAngvel3D

setBodyTranslation3D

setPhysicsLayers

shapeCast2D

shapeCast3D

vecEcsToPhys

vecEcsToPhys3D

vecPhysToEcs

vecPhysToEcs3D

wakeBody2D

wakeBody3D

Zones

Essential

zone2DEvents

zone3DEvents

Types

ZoneHandler

ZonePhase

Variables

zone2DEventsManager

zone3DEventsManager

Functions

clearZoneState

zone2DSystem

zone3DSystem

Timeline

Essential

TimelineDef

timelineEvents

Interfaces

ActivationSpan

ActivationTrackDef

AnimationClipBlock

AnimationTrackDef

AudioCueBlock

AudioTrackDef

ControlClipBlock

ControlTrackDef

SignalMarker

SignalTrackDef

TrackBase

Types

SequenceEndHandler

SequenceMarkerHandler

SequenceStartHandler

TrackDef

TrackKind

Variables

timelineEventsManager

Functions

applyTimelineState

clearControlSpawns

clearTimelineCache

collectTimelineAudioRefs

collectTimelineControlRefs

defaultTimeline

getTimeline

invalidateTimeline

loadTimelineNow

normalizeTimeline

previewTimelineAt

previewTimelineStep

resolveTimelineAt

setTimeline

timelineSystem

Particles

Essential

ParticleEffectDef

ParticleHandle

Interfaces

AlphaStop

ColorStop

Curve

CurvePoint

EmissionBurst

EmitterShape

Gradient

IParticleBackend

MinMax

RenderConfig

RGB

Types

BlendMode

EmitterShapeType

Functions

clearParticleCache

defaultParticleEffect

getParticleEffect

invalidateParticleEffect

setParticleEffect

Skinning

Interfaces

AutoRig2DOptions

AutoWeightOptions

AutoWeights

BindBone

BuildRig2DOptions

GridMesh

GridOptions

Mat2D

PaintWeightsOptions

PaintWeightsResult

ParsedRig2D

Rig2DBone

Rig2DFile

Skin2DBuffer

SuggestBonesOptions

Functions

apply2D

autoRig2D

boneWeightField

buildRig2D

clearRig2DCache

clearSkin2DBuffers

compose2D

computeAutoWeights

deriveBindMatrices

dominantBoneField

generateGridMesh

getRig2D

getSkin2DBuffer

getSkin2DDeformVersion

identity2D

invalidateRig2D

invert2D

mul2D

normalizeRig2D

paintWeights

setRig2D

skin2DSystem

skinVertex2D

suggestBones

Audio

Essential

AudioCue

AudioPlaySpec

BusName

audioPlay

cueClip

cueSound

setAudioBusVolume

setAudioMuted

stopEntityAudio

stopWorldAudio

Interfaces

AudioHandle

AudioImportSettings

AudioLogEntry

ClipBankEntry

Functions

acquireAudio

audioDispose

audioResume

audioStopAll

audioSystem

clearAudioCues

clearAudioLog

clipRefForKey

crossfadeAudio

disposeAllAudioBuffers

disposeAudioContext

drainAudioCues

getAudioCacheStats

getAudioContext

getAudioLog

getCachedAudioBuffer

hasAudioSupport

invalidateAudio

isAudioMuted

parseClipBank

releaseAudioForScene

resolveAudioUrl

setAudioRecordMode

setAudioWorldPositionResolver

stringifyClipBank

updateAudioListener

Input

Interfaces

GamepadSnapshot

InputFrame

InputSource

PointerFrame

Types

Axis

AxisMap

DigitalAction

FlagMap

InputDevice

PromptAction

Variables

AXES

DIGITAL

gamepadSource

inputSourcesManager

keyboardSource

PROMPT_ACTIONS

Functions

applyDeadzone

attachInputSources

beginSample

calibratePresentationScale

characterInput3DSystem

characterInputSystem

clampAxes

computeEdges

computePointerEdge

createInputFrame

detachInputSources

getPresentationScale

getSources

inputSystem

makeAxes

makeFlags

makePointer

promptFor

registerInputPromptSources

registerSource

sampleGamepadInto

unregisterSource

UI

Essential

clearUIValues

hostCanvasUnder

markUIDirty

requestActivate

resetFocus

setFocus

setUIValue

setUIValues

UIRenderer

Interfaces

FontInfo

Types

NavDir

StoreHook

Variables

useFocusStore

VALUE_TOKEN

Functions

activeScope

addStoreHook

applyBindings

consumePendingActivation

focusedGuid

fontFamilyFromPath

fontPathFromFamily

getHooksVersion

getLoadedFontFamilies

getLoadedFonts

getStoreHooks

hostCanvases

loadAllFonts

loadFont

onEditorDirty

parseFontFilename

pickInDirection

popScope

pushScope

removeStoreHook

resolveTemplate

setEditorDirtyCallback

subscribeHooksVersion

uiFocusSystem

uiTreeProjection

Storage

Essential

PlayerPrefs

Interfaces

PlayerPrefsInitOptions

PrefsBackend

Types

JsonValue

Classes

InMemoryBackend

LocalStorageBackend

PreferencesBackend

Functions

selectDefaultBackend

Rendering

Essential

RenderSettings

SceneRenderer

getRenderSettings

Interfaces

ContainerBox

HandleFilter

InteractionHandle

LightSample

OffscreenCameraOverride

OffscreenRenderOpts

OffscreenRenderResult

PickedLights

PickedPointLight

PixiRenderSettings

ThreeRenderSettings

WebRenderSettings

WebSizing

Types

HandleProvider

Variables

MAX_SHADER_POINT_LIGHTS

PRIORITY_ECS

PRIORITY_RENDER_2D

PRIORITY_RENDER_3D

targetFPS

Functions

clampBufferSize

clearRenderSurfaces

collectHandles

colliderOutline2D

computeContainerBox

getCurrentFPS

getEntityMaterials

getEntityObjects

hasSceneRenderer

keyDirFromEuler

linearFromHex

materialInstanceSystem

pickSceneLights

registerFrameCallback

registerHandleProvider

registerRenderSurface

registerSceneRenderer

renderSceneOffscreen

resetMaterialInstanceClocks

resetMaterialInstanceClones

resetRenderSettings

resolveHandle

resolveToneMapping

rotate3DSystem

setRenderSettings

setTargetFPS

startFrameDriver

stepOneFrame

stopFrameDriver

unregisterFrameCallback

unregisterSceneRenderer

useGameLoop

Materials, Shaders & Textures

Interfaces

MaterialBuilder

ShaderManifest

ShaderParam

Types

CustomShaderBuild

ShaderParamSchema

ShaderParamType

Variables

rendererReady

Functions

coerceParamValue

disposeAllSharedTextures

fetchShaderManifest

getCustomShader

getCustomShaderSchema

getMaterialBuilder

getRegisteredMaterialTypes

getRegisteredShaderNames

getSharedTextureStats

invalidateTexture

loadTexture3D

mergeParamDefaults

onRendererReady

registerCustomShader

registerMaterialType

releaseTexture3D

setActiveRenderer

unregisterCustomShader

Assets & GUIDs

Essential

AssetType

assetUrl

isGuid

newGuid

resolveRef

Interfaces

AssetEntry

AssetManifestEntry

AssetManifestFile

AssetSchema

BinaryAssetMeta

FieldMeta

Types

AssetFieldType

AssetSchemaType

Functions

clearManifest

defaultAssetData

ensureManifestLoaded

getAllAssets

getAssetEntry

getAssetSchema

getAssetType

getAudioLoadType

getGuidForPath

isExternalUrl

isInternalAssetPath

loadManifestJson

normalizeAssetData

registerAsset

resolveGuidToPath

resolveSceneByName

serializeManifest

unregisterAsset

validateAssetData

withCacheBust

Resource Cache

Essential

acquireMaterial

acquireMesh

acquireModel

acquirePrefab

releaseAllForScene

Interfaces

ModelPostprocessor

RiggedModel

Types

SceneId

Variables

PRIMITIVE_NAMES

Functions

acquireEnvironment

acquireRiggedModel

createPrimitiveMesh

disposeAllCachedResources

disposeAllRiggedModels

ensureRiggedModelLoaded

getAllModelPostprocessors

getBoneNames

getCachedEnvironment

getCachedPrefab

getClipNames

getMeshTemplate

getModelPostprocessor

getModelPostprocessorIds

getResourceStats

getRiggedModel

getTemplatesForModel

invalidateMaterial

invalidateModel

invalidatePrefab

isPrimitive

loadGLB

loadModelTemplates

onModelInvalidated

registerModelPostprocessor

registerRuntimeMeshTemplate

releaseEnvironment

releaseMaterial

releaseMesh

releaseModel

releasePrefab

releaseRiggedModelsForScene

resolveMaterial

resolveMaterialForMesh

resolveMeshTemplate

unregisterRuntimeMeshTemplate

Scene & Prefabs

Essential

Scene

SceneManager

SceneResourceRef

SceneState

sceneManager

collectResourceRefsFromEntities

gameIdFromScenePath

spawnPrefabInstance

Interfaces

ApplyResult

LoadSceneOptions

MutableEntity

MutableScene

MutateEntityRef

SceneData

SceneEntityEntry

SceneLoadOptions

SceneSchema

ValidationResult

Types

LoadedSceneEntry

MutateOp

Variables

REF_FIELDS_BY_TRAIT

Functions

applyOps

buildSceneSchema

clearAllOverrideMarks

clearOverrideMarks

deriveInstanceMemberGuids

getOverrideMarkSet

instantiatePrefabIntoWorld

loadSceneFile

markOverride

validateSceneData

Managers

Essential

NavigationManager

TimeManager

navigationManager

timeManager

getActiveGameId

registerManager

Interfaces

ManagerContext

ManagerDef

Types

ManagerScope

Functions

disposeActiveGameManagers

getRegisteredManagers

initGameManagersFor

registerManagers

unregisterManager

unregisterManagers

Game Definition & Services

Essential

AppServices

GameConfig

GameDefinition

getGameConfig

registerAppServices

setGameConfig

Interfaces

AdsService

AttributionService

CrashlyticsService

EditorPanelDef

Variables

ENGINE_API_VERSION

ENGINE_VERSION

SCENE_FORMAT_VERSION

Functions

appServices

clearAppServices

Actions

Essential

UIActionContext

dispatchUIAction

registerUIAction

Interfaces

DispatchOptions

UIActionDef

Types

UIActionHandler

UIActionPayload

Variables

useAudioMixStore

Functions

dispatchGameAction

getUIActionNames

getUIActionParams

hasUIAction

registerAudioControls

registerEngineActions

unregisterUIAction

Play State & Preview

Essential

getPlayState

setPlayState

Types

PlayState

RunMode

Functions

canEdit

clearSkeletalSeeks

getRunMode

getSkeletalSeek

hasSkeletalSeeks

inPreviewSession

isAdvancing

isLiveRender

isPoseOnly

isSimRunning

isTimelinePreviewActive

onPlayStateChange

onRunModeChange

requestSkeletalSeek

setRunMode

setTimelinePreviewActive

shouldFireActions

shouldRunSimTier

Debug & Journal

Essential

emit

isDebugMenuEnabled

journalEvents

registerDebugCommand

Interfaces

DebugCommandDef

DebugTabDef

EntityScreenBounds

GameEvent

ScreenRect

Types

BoundsProvider

JournalLevel

Functions

clearJournal

collectScreenBounds

drainJournal

entityRef

getDebugCommands

getDebugCommandTabs

getDebugTabs

isJournalEnabled

isVerboseType

journalDecision

journalError

journalState

journalWarn

registerBoundsProvider

registerDebugTab

resolveRefName

setDebugMenuEnabled

setJournalEnabled

setJournalTick

setVerboseCapture

unregisterDebugCommand

unregisterDebugTab

verboseCaptureState

Testing Harness

Essential

TestWorld

createTestWorld

CreateTestWorldOptions

TestSystemDef

Store

Essential

useGameStore

Interfaces

UIBindableState

Types

FontStatus

Screen

OTA Updates

Essential

checkForUpdate

fetchRelease

Interfaces

CheckForUpdateOptions

FetchReleaseOptions

OtaManifest

OtaNativePlugin

OtaRelease

Types

FetchReleaseResult

OtaCheckResult

Functions

validateManifest

validateRelease

verifyReleaseSignature

All exports (A–Z)

acquireAudio

acquireEnvironment

acquireMaterial

acquireMesh

acquireModel

acquirePrefab

acquireRiggedModel

ActivationSpan

ActivationTrackDef

activeScope

activeSpriteClip

addDirtyListener

addForce2D

addForce3D

addStoreHook

addTorque2D

addTorque3D

AdsService

advanceClipTime

advanceManual

AlphaStop

AmbientOcclusionPostFX

angEcsToPhys

angPhysToEcs

AnimationClipBlock

AnimationClipDef

AnimationLibrary

animationSystem

AnimationTrack

AnimationTrackDef

Animator

ANIMATOR_CLIP_TRAITS

ANIMSET_DEFAULTS

AnimSetClipDef

AnimSetDef

apply2D

applyBindings

applyClipAtTime

applyClipDeform

applyDeadzone

applyImpulse2D

applyImpulse3D

applyOps

ApplyResult

applyTangentMode

applyTimelineState

applyTorqueImpulse2D

applyTorqueImpulse3D

appServices

AppServices

AssetEntry

AssetFieldType

AssetManifestEntry

AssetManifestFile

AssetSchema

AssetSchemaType

AssetType

assetUrl

attachInputSources

AttributionService

AudioCue

AudioCueBlock

audioDispose

AudioHandle

AudioImportSettings

AudioListener

AudioLogEntry

audioPlay

AudioPlaySpec

audioResume

AudioSource

audioStopAll

audioSystem

AudioTrackDef

autoRig2D

AutoRig2DOptions

autoTangents

AutoWeightOptions

AutoWeights

AXES

Axis

AxisMap

beginDeform2DFrame

beginSample

Billboard3D

BinaryAssetMeta

BindBone

BlendMode

BloomPostFX

BodyType2D

BodyType3D

Bone

Bone2D

BoneAttachment

boneWeightField

BoundsProvider

buildEntityIndex

buildEntityTree

buildRig2D

BuildRig2DOptions

buildSceneSchema

BusName

calibratePresentationScale

Camera

CameraFrame

canEdit

Canvas2D

characterAnimationSystem

CharacterAnimator2D

CharacterController2D

CharacterController3D

characterInput3DSystem

characterInputSystem

checkForUpdate

CheckForUpdateOptions

clampAngle

clampAxes

clampBufferSize

clearAllOverrideMarks

clearAnimationClipCache

clearAnimSetCache

clearAppServices

clearAudioCues

clearAudioLog

clearControlSpawns

clearDeform2DBuffers

clearJournal

clearLateUpdates

clearManifest

clearOverrideMarks

clearParticleCache

clearRenderSurfaces

clearRig2DCache

clearSkeletalSeeks

clearSkin2DBuffers

clearSpriteAnimCache

clearTimelineCache

clearUIValues

clearZoneState

ClipBankEntry

clipRefForKey

coerceParamValue

collectHandles

collectResourceRefsFromEntities

collectScreenBounds

collectTimelineAudioRefs

collectTimelineControlRefs

Collider2D

Collider3D

colliderOutline2D

ColliderShape2D

ColliderShape3D

CollisionHandler

CollisionPhase

ColorStop

compose2D

computeAutoWeights

computeContainerBox

computeEdges

computePointerEdge

consumePendingActivation

ContactDetail3D

ContactHandler3D

ContainerBox

ControlClipBlock

ControlTrackDef

CrashlyticsService

createInputFrame

createPrimitiveMesh

createTestWorld

CreateTestWorldOptions

crossfadeAudio

cueClip

cueSound

Curve

CurvePoint

CustomShaderBuild

deactivatedEntities

DebugCommandDef

DebugTabDef

DEFAULT_TANGENT_WEIGHT

defaultAnimationClip

defaultAssetData

defaultParticleEffect

defaultSpriteClip

defaultTimeline

DeformKey

DeformTrack

deleteEntities

deleteEntity

DepthOfFieldPostFX

deriveBindMatrices

deriveInstanceMemberGuids

deriveLayer

detachInputSources

DIGITAL

DigitalAction

Director

dispatchGameAction

DispatchOptions

dispatchUIAction

disposeActiveGameManagers

disposeAllAudioBuffers

disposeAllCachedResources

disposeAllPhysics2D

disposeAllPhysics3D

disposeAllRiggedModels

disposeAllSharedTextures

disposeAudioContext

disposePhysics2D

disposePhysics3D

dominantBoneField

drainAudioCues

drainJournal

EditorPanelDef

EmissionBurst

emit

EmitterShape

EmitterShapeType

ENGINE_API_VERSION

ENGINE_VERSION

ensureManifestLoaded

ensureRiggedModelLoaded

EntityAttributes

EntityIndex

EntityInfo

entityRef

EntityScreenBounds

Euler3

eulerToQuat

evalBooleanTrack

evalColorTrack

evalDeformTrack

evalTrack

evalTrackValue

fetchRelease

FetchReleaseOptions

FetchReleaseResult

fetchShaderManifest

FieldHint

FieldMeta

FieldType

findEntity

findEntityByGuid

findEntityById

findKeyIndex

FlagMap

FlameMesh

FlatSprite3D

focusedGuid

fontFamilyFromPath

FontInfo

fontPathFromFamily

FontStatus

GameConfig

GameDefinition

GameEvent

gameIdFromScenePath

GamepadSnapshot

gamepadSource

generateGridMesh

getActiveGameId

getAllAssets

getAllEntities

getAllModelPostprocessors

getAllTraits

getAnimationClip

getAnimSet

getAssetEntry

getAssetSchema

getAssetType

getAudioCacheStats

getAudioContext

getAudioLoadType

getAudioLog

getBoneNames

getCachedAudioBuffer

getCachedEnvironment

getCachedPrefab

getClipNames

getContactState

getCurrentFPS

getCurrentWorld

getCustomShader

getCustomShaderSchema

getDebugCommands

getDebugCommandTabs

getDebugTabs

getDeform2D

getDeform2DVersion

getEntityMaterials

getEntityObjects

getEntityTraits

getGameConfig

getGuidForPath

getHooksVersion

getInput

getLoadedFontFamilies

getLoadedFonts

getMaterialBuilder

getMeshTemplate

getModelPostprocessor

getModelPostprocessorIds

getOverrideMarkSet

getParentWorldMatrix3D

getParticleEffect

getPhysicsLayerMatrix

getPhysicsLayerNames

getPlayState

getPresentationScale

getReadSourceNames

getReadValue

getRegisteredManagers

getRegisteredMaterialTypes

getRegisteredShaderNames

getRegisteredSystems

getRenderSettings

getResourceStats

getRig2D

getRiggedModel

getRunMode

getSharedTextureStats

getSimDelta

getSkeletalSeek

getSkin2DBuffer

getSkin2DDeformVersion

getSources

getSpriteAnim

getStoreHooks

getStructureVersion

getTemplatesForModel

getTime

getTimeline

getTimeScale

getTraitByName

getTraitMeta

getUIActionNames

getUIActionParams

getVisualDelta

getWheelDelta

getWorldMatrix3D

getWorldTransform3D

Gradient

GridMesh

GridOptions

HandleFilter

HandleProvider

hasAudioSupport

hasParent

hasSceneRenderer

hasSkeletalSeeks

hasUIAction

hostCanvases

hostCanvasUnder

identity2D

inferFields

initGameManagersFor

initRapier2D

initRapier3D

InMemoryBackend

inPreviewSession

Input

inputAxis

InputDevice

InputFrame

inputHeld

inputPointer

inputPressed

inputReleased

InputSource

inputSourcesManager

inputSystem

instantiatePrefabIntoWorld

InteractionHandle

invalidateAnimationClip

invalidateAnimSet

invalidateAudio

invalidateMaterial

invalidateModel

invalidateParticleEffect

invalidatePrefab

invalidateRig2D

invalidateSpriteAnim

invalidateTexture

invalidateTimeline

invert2D

IParticleBackend

isAdvancing

isAudioMuted

isDebugMenuEnabled

isEntityActiveInHierarchy

isExternalUrl

isGuid

isInternalAssetPath

isJournalEnabled

isLiveRender

isManualClock

isPoseOnly

isPrimitive

isRapier3DReady

isRapierReady

isSimRunning

isTimelinePreviewActive

isVerboseType

Joint2D

Joint3D

JointType2D

JointType3D

journalDecision

journalError

journalEvents

JournalLevel

journalState

journalWarn

JsonValue

keyboardSource

keyDirFromEuler

Keyframe

lastInputDevice

LateUpdateFn

layersCollide

lenToPhys

lenToPhys3D

LightSample

linearFromHex

loadAllFonts

LoadedSceneEntry

loadFont

loadGLB

loadManifestJson

loadModelTemplates

loadSceneFile

LoadSceneOptions

loadTexture3D

loadTimelineNow

LocalStorageBackend

makeAxes

makeFlags

makePointer

ManagerContext

ManagerDef

ManagerScope

markOverride

markPersistent

markStructureDirty

markUIDirty

Mat2D

MaterialAsset

MaterialBuilder

MaterialInstance

materialInstanceSystem

MaterialParamOverride

MaterialParamSource

MAX_SHADER_POINT_LIGHTS

mergeParamDefaults

MeshAsset

MinMax

ModelPostprocessor

ModelSource

mul2D

MutableEntity

MutableScene

MutateEntityRef

MutateOp

NavDir

navigationManager

NavigationManager

newGuid

normalizeAnimationClip

normalizeAssetData

normalizeRig2D

normalizeSpriteAnim

normalizeTimeline

NPRPostFX

OffscreenCameraOverride

OffscreenRenderOpts

OffscreenRenderResult

OnCollision2D

OnCollision3D

onEditorDirty

onModelInvalidated

onPlayStateChange

onRendererReady

onRunModeChange

OnSequence

onStructureDirty

onWorldSwap

OnZone2D

OnZone3D

OtaCheckResult

OtaManifest

OtaNativePlugin

OtaRelease

packCollisionGroups

paintWeights

PaintWeightsOptions

PaintWeightsResult

parseClipBank

ParsedRig2D

parseFontFilename

parsePointsToPhys

ParticleEffectDef

ParticleEmitter

ParticleHandle

Paused

Persistent

Physics2D

physics2DEvents

physics2DEventsManager

physics2DSystem

Physics3D

physics3DEvents

physics3DEventsManager

physics3DSystem

PhysicsLayersConfig

PickedLights

PickedPointLight

pickInDirection

pickSceneLights

PixiRenderSettings

PlayerPrefs

PlayerPrefsInitOptions

PlayState

pointerDown

pointerDrag

PointerFrame

pointerPos

pointerPressed

pointerReleased

pointQuery2D

pointQuery3D

popScope

PrefabInstance

PreferencesBackend

PrefsBackend

previewTimelineAt

previewTimelineStep

PRIMITIVE_NAMES

PRIORITY_ECS

PRIORITY_RENDER_2D

PRIORITY_RENDER_3D

PROMPT_ACTIONS

PromptAction

promptFor

pushScope

Quat

quatToEuler

rawNow

raycast2D

raycast3D

readTraitData

readTraitDataFull

REF_FIELDS_BY_TRAIT

registerAppServices

registerAsset

registerAudioControls

registerBoundsProvider

registerCustomShader

registerDebugCommand

registerDebugTab

registerEngineActions

registerEntity

registerFrameCallback

registerHandleProvider

registerInputPromptSources

registerLateUpdate

registerManager

registerManagers

registerMaterialType

registerModelPostprocessor

registerProjection

registerReadSource

registerRenderSurface

registerRuntimeMeshTemplate

registerSceneRenderer

registerSource

registerSystem

registerTrait

registerUIAction

releaseAllForScene

releaseAudioForScene

releaseEnvironment

releaseMaterial

releaseMesh

releaseModel

releasePrefab

releaseRiggedModelsForScene

releaseTexture3D

removeStoreHook

Renderable2D

Renderable3D

Renderable3DPrimitive

RenderableUI

RenderConfig

rendererReady

renderSceneOffscreen

RenderSettings

requestActivate

requestSkeletalSeek

resetFocus

resetForces2D

resetForces3D

resetMaterialInstanceClocks

resetMaterialInstanceClones

resetPhysicsLayers

resetRenderSettings

resetTimeBaseline

resolveAnimSetParams

resolveAudioUrl

resolveColliderBits

ResolvedAnimParams

resolveGuidToPath

resolveHandle

resolveMaterial

resolveMaterialForMesh

resolveMeshTemplate

resolveRef

resolveRefName

resolveSceneByName

resolveSpriteClip

resolveTemplate

resolveTimelineAt

resolveToneMapping

resolveTrackTarget

restoreRealClock

RGB

Rig2DBone

Rig2DFile

RiggedModel

RigidBody2D

RigidBody3D

rngBool

rngFloat

rngInt

rngNext

rngPick

Rotate3D

rotate3DSystem

runLateUpdates

RunMode

runPipeline

sampleGamepadInto

Scene

SCENE_FORMAT_VERSION

SceneData

SceneEntityEntry

SceneId

SceneLoadOptions

sceneManager

SceneManager

SceneRenderer

SceneResourceRef

SceneSchema

SceneState

Screen

ScreenRect

seedRng

selectDefaultBackend

SensorHandler

SequenceEndHandler

SequenceMarkerHandler

SequenceStartHandler

serializeManifest

setActiveRenderer

setAngvel2D

setAngvel3D

setAnimationClip

setAnimSet

setAudioBusVolume

setAudioMuted

setAudioRecordMode

setAudioWorldPositionResolver

setBodyTranslation3D

setCurrentWorld

setDebugMenuEnabled

setDeform2D

setEditorDirtyCallback

setFocus

setGameConfig

setInputAxis

setInputDigital

setInputPointer

setJournalEnabled

setJournalTick

setLinvel2D

setLinvel3D

setManualNow

setNameTransform

setParticleEffect

setPhysicsLayers

setPlayState

setRenderSettings

setRig2D

setRunMode

setSpriteAnim

setTargetFPS

setTimeline

setTimelinePreviewActive

setTimeScale

setUIValue

setUIValues

setVerboseCapture

ShaderManifest

ShaderParam

ShaderParamSchema

ShaderParamType

shapeCast2D

shapeCast3D

shouldFireActions

shouldRunSimTier

SignalMarker

SignalTrackDef

SkeletalAnimator

Skin2DBuffer

skin2DSystem

SkinnedMeshRenderer

SkinnedModel

SkinnedSprite2D

skinVertex2D

spawnPrefabInstance

spriteAnimationSystem

SpriteAnimator

SpriteAnimDef

spriteAnimHasClip

SpriteAnimSource

SpriteClip

startFrameDriver

stepOneFrame

StepOptions

STEPPED

stepSimulation

stopEntityAudio

stopFrameDriver

stopWorldAudio

StoreHook

stringifyClipBank

SubscribableStore

subscribeHooksVersion

suggestBones

SuggestBonesOptions

switchableClipNames

SYSTEM_PRIORITY

SystemOptions

TangentMode

targetFPS

TestSystemDef

TestWorld

Text2D

Text3D

TextAnimation

ThreeRenderSettings

Time

TimelineDef

timelineEvents

timelineEventsManager

timelineSystem

timeManager

TimeManager

timeSystem

Tint

TrackBase

TrackDef

TrackKind

TrackValueType

TraitMeta

Transform

transformName

transformPropagationSystem

Transient

UIAction

UIActionBinding

UIActionContext

UIActionDef

UIActionEvent

UIActionHandler

UIActionKind

UIActionPayload

UIAnchor

UIBindableState

UIBinding

UIElement

UIFocusable

uiFocusSystem

UIRenderer

uiTreeProjection

unregisterAsset

unregisterCustomShader

unregisterDebugCommand

unregisterDebugTab

unregisterEntity

unregisterFrameCallback

unregisterLateUpdate

unregisterManager

unregisterManagers

unregisterProjection

unregisterReadSource

unregisterRuntimeMeshTemplate

unregisterSceneRenderer

unregisterSource

unregisterSystem

unregisterUIAction

updateAudioListener

useAudioMixStore

useFocusStore

useGameLoop

useGameStore

validateAssetData

validateManifest

validateRelease

validateSceneData

ValidationResult

VALUE_TOKEN

Vec2

Vec3

vecEcsToPhys

vecEcsToPhys3D

vecPhysToEcs

vecPhysToEcs3D

verboseCaptureState

verifyReleaseSignature

VignettePostFX

wakeBody2D

wakeBody3D

WebRenderSettings

WebSizing

withCacheBust

worldToLocal3D

WorldTransform3D

worldTransforms

writeTraitField

Zone2D

zone2DEvents

zone2DEventsManager

zone2DSystem

Zone3D

zone3DEvents

zone3DEventsManager

zone3DSystem

ZoneHandler

ZoneOccupant

ZonePhase

Rendering API

Rendering

Essential

Canvas2DMount

Game

Scene2D

Scene3D

Interfaces

Canvas2DSlot

CanvasScale

SceneLightUniforms

Functions

activeFrameId

allocate

applyNprFragmentOutput

buildSceneDiffuseNode

computeActiveFrameFit

computeCanvasScale

createRenderer

destroyPool

easeCameraBlend

getAllocatedEntityIds

getApp

getSceneLightUniforms

getSlot

getWebGPUSupported

initPool

isShowColliders2D

nprFragmentOutput

release

releaseAll

renderAll

resize

setActiveCameraFrame

setShowColliders2D

startScene2D

stopScene2D

syncCamera

syncEnvironment

syncFog

syncLights

syncRenderables

updateSceneLightUniforms

useCanvas2DInit

All exports (A–Z)

activeFrameId

allocate

applyNprFragmentOutput

buildSceneDiffuseNode

Canvas2DMount

Canvas2DSlot

CanvasScale

computeActiveFrameFit

computeCanvasScale

createRenderer

destroyPool

easeCameraBlend

Game

getAllocatedEntityIds

getApp

getSceneLightUniforms

getSlot

getWebGPUSupported

initPool

isShowColliders2D

nprFragmentOutput

release

releaseAll

renderAll

resize

Scene2D

Scene3D

SceneLightUniforms

setActiveCameraFrame

setShowColliders2D

startScene2D

stopScene2D

syncCamera

syncEnvironment

syncFog

syncLights

syncRenderables

updateSceneLightUniforms

useCanvas2DInit

On this page

@modoki/engine / index / rendererReady

Variable: rendererReady

const rendererReady: Promise<void>

Pager

Previous pageShaderParamType

Next pagecoerceParamValue

Built with Modoki.

© 2026 modoki