Open 3D Engine AzCore API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
AZ::JsonDeserializerSettings Struct Referencefinal

Optional settings used while loading a json value to an object. More...

#include <JsonSerializationSettings.h>

Public Attributes

JsonSerializationMetadata m_metadata
 Metadata can be used to pass additional information to serializers. Look at individual serializers for available options.
 
JsonSerializationResult::JsonIssueCallback m_reporting
 
SerializeContextm_serializeContext = nullptr
 Optional serialize context. If not provided the default instance will be retrieved through an EBus call.
 
JsonRegistrationContextm_registrationContext = nullptr
 Optional json registration context. If not provided the default instance will be retrieved through an EBus call.
 
bool m_clearContainers = false
 

Detailed Description

Optional settings used while loading a json value to an object.

Member Data Documentation

◆ m_clearContainers

bool AZ::JsonDeserializerSettings::m_clearContainers = false

If true this will clear all containers in the object before applying the data from the json document. If set to false any values in the container will be kept and not overwritten. Note that this does not apply to containers where elements have a fixed location such as smart pointers or AZStd::tuple.

◆ m_reporting

JsonSerializationResult::JsonIssueCallback AZ::JsonDeserializerSettings::m_reporting

Optional callback when issues are encountered. If not provided reporting will be forwarded to the default issue reporting. This can also be used to change the returned result code to alter the behavior of the deserializer.


The documentation for this struct was generated from the following file: