Navigation
Unreal Engine C++ API Reference > Runtime > CoreUObject > UObject
References
Module | CoreUObject |
Header | /Engine/Source/Runtime/CoreUObject/Public/UObject/AssetRegistryTagsContext.h |
Include | #include "UObject/AssetRegistryTagsContext.h" |
Syntax
class FAssetRegistryTagsContext
Remarks
Interface used by GetAssetRegistryTags to access the calling context data.
API Notes: CookTag functions on this class add CookTags - tags that are added only when cooking and that are added to the development AssetRegistry used for patches patches, DLC, and iterative cooking, but are removed from the runtime AssetRegistry passed into the game. CookTags can only be added when WantsCookTags() is true, calls in other Context states are ignored. All tags added with the CookTags interface have "Cook_" prepended to their names prior to being saved into the development to the asset registry.
CookType: When GetAssetRegistryTags is called for package saves during cook, the cook type is set depending on the type of cook. Cooks in Unreal can be either CookByTheBook or CookOnTheFly. If GetAssetRegistryTags was called for other reasons, the CookType is reported as unknown. CookByTheBook means that the project's packaging settings are read by the cooker and a list of all referenced packages are found and those packages are saved and packaged. CookOnTheFly means that the game is running without packaged data, and is connecting to the cooker process to request the cooked version of packages that it demands. Only the packages requested by the runtime session are cooked.
Constructors
Type | Name | Description | |
---|---|---|---|
![]() |
This is an implicit constructor to reduce the boilerplate for calling GetAssetRegistryTags. | ||
![]() |
FAssetRegistryTagsContext
(
const FAssetRegistryTagsContext& Other |
Functions
Type | Name | Description | |
---|---|---|---|
![]() |
void | AddCookTag
(
UObject::FAssetRegistryTag TagResult |
AddTag but for a cooktag. |
![]() |
void | AddTag
(
UObject::FAssetRegistryTag TagResult |
Output function: move the given tag into the results, overwriting previous result if it exists. |
![]() ![]() |
bool | ContainsCookTag
(
FName TagName |
ContainsTag but for a cooktag. |
![]() ![]() |
bool | ContainsTag
(
FName TagName |
Output function: Report whether a tag is already in the output. |
![]() ![]() |
void | EnumerateTags
(
TFunctionRef< void(const UObject::FAssetRegistryTag&)> Visitor |
Pass each tag so far reported to the context into the provided Visitor, including CookTags. |
![]() |
UObject::FAssetRegistryTag * | FindCookTag
(
FName TagName |
FindTag but for a cooktag. |
![]() |
UObject::FAssetRegistryTag & | FindOrAddCookTag
(
FName TagName, |
FindOrAddCookTag but for a cooktag. |
![]() |
UObject::FAssetRegistryTag & | FindOrAddTag
(
FName TagName, |
Output function: Add a tag if it does not already exist. |
![]() |
UObject::FAssetRegistryTag * | Output function: Find a tag in the output if it already exists. | |
![]() |
const FAssetBundleData * | ||
![]() ![]() |
EAssetRegistryTagsCaller | GetCaller () |
|
![]() ![]() |
UE::Cook::ECookingDLC | If IsCooking is true, returns whether whether the cook is for a DLC rather than base game. | |
![]() ![]() |
UE::Cook::ECookType | GetCookType () |
If IsCooking is true, returns the cook type, |
![]() ![]() |
int32 | GetNumTags () |
Return the number of tags so far reported to the context, including CookTags. |
![]() ![]() |
const UObject * | GetObject () |
|
![]() ![]() |
const ITargetPlatform * | Return the targetplatform of the save, if cooking. Null if not saving or not cooking. | |
![]() ![]() |
bool | If IsCooking is true, reports whether the cook is CookByTheBook. | |
![]() ![]() |
bool | IsCooking () |
Report whether this is a save into a target-specific cooked format. False if not saving. |
![]() ![]() |
bool | If IsCooking is true, reports whether the cook is CookByTheBook. | |
![]() ![]() |
bool | If IsCooking is true, reports whether the cook type is unknown and could be any type of cook. | |
![]() ![]() |
bool | IsFullUpdate () |
Whether all tags should be calculated, as set by the creator of the context (e.g. SavePackage). |
![]() ![]() |
bool | Return whether the package is being saved due to a procedural save. | |
![]() ![]() |
bool | IsSaving () |
Whether the call is coming from SavePackage. See functions below for determining what kind of save. |
![]() |
void | SetBundleResult
(
const FAssetBundleData* InBundleResult |
|
![]() ![]() |
bool | True if the caller wants the FAssetBundleData structure (if present) to be stored as a pointer. | |
![]() ![]() |
bool | Return whether the context is collecting cook tags. |