Class Layer

constructor

• new Layer(scene, layerData?): Layer

• Creates a new layer.

  Parameters

  • scene: Scene
  • OptionallayerData: TMXLayer

  Returns Layer

Optionaldata

id

Optionalimage

OptionallayerCanvas

OptionallayerContext

Optionalname

Optionalobjects

offset

parallax

properties

renderOrder

repeatX

repeatY

scene

size

Optionaltint

type

visible

clearTile

• clearTile(pos): void

• Clears the tile at the specified position.

  Parameters

  • pos: Vector

    The position of the tile to clear.

  Returns void

draw

• draw(): void

• Draws the layer.

  Returns void

drawTileAt

• drawTileAt(tileId, index): void

• Draws a tile at the specified index on the layer.

  Parameters

  • tileId: number

    The ID of the tile to draw.
  • index: number

    The index of the tile on the layer.

  Returns void

drawToMainContext

• drawToMainContext(pos, size): void

• Draws the layer canvas to the main context at the specified position and size.

  Parameters

  • pos: Vector

    The position to draw the layer canvas.
  • size: Vector

    The size of the layer canvas.

  Returns void

forEachVisibleObject

• forEachVisibleObject(cb): void

• Iterates over each visible object in the layer and invokes the provided callback function. The callback function receives the object as a parameter.

  Parameters

  • cb: ((obj: Entity) => void)

    The callback function to be invoked for each visible object.

    • • (obj): void

      • Parameters

        • obj: Entity

        Returns void

  Returns void

forEachVisibleTile

• forEachVisibleTile(fn): void

• Iterates over each visible tile and executes the provided callback function.

  Parameters

  • fn: ((tile: Tile, pos: Vector, flipH: boolean, flipV: boolean) => void)

    The callback function to execute for each visible tile. It receives the tile object, position, and flips as parameters.

    • • (tile, pos, flipH, flipV): void

      • Parameters

        • tile: Tile
        • pos: Vector
        • flipH: boolean
        • flipV: boolean

        Returns void

  Returns void

getTile

• getTile(pos): null | number

• Retrieves the tile at the specified position.

  Parameters

  • pos: Vector

    The position of the tile.

  Returns null | number

  The tile at the specified position, or null if the position is out of range or the data is not available.

postUpdate

• postUpdate(): void

• Post-update method. This method is called after the update and draw. It can be used to perform additional operations after the update.

  Returns void

renderToCanvas

• renderToCanvas(): void

• Renders the tiles to the layer canvas.z

  Returns void

setTile

• setTile(pos, tileId): void

• Sets the tile at the specified position.

  Parameters

  • pos: Vector

    The position of the tile.
  • tileId: number

    The ID of the tile to set.

  Returns void

toggleVisibility

• toggleVisibility(visible?): void

• Toggles the visibility of the layer.

  Parameters

  • visible: boolean = !this.visible

  Returns void

update

• update(): void

• Updates the layer.

  Returns void