ldtk::definitions class

Public functions

auto get_entity_def(gen::entity_ident identifier) const -> const entity_definition& constexpr
Looks up a entity definition with its identifier.
auto get_layer_def(gen::layer_ident identifier) const -> const layer_definition& constexpr
Looks up a layer definition with its identifier.
auto get_level_field_def(gen::level_field_ident identifier) const -> const field_definition& constexpr
Looks up a level field definition with its identifier.
auto get_tileset_def(gen::tileset_ident identifier) const -> const tileset_definition& constexpr
Looks up a tileset definition with its identifier.
auto entities() const -> const bn::span<const entity_definition>& constexpr
All entities definitions, including their custom fields.
auto layers() const -> const bn::span<const layer_definition>& constexpr
All layer definitions.
auto level_fields() const -> const bn::span<const field_definition>& constexpr
All custom fields available to all levels.
auto tilesets() const -> const bn::span<const tileset_definition>& constexpr
All tilesets.

Function documentation

const entity_definition& ldtk::definitions::get_entity_def(gen::entity_ident identifier) const constexpr

Looks up a entity definition with its identifier.

Parameters
identifier Unique identifier of the entity to search for.
Returns Reference to the entity definition.

const layer_definition& ldtk::definitions::get_layer_def(gen::layer_ident identifier) const constexpr

Looks up a layer definition with its identifier.

Parameters
identifier Unique identifier of the layer to search for.
Returns Reference to the layer definition.

const field_definition& ldtk::definitions::get_level_field_def(gen::level_field_ident identifier) const constexpr

Looks up a level field definition with its identifier.

Parameters
identifier Unique identifier of the level field to search for.
Returns Reference to the level field definition.

const tileset_definition& ldtk::definitions::get_tileset_def(gen::tileset_ident identifier) const constexpr

Looks up a tileset definition with its identifier.

Parameters
identifier Unique identifier of the tileset to search for.
Returns Reference to the tileset definition.