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: number, y: number, graphicsOffset: Vector, map: IsometricMap): 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$: Util.Observable<Entity> = ...

childrenRemoved$

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

componentAdded$

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

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

componentRemoved$

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

eventDispatcher

eventDispatcher: EventDispatcher<any>

Direct access to the game object event dispatcher.

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

events

get events(): EventDispatcher<any>
Returns EventDispatcher<any>
Inherited from Entity.events
- Defined in EntityComponentSystem/Entity.ts:93

isInitialized

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

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

name

get name(): string
Returns string
Inherited from Entity.name
- Defined in EntityComponentSystem/Entity.ts:89

parent

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

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

Methods

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

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

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

`Protected` _setName

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

addChild

addChild(entity: 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:232

addCollider

addCollider(collider: 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: T, force?: boolean): Entity
Adds a component to the entity
Type Parameters
- T extends Component<string, T>
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:331

addGraphic

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

addTag

addTag(tag: string): Entity
Adds a tag to an entity

Returns
Entity
Parameters
- tag: string
Returns Entity
Inherited from Entity.addTag
- Defined in EntityComponentSystem/Entity.ts:137

addTemplate

addTemplate(templateEntity: Entity, force?: boolean): 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:316

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

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

draw

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

emit

emit(eventName: string, eventObject: any): void
Emits a new event
Parameters
- eventName: string
  
  Name of the event to emit
- eventObject: any
  
  Data associated with this event
Returns void
Inherited from Entity.emit
- Defined in Class.ts:45

get

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

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

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

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

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

getGraphics

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

has

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

hasTag

hasTag(tag: string): 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:128

isKilled

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

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

off

off(eventName: string, handler?: ((event: any) => void)): void
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
Inherited from Entity.off
- Defined in Class.ts:36

on

on(eventName: string, handler: ((event: any) => void)): void
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
Inherited from Entity.on
- Defined in Class.ts:24

onInitialize

onInitialize(_engine: 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:498

onPostUpdate

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

onPreUpdate

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

once

once(eventName: string, handler: ((event: any) => void)): void
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
Inherited from Entity.once
- Defined in Class.ts:55

removeAllChildren

removeAllChildren(): Entity
Removes all children from this entity

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

removeChild

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

removeCollider

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

removeComponent

removeComponent<ComponentOrType>(componentOrType: ComponentOrType, force?: boolean): 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:369

removeGraphic

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

removeTag

removeTag(tag: string, force?: boolean): 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:148

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

update

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

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$

eventDispatcher

id

Readonly map

scene

solid

Readonly x

Readonly y

Accessors

center

Returns Vector

children

Returns readonly Entity[]

events

Returns EventDispatcher<any>

isInitialized

Returns boolean

name

Returns string

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

Parameters

component: T

force: boolean = false

`Readonly` map

`Readonly` x

`Readonly` y

`Protected` _setName