Ldtk

Ldtk

Creates LDTK module managers.

Constructor

new Ldtk($data)

Description:
  • Creates a new LDTK module manager.
Source:
Example
const ldtk = new Ldtk(data);
ldtk.getEntities({$level, $layer});
Parameters:
Name Type Description
$data TypeLdtk The LDTK JSON data.

Members

data :TypeLdtk

Description:
  • Gets the LDTK JSON data.
Source:
Gets the LDTK JSON data.
Type:
  • TypeLdtk

Methods

getEntities($parameters) → {Array.<TypeEntity>}

Description:
  • Gets the entities from the given level on the given layer.
Source:
Parameters:
Name Type Description
$parameters Object The given parameters.
$parameters.$layer string The layer of the entities to get.
$parameters.$level string The level of the entities to get.
Returns:
Type
Array.<TypeEntity>

getEntitiesData($parameters) → {Array.<TypeLdtkEntity>}

Description:
  • Gets the LDTK JSON data entities from the given level on the given layer.
Source:
Parameters:
Name Type Description
$parameters Object The given parameters.
$parameters.$layer string The layer of the entities to get.
$parameters.$level string The level of the entities to get.
Returns:
Type
Array.<TypeLdtkEntity>

getGrid($parameters) → {TypeGrid|undefined}

Description:
  • Gets the grid from the given level on the given layer.
Source:
Parameters:
Name Type Description
$parameters Object The given parameters.
$parameters.$layer string The layer of the grid to get.
$parameters.$level string The level of the grid to get.
Returns:
Type
TypeGrid | undefined

getGridData($parameters) → {TypeLdtkLayer}

Description:
  • Gets the LDTK JSON data layer grid from the given level on the given layer.
Source:
Parameters:
Name Type Description
$parameters Object The given parameters.
$parameters.$layer string The layer of the grid to get.
$parameters.$level string The level of the grid to get.
Returns:
Type
TypeLdtkLayer

Type Definitions

TypeEntity

Description:
  • A transformed LDTK JSON entity.
Source:
Properties:
Name Type Description
TypeEntity.$identifier string The identifier.
TypeEntity.$position Vector2 The position.
TypeEntity.$type string The type.
A transformed LDTK JSON entity.
Type:
  • Object

TypeGrid

Description:
  • A transformed LDTK JSON grid.
Source:
Properties:
Name Type Description
TypeGrid.$cell Vector2 The size of each cell.
TypeGrid.$data Array.<number> The flat data (one-dimensional).
TypeGrid.$definitions Map.<number, string> The data definitions.
TypeGrid.$height number The number of cells on the y-axis.
TypeGrid.$position Vector2 The position.
TypeGrid.$width number The number of cells on the x-axis.
A transformed LDTK JSON grid.
Type:
  • Object

TypeLdtk

Description:
  • A LDTK JSON data.
Source:
Properties:
Name Type Description
TypeLdtk.defs TypeLdtkDefinitions The definitions.
TypeLdtk.levels Array.<TypeLdtkLevel> The delevs.
A LDTK JSON data.
Type:
  • Object

TypeLdtkDefinitionLayer

Description:
  • A LDTK JSON data layer definition.
Source:
Properties:
Name Type Description
TypeLdtkDefinitionLayer.identifier string The identifier.
TypeLdtkDefinitionLayer.intGridValues Array.<TypeLdtkDefinitionLayerGridValue> The grid values.
A LDTK JSON data layer definition.
Type:
  • Object

TypeLdtkDefinitionLayerGridValue

Description:
  • A LDTK JSON data layer grid value definition.
Source:
Properties:
Name Type Description
TypeLdtkDefinitionLayerGridValue.identifier string The identifier.
TypeLdtkDefinitionLayerGridValue.value number The value.
A LDTK JSON data layer grid value definition.
Type:
  • Object

TypeLdtkDefinitions

Description:
  • A LDTK JSON data definition.
Source:
Properties:
Name Type Description
TypeLdtkDefinitionLayer.layers Array.<TypeLdtkDefinitionLayer> The layers' definitions.
A LDTK JSON data definition.
Type:
  • Object

TypeLdtkEntity

Description:
  • A LDTK JSON data entity.
Source:
Properties:
Name Type Description
TypeLdtkEntity.__identifier string The identifier.
TypeLdtkEntity.fieldInstances Array.<TypeLdtkEntityField> The custom fields.
TypeLdtkEntity.iid string The iid.
TypeLdtkEntity.px Array.<number> The position.
A LDTK JSON data entity.
Type:
  • Object

TypeLdtkEntityField

Description:
  • A LDTK JSON data custom field.
Source:
Properties:
Name Type Description
TypeLdtkEntityField.__identifier string The identifier.
TypeLdtkEntityField.__type string The type.
TypeLdtkEntityField.__value any The value.
A LDTK JSON data custom field.
Type:
  • Object

TypeLdtkLayer

Description:
  • A LDTK JSON data layer.
Source:
Properties:
Name Type Description
TypeLdtkLayer.__cHei number The number of grid cells on the x-axis.
TypeLdtkLayer.__cWid number The number of grid cells on the y-axis.
TypeLdtkLayer.__gridSize number The size of each cell.
TypeLdtkLayer.__identifier string The identifier.
TypeLdtkLayer.entityInstances Array.<TypeLdtkEntity> The entities.
TypeLdtkLayer.intGridCsv Array.<number> The grid values.
A LDTK JSON data layer.
Type:
  • Object

TypeLdtkLevel

Description:
  • A LDTK JSON data level.
Source:
Properties:
Name Type Description
TypeLdtkLevel.identifier string The identifier.
TypeLdtkLevel.layerInstances Array.<TypeLdtkLayer> The layers.
TypeLdtkLevel.pxHei number The height.
TypeLdtkLevel.pxWid number The width.
A LDTK JSON data level.
Type:
  • Object