Class 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

Entity
- IsometricTile

Constructors

constructor

new IsometricTile(x, y, graphicsOffset, map): IsometricTile
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
Overrides Entity.constructor
- Defined in TileMap/IsometricMap.ts:129

Properties

active

active: boolean = true

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

childrenAdded$

childrenAdded$: Observable<Entity> = ...

childrenRemoved$

childrenRemoved$: Observable<Entity> = ...

componentAdded$

componentAdded$: Observable<AddedComponent> = ...

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

componentRemoved$

componentRemoved$: Observable<RemovedComponent> = ...

events

events: EventEmitter<EntityEvents> = ...

Listen to or emit events for an entity

id

id: number = ...

The unique identifier for the entity

`Readonly` map

map: IsometricMap

Reference to the [[IsometricMap]] this tile is part of

scene

scene: Scene<unknown> = null

The scene that the entity is in, if any

solid

solid: boolean = false

Indicates whether this tile is solid

`Readonly` x

x: number

Integer tile x coordinate

`Readonly` y

y: number

Integer tile y coordinate

Accessors

center

get center(): Vector
Returns the center of the [[IsometricTile]]

Returns Vector
- Defined in TileMap/IsometricMap.ts:118

children

get children(): readonly Entity[]
Get the direct children of this entity

Returns readonly Entity[]
Inherited from Entity.children
- Defined in EntityComponentSystem/Entity.ts:233

isInitialized

get isInitialized(): boolean
Gets whether the actor is Initialized

Returns boolean
Inherited from Entity.isInitialized
- Defined in EntityComponentSystem/Entity.ts:470

name

get name(): string
Returns string
Inherited from Entity.name
- Defined in EntityComponentSystem/Entity.ts:108
set name(name): void
Parameters
- name: string
Returns void
Inherited from Entity.name
- Defined in EntityComponentSystem/Entity.ts:112

parent

get parent(): Entity
Returns Entity
Inherited from Entity.parent
- Defined in EntityComponentSystem/Entity.ts:222

pos

get pos(): Vector
Returns the top left corner of the [[IsometricTile]] in world space

Returns Vector
- Defined in TileMap/IsometricMap.ts:111

types

get types(): string[]
The types of the components on the Entity

Returns string[]
Inherited from Entity.types
- Defined in EntityComponentSystem/Entity.ts:174

Methods

_initialize

_initialize(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
- engine: Engine
Returns void
Inherited from Entity._initialize
- Defined in EntityComponentSystem/Entity.ts:480

_postupdate

_postupdate(engine, delta): 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
- engine: Engine
- delta: number
Returns void
Inherited from Entity._postupdate
- Defined in EntityComponentSystem/Entity.ts:505

_preupdate

_preupdate(engine, delta): 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
- engine: Engine
- delta: number
Returns void
Inherited from Entity._preupdate
- Defined in EntityComponentSystem/Entity.ts:494

`Protected` _setName

_setName(name): void
Parameters
- name: string
Returns void
Inherited from Entity._setName
- Defined in EntityComponentSystem/Entity.ts:101

addChild

addChild(entity): Entity
Adds an entity to be a child of this entity
Parameters
- entity: Entity
Returns Entity
Inherited from Entity.addChild
- Defined in EntityComponentSystem/Entity.ts:251

addCollider

addCollider(collider): void
Adds a collider to the IsometricTile

Note! the [[Tile.solid]] must be set to true for it to act as a "fixed" collider
Parameters
- collider: Collider
Returns void
- Defined in TileMap/IsometricMap.ts:67

addComponent

addComponent<T>(component, force?): Entity
Adds a component to the entity
Type Parameters
- T extends Component<string>
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
Inherited from Entity.addComponent
- Defined in EntityComponentSystem/Entity.ts:350

addGraphic

addGraphic(graphic): void
Tile graphics
Parameters
- graphic: Graphic
Returns void
- Defined in TileMap/IsometricMap.ts:22

addTag

addTag(tag): Entity
Adds a tag to an entity
Parameters
- tag: string
Returns Entity
Entity
Inherited from Entity.addTag
- Defined in EntityComponentSystem/Entity.ts:156

addTemplate

addTemplate(templateEntity, force?): Entity
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
Inherited from Entity.addTemplate
- Defined in EntityComponentSystem/Entity.ts:335

clearColliders

clearColliders(): void
Clears all colliders from the IsometricTile

Returns void
- Defined in TileMap/IsometricMap.ts:87

clearComponents

clearComponents(): void
Returns void
Inherited from Entity.clearComponents
- Defined in EntityComponentSystem/Entity.ts:402

clearGraphics

clearGraphics(): void
Returns void
- Defined in TileMap/IsometricMap.ts:47

clone

clone(): Entity
Creates a deep copy of the entity and a copy of all its components

Returns Entity
Inherited from Entity.clone
- Defined in EntityComponentSystem/Entity.ts:319

draw

draw(gfx, _elapsed): void
Parameters
- gfx: ExcaliburGraphicsContext
- _elapsed: number
Returns void
- Defined in TileMap/IsometricMap.ts:169

emit

emit<TEventName>(eventName, event): void
Type Parameters
- TEventName extends EventKey<EntityEvents>
Parameters
- eventName: TEventName
- event: EntityEvents[TEventName]
Returns void
Inherited from Entity.emit
- Defined in EntityComponentSystem/Entity.ts:554
emit(eventName, event?): void
Parameters
- eventName: string
- Optional event: any
Returns void
Inherited from Entity.emit
- Defined in EntityComponentSystem/Entity.ts:555

get

get<T>(type): T
Get a component by type with typecheck

(Does not work on tag components, use .hasTag("mytag") instead)
Type Parameters
- T extends Component<string>
Parameters
- type: ComponentCtor<T>
Returns T
Inherited from Entity.get
- Defined in EntityComponentSystem/Entity.ts:455
get<T>(type): T
Type Parameters
- T extends Component<string>
Parameters
- type: string
Returns T
Inherited from Entity.get
- Defined in EntityComponentSystem/Entity.ts:456

getAncestors

getAncestors(): Entity[]
Returns a list of parent entities starting with the topmost parent. Includes the current entity.

Returns Entity[]
Inherited from Entity.getAncestors
- Defined in EntityComponentSystem/Entity.ts:292

getColliders

getColliders(): readonly Collider[]
Returns readonly Collider[]
- Defined in TileMap/IsometricMap.ts:57

getComponents

getComponents(): Component<string>[]
Returns Component<string>[]
Inherited from Entity.getComponents
- Defined in EntityComponentSystem/Entity.ts:194

getDescendants

getDescendants(): Entity[]
Returns a list of all the entities that descend from this entity. Includes the current entity.

Returns Entity[]
Inherited from Entity.getDescendants
- Defined in EntityComponentSystem/Entity.ts:305

getGraphics

getGraphics(): readonly Graphic[]
Returns readonly Graphic[]
- Defined in TileMap/IsometricMap.ts:16

has

has<T>(type): boolean
Check if a component type exists
Type Parameters
- T extends Component<string>
Parameters
- type: ComponentCtor<T>
Returns boolean
Inherited from Entity.has
- Defined in EntityComponentSystem/Entity.ts:439
has(type): boolean
Parameters
- type: string
Returns boolean
Inherited from Entity.has
- Defined in EntityComponentSystem/Entity.ts:440

hasTag

hasTag(tag): boolean
Check if a tag exists on the entity
Parameters
- tag: string
  name to check for
Returns boolean
Inherited from Entity.hasTag
- Defined in EntityComponentSystem/Entity.ts:147

isKilled

isKilled(): boolean
Returns boolean
Inherited from Entity.isKilled
- Defined in EntityComponentSystem/Entity.ts:132

kill

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
Inherited from Entity.kill
- Defined in EntityComponentSystem/Entity.ts:125

off

off<TEventName>(eventName, handler): void
Type Parameters
- TEventName extends EventKey<EntityEvents>
Parameters
- eventName: TEventName
- handler: Handler<EntityEvents[TEventName]>
Returns void
Inherited from Entity.off
- Defined in EntityComponentSystem/Entity.ts:572
off(eventName, handler): void
Parameters
- eventName: string
- handler: Handler<unknown>
Returns void
Inherited from Entity.off
- Defined in EntityComponentSystem/Entity.ts:573
off(eventName): void
Parameters
- eventName: string
Returns void
Inherited from Entity.off
- Defined in EntityComponentSystem/Entity.ts:574

on

on<TEventName>(eventName, handler): Subscription
Type Parameters
- TEventName extends EventKey<EntityEvents>
Parameters
- eventName: TEventName
- handler: Handler<EntityEvents[TEventName]>
Returns Subscription
Inherited from Entity.on
- Defined in EntityComponentSystem/Entity.ts:560
on(eventName, handler): Subscription
Parameters
- eventName: string
- handler: Handler<unknown>
Returns Subscription
Inherited from Entity.on
- Defined in EntityComponentSystem/Entity.ts:561

onInitialize

onInitialize(_engine): 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
- _engine: Engine
Returns void
Inherited from Entity.onInitialize
- Defined in EntityComponentSystem/Entity.ts:516

onPostUpdate

onPostUpdate(_engine, _delta): 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
- _delta: number
Returns void
Inherited from Entity.onPostUpdate
- Defined in EntityComponentSystem/Entity.ts:534

onPreUpdate

onPreUpdate(_engine, _delta): 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
- _delta: number
Returns void
Inherited from Entity.onPreUpdate
- Defined in EntityComponentSystem/Entity.ts:525

once

once<TEventName>(eventName, handler): Subscription
Type Parameters
- TEventName extends EventKey<EntityEvents>
Parameters
- eventName: TEventName
- handler: Handler<EntityEvents[TEventName]>
Returns Subscription
Inherited from Entity.once
- Defined in EntityComponentSystem/Entity.ts:566
once(eventName, handler): Subscription
Parameters
- eventName: string
- handler: Handler<unknown>
Returns Subscription
Inherited from Entity.once
- Defined in EntityComponentSystem/Entity.ts:567

removeAllChildren

removeAllChildren(): Entity
Removes all children from this entity

Returns Entity
Inherited from Entity.removeAllChildren
- Defined in EntityComponentSystem/Entity.ts:281

removeChild

removeChild(entity): Entity
Remove an entity from children if it exists
Parameters
- entity: Entity
Returns Entity
Inherited from Entity.removeChild
- Defined in EntityComponentSystem/Entity.ts:269

removeCollider

removeCollider(collider): void
Removes a collider from the IsometricTile
Parameters
- collider: Collider
Returns void
- Defined in TileMap/IsometricMap.ts:76

removeComponent

removeComponent<ComponentOrType>(componentOrType, force?): Entity
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
Inherited from Entity.removeComponent
- Defined in EntityComponentSystem/Entity.ts:388

removeGraphic

removeGraphic(graphic): void
Parameters
- graphic: Graphic
Returns void
- Defined in TileMap/IsometricMap.ts:39

removeTag

removeTag(tag, force?): Entity
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
Inherited from Entity.removeTag
- Defined in EntityComponentSystem/Entity.ts:167

unparent

unparent(): void
Unparents this entity, if there is a parent. Otherwise it does nothing.

Returns void
Inherited from Entity.unparent
- Defined in EntityComponentSystem/Entity.ts:240

update

update(engine, delta): void
Internal
Entity update lifecycle, called internally
Parameters
- engine: Engine
- delta: number
Returns void
Inherited from Entity.update
- Defined in EntityComponentSystem/Entity.ts:545

Class IsometricTile

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

x: number

y: number

graphicsOffset: Vector

map: IsometricMap

Returns IsometricTile

Properties

active

childrenAdded$

childrenRemoved$

componentAdded$

componentRemoved$

events

id

Readonly map

scene

solid

Readonly x

Readonly y

Accessors

center

Returns Vector

children

Returns readonly Entity[]

isInitialized

Returns boolean

name

Returns string

Parameters

name: string

Returns void

parent

Returns Entity

pos

Returns Vector

tags

Returns readonly string[]

types

Returns string[]

Methods

_initialize

Parameters

engine: Engine

Returns void

_postupdate

Parameters

engine: Engine

delta: number

Returns void

_preupdate

Parameters

engine: Engine

delta: number

Returns void

Protected _setName

Parameters

name: string

Returns void

addChild

Parameters

entity: Entity

Returns Entity

addCollider

Parameters

collider: Collider

Returns void

addComponent

Type Parameters

T extends Component<string>

Parameters

component: T

`Readonly` map

`Readonly` x

`Readonly` y

`Protected` _setName

`Optional` event: any