API reference

Every public class, method, and event in @codexo/exojs. Generated from source.

I

interfaceObjectLayerOptions

@codexo/exojs-tilemap / tilemap / stable

Construction options for an ObjectLayer.

14
props
0
methods
0
events
Import
import { ObjectLayerOptions } from '@codexo/exojs-tilemap'

Construction options for an ObjectLayer.

Properties14
class?: string
Layer class string.
drawOrder?: "index" | "topdown"
Draw order for the objects (Tiled draworder): 'topdown' (sorted by y) or 'index' (source order). Informational; objects are stored as given. Default 'topdown'.
id: number
Layer id (unique within the map).
name?: string
Layer name.
objects?: readonly TileMapObjectA format-independent map object. The geometry kind is the discriminant; narrow on `kind` to read shape-specific fields. Template objects are not yet represente…<TilePropertiesAn immutable, flat key-value bag of generic tile properties. Adapters copy and freeze source properties; the runtime never retains a caller-owned mutable objec…>[]
The objects in this layer.
offsetX?: number
Layer pixel offset X. Default 0.
offsetY?: number
Layer pixel offset Y. Default 0.
opacity?: number
Layer opacity in [0, 1]. Default 1.
parallaxScale?: number
Uniform parallax scale around the layer origin. Default 1.
parallaxX?: number
Parallax scroll factor on the X axis. 1 = full camera speed (normal), 0.5 = half speed (farther away), 0 = stationary. Default 1.
parallaxY?: number
Parallax scroll factor on the Y axis. 1 = full camera speed (normal), 0.5 = half speed (farther away), 0 = stationary. Default 1.
properties?: TilePropertiesAn immutable, flat key-value bag of generic tile properties. Adapters copy and freeze source properties; the runtime never retains a caller-owned mutable objec…
Layer-level properties (copied and frozen).
tintColor?: null | number
Multiplicative layer tint as a 0xRRGGBB integer, or null for no tint (Tiled tintcolor). Default null.
visible?: boolean
Whether the layer is visible. Default true.
Source
packages/exojs-tilemap/src/ObjectLayer.ts