Fields

In file LDtkLoader/defs/FieldDef.hpp

• Enums

  • ldtk::FieldType

• Struct and classes

  • ldtk::FieldDef

• Types

  • ldtk::getFieldType<T>

Enum class : ldtk::FieldType

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

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

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

const auto& field_value = entity.getField<ldtk::FieldType::ArrayEntityRef>();
// The field_value variable will be a ldtk::ArrayField<ldtk::EntityRef>

Class : ldtk::FieldDef

Fields

type

ldtk::FieldType ldtk::FieldDef::type;

Type of the Field defined by the FieldDef.

name

std::string ldtk::FieldDef::name;

Name of the Field defined by the FieldDef.

Type : ldtk::getFieldType<T>

Mainly for internal use

template<FieldType T>
using getFieldType = typename field_type_from_enum_<T>::type;

Utility used to get the underlying type from a FieldType enum value.

For example, to get the underlying type of a ldtk::FieldType::ArrayColor field, you can use ldtk::getFieldType<ldtk::FieldType::ArrayColor>.