Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Index

Constructors

Properties

active: boolean = true

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

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

Isometric map ColliderComponent

columns: number

Number of tiles wide

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

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

componentRemoved$: Util.Observable<RemovedComponent> = ...
eventDispatcher: EventDispatcher<any>

Direct access to the game object event dispatcher.

graphicsOffset: Vector = ...
id: number = ...

The unique identifier for the entity

renderFromTopOfGraphic: boolean = false

Render the tile graphic from the top instead of the bottom

default is false meaning rendering from the bottom

rows: number

Number of tiles high

tileHeight: number

Height of individual tile in pixels

tileWidth: number

Width of individual tile in pixels

tiles: IsometricTile[]

List containing all of the tiles in IsometricMap

Isometric map TransformComponent

Accessors

  • get children(): readonly Entity[]
  • get isInitialized(): boolean
  • get name(): string
  • get tags(): readonly string[]
  • get types(): string[]

Methods

  • _initialize(engine: Engine): void
  • 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.

    internal

    Parameters

    Returns void

  • _postupdate(engine: Engine, delta: number): void
  • _preupdate(engine: Engine, delta: number): void
  • _setName(name: string): void
  • addComponent<T>(component: T, force?: boolean): Entity
  • 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

  • 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

  • flagCollidersDirty(): void
  • has<T>(type: ComponentCtor<T>): boolean
  • has(type: string): boolean
  • hasTag(tag: string): boolean
  • isKilled(): boolean
  • kill(): void
  • 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

  • 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

  • onInitialize(_engine: Engine): void
  • 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

    Returns void

  • 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

    Returns void

  • 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

  • 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

    Parameters

    • componentOrType: ComponentOrType
    • force: boolean = false

    Returns Entity

  • removeTag(tag: string, force?: boolean): Entity
  • unparent(): void
  • update(): void
  • updateColliders(): void