Open 3D Engine AzFramework 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.
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
AzFramework::SpawnableMetaData Class Referencefinal

#include <SpawnableMetaData.h>

Public Types

enum class  ValueType {
  Unavailable , Boolean , UnsignedInteger , SignedInteger ,
  FloatingPoint , String , ArraySize
}
 
using TableKey = AZ::HashValue64
 
using TableValue = AZStd::variant< bool, AZ::u64, AZ::s64, double, AZStd::string, SpawnableMetaDataArraySize >
 
using TableEntry = AZStd::pair< TableKey, TableValue >
 
using Table = AZStd::vector< TableEntry >
 

Public Member Functions

 AZ_TYPE_INFO (SpawnableMetaData, "{3832FA08-B10B-49AF-A81E-8E2FC1FF98B1}")
 
 SpawnableMetaData (Table table)
 
bool Get (AZStd::string_view key, bool &value) const
 
bool Get (AZStd::string_view key, AZ::u64 &value) const
 
bool Get (AZStd::string_view key, AZ::s64 &value) const
 
bool Get (AZStd::string_view key, double &value) const
 
bool Get (AZStd::string_view key, AZStd::string_view &value) const
 
bool Get (AZStd::string_view key, SpawnableMetaDataArraySize &value) const
 
bool Get (AZStd::string_view arrayKey, uint64_t index, bool &value) const
 
bool Get (AZStd::string_view arrayKey, uint64_t index, AZ::u64 &value) const
 
bool Get (AZStd::string_view arrayKey, uint64_t index, AZ::s64 &value) const
 
bool Get (AZStd::string_view arrayKey, uint64_t index, double &value) const
 
bool Get (AZStd::string_view arrayKey, uint64_t index, AZStd::string_view &value) const
 
bool Get (AZStd::string_view arrayKey, SpawnableMetaDataArrayIndex index, bool &value) const
 
bool Get (AZStd::string_view arrayKey, SpawnableMetaDataArrayIndex index, AZ::u64 &value) const
 
bool Get (AZStd::string_view arrayKey, SpawnableMetaDataArrayIndex index, AZ::s64 &value) const
 
bool Get (AZStd::string_view arrayKey, SpawnableMetaDataArrayIndex index, double &value) const
 
bool Get (AZStd::string_view arrayKey, SpawnableMetaDataArrayIndex index, AZStd::string_view &value) const
 
ValueType GetType (AZStd::string_view key) const
 
ValueType GetType (AZStd::string_view arrayKey, uint64_t index) const
 
ValueType GetType (AZStd::string_view arrayKey, SpawnableMetaDataArrayIndex index) const
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 

Static Public Attributes

static constexpr uint64_t ArrayKeyRoot = 146223222818353
 

Detailed Description

Simple meta data that can be stored along with a spawnable. This class is designed to be read-only and is expected to be serialized. AzToolsFramework provides a class for constructing meta data.

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