RegionManager.new()

Overview

This function creates a new instance of RegionManager.

Syntax

RegionManager.new( params )

params (required)

Table. Contains all required inputs. See Required Properties below.

Required Properties

The params table contains the following properties. Please reference the usage guide for more details on these properties.

regionWidthInTiles (required)

Number. Specifies how many tiles wide each region will be.

regionHeightInTiles (required)

Number. Specifies how many tiles high each region will be.

renderRegionWidth (required)

Number. Specifies how many regions wide the render region will be.

renderRegionHeight (required)

Number. Specifies how many regions high the render region will be.

tileSize (required)

Number. The size of the square tiles.

tileLayersByIndex (required)

Table. This table needs to contain all the TileLayers keyed by their layer index.

entityLayersByIndex (required)

Table. This table needs to contain all the EntityLayers keyed by their layer index.

camera (required)

Camera Reference to the camera used by the tile engine.

listener (required)

Table. Table containing the following listener functions:

• getRegion(params)
• regionReleased(regionData)

Please reference the usage guide for details on how to implement these functions.

Examples

local TileEngine = require "plugin.wattageTileEngine"
local RegionManager = TileEngine.RegionManager

regionManager = RegionManager.new({
    regionWidthInTiles = 3,
    regionHeightInTiles = 3,
    renderRegionWidth = 5,
    renderRegionHeight = 3,
    tileSize = 128,
    tileLayersByIndex = { [1] = bufferLayer },
    entityLayersByIndex = { [2] = entityLayer },
    camera = tileEngineViewControl.getCamera(),
    listener = scene
})