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::JsonImportSettings Struct Referencefinal

#include <JsonImporter.h>

Public Attributes

JsonSerializationResult::JsonIssueCallback m_reporting
 Reporting callback used to output errors around $import resolution.
 
BaseJsonImporterm_importer = nullptr
 
ImportTracking m_resolveFlags = ImportTracking::All
 
bool m_resolveNestedImports = true
 
AZ::IO::FixedMaxPath m_loadedJsonPath
 Path of the file which corresponds to the Json Document that is being checked for imports.
 

Detailed Description

Settings used to configure how resolution of a $import directive during JSON deserialization occurs

Member Data Documentation

◆ m_importer

BaseJsonImporter* AZ::JsonImportSettings::m_importer = nullptr

Importer object which to invoke ResolveImports/RestoreImports function to resolve the $import directive If nullptr, then the operation is a no-op

◆ m_resolveFlags

ImportTracking AZ::JsonImportSettings::m_resolveFlags = ImportTracking::All

Enum options that control how the BaseJsonImporter stores the results of the import operation ImportTracking::Imports stores the value of $import field as found in the JSON file as well as the resolved absolute path of the file on disk Any Filesystem <alias>@ aliases would be resolved ImportTracking::Dependences stores only the absolute path of the file to import that should reside on the file system

◆ m_resolveNestedImports

bool AZ::JsonImportSettings::m_resolveNestedImports = true

Boolean to control whether imports inside of the imported files are resolved as well. If false, then only the imports in the supplied rapidjson::Value is resolved


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