Interface MapObject

A map object.

interface MapObject {
    ellipse?: boolean;
    gid?: number;
    height?: number;
    id: number;
    name?: string;
    point?: boolean;
    polygon?: Point[];
    polyline?: Point[];
    properties?: AnyProperty[];
    rotation?: number;
    template?: string;
    text?: Text;
    type?: string;
    visible?: boolean;
    width?: number;
    x: number;
    y: number;
}

Hierarchy (view full)

Properties

ellipse? gid? height? id name? point? polygon? polyline? properties? rotation? template? text? type? visible? width? x y

Properties

Optional ellipse

ellipse?: boolean

True if object is an ellipse. False or undefined if not.

Optional gid

gid?: number

Global tile ID, only if object represents a tile.

Optional height

height?: number

Height in pixels. Always 0 for points. Default is 0.

id

id: number

Incremental ID, unique across all objects.

Optional name

name?: string

The name assigned to this object. Default is empty.

Optional point

point?: boolean

True if object is a point. False or undefined if not.

Optional polygon

polygon?: Point[]

Array of points if object is a polygon.

Optional polyline

polyline?: Point[]

Array of points if object is a polyline.

Optional properties

properties?: AnyProperty[]

Array of object properties.

Optional rotation

rotation?: number

Rotation angle in degrees clockwise. Default is 0.

Optional template

template?: string

Reference to a template file, in case object is a template instance.

Optional text

text?: Text

Text data if object is a text.

Optional type

type?: string

The class of the object. Was saved as class in older Tiled v1.9. Default is empty.

Optional visible

visible?: boolean

Whether object is shown in editor. Default is true.

Optional width

width?: number

Width in pixels. Always 0 for points. Default is 0.

x

x: number

X coordinate in pixels.

y

y: number

Y coordinate in pixels.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc