DataConfig
Serialization framework for Unreal Engine Property System that just works!
Unreal Engine features a powerful Property System which implements C++ runtime reflection. DataConfig is a serialization framework build on top of it. Notably features:
- Support every type can be marked as
UPROPERTY(), including delegates andUObjectreferences. - Pull/Push styled API for verbatim data access and lossless type infomation.
- Out of the box JSON deserialization that supports custom conversion logic.
- Designed as a collection of tools that can be easily extended to support other formats.
Documentation
See DataConfig Book for details.
Example
Given a struct annotated and processed with Unreal's Property System:
UENUM()
enum class EDcTestExampleEnum
{
Foo, Bar, Baz
};
USTRUCT()
struct FDcTestExampleStruct
{
GENERATED_BODY()
UPROPERTY() FString StrField;
UPROPERTY() EDcTestExampleEnum EnumField;
UPROPERTY() TArray Colors;
};
DataConfig can deserialize an instance from JSON with the snippet below:
FString Str = TEXT(R"(
{
"StrField" : "Lorem ipsum dolor sit amet",
"EnumField" : "Bar",
"Colors" : [
"#FF0000FF", "#00FF00FF", "#0000FFFF"
]
}
)");
FDcTestExampleStruct Dest;
// create and setup a deserializer
FDcDeserializer Deserializer;
DcSetupJsonDeserializeHandlers(Deserializer);
Deserializer.AddPredicatedHandler(
FDcDeserializePredicate::CreateStatic(DcExtra::PredicateIsColorStruct),
FDcDeserializeDelegate::CreateStatic(DcExtra::HandlerColorDeserialize)
);
// prepare context for this run
FDcPropertyDatum Datum(FDcTestExampleStruct::StaticStruct(), &Dest);
FDcJsonReader Reader(Str);
FDcPropertyWriter Writer(Datum);
FDcDeserializeContext Ctx;
Ctx.Reader = &Reader;
Ctx.Writer = &Writer;
Ctx.Deserializer = &Deserializer;
Ctx.Properties.Push(Datum.Property);
DC_TRY(Ctx.Prepare());
// kick off deserialization
DC_TRY(Deserializer.Deserialize(Ctx));
// validate results
check(Dest.StrField == TEXT("Lorem ipsum dolor sit amet"));
check(Dest.EnumField == EDcTestExampleEnum::Bar);
check(Dest.Colors[0] == FColor::Red);
check(Dest.Colors[1] == FColor::Green);
check(Dest.Colors[2] == FColor::Blue);
Note that enum is deserialized by its name and FColor is deserialized from a html color string like #RRGGBBAA.
Say if we accidentally mistyped the EnumField value:
{
"StrField" : "Lorem ipsum dolor sit amet",
"EnumField" : "Far",
DataConfig would fail gracefully with diagnostics:
# DataConfig Error: Enum name not found in enum type: EDcTestExampleEnum, Actual: 'Far'
- [JsonReader] --> 4:25
2 | {
3 | "StrField" : "Lorem ipsum dolor sit amet",
4 | "EnumField" : "Far",
| ^
5 | "Colors" : [
6 | "#FF0000FF", "#00FF00FF", "#0000FFFF"
- [PropertyWriter] Writing property: (FDcTestExampleStruct)$root.(EEDcTestExampleEnum)EnumField
License
DataConfig is released under MIT License.
It would be trememdously helpful if you credit us in your projects. See the license page for details.
290 Dec 31, 2022
419 Jan 1, 2023
99 Dec 24, 2022
79 Nov 5, 2022
51 Dec 17, 2022
455 Sep 7, 2021
247 Dec 8, 2022
281 Dec 10, 2022
1.1k Jan 2, 2023
711 Jan 7, 2023
2.5k Dec 31, 2022
299 Dec 31, 2022
9.5k Jan 1, 2023
771 Jan 2, 2023
3.4k Jan 3, 2023
654 Jan 2, 2023
19.7k Jan 9, 2023
596 Jan 7, 2023
383 Dec 23, 2022