Class IsometricMap

The IsometricMap is a special tile map that provides isometric rendering support to Excalibur

The tileWidth and tileHeight should be the height and width in pixels of the parallelogram of the base of the tile art asset. The tileWidth and tileHeight is not necessarily the same as your graphic pixel width and height.

Please refer to the docs https://excaliburjs.com for more details calculating what your tile width and height should be given your art assets.

Hierarchy

Entity
- IsometricMap

Constructors

constructor

new IsometricMap(options: IsometricMapOptions): IsometricMap
Parameters
- options: IsometricMapOptions
Returns IsometricMap
Overrides Entity.constructor
- Defined in TileMap/IsometricMap.ts:270

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

collider

collider: ColliderComponent

Isometric map ColliderComponent

`Readonly` columns

columns: number

Number of tiles wide

componentAdded$

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

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

componentRemoved$

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

events

events: EventEmitter<EntityEvents> = ...

Listen to or emit events for an entity

graphicsOffset

graphicsOffset: Vector = ...

id

id: number = ...

The unique identifier for the entity

renderFromTopOfGraphic

renderFromTopOfGraphic: boolean = false

Render the tile graphic from the top instead of the bottom

default is false meaning rendering from the bottom

`Readonly` rows

rows: number

Number of tiles high

scene

scene: Scene<unknown> = null

The scene that the entity is in, if any

`Readonly` tileHeight

tileHeight: number

Height of individual tile in pixels

`Readonly` tileWidth

tileWidth: number

Width of individual tile in pixels

`Readonly` tiles

tiles: IsometricTile[]

List containing all of the tiles in IsometricMap

transform

transform: TransformComponent

Isometric map TransformComponent

Accessors

children

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

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

isInitialized

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

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

name

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

parent

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

types

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

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

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

_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:500

_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:489

`Protected` _setName

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

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

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

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

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

clearComponents

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

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

debug

debug(gfx: ExcaliburGraphicsContext): void
Debug draw for IsometricMap, called internally by excalibur when debug mode is toggled on
Parameters
- gfx: ExcaliburGraphicsContext
Returns void
- Defined in TileMap/IsometricMap.ts:418

emit

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

flagCollidersDirty

flagCollidersDirty(): void
Returns void
- Defined in TileMap/IsometricMap.ts:321

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:449
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:450

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

getComponents

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

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

getTile

getTile(x: number, y: number): IsometricTile
Returns the IsometricTile by its x and y coordinates
Parameters
- x: number
- y: number
Returns IsometricTile
- Defined in TileMap/IsometricMap.ts:386

getTileByPoint

getTileByPoint(point: Vector): IsometricTile
Returns the IsometricTile by testing a point in world coordinates, returns null if no Tile was found.
Parameters
- point: Vector
Returns IsometricTile
- Defined in TileMap/IsometricMap.ts:397

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:433
has(type: string): boolean
Parameters
- type: string
Returns boolean
Inherited from Entity.has
- Defined in EntityComponentSystem/Entity.ts:434

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

isKilled

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

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

off

off<TEventName>(eventName: TEventName, handler: Handler<EntityEvents[TEventName]>): 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:568
off(eventName: string, handler: Handler<unknown>): void
Parameters
- eventName: string
- handler: Handler<unknown>
Returns void
Inherited from Entity.off
- Defined in EntityComponentSystem/Entity.ts:569
off(eventName: string): void
Parameters
- eventName: string
Returns void
Inherited from Entity.off
- Defined in EntityComponentSystem/Entity.ts:570

on

on<TEventName>(eventName: TEventName, handler: Handler<EntityEvents[TEventName]>): 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:556
on(eventName: string, handler: Handler<unknown>): Subscription
Parameters
- eventName: string
- handler: Handler<unknown>
Returns Subscription
Inherited from Entity.on
- Defined in EntityComponentSystem/Entity.ts:557

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

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

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

once

once<TEventName>(eventName: TEventName, handler: Handler<EntityEvents[TEventName]>): 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:562
once(eventName: string, handler: Handler<unknown>): Subscription
Parameters
- eventName: string
- handler: Handler<unknown>
Returns Subscription
Inherited from Entity.once
- Defined in EntityComponentSystem/Entity.ts:563

removeAllChildren

removeAllChildren(): Entity
Removes all children from this entity

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

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

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

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

tileToWorld

tileToWorld(tileCoordinate: Vector): Vector
Given a tile coordinate, return the top left corner in world space
Parameters
- tileCoordinate: Vector
Returns Vector
- Defined in TileMap/IsometricMap.ts:373

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

update

update(): void
Internal
Entity update lifecycle, called internally

Returns void
Overrides Entity.update
- Defined in TileMap/IsometricMap.ts:313

updateColliders

updateColliders(): void
Returns void
- Defined in TileMap/IsometricMap.ts:335

worldToTile

worldToTile(worldCoordinate: Vector): Vector
Convert world space coordinates to the tile x, y coordinate
Parameters
- worldCoordinate: Vector
Returns Vector
- Defined in TileMap/IsometricMap.ts:358

Class IsometricMap

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: IsometricMapOptions

Returns IsometricMap

Properties

active

childrenAdded$

childrenRemoved$

collider

Readonly columns

componentAdded$

componentRemoved$

events

graphicsOffset

id

renderFromTopOfGraphic

Readonly rows

scene

Readonly tileHeight

Readonly tileWidth

Readonly tiles

transform

Accessors

children

Returns readonly Entity[]

isInitialized

Returns boolean

name

Returns string

parent

Returns Entity

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

addComponent

Type Parameters

T extends Component<string, T>

Parameters

component: T

force: boolean = false

Returns Entity

addTag

Returns

Parameters

tag: string

Returns Entity

addTemplate

Parameters

`Readonly` columns

`Readonly` rows

`Readonly` tileHeight

`Readonly` tileWidth

`Readonly` tiles

`Protected` _setName

`Optional` event: any