Skip to main content

TileMap

The TileMap provides a mechanism for doing flat 2D tiles rendered in a grid.

TileMaps are useful for top down or side scrolling grid oriented games.

Hierarchy

Implements

  • HasNestedPointerEvents

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

publicchildrenAdded$

childrenAdded$: Observable<Entity<any>> = ...

publicchildrenRemoved$

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

publiccollider

collider: ColliderComponent

publicreadonlycolumns

columns: number

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.

publicevents

events: EventEmitter<TileMapEvents> = ...

Listen to or emit events for an entity

publicid

id: number = ...

The unique identifier for the entity

publicisActive

isActive: boolean = true

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

publiclogger

logger: Logger = ...

publicmeshingLookBehind

meshingLookBehind: number = 10

publicname

name: string = ...

publicpointer

pointer: PointerComponent

publicrenderFromTopOfGraphic

renderFromTopOfGraphic: boolean = false

publicreadonlyrows

rows: number

publicscene

scene: Scene<unknown> = null

The current scene that the entity is in, if any

publictagAdded$

tagAdded$: Observable<string> = ...

publictagRemoved$

tagRemoved$: Observable<string> = ...

publicreadonlytileHeight

tileHeight: number

publicreadonlytileWidth

tileWidth: number

publicreadonlytiles

tiles: Tile[] = []

publictransform

transform: TransformComponent

Accessors

publicactive

  • get active(): boolean
  • set active(val: boolean): void

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

    @deprecated

    use isActive

    Returns boolean

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

    @deprecated

    use isActive

    Parameters

    • val: boolean

    Returns void

publicchildren

  • get children(): readonly Entity<any>[]

  • Get the direct children of this entity

    Returns readonly Entity<any>[]

publicheight

  • get height(): number

  • Height of the whole tilemap in pixels

    Returns number

publicisAdded

  • get isAdded(): boolean

  • Returns boolean

publicisInitialized

  • get isInitialized(): boolean

  • Gets whether the actor is Initialized

    Returns boolean

publicparent

  • Returns Entity<any>

publicpos

publicrotation

  • get rotation(): number
  • set rotation(val: number): void

  • Returns number

  • Parameters

    • val: number

    Returns void

publicscale

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

publicvel

publicwidth

  • get width(): number

  • Width of the whole tile map in pixels

    Returns number

publicx

  • get x(): number
  • set x(val: number): void

  • Returns number

  • Parameters

    • val: number

    Returns void

publicy

  • get y(): number
  • set y(val: number): void

  • Returns number

  • Parameters

    • val: number

    Returns void

publicz

  • get z(): number
  • set z(val: number): void

  • Returns number

  • Parameters

    • val: number

    Returns void

Methods

public_initialize

  • _initialize(engine: Engine<any>): void

  • Parameters

    Returns void

publicaddChild

  • Adds an entity to be a child of this entity

    Parameters

    Returns Entity<any>

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>

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>

publicclearComponents

  • clearComponents(): void

  • Returns void

publicclone

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

    Returns Entity<any>

publicdebug

publicdraw

  • Draws the tile map to the screen. Called by the Scene.

    Parameters

    Returns void

publicemit

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

publicflagCollidersDirty

  • flagCollidersDirty(): void

  • Returns void

publicflagTilesDirty

  • flagTilesDirty(): void

  • Returns void

get

publicgetAncestors

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

    Returns Entity<any>[]

publicgetColumns

  • getColumns(): readonly Tile[][]

  • Returns readonly Tile[][]

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

publicgetOnScreenTiles

  • getOnScreenTiles(): readonly Tile[]

  • Returns the on screen tiles for a tilemap, this will overshoot by a small amount because of the internal quad tree data structure.

    Useful if you need to perform specific logic on onscreen tiles

    Returns readonly Tile[]

publicgetRows

  • getRows(): readonly Tile[][]

  • Returns readonly Tile[][]

publicgetTile

  • getTile(x: number, y: number): Tile

  • Returns the Tile by its x and y integer coordinates

    Returns null if out of bounds

    For example, if I want the tile in fifth column (x), and second row (y): getTile(4, 1) 0 based, so 0 is the first in row/column

    Parameters

    • x: number
    • y: number

    Returns Tile

publicgetTileByIndex

  • getTileByIndex(index: number): Tile

  • Returns the Tile by index (row major order)

    Returns null if out of bounds

    Parameters

    • index: number

    Returns Tile

publicgetTileByPoint

  • Returns the Tile by testing a point in world coordinates, returns null if no Tile was found.

    Parameters

    Returns Tile

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<TileMapEvents[TEventName]>): void
  • off(eventName: string, handler: Handler<unknown>): void
  • off(eventName: string): void

publicon

publiconAdd

  • onAdd(engine: Engine<any>): void

  • onAdd is called when Actor is added to scene. This method is meant to be overridden.

    Synonymous with the event handler .on('add', (evt) => {...})

    Parameters

    Returns void

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>, elapsed: 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>
    • elapsed: number

    Returns void

publiconPreUpdate

  • onPreUpdate(engine: Engine<any>, elapsed: 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>
    • elapsed: number

    Returns void

publiconRemove

  • onRemove(engine: Engine<any>): void

  • onRemove is called when Actor is added to scene. This method is meant to be overridden.

    Synonymous with the event handler .on('remove', (evt) => {...})

    Parameters

    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>

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

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

publicupdate

  • update(engine: Engine<any>, elapsed: number): void

  • Parameters

    • engine: Engine<any>
    • elapsed: number

    Returns void

Page Options