Skip to main content

Particle

Particle is used in a [[ParticleEmitter]]

Hierarchy

  • ParticleImpl<this>
    • Particle

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

publicacceleration

acceleration: Vector = ...

publicactive

active: boolean = true

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

publicbeginColor

beginColor: Color = Color.White

publicchildrenAdded$

childrenAdded$: Observable<Entity<any>> = ...

publicchildrenRemoved$

childrenRemoved$: Observable<Entity<any>> = ...

publiccomponentAdded$

componentAdded$: Observable<Component> = ...

publiccomponentRemoved$

componentRemoved$: Observable<Component> = ...

publiccomponentValues

componentValues: Component[] = []

publicreadonlycomponents

components: Map<Function, Component> = ...

Current components on the entity

Do not modify

Use addComponent/removeComponent otherwise the ECS will not be notified of changes.

publiccurrentRotation

currentRotation: number = 0

publicelapsedMultiplier

elapsedMultiplier: number = 0

publicemitter

emitter: ParticleEmitter = null

publicendColor

endColor: Color = Color.White

publicendSize

endSize: number

publicevents

events: EventEmitter<EntityEvents> = ...

Listen to or emit events for an entity

publicfadeFlag

fadeFlag: boolean = false

publicfocus

focus: Vector = null

publicfocusAccel

focusAccel: number = 0

publicgraphics

graphics: GraphicsComponent

publicid

id: number = ...

The unique identifier for the entity

publicisOffscreen

isOffscreen: boolean = false

publiclife

life: number = 300

publicname

name: string = ...

publicopacity

opacity: number = 1

publicparticleRotationalVelocity

particleRotationalVelocity: number = 0

publicparticleSize

particleSize: number = 5

publicparticleSprite

particleSprite: Graphic = null

publicposition

position: Vector = ...

publicscene

scene: Scene<unknown> = null

The current scene that the entity is in, if any

publicsizeRate

sizeRate: number = 0

publicstartSize

startSize: number

publictagAdded$

tagAdded$: Observable<string> = ...

publictagRemoved$

tagRemoved$: Observable<string> = ...

publictransform

transform: TransformComponent

publicvelocity

velocity: Vector = ...

publicvisible

visible: boolean = true

Accessors

publicchildren

  • get children(): readonly Entity<any>[]

  • Get the direct children of this entity

    Returns readonly Entity<any>[]

publicisInitialized

  • get isInitialized(): boolean

  • Gets whether the actor is Initialized

    Returns boolean

publicparent

  • Returns Entity<any>

publictags

  • get tags(): Set<string>

  • Specifically get the tags on the entity from [[TagsComponent]]

    Returns Set<string>

publictypes

  • The types of the components on the Entity

    Returns ComponentCtor[]

Methods

publicaddChild

  • Adds an entity to be a child of this entity

    Parameters

    Returns Entity<any>

publicaddComponent

  • addComponent<TComponent>(component: TComponent, force?: boolean): Entity<any>

  • Adds a component to the entity

    Type parameters

    Parameters

    • component: TComponent

      Component or Entity to add copy of components from

    • force: boolean = false

      Optionally overwrite any existing components of the same type

    Returns Entity<any>

publicaddTag

  • addTag(tag: string): Entity<any>

  • Adds a tag to an entity

    Parameters

    • tag: string

    Returns Entity<any>

publicaddTemplate

  • addTemplate(templateEntity: Entity<any>, force?: boolean): Entity<any>

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

    Parameters

    • templateEntity: Entity<any>

      Entity to use as a template

    • force: boolean = false

      Force component replacement if it already exists on the target entity

    Returns Entity<any>

publicclearComponents

  • clearComponents(): void

  • Returns void

publicclone

  • Creates a deep copy of the entity and a copy of all its components

    Returns Entity<any>

publicemit

  • emit<TEventName>(eventName: TEventName, event: EntityEvents[TEventName]): void
  • emit(eventName: string, event?: any): void

  • Type parameters

    Parameters

    Returns void

get

publicgetAncestors

  • Returns a list of parent entities starting with the topmost parent. Includes the current entity.

    Returns Entity<any>[]

publicgetComponents

  • Returns all component instances on entity

    Returns Component[]

publicgetDescendants

  • getDescendants(): Entity<any>[]

  • Returns a list of all the entities that descend from this entity. Includes the current entity.

    Returns Entity<any>[]

publichas

  • Check if a component type exists

    Type parameters

    Parameters

    Returns boolean

hasAll

  • hasAll<TComponent>(requiredTypes: ComponentCtor<TComponent>[]): boolean

  • Verifies that an entity has all the required types

    Type parameters

    Parameters

    Returns boolean

hasAllTags

  • hasAllTags(requiredTags: string[]): boolean

  • Verifies that an entity has all the required tags

    Parameters

    • requiredTags: string[]

    Returns boolean

publichasTag

  • hasTag(tag: string): boolean

  • Check if a tag exists on the entity

    Parameters

    • tag: string

      name to check for

    Returns boolean

publicisKilled

  • isKilled(): boolean

  • Returns boolean

publickill

  • kill(): void

  • Returns void

publicoff

  • off<TEventName>(eventName: TEventName, handler: Handler<EntityEvents[TEventName]>): void
  • off(eventName: string, handler: Handler<unknown>): void
  • off(eventName: string): void

publicon

publiconInitialize

  • onInitialize(engine: Engine<any>): void

  • 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

publiconPostUpdate

  • onPostUpdate(engine: Engine<any>, delta: number): void

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

    onPostUpdate is called directly after an entity is updated.

    Parameters

    • engine: Engine<any>
    • delta: number

    Returns void

publiconPreUpdate

  • onPreUpdate(engine: Engine<any>, delta: number): void

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

    onPreUpdate is called directly before an entity is updated.

    Parameters

    • engine: Engine<any>
    • delta: number

    Returns void

publiconce

publicremoveAllChildren

  • removeAllChildren(): Entity<any>

  • Removes all children from this entity

    Returns Entity<any>

publicremoveChild

  • Remove an entity from children if it exists

    Parameters

    Returns Entity<any>

publicremoveComponent

  • removeComponent<TComponent>(typeOrInstance: TComponent | ComponentCtor<TComponent>, force?: boolean): Entity<Exclude<any, TComponent>>

  • 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

    Parameters

    • typeOrInstance: TComponent | ComponentCtor<TComponent>
    • force: boolean = false

    Returns Entity<Exclude<any, TComponent>>

publicremoveTag

  • removeTag(tag: string): Entity<any>

  • Removes a tag on the entity

    Removals are deferred until the end of update

    Parameters

    • tag: string

    Returns Entity<any>

publicunparent

  • unparent(): void

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

    Returns void

publicupdate

  • update(engine: Engine<any>, delta: number): void

  • Parameters

    • engine: Engine<any>
    • delta: number

    Returns void