Navigation
API > API/Developer > API/Developer/CookMetadata
Structure serialized to disk to contain non-asset related metadata about a cook. This should always exist alongside a Development Asset Registry, and to ensure that the pair is not out of sync, users should validate the development asset registry they are using with GetAssociatedDevelopmentAssetRegistryHash().
| Name | FCookMetadataState |
| Type | class |
| Header File | /Engine/Source/Developer/CookMetadata/Public/CookMetadata.h |
| Include Path | #include "CookMetadata.h" |
Syntax
class FCookMetadataState
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FCookMetadataState
(
FCookMetadataState&& Rhs |
CookMetadata.h | ||
FCookMetadataState
(
const FCookMetadataState& |
CookMetadata.h | ||
| CookMetadata.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FCookMetadataState() |
CookMetadata.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AssociatedDevelopmentAssetRegistryHash | uint64 | CookMetadata.h | ||
| AssociatedDevelopmentAssetRegistryHashPostWriteback | uint64 | Asset registry size writeback changes the AR, so we have a separate hash for that DevAR that this also matches. | CookMetadata.h | |
| BuildVersion | FString | BUILD_VERSION definition from definitions.h for the cook. | CookMetadata.h | |
| HordeJobId | FString | If cooked on Horde, this is the job id that cooked it. | CookMetadata.h | |
| Platform | FString | CookMetadata.h | ||
| PluginHierarchy | FCookMetadataPluginHierarchy | CookMetadata.h | ||
| ShaderPseudoHierarchy | FCookMetadataShaderPseudoHierarchy | CookMetadata.h | ||
| SizesPresent | ECookMetadataSizesPresent | Updated by unrealpak when plugin size information is added. | CookMetadata.h | |
| Version | ECookMetadataStateVersion | CookMetadata.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
uint64 GetAssociatedDevelopmentAssetRegistryHash() |
CookMetadata.h | ||
uint64 GetAssociatedDevelopmentAssetRegistryHashPostWriteback() |
CookMetadata.h | ||
const FString GetBuildVersion() |
CookMetadata.h | ||
const FString & GetHordeJobId() |
CookMetadata.h | ||
FCookMetadataPluginHierarchy & GetMutablePluginHierarchy() |
So that unrealpak can update the sizes. | CookMetadata.h | |
const FString & GetPlatform() |
CookMetadata.h | ||
const FCookMetadataPluginHierarchy & GetPluginHierarchy() |
CookMetadata.h | ||
const FCookMetadataShaderPseudoHierarchy & GetShaderPseudoHierarchy() |
CookMetadata.h | ||
ECookMetadataSizesPresent GetSizesPresent() |
CookMetadata.h | ||
FText GetSizesPresentAsText () |
Returns what size information is present in FCookMetadataPluginEntry. | CookMetadata.h | |
bool IsValid() |
CookMetadata.h | ||
bool ReadFromFile
(
const FString& FilePath |
CookMetadata.h | ||
void Reset() |
CookMetadata.h | ||
bool SaveToFile
(
const FString& FilePath |
CookMetadata.h | ||
bool Serialize
(
FArchive& Ar |
CookMetadata.h | ||
void SetAssociatedDevelopmentAssetRegistryHash
(
uint64 InHash |
Associated DevAR Hash. | CookMetadata.h | |
void SetAssociatedDevelopmentAssetRegistryHashPostWriteback
(
uint64 InHash |
CookMetadata.h | ||
void SetHordeJobId
(
FString&& InHordeJobId |
CookMetadata.h | ||
void SetPlatformAndBuildVersion
(
const FString& InPlatform, |
CookMetadata.h | ||
void SetPluginHierarchyInfo
(
FCookMetadataPluginHierarchy&& InPluginHierarchy |
Plugin hierarchy information. | CookMetadata.h | |
void SetShaderPseudoHieararchy
(
FCookMetadataShaderPseudoHierarchy&& InHierarchy |
CookMetadata.h | ||
void SetSizesPresent
(
ECookMetadataSizesPresent InSizesPresent |
CookMetadata.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static uint64 ComputeHashOfDevelopmentAssetRegistry
(
FMemoryView InSerializedDevelopmentAssetRegistry |
CookMetadata.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FCookMetadataState & operator=
(
FCookMetadataState&& O |
CookMetadata.h | ||
FCookMetadataState & operator=
(
const FCookMetadataState& |
CookMetadata.h |