Skip to main content

IsometricTile

An Entity is the base type of anything that can have behavior in Excalibur, they are part of the built in entity component system

Entities can be strongly typed with the components they contain

const entity = new Entity<ComponentA | ComponentB>();
entity.components.a; // Type ComponentA
entity.components.b; // Type ComponentB

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Construct a new IsometricTile

    Parameters

    • x: number

      tile coordinate in x (not world position)

    • y: number

      tile coordinate in y (not world position)

    • graphicsOffset: Vector

      offset that tile should be shifted by (default (0, 0))

    • map: IsometricMap

      reference to owning IsometricMap

    Returns IsometricTile

Properties

publicactive

active: boolean = true

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

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.

publicdata

data: Map<string, any> = ...

Arbitrary data storage per tile, useful for any game specific data

publicevents

events: EventEmitter<EntityEvents & IsometricTilePointerEvents> = ...

Listen to or emit events for an entity

publicid

id: number = ...

The unique identifier for the entity

publicreadonlymap

map: IsometricMap

Reference to the IsometricMap this tile is part of

publicname

name: string = ...

publicscene

scene: Scene<unknown> = null

The current scene that the entity is in, if any

publicsolid

solid: boolean = false

Indicates whether this tile is solid

publictagAdded$

tagAdded$: Observable<string> = ...

publictagRemoved$

tagRemoved$: Observable<string> = ...

publicreadonlyx

x: number

Integer tile x coordinate

publicreadonlyy

y: number

Integer tile y coordinate

Accessors

publiccenter

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>

publicpos

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>

publicaddCollider

  • Adds a collider to the IsometricTile

    Note! the Tile.solid must be set to true for it to act as a "fixed" collider

    Parameters

    Returns void

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>

publicaddGraphic

  • addGraphic(graphic: Graphic, options?: { offset?: Vector }): void

  • Tile graphics

    Parameters

    Returns void

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>

publicclearColliders

  • clearColliders(): void

  • Clears all colliders from the IsometricTile

    Returns void

publicclearComponents

  • clearComponents(): void

  • Returns void

publicclearGraphics

  • clearGraphics(): void

  • Returns void

publicclone

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

    Returns Entity<any>

draw

publicemit

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

get

publicgetAncestors

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

    Returns Entity<any>[]

publicgetColliders

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>[]

publicgetGraphics

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

  • Kill the entity, means it will no longer be updated. Kills are deferred to the end of the update. If parented it will be removed from the parent when killed.

    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>

publicremoveCollider

  • removeCollider(collider: Collider): void

  • Removes a collider from the IsometricTile

    Parameters

    Returns void

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>>

publicremoveGraphic

  • removeGraphic(graphic: Graphic): void

  • Parameters

    Returns void

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