TilemapQuad

EntityVisualQuadceramic.TilemapQuad (Class)

Specialized Quad visual used to render individual tiles in a tilemap layer.

TilemapQuad extends the basic Quad to add tilemap-specific properties and implements object pooling for efficient memory management. Each quad represents a single visible tile within a TilemapLayer and is automatically managed by the layer's rendering system.

Features

  • Object Pooling: Reuses instances to minimize garbage collection
  • Tile Properties: Stores tile index, position, and tile data
  • Arcade Physics: When arcade plugin is enabled, can have physics bodies attached
  • Automatic Management: Created and recycled automatically by TilemapLayer

Internal Usage

This class is primarily used internally by TilemapLayer. Direct instantiation is not recommended - use the static get() method to obtain pooled instances.

// Internal usage by TilemapLayer
var quad = TilemapQuad.get();
quad.index = tileIndex;
quad.column = col;
quad.row = row;
quad.tilemapTile = tileData;
// ... configure visual properties

// When done, recycle back to pool:
quad.recycle();

Static Members

tilemap
get(): TilemapQuad

Gets a TilemapQuad instance from the object pool. If the pool is empty, creates a new instance. The returned quad will be active and ready for use.

Returns Description
TilemapQuad A TilemapQuad instance ready for configuration

Instance Members

tilemap
index: Int

The tile index in the layer's flat tile array. Set to -1 when the quad is not in use.


tilemap
column: Int

The column position of this tile in the tilemap grid (0-based). Set to -1 when the quad is not in use.


tilemap
row: Int

The row position of this tile in the tilemap grid (0-based). Set to -1 when the quad is not in use.


tilemap
tilemapTile: TilemapTile

The tile data including GID and flip flags. Contains the global tile ID and transformation information.


tilemap
recycle(): Void

Returns this TilemapQuad to the object pool for reuse. Automatically removes the quad from its parent, resets all properties, and marks it as inactive. This method should be called when the tile is no longer needed to free memory and reduce garbage collection.


tilemap
new(): Void

Private Members

tilemap
pool: Pool<TilemapQuad>

Static object pool for recycling TilemapQuad instances. Initialized on first use to reduce memory allocation.

Metadata

Name Parameters
:build ceramic.macros.EntityMacro.buildForCompletion()
:autoBuild ceramic.macros.EntityMacro.buildForCompletion()
:build tracker.macros.EventsMacro.build()
:autoBuild tracker.macros.EventsMacro.build()