Open 3D Engine AzToolsFramework 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 Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
AzToolsFramework::MetadataManager Class Reference

#include <MetadataManager.h>

Inherits AZ::Component, and AZ::Interface::Registrar.

Public Member Functions

 AZ_COMPONENT (MetadataManager, "{CB738803-3B6C-4B62-9DC2-1980D340F288}", IMetadataRequests)
 
AZ::Outcome< bool, AZStd::string > GetValue (AZ::IO::PathView file, AZStd::string_view key, void *outValue, AZ::Uuid typeId) override
 
AZ::Outcome< bool, AZStd::string > GetJson (AZ::IO::PathView file, AZStd::string_view key, rapidjson::Document &outValue) override
 
AZ::Outcome< bool, AZStd::string > GetValueVersion (AZ::IO::PathView file, AZStd::string_view key, int &version) override
 
AZ::Outcome< void, AZStd::string > SetValue (AZ::IO::PathView file, AZStd::string_view key, const void *inValue, AZ::Uuid typeId) override
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 
static AZ::IO::Path ToMetadataPath (AZ::IO::Path path)
 

Static Public Attributes

static constexpr const char * MetadataFileExtensionNoDot = "meta"
 
static constexpr const char * MetadataFileExtension = ".meta"
 
static constexpr const char * MetadataVersionKey = "/FileVersion"
 
static constexpr const char * MetadataObjectVersionField = "__version"
 
static constexpr int MetadataVersion = 1
 

Protected Member Functions

void Activate () override
 
void Deactivate () override
 

Detailed Description

Component that handles reading/writing to metadata files. Metadata files are stored alongside source assets and can contain any generic data that needs to be associated with a file.

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