Interface Layer<T>

Map layer.

interface Layer<T> {
    class?: string;
    id: number;
    locked?: boolean;
    name: string;
    offsetx?: number;
    offsety?: number;
    opacity: number;
    parallaxx?: number;
    parallaxy?: number;
    properties?: AnyProperty[];
    tintcolor?: string;
    type: T;
    visible: boolean;
    x: number;
    y: number;
}

Type Parameters

  • T extends string = string

Hierarchy (view full)

Properties

class? id locked? name offsetx? offsety? opacity parallaxx? parallaxy? properties? tintcolor? type visible x y

Properties

Optional class

class?: string

The class of the layer.

id

id: number

Incremental ID. Unique across all layers.

Optional locked

locked?: boolean

Whether layer is locked in the editor. Default is false.

name

name: string

The layer's name.

Optional offsetx

offsetx?: number

Optional horizontal layer offset in pixels. Default is 0.

Optional offsety

offsety?: number

Optional vertical layer offset in pixels. Default is 0.

opacity

opacity: number

Layer opacity between 0 and 1.

Optional parallaxx

parallaxx?: number

Horizontal parallax factor. Default is 1.

Optional parallaxy

parallaxy?: number

Vertical parallax factor. Default is 1.

Optional properties

properties?: AnyProperty[]

Array of properties. Empty if not set.

Optional tintcolor

tintcolor?: string

Optional tint color that is multiplied with any graphics drawn by this layer or any child layer.

type

type: T

The layer type.

visible

visible: boolean

Whether layer is shown or hidden in editor.

x

x: number

Horizontal layer offset in tiles. Always 0.

y

y: number

Vertical layer offset in tiles. Always 0.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc