API reference

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

T

typeLdtkFieldInstance

@codexo/exojs-ldtk / ldtk / stable

A field value on an entity or level instance, discriminated by `__type`. `Array<T>` fields (e.g. `Array<Int>`, `Array<Point>`) carry a raw element array whose per-element shape matches the corresponding non-array `__value` shape above; see import('./ldtkToTileMap').ldtkToTileMap's field conversion for the exhaustive mapping into the canonical import('@codexo/exojs-tilemap').TilePropertyValue.

0
props
0
methods
0
events
Import
import { LdtkFieldInstance } from '@codexo/exojs-ldtk'

A field value on an entity or level instance, discriminated by `__type`. `Array<T>` fields (e.g. `Array<Int>`, `Array<Point>`) carry a raw element array whose per-element shape matches the corresponding non-array `__value` shape above; see import('./ldtkToTileMap').ldtkToTileMap's field conversion for the exhaustive mapping into the canonical import('@codexo/exojs-tilemap').TilePropertyValue.

Definition1
{ __identifier: string; __type: "EntityRef"; __value: LdtkFieldEntityRefValue | null } | { __identifier: string; __type: "Point"; __value: LdtkFieldPointValue | null } | { __identifier: string; __type: "Tile"; __value: LdtkFieldTileValue | null } | { __identifier: string; __type: LdtkFieldEnumTypeThe `__type` LDtk writes for an enum-valued field: the enum's identifier qualified by where it is defined. The `__value` is the selected entry's identifier as…; __value: null | string } | { __identifier: string; __type: LdtkFieldScalarType; __value: boolean | null | number | string } | { __identifier: string; __type: templateLiteral; __value: null | readonly unknown[] }
Source