• Classes

  • ldtk::FilePath

• Structs

  • ldtk::Point<T>
  • ldtk::Rect<T>
  • ldtk::Color
  • ldtk::EntityRef
  • ldtk::TileRect
  • ldtk::NineSliceBorders
  • ldtk::IntGridValue
  • ldtk::Vertex

• Enums

  • ldtk::WorldLayout
  • ldtk::LayerType
  • ldtk::FieldType
  • ldtk::Dir

• Types

  • ldtk::FileLoader

A string that contains file path information.

• Constructor
• Methods

ldtk::FilePath::FilePath()

Default constructor. Constructs an empty FilePath.

ldtk::FilePath::FilePath(const std::string&)

Construct a FilePath from a valid provided string.

ldtk::FilePath::directory() const -> std::string

Returns the path to the directory containing the file.

ldtk::FilePath::filename() const -> std::string

Returns the filename (including the extension) of the FilePath.

ldtk::FilePath::extension() const -> std::string

Returns only the extension of the file (e.g. png, json, txt ...).

🔝

Represents a two dimentional coordinate.

T can be one of the following types: float, int or unsigned int.

Aliases:

• ldtk::FloatPoint = ldtk::Point<float>
• ldtk::IntPoint = ldtk::Point<int>
• ldtk::UIntPoint = ldtk::Point<unsigned int>

T ldtk::Point<T>::x

X coordinate of the Point.

T ldtk::Point<T>::y

Y coordinate of the Point.

🔝

Represents an axis aligned rectangle.

T can be one of the following types: float or int.

Aliases:

• ldtk::FloatRect = ldtk::Rect<float>
• ldtk::IntRect = ldtk::Rect<int>

• x
• y
• width
• height

T ldtk::Rect<T>::x

X coordinate of the top left corner of the Rect.

T ldtk::Rect<T>::y

Y coordinate of the top left corner of the Rect.

T ldtk::Rect<T>::width

Width of the Rect.

T ldtk::Rect<T>::height

Height of the Rect.

🔝

Represents a color value in the 32 bits RGBA format.

• r
• g
• b
• a

std::uint8_t ldtk::Color::r

Red component of the Color.

std::uint8_t ldtk::Color::g

Green component of the Color.

std::uint8_t ldtk::Color::n

Blue component of the Color.

std::uint8_t ldtk::Color::a

Alpha component of the Color (opacity).

🔝

Represents a reference to an Entity.

ldtk::EntityRef::operator->() const -> const ldtk::Entity*

Returns a pointer to the Entity referenced by the EntityRef.

This operator allows to access the Entity reference like this:

entity_ref->getName(); // returns the name of the referenced Entity

🔝

Represents a rectangle of one or multiple tiles. Used in TileField.

• Fields
• Methods

const IntRect ldtk::TileRect::bounds

🔝

ldtk::TileRect::getTileset() const -> const Tileset&

Returns the Tileset to which the tile belongs.

🔝

Represents the dimensions of the 9-slice tile render.

• top
• right
• bottom
• left

int ldtk::NineSliceBorders::top

int ldtk::NineSliceBorders::right

int ldtk::NineSliceBorders::bottom

int ldtk::NineSliceBorders::left

🔝

Represents the grid values that can be painted on an IntGrid layer.

const int ldtk::IntGridValue::value

const std::string ldtk::IntGridValue::name

const ldtk::Color ldtk::IntGridValue::color

🔝

Represents a vertex composed of a position and a texture coordinate.

The graphic representation of a Tile is composed of 4 vertices.

const ldtk::FloatPoint ldtk::Vertex::pos

Coordinate of the vertex in pixels, relative to the Level.

const ldtk::IntPoint ldtk::Vertex::tex

Texture coordinate of the vertex, in pixels.

🔝

Contains enum values representing all the possible types of World layouts.

0. WorldLayout::Free
1. WorldLayout::GridVania
2. WorldLayout::LinearHorizontal
3. WorldLayout::LinearVertical

🔝

Contains enum values representing all the possible types of Layers.

0. LayerType::IntGrid
1. LayerType::Entities
2. LayerType::Tiles
3. LayerType::AutoLayer

🔝

Contains enum values representing all the possible types of a Field.

These enum values can be used to get a field from an Entity. For example:

const auto& field_value = entity.getField<ldtk::FieldType::ArrayEntityRef>();
// The type of field_value is ldtk::ArrayField<ldtk::EntityRef>

0. FieldType::Int
1. FieldType::Float
2. FieldType::Bool
3. FieldType::String
4. FieldType::Color
5. FieldType::Point
6. FieldType::Enum
7. FieldType::FilePath
8. FieldType::Tile
9. FieldType::EntityRef
10. FieldType::ArrayInt
11. FieldType::ArrayFloat
12. FieldType::ArrayBool
13. FieldType::ArrayString
14. FieldType::ArrayColor
15. FieldType::ArrayPoint
16. FieldType::ArrayEnum
17. FieldType::ArrayFilePath
18. FieldType::ArrayTile
19. FieldType::ArrayEntityRef

🔝

Contains enum values representing all the possible Directions of Level neighbours.

It is used by ldtk::Level::getNeighbours(const ldtk::Dir&) and returned by ldtk::getNeighbourDirection(const Level&).

0. Dir::None
1. Dir::North
2. Dir::NorthEast
3. Dir::East
4. Dir::SouthEast
5. Dir::South
6. Dir::SouthWest
7. Dir::West
8. Dir::NorthWest

🔝

using ldtk::FileLoader = std::function<std::unique_ptr<std::streambuf>(const std::string&)>

FileLoader is the type of a function that takes the path of a file as parameter and returns a unique pointer to a standard stream buffer for that file.

This allows to load a Project from a custom source stream (e.g. from a virtual filesystem).

🔝