API reference

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

I

interfaceImageLayerOptions

@codexo/exojs-tilemap / tilemap / stable

Construction options for an ImageLayer.

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

Construction options for an ImageLayer.

Properties16
class?: string
Layer class string.
id: number
Layer id (unique within the map).
image: string
Resolved image URL.
name?: string
Layer name.
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
Horizontal parallax factor. Default 1.
parallaxY?: number
Vertical parallax factor. 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 properties (copied and frozen).
repeatX?: boolean
Whether the image repeats horizontally. Default false.
repeatY?: boolean
Whether the image repeats vertically. Default false.
texture?: TextureA static GPU texture sourced from an image, canvas, or video element. Holds the pixel source, its sampling state (ScaleModes, WrapModes) and its upload state (… | null
Loaded texture for the image, or null if unavailable.
tintColor?: null | number
Tint colour as 0xRRGGBB, or null. Default null.
visible?: boolean
Whether the layer is visible. Default true.
Source
packages/exojs-tilemap/src/ImageLayer.ts