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::SettingsRegistryVisitorUtils::FieldVisitor Struct Referenceabstract

#include <SettingsRegistryVisitorUtils.h>

Inherits AZ::SettingsRegistryInterface::Visitor.

Inherited by AZ::SettingsRegistryVisitorUtils::ArrayVisitor, and AZ::SettingsRegistryVisitorUtils::ObjectVisitor.

Public Types

using VisitResponse = AZ::SettingsRegistryInterface::VisitResponse
 
using VisitAction = AZ::SettingsRegistryInterface::VisitAction
 

Public Member Functions

virtual AZ::SettingsRegistryInterface::VisitResponse Visit (const AZ::SettingsRegistryInterface::VisitArgs &visitArgs)=0
 
- Public Member Functions inherited from AZ::SettingsRegistryInterface::Visitor
virtual VisitResponse Traverse (const VisitArgs &visitArgs, VisitAction action)
 
virtual void Visit (const VisitArgs &visitArgs, bool value)
 
virtual void Visit (const VisitArgs &visitArgs, s64 value)
 
virtual void Visit (const VisitArgs &visitArgs, u64 value)
 
virtual void Visit (const VisitArgs &visitArgs, double value)
 
virtual void Visit (const VisitArgs &visitArgs, AZStd::string_view value)
 

Protected Types

enum class  VisitFieldType { Array , Object , ArrayOrObject }
 

Protected Member Functions

 FieldVisitor (const VisitFieldType visitFieldType)
 

Detailed Description

Interface for visiting the fields of an array or object To access the values, use the SettingsRegistryInterface Get/GetObject methods

Member Function Documentation

◆ Visit()

virtual AZ::SettingsRegistryInterface::VisitResponse AZ::SettingsRegistryVisitorUtils::FieldVisitor::Visit ( const AZ::SettingsRegistryInterface::VisitArgs visitArgs)
pure virtual
Returns
VisitResponse of Done halts further iteration of sibling fields all other VisitRepsonse values are ignored

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