Skip to content

Manual API reference Examples

Select theme

Overview
Core API
- audio-provider
  - Interfaces
    AudioPlayOptions
    AudioProvider
  - Type Aliases
    AudioHandle
- component-store
  - Classes
    ComponentStore
    TagStore
  - Interfaces
    ColumnField
    ComponentDef
    ComponentStoreLike
    RegistryComponentOptions
    SimpleComponentOptions
    TagDef
  - Type Aliases
    AnyComponentDef
    ComponentMigration
    ComponentValues
    NumericColumnKind
    RegistryComponentValue
    RegistryIdKind
    SimpleFieldKind
    SimpleSchema
    StoreDeleteHandler
    StoreSetHandler
    StoreValidateHandler
  - Functions
    registryComponent
    simpleComponent
- entity-id
  - Type Aliases
    EntityId
  - Variables
    ENTITY_GENERATION_MAX
    ENTITY_INDEX_BITS
    ENTITY_INDEX_MAX
  - Functions
    entityGeneration
    entityIndex
    formatEntityId
    isEntityId
    packEntityId
- event-bus
  - Classes
    EventBus
  - Interfaces
    EventContext
- input-source
  - Interfaces
    InputProvider
  - Type Aliases
    InputRawEvent
- lifecycle
  - Type Aliases
    LifecycleEvent
- query
  - Classes
    Query
- renderer
  - Interfaces
    Renderer
- scheduler
  - Classes
    Scheduler
  - Interfaces
    ComponentRef
    SchedulableSystem
    SchedulerOptions
- spatial-structure
  - Interfaces
    SpatialStructure
- template
  - Interfaces
    EntityTemplate
  - Functions
    composeTemplates
- test-utils
  - Classes
    GenericEntityBuilder
    TestWorld
  - Functions
    createTestWorld
    eid
    entity
- tick-runner
  - Classes
    TickRunner
  - Interfaces
    TickFlushableEvents
    TickRunnerOptions
- tick-source
  - Interfaces
    TickInfo
    TickSource
- validation
  - Functions
    asArray
    asBoolean
    asEntityId
    asNumber
    asObject
    asString
- world
  - Classes
    EcsWorld
  - Interfaces
    SpatialOptions
Modules API
- animation
- asset-loader
  - Classes
    AssetLoader
  - Interfaces
    AssetBatchLoadOptions
    AssetBatchProgress
    AssetHandle
    AssetLoadContext
    AssetLoaderOptions
    AssetLoadOptions
    FontFaceAssetOptions
    FontLoaderOptions
    ImageAssetOptions
    ImageLoaderOptions
  - Type Aliases
    AssetKind
    AssetValue
  - Functions
    arrayBufferAsset
    audioBufferAsset
    createAssetHandle
    fontFaceAsset
    imageAsset
    jsonAsset
    textAsset
- attach
  - Interfaces
    Attach
    AttachSystemOptions
    AttachTickCtx
  - Variables
    AttachDef
  - Functions
    makeAttachSystem
- audio
  - Classes
    AudioQueue
    WebAudioProvider
  - Interfaces
    AudioListener
    AudioOneShot
    AudioSource
    AudioSpatial
    AudioSystemError
    AudioSystemOptions
    AudioTickCtx
    SpatialDefaults
    WebAudioProviderOptions
  - Type Aliases
    AudioSystemErrorKind
  - Variables
    AudioSourceDef
  - Functions
    makeAudioSystem
- behavior-tree
  - Type Aliases
    BtNode
    BtStatus
  - Functions
    action
    condition
    inverter
    selector
    sequence
- camera
  - Interfaces
    Camera
    CameraFollowOptions
    CameraFollowTickCtx
    CameraOptions
  - Variables
    CAMERA_NO_LIMIT
    CameraDef
  - Functions
    cameraToView
    cameraViewRect
    clampCameraToLimits
    makeCamera
    makeFollowCameraSystem
    viewToWorld
    worldToView
- camera-3d
- collision
  - Interfaces
    Aabb
    BounceResult
    RayHit
    ShapeAabb
    ShapeCircle
    SweptHit
    TriggerSystemOptions
    Vec2
  - Type Aliases
    AabbAxis
  - Variables
    ShapeAabbDef
    ShapeCircleDef
  - Functions
    aabbContainsPoint
    aabbVsAabb
    aabbVsAabbSwept
    aabbVsCircle
    bounceOffAabb
    circleContainsPoint
    circleVsCircle
    makeTriggerSystem
    rayVsAabb
    reflect
- collision-3d
  - Interfaces
    Aabb3
    Obb3
    Plane3
    RayHit3
    ShapeAabb3
    ShapeSphere3
    SweptHit3
  - Type Aliases
    Aabb3Axis
  - Variables
    ShapeAabb3Def
    ShapeSphere3Def
  - Functions
    aabb3ContainsPoint
    aabb3VsAabb3
    aabb3VsAabb3Swept
    aabb3VsObb3
    aabb3VsPlane3
    aabb3VsSphere3
    obb3VsObb3
    obb3VsSphere3
    plane3DistanceToPoint
    rayVsAabb3
    rayVsObb3
    rayVsPlane3
    sphere3ContainsPoint
    sphere3VsPlane3
    sphere3VsSphere3
- cooldown
  - Interfaces
    CooldownSystemOptions
    CooldownTickCtx
  - Type Aliases
    Cooldown
  - Variables
    CooldownDef
  - Functions
    makeCooldown
    makeCooldownSystem
    ready
    trigger
- drag-drop
  - Classes
    DragDrop
  - Interfaces
    DragDropOptions
    DragSession
    DropResult
  - Type Aliases
    DragProbe
- easing
  - Type Aliases
    Easing
  - Variables
    easeInBack
    easeInBounce
    easeInCirc
    easeInCubic
    easeInElastic
    easeInExpo
    easeInOutBack
    easeInOutBounce
    easeInOutCirc
    easeInOutCubic
    easeInOutElastic
    easeInOutExpo
    easeInOutQuad
    easeInOutQuart
    easeInOutQuint
    easeInOutSine
    easeInQuad
    easeInQuart
    easeInQuint
    easeInSine
    easeOutBack
    easeOutBounce
    easeOutCirc
    easeOutCubic
    easeOutElastic
    easeOutExpo
    easeOutQuad
    easeOutQuart
    easeOutQuint
    easeOutSine
    linear
- fsm
  - Interfaces
    Fsm
    FsmState
  - Type Aliases
    FsmStates
  - Functions
    makeFsm
    tickFsm
- game-search
  - Interfaces
    AlphaBetaOptions
    AlphaBetaResult
    MctsOptions
    MctsResult
    SearchGame
  - Variables
    WIN_SCORE
  - Functions
    alphaBetaSearch
    mctsSearch
- goap
  - Interfaces
    GoapAction
  - Type Aliases
    WorldState
  - Functions
    plan
- grid-based
  - Interfaces
    Point
    VisibilityGrid
  - Functions
    bresenhamLine
    computeFieldOfView
    hasLineOfSight
- input
  - Classes
    GamepadProvider
    KeyboardProvider
    MouseLookProvider
    PointerProvider
  - Interfaces
    EventInput
    GamepadProviderOptions
    GamepadSnapshot
    InputState
    KeyboardProviderOptions
    LockSource
    LookDelta
    MouseLookOptions
    MouseLookState
    MouseLookTarget
    PointerProviderOptions
    PointerState
    PointerTarget
  - Type Aliases
    GamepadCode
    GamepadSource
    InputEvent
    InputMap
    KeyboardCode
    KeyboardEmitSource
    PointerCode
    PointerProjector
  - Variables
    Gamepad
    Key
    Pointer
  - Functions
    createEventInput
    createInput
    projectPointer
- kinematics
  - Interfaces
    Grounded
    KinematicsSystemOptions
    KinematicsTickCtx
  - Variables
    GroundedDef
  - Functions
    makeKinematicsSystem
- kinematics-3d
  - Interfaces
    Grounded3
    Kinematics3DSystemOptions
    Kinematics3DTickCtx
  - Variables
    Grounded3Def
  - Functions
    makeKinematics3DSystem
- lifetime
  - Interfaces
    LifetimeSystemOptions
    LifetimeTickCtx
  - Type Aliases
    Lifetime
  - Variables
    LifetimeDef
  - Functions
    makeLifetime
    makeLifetimeSystem
- math
  - Interfaces
    Quat
    Vec3
  - Type Aliases
    Mat4
  - Variables
    QUAT_IDENTITY
  - Functions
    approximately
    clamp
    clamp01
    degToRad
    inverseLerp
    lerp
    lerpAngle
    mat4Compose
    mat4Identity
    mat4Invert
    mat4LookAt
    mat4Multiply
    mat4Orthographic
    mat4Perspective
    mat4TransformDirection
    mat4TransformPoint
    mat4TransformVec4
    mat4Transpose
    pingPong
    quatConjugate
    quatForward
    quatFromAxisAngle
    quatLookRotation
    quatMul
    quatNormalize
    quatRotate
    quatSlerp
    quatUp
    radToDeg
    remap
    smoothstep
    vec2MoveToward
    vec2Normalize
    vec2ScaleToLength
    vec3Add
    vec3AddScaled
    vec3ClampLength
    vec3Cross
    vec3Distance
    vec3Dot
    vec3Length
    vec3LengthSq
    vec3Lerp
    vec3MoveToward
    vec3Negate
    vec3Normalize
    vec3RandomUnit
    vec3Reflect
    vec3Scale
    vec3ScaleToLength
    vec3Sub
    wrap
  - References
    Vec2
- motion
  - Interfaces
    Bounds
    VelocityIntegrationOptions
    VelocityIntegrationTickCtx
  - Type Aliases
    VelocityIntegrationBoundary
  - Functions
    makeVelocityIntegrationSystem
- motion-3d
  - Interfaces
    Bounds3D
    VelocityIntegration3DOptions
    VelocityIntegration3DTickCtx
  - Type Aliases
    VelocityIntegration3DBoundary
  - Functions
    makeVelocityIntegration3DSystem
- noise
  - Interfaces
    Fbm1DOptions
    Fbm2DOptions
    Fbm3DOptions
  - Type Aliases
    Noise1D
    Noise2D
    Noise3D
  - Functions
    fbm1D
    fbm2D
    fbm3D
    perlin1D
    perlin2D
    perlin3D
    simplex2D
    simplex3D
    valueNoise1D
    valueNoise2D
    valueNoise3D
- particles
  - Interfaces
    BurstConfig
    Particle
    ParticleEmitter
    ParticleEmitterSystemOptions
    ParticleEmitterTickCtx
    ParticleSystemOptions
    ParticleTickCtx
  - Type Aliases
    EmissionShape
    Range
  - Variables
    ParticleDef
    ParticleEmitterDef
    ParticleTag
  - Functions
    burst
    makeParticleEmitterSystem
    makeParticleSystem
- pathfinding
  - Interfaces
    FindPathOptions
    PathNode
  - Functions
    findPath
- pile
  - Interfaces
    InPile
    MoveAllOptions
    Pile
  - Variables
    InPileDef
    PileDef
  - Functions
    addToPile
    createPile
    indexInPile
    installPiles
    moveAll
    moveItem
    movePileAll
    movePileTop
    moveTop
    pileItems
    pileOf
    pileSize
    pileTop
    removeFromPile
    shufflePile
- render-canvas2d
  - Classes
    Canvas2DRenderer
  - Interfaces
    Canvas2DRenderContext
    Opacity
    PolygonPoint
    RenderOrder
    RenderView
    ResolvedSpriteFrame
    ScreenSpace
    SpriteFrameSource
  - Type Aliases
    CircleAnchor
    RectAnchor
    Renderable
  - Variables
    OpacityDef
    RenderableDef
    RenderOrderDef
    ScreenSpaceDef
- render-dom
  - Classes
    DomRenderer
  - Interfaces
    DomRenderable
    DomRenderContext
    DomRendererOptions
  - Variables
    DomRenderableDef
  - Functions
    entityAtPoint
- render-scene3d
  - Classes
    Scene3DRenderer
  - Interfaces
    Scene3DRenderContext
    Scene3DRendererOptions
    SceneGraph
  - Type Aliases
    Scene3DEntry
- rng
  - Interfaces
    SeededRng
  - Type Aliases
    RandomFn
  - Functions
    makeSeededRng
    pick
    randomFloat
    randomInt
    shuffle
- save
  - Classes
    IndexedDBBackend
    LocalStorageBackend
    MigrationRegistry
    SaveStorage
  - Interfaces
    IndexedDbSaveOptions
    SaveEnvelope
  - Type Aliases
    MigrateFn
  - Functions
    computeChecksum
    createEnvelope
    verifyEnvelope
- scene-transition
  - Classes
    SceneTransitionQueue
  - Type Aliases
    TransitionApplier
  - Functions
    transferEntities
- spatial
  - Classes
    ContinuousHashGrid2D
    HashGrid2D
    HashGrid3D
  - Interfaces
    CellKey
    GridSyncOnMoveOptions
    HashGrid3DOptions
  - Type Aliases
    GridSyncOnMove
  - Functions
    cellOfPoint
    cellsForAabb
    cellsForCircle
    makeGridSyncOnMove
- spawner
  - Interfaces
    Spawner
    SpawnerOptions
  - Functions
    makeSpawner
    resetSpawner
    tickSpawner
- stats
  - Classes
    FrameStats
    TimedTickSource
  - Interfaces
    FrameStatsOptions
    StatsOverlayOptions
  - Functions
    drawStatsOverlay
- steering
  - Interfaces
    CircleObstacle
    Neighbor
    Path
    Segment
    WallFollowParams
    WanderParams
    WanderState
    WeightedForce
  - Functions
    alignment
    arrive
    cohesion
    combine
    evade
    flee
    obstacleAvoidance
    pathFollowing
    pursue
    seek
    separation
    truncate
    wallFollowing
    wander
- texture-atlas
  - Classes
    TextureAtlasRegistry
  - Interfaces
    AtlasFrame
    ParsedAtlas
    ResolvedAtlasFrame
  - Functions
    parseTexturePackerAtlas
- tick
  - Classes
    AnimationFrameTickSource
    FixedAccumulatorTickSource
    FixedIntervalTickSource
    ManualTickSource
  - Interfaces
    AnimationFrameTickSourceOptions
    FixedAccumulatorTickSourceOptions
- tilemap
  - Interfaces
    BuildCollisionGridOptions
    BuildTilemapAtlasOptions
    CollisionGrid
    SpawnTilemapOptions
    TileTransform
  - Functions
    buildCollisionGrid
    buildTilemapAtlas
    spawnTilemap
    tileTransform
- timer
  - Interfaces
    Timer
  - Type Aliases
    TimerMode
  - Variables
    timerSchema
  - Functions
    finished
    fraction
    justFinished
    makeTimer
    restart
    tickTimer
- tmx
  - Interfaces
    ParseTmxOptions
    ResolvedTile
    TmxFrame
    TmxLayer
    TmxMap
    TmxObject
    TmxObjectGroup
    TmxProperty
    TmxText
    TmxTileset
  - Type Aliases
    TmxProperties
  - Variables
    TMX_FLIP_D
    TMX_FLIP_H
    TMX_FLIP_V
  - Functions
    gidToFrame
    parseTmx
    resolveGid
- transform
  - Interfaces
    Position
    Rotation
    Scale
    Velocity
  - Variables
    PositionDef
    RotationDef
    ScaleDef
    VelocityDef
- transform-3d
  - Interfaces
    Scale3D
    Velocity3D
  - Type Aliases
    Position3D
    Rotation3D
  - Variables
    Position3DDef
    Rotation3DDef
    Scale3DDef
    Velocity3DDef
- turn-based
  - Classes
    TurnCycler
  - Interfaces
    TurnCyclerTags
    TurnOrder
  - Functions
    addSeat
    advanceTurn
    currentSeat
    makeTurnOrder
    nextSeat
    passTurnTo
    removeSeat
    reverseTurns
- tween
  - Interfaces
    Tween
  - Functions
    makeTween
    resetTween
    tickTween
    tweenDone
    tweenValue
- worker-pool
  - Classes
    WorkerPool
  - Interfaces
    WorkerLike
    WorkerPoolOptions
  - Functions
    handleJobs

Select theme

On this page

Overview

On this page

Overview

ParticleDef

const ParticleDef: ComponentDef<Particle>

Defined in: src/modules/particles/particles.ts:103