Interface ParticleArgs

Hierarchy

  • Partial<ParticleImpl>
    • ParticleArgs

Properties

acceleration? active? beginColor? children childrenAdded$? childrenRemoved$? componentAdded$? componentRemoved$? currentRotation? elapsedMultiplier? emitter endColor? endSize? eventDispatcher? events fadeFlag? focus? focusAccel? graphics? id? isInitialized isOffscreen? life? name opacity? parent particleRotationalVelocity? particleSize? particleSprite? position? scene? sizeRate? startSize? tags transform? types velocity? visible?

Methods

_initialize? _postupdate? _preupdate? addChild? addComponent? addTag? addTemplate? clone? emit? get? getAncestors? getComponents? getDescendants? has? hasTag? isKilled? kill? off? on? onInitialize? onPostUpdate? onPreUpdate? once? removeAllChildren? removeChild? removeComponent? removeTag? unparent? update?

Properties

Optional acceleration

acceleration?: Vector

Optional active

active?: boolean = true

Whether this entity is active, if set to false it will be reclaimed

Optional beginColor

beginColor?: Color = Color.White

children

children: readonly Entity[]

Optional childrenAdded$

childrenAdded$?: Util.Observable<Entity> = ...

Optional childrenRemoved$

childrenRemoved$?: Util.Observable<Entity> = ...

Optional componentAdded$

componentAdded$?: Util.Observable<AddedComponent> = ...

Observable that keeps track of component add or remove changes on the entity

Optional componentRemoved$

componentRemoved$?: Util.Observable<RemovedComponent> = ...

Optional currentRotation

currentRotation?: number

Optional elapsedMultiplier

elapsedMultiplier?: number = 0

emitter

emitter: ParticleEmitter

Optional endColor

endColor?: Color = Color.White

Optional endSize

endSize?: number

Optional eventDispatcher

eventDispatcher?: EventDispatcher<any>

Direct access to the game object event dispatcher.

events

events: EventDispatcher<any>

Optional fadeFlag

fadeFlag?: boolean = false

Optional focus

focus?: Vector = null

Optional focusAccel

focusAccel?: number = 0

Optional graphics

graphics?: GraphicsComponent

Optional id

id?: number = ...

The unique identifier for the entity

isInitialized

isInitialized: boolean

Optional isOffscreen

isOffscreen?: boolean = false

Optional life

life?: number = 300

name

name: string

Optional opacity

opacity?: number = 1

parent

parent: Entity

Optional particleRotationalVelocity

particleRotationalVelocity?: number

Optional particleSize

particleSize?: number

Optional particleSprite

particleSprite?: Sprite

Optional position

position?: Vector

Optional scene

scene?: Scene<unknown> = null

The scene that the entity is in, if any

Optional sizeRate

sizeRate?: number = 0

Optional startSize

startSize?: number

tags

tags: readonly string[]

Optional transform

transform?: TransformComponent

types

types: string[]

Optional velocity

velocity?: Vector

Optional visible

visible?: boolean = true

Methods

Optional _initialize

  • _initialize(engine: Engine): void
  • Internal

    Initializes this entity, meant to be called by the Scene before first update not by users of Excalibur.

    It is not recommended that internal excalibur methods be overridden, do so at your own risk.

    Parameters

    Returns void

Optional _postupdate

  • _postupdate(engine: Engine, delta: number): void
  • Internal

    It is not recommended that internal excalibur methods be overridden, do so at your own risk.

    Internal _preupdate handler for onPostUpdate lifecycle event

    Parameters

    Returns void

Optional _preupdate

  • _preupdate(engine: Engine, delta: number): void
  • Internal

    It is not recommended that internal excalibur methods be overridden, do so at your own risk.

    Internal _preupdate handler for onPreUpdate lifecycle event

    Parameters

    Returns void

Optional addChild

Optional addComponent

  • Adds a component to the entity

    Type Parameters

    Parameters

    • component: T

      Component or Entity to add copy of components from

    • force: boolean = false

      Optionally overwrite any existing components of the same type

    Returns Entity

Optional addTag

Optional addTemplate

  • Adds a copy of all the components from another template entity as a "prefab"

    Parameters

    • templateEntity: Entity

      Entity to use as a template

    • force: boolean = false

      Force component replacement if it already exists on the target entity

    Returns Entity

Optional clone

Optional emit

  • Emits a new event

    Parameters

    • eventName: string

      Name of the event to emit

    • eventObject: any

      Data associated with this event

    Returns void

Optional get

Optional getAncestors

Optional getComponents

Optional getDescendants

Optional has

Optional hasTag

  • Check if a tag exists on the entity

    Parameters

    • tag: string

      name to check for

    Returns boolean

Optional isKilled

Optional kill

  • Returns void

Optional off

  • Alias for removeEventListener. If only the eventName is specified it will remove all handlers registered for that specific event. If the eventName and the handler instance are specified only that handler will be removed.

    Parameters

    • eventName: string

      Name of the event to listen for

    • Optional handler: ((event: any) => void)

      Event handler for the thrown event

        • (event: any): void

        • Parameters

          • event: any

          Returns void

    Returns void

Optional on

  • Alias for addEventListener. You can listen for a variety of events off of the engine; see the events section below for a complete list.

    Parameters

    • eventName: string

      Name of the event to listen for

    • handler: ((event: any) => void)

      Event handler for the thrown event

        • (event: any): void

        • Parameters

          • event: any

          Returns void

    Returns void

Optional onInitialize

  • onInitialize is called before the first update of the entity. This method is meant to be overridden.

    Synonymous with the event handler .on('initialize', (evt) => {...})

    Parameters

    Returns void

Optional onPostUpdate

  • Safe to override onPostUpdate lifecycle event handler. Synonymous with .on('postupdate', (evt) =>{...})

    onPostUpdate is called directly after an entity is updated.

    Parameters

    • _engine: Engine
    • _delta: number

    Returns void

Optional onPreUpdate

  • Safe to override onPreUpdate lifecycle event handler. Synonymous with .on('preupdate', (evt) =>{...})

    onPreUpdate is called directly before an entity is updated.

    Parameters

    • _engine: Engine
    • _delta: number

    Returns void

Optional once

  • Once listens to an event one time, then unsubscribes from that event

    Parameters

    • eventName: string

      The name of the event to subscribe to once

    • handler: ((event: any) => void)

      The handler of the event that will be auto unsubscribed

        • (event: any): void

        • Parameters

          • event: any

          Returns void

    Returns void

Optional removeAllChildren

Optional removeChild

Optional removeComponent

  • Removes a component from the entity, by default removals are deferred to the end of entity update to avoid consistency issues

    Components can be force removed with the force flag, the removal is not deferred and happens immediately

    Type Parameters

    • ComponentOrType extends string | Component<string>

    Parameters

    • componentOrType: ComponentOrType
    • force: boolean = false

    Returns Entity

Optional removeTag

  • Removes a tag on the entity

    Removals are deferred until the end of update

    Parameters

    • tag: string
    • force: boolean = false

      Remove component immediately, no deferred

    Returns Entity

Optional unparent

  • Unparents this entity, if there is a parent. Otherwise it does nothing.

    Returns void

Optional update

  • Parameters

    • _engine: Engine
    • delta: number

    Returns void

Settings

Member Visibility

Theme