API reference

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

I

interfaceTiledObjectData

@codexo/exojs-tiled / tiled / stable

An object placed in an object layer (or a tile's collision `objectgroup`). The shape is determined by which of `point` / `ellipse` / `polygon` / `polyline` / `text` / `gid` is present; absent of all of these, the object is a plain rectangle.

18
props
0
methods
0
events
Import
import { TiledObjectData } from '@codexo/exojs-tiled'

An object placed in an object layer (or a tile's collision `objectgroup`). The shape is determined by which of `point` / `ellipse` / `polygon` / `polyline` / `text` / `gid` is present; absent of all of these, the object is a plain rectangle.

Properties18
class?: string
Object class as Tiled 1.9 wrote it. Absent in every other version.
ellipse?: boolean
gid?: number
Tile object reference; may carry flip/rotation flag bits in the high bits.
height: number
id: number
name: string
point?: boolean
polygon?: readonly TiledPointDataA 2D point as written by Tiled (used for tile offsets and object shapes).[]
polyline?: readonly TiledPointDataA 2D point as written by Tiled (used for tile offsets and object shapes).[]
properties?: readonly TiledPropertyDataOne custom property entry as written by Tiled (`properties` arrays on maps, tilesets, tiles, layers and objects). - `string` / `color` / `file` → `value` is a…[]
rotation: number
template?: string
Path to a .tx object template this object was instantiated from.
text?: TiledTextDataText rendering options for a `text` object (object layers).
type: string
Object class, under the name Tiled 1.10 and later write. Empty when unset. Tiled 1.9 wrote the same value as TiledObjectData.class instead; see import('./TiledObject').TiledObject.type for how the two are reconciled.
visible: boolean
width: number
x: number
y: number
Source
packages/exojs-tiled/src/data.ts