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::SettingsRegistryMergeUtils::DumperSettings Struct Reference

Structure for configuring how values should be dumped from the Settings Registry. More...

#include <SettingsRegistryMergeUtils.h>

Public Attributes

bool m_prettifyOutput {}
 Determines if a PrettyWriter should be used when dumping the Settings Registry.
 
AZStd::function< bool(AZStd::string_view path)> m_includeFilter
 
AZStd::string_view m_jsonPointerPrefix
 

Detailed Description

Structure for configuring how values should be dumped from the Settings Registry.

Member Data Documentation

◆ m_includeFilter

AZStd::function<bool(AZStd::string_view path)> AZ::SettingsRegistryMergeUtils::DumperSettings::m_includeFilter

Include filter which is used to indicate which paths of the Settings Registry should be traversed. If the include filter is empty then all paths underneath the JSON pointer path are included otherwise the include filter invoked and if it returns true does it proceed with traversal down the path The supplied JSON pointer will be a complete path from the root of the registry

◆ m_jsonPointerPrefix

AZStd::string_view AZ::SettingsRegistryMergeUtils::DumperSettings::m_jsonPointerPrefix

JSON pointer prefix to dump all settings underneath For example if the prefix is "/Amazon/Settings", then the dumped settings will be placed underneath an object at that path """ { "Amazon":{ "Settings":{ <Dumped values> } } }


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