Skip to content
YAGE
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Getting Started
Installation
Your First Game
Concepts
Engine & Plugins
Entities & Components
Systems
Scenes
Events
Dependency Injection
Game Loop
Guides
Rendering
Overview
Responsive Canvas
Sprites & Animation
Graphics
Text
Camera & Layers
Effects & Masks
Input
Processes & Tweens
Physics
Audio
Particles
Tilemaps
UI
UI (React)
Save & Load
Snapshot Quicksave
Assets
Loading Scene
Debug Tools
Patterns
Project Layout
Entity Subclasses
Testing
Scene Management
State Management
Persistent World State
Common Game Patterns
Reference
Packages
API
@yagejs/audio
Classes
AudioManager
AudioPlugin
SoundComponent
SoundHandle
Interfaces
AudioConfig
AudioPlayOptions
ChannelConfig
SoundComponentOptions
SoundData
Variables
AudioManagerKey
VERSION
Functions
sound
@yagejs/core
Enumerations
LogLevel
Phase
Classes
AssetHandle
AssetManager
Component
ComponentFixedUpdateSystem
ComponentUpdateSystem
Engine
EngineContext
Entity
ErrorBoundary
EventBus
EventToken
GameLoop
Inspector
KeyframeAnimator
LoadingScene
Logger
Process
ProcessComponent
ProcessSlot
ProcessSystem
QueryCache
QueryResult
Scene
SceneHookRegistry
SceneManager
Sequence
ServiceKey
System
SystemScheduler
TimerEntity
TraitToken
Transform
Vec2
Interfaces
AssetLoader
Blueprint
CameraSnapshot
Codec
ComponentStateSnapshot
CreateCounterOptions
CreateListOptions
CreateMapOptions
CreateRecordOptions
CreateSetOptions
CreateValueOptions
EngineConfig
EngineEvents
EngineSnapshot
EntityCallbacks
EntityFilter
EntitySnapshot
ErrorSnapshot
EventLogEntry
GameLoopCallbacks
GameLoopConfig
InputStateSnapshot
InspectorTimeController
Keyframe
KeyframeAnimationDef
KeyframeTrackOptions
LeafBuilder
ListEncoded
LogEntry
LoggerConfig
PhysicsSnapshot
Plugin
PointerSnapshot
ProcessOptions
ProcessSlotConfig
RandomService
Reactive
ReactiveCounter
ReactiveList
ReactiveMap
ReactiveRecord
ReactiveSet
ReactiveValue
RendererAdapter
Resettable
SceneHooks
SceneSnapshot
SceneTransition
SceneTransitionContext
SceneTransitionOptions
ScopedProcessQueue
Serializable
ServiceKeyOptions
SmoothDampResult
SnapshotResolver
SpawnOptions
SystemSnapshot
TransformData
UINodeSnapshot
UITreeSnapshot
Vec2Like
WorldEntitySnapshot
WorldSceneSnapshot
Type Aliases
ComponentClass
EasingFunction
EncodedForLeaf
EncodedStore
EventMap
Interpolatable
ReactiveStore
SceneTransitionKind
ServiceScope
StoreLeaves
Variables
AssetManagerKey
easeInOutQuad
easeInQuad
easeLinear
easeOutBounce
easeOutQuad
EngineKey
ErrorBoundaryKey
EventBusKey
GameLoopKey
globalRandom
InspectorKey
LoggerKey
MathUtils
ProcessSystemKey
QueryCacheKey
RandomKey
RendererAdapterKey
SceneHookRegistryKey
SceneManagerKey
SERIALIZABLE_KEY
SerializableRegistry
STATE_KIND
SystemSchedulerKey
Tween
VERSION
Functions
advanceFrames
createCounter
createDefaultRandomSeed
createKeyframeTrack
createList
createMap
createMockEntity
createMockScene
createRandomService
createRecord
createSet
createStore
createTestEngine
createValue
dateCodec
defineBlueprint
defineEvent
defineTrait
devWarn
filterEntities
getSerializableType
interpolate
isDev
isPointerConsumeContainer
isSerializable
jsonCodec
makeEntityScopedQueue
makeGlobalScopedQueue
makeSceneScopedQueue
mapCodec
markPointerConsumeContainer
normalizeSeed
_resetEntityIdCounter
resolveTransition
serializable
setCodec
trait
unmarkPointerConsumeContainer
@yagejs/debug
Classes
DebugPlugin
DebugRegistryImpl
StatsStore
Interfaces
CameraStackSnapshot
DebugConfig
DebugDiagnostics
IDebugClock
LayerTransformSnapshot
@yagejs/effects
Interfaces
BloomHandle
BloomOptions
BulgePinchHandle
BulgePinchOptions
ChromaticAberrationHandle
ChromaticAberrationOptions
ColorGradeHandle
ColorGradeOptions
ColorizeHandle
ColorizeOptions
CRTOptions
DropShadowHandle
DropShadowOptions
GlowHandle
GlowOptions
GodRayHandle
GodRayOptions
HalftoneHandle
HalftoneOptions
HitFlashHandle
HitFlashOptions
MotionBlurHandle
MotionBlurOptions
OldFilmOptions
OutlineHandle
OutlineOptions
PixelateHandle
PixelateOptions
ShockwaveHandle
ShockwaveOptions
VignetteHandle
VignetteOptions
WaveHandle
WaveOptions
Type Aliases
ColorGradePreset
CRTHandle
OldFilmHandle
Variables
bloom
bulgePinch
chromaticAberration
colorGrade
colorize
crt
dropShadow
glow
godRay
halftone
hitFlash
motionBlur
oldFilm
outline
pixelate
shockwave
vignette
wave
@yagejs/input
Classes
InputManager
InputPlugin
Interfaces
CameraLike
GamepadInfo
InputConfig
PointerInfo
RebindOptions
RebindResult
Type Aliases
ActionMapDefinition
GamepadAxisKey
InputConflictPolicy
PointerType
RendererLike
Variables
InputManagerKey
Functions
getKeyDisplayName
@yagejs/particles
Classes
ParticleEmitterComponent
ParticlePool
ParticlesPlugin
ParticleSystem
Interfaces
EmitterConfig
Lerped
ParticleEmitterData
Type Aliases
NumberRange
Variables
ParticlePresets
Functions
isLerped
resolveRange
@yagejs/physics
Classes
ColliderComponent
CollisionLayers
PhysicsInterpolationSystem
PhysicsPlugin
PhysicsSystem
PhysicsWorld
PhysicsWorldManager
RigidBodyComponent
Interfaces
ColliderConfig
ColliderData
CollisionEvent
PhysicsAlphaRef
PhysicsConfig
RaycastHit
RigidBodyConfig
RigidBodyData
ScenePhysicsContext
TriggerEvent
Type Aliases
BodyType
ColliderShape
Variables
PhysicsWorldKey
PhysicsWorldManagerKey
VERSION
@yagejs/renderer
Classes
AnimatedSpriteComponent
AnimationController
CameraBoundsComponent
CameraComponent
CameraEntity
CameraFollow
CameraShake
CameraZoom
DisplaySystem
EffectsHost
EffectStack
GraphicsComponent
LayeredAnimationController
RendererPlugin
RenderLayer
RenderLayerManager
SceneRenderTreeProviderImpl
ScreenFollow
SpriteComponent
TextComponent
Interfaces
AnimatedSpriteComponentOptions
AnimatedSpriteData
AnimationControllerData
AnimationDef
AtlasFrameSource
CameraBinding
CameraBounds
CameraBoundsComponentData
CameraComponentData
CameraComponentOptions
CameraEntityParams
CameraFitToRect
CameraFollowData
CameraFollowOptions
CameraShakeData
CameraShakeOptions
CameraZoomData
ChessboardOptions
CreateLayerOptions
CrossFadeOptions
Effect
EffectDefinition
EffectHandle
EffectStackEntry
EffectStackSnapshot
EffectTarget
FadeOptions
FlashOptions
GradientStop
GraphicsComponentOptions
GraphicsData
InstallBitmapFontOptions
IrisOptions
IrisRevealOptions
LayerDef
LayeredAnimationControllerOptions
LinearGradientOptions
Mask
MaskDefinition
MaskHandle
MaskSnapshot
RadialGradientOptions
RawFilterOptions
RectMaskOptions
RendererConfig
RendererFitOptions
RendererSnapshotData
SceneRenderTree
SceneRenderTreeProvider
ScreenFollowData
ScreenFollowOptions
SlidePushOptions
SpriteComponentOptions
SpriteData
StripFrameSource
TextComponentOptions
TextData
TextureSliceOptions
VirtualRect
Type Aliases
BitmapFontHandle
BitmapFontResource
BitmapTextOption
CanvasRect
ColorValue
DisplayBitmapText
DisplayContainer
DisplaySprite
DisplayText
EffectFactory
EffectScope
EnsureLayerOptions
FitMode
FrameSource
GradientFill
GradientSpace
GraphicsContext
LayerSortFn
LayerSpace
MaskFactory
PointLike
RendererAsset
ScreenFollowTarget
SlideDirection
TextStyle
TextureHandle
TextureInput
TextureResource
Variables
rectMask
RendererKey
SceneRenderTreeKey
SceneRenderTreeProviderKey
ySort
Functions
attachMask
bitmapFont
buildTextOptions
chessboard
crossFade
defineEffect
defineMask
fade
flash
getSceneContainer
getVirtualBounds
graphicsMask
installBitmapFont
iris
irisReveal
isAtlasSource
isStripSource
linearGradient
radialGradient
rawFilter
renderAsset
resolveFrames
resolveTextureInput
restoreMask
sliceSheet
sliceTextureFrames
slidePush
spriteMask
spritesheet
texture
ySortBy
@yagejs/save
Classes
CorruptPayloadError
InvalidKeyError
LocalStorageSnapshotStorage
Save
SavePlugin
SlotNotFoundError
SnapshotPlugin
SnapshotService
StoreMigrationMissingError
StoreVersionTooNewError
Interfaces
ComponentSnapshot
CreateSaveOptions
EntitySnapshotEntry
GameSnapshot
LocalStorageAdapterOptions
PersistOptions
RestoreOptions
SaveAdapter
SavePluginOptions
SaveSlotOptions
SceneSnapshotEntry
SlotInfo
SnapshotContributor
SnapshotPluginOptions
SnapshotResolver
SnapshotStorage
Type Aliases
UntypedSlots
Variables
SaveServiceKey
SnapshotServiceKey
VERSION
Functions
createSave
localStorageAdapter
memoryAdapter
@yagejs/tilemap
Classes
TilemapComponent
TilemapPlugin
TilemapRenderSystem
Interfaces
CapsuleColliderConfig
CapsuleObject
CircleColliderConfig
EllipseObject
HasProperties
MapObject
MapObjectProperty
ObjectGroup
ObjectLayerData
PointObject
PolygonColliderConfig
PolygonObject
PolylineColliderConfig
RectangleObject
RectColliderConfig
TileData
TiledMapData
TileLayer
TileLayerData
TilemapComponentData
TilemapComponentOptions
TilemapData
TileObjectProperty
TilesetData
TilesetRef
Type Aliases
TilemapColliderConfig
TileObject
Variables
tiledMapAssetExtension
Functions
createTilemapLayers
extractCollisionShapes
extractObjects
getProperty
getPropertyArray
resolveObjectRef
resolveObjectRefArray
tiledMap
tiledObjectKey
toPhysicsColliders
toTilemapData
@yagejs/ui
Enumerations
Anchor
Classes
BackgroundRenderer
LoadingSceneProgressBar
PanelNode
PixiCheckbox
PixiFancyButton
PixiInput
PixiProgressBar
PixiRadioGroup
PixiSelect
PixiSlider
PixiUIBase
PointerEvents
ScrollViewNode
UIButton
UICheckbox
UIImage
UILayoutSystem
UINineSlice
UIPanel
UIPlugin
UIProgressBar
UIText
Interfaces
ColorBackground
ConsumeInputProps
FancyButtonAnimations
LayoutProps
LoadingSceneProgressBarOptions
NineSliceViewOptions
PanelProps
PixiCheckboxProps
PixiFancyButtonProps
PixiInputProps
PixiProgressBarProps
PixiRadioGroupProps
PixiSelectProps
PixiSliderProps
PointerEventProps
ScrollbarOptions
ScrollViewProps
TextureBackground
UIButtonProps
UICheckboxProps
UIContainerElement
UIElement
UIImageProps
UINineSliceProps
UIPanelOptions
UIProgressBarProps
UITextProps
Type Aliases
BackgroundOptions
FlexDirection
LayoutValue
Padding
PixiViewType
PositionValue
UIPositioning
Variables
UI_DEFAULT_LAYER
UI_DEFAULT_LAYER_ORDER
Functions
applyLayoutProps
createNineSliceView
createYogaNode
isTextureBackground
pivotOffsetFromAnchor
resolveAnchor
resolveTexture
setAssetManager
setYoga
GitHub
Select theme
Dark
Light
Auto
DisplayText
DisplayText
=
Text
Defined in:
renderer/src/public-types.ts:38
A text display object.
