FGameplayTagRegistry
- Module
- Core
- Header
#include "Core/GameplayTagContainer.h"- Namespace
Mowo
Public functions
| Returns | Name | Description |
|---|---|---|
FGameplayTagRegistry& | Get | |
FGameplayTag | AddNativeTag | Declares a tag (and every parent of it). |
uint32_t | LoadFromIni | Reads [/Script/GameplayTags.GameplayTagsSettings] from an INI already combined (GameplayTagList and GameplayTagRedirects). |
uint32_t | LoadForProject | The GameplayTags INI hierarchy of a project (BaseGameplayTags.ini under Engine/Config, DefaultGameplayTags.ini under the project's Config). |
void | AddRedirect | |
FGameplayTag | Request | The tag for path, following redirects. |
bool | IsDeclared | |
std::vector<std::string> | GetAllTags | |
std::vector<std::string> | GetUndeclaredRequests | |
std::string | GetComment | |
uint16_t | GetNetIndex | Index into the sorted declared-tag list, 1-based (0 = not declared). |
FGameplayTag | FromNetIndex | |
void | GetParents | Every proper ancestor of tag, nearest first ("A.B.C" -> "A.B", "A"). |
void | Reset |
Function details
Get
static FGameplayTagRegistry& Get()AddNativeTag
FGameplayTag AddNativeTag(std::string_view path, const char* comment = nullptr)Declares a tag (and every parent of it). Returns the tag.
LoadFromIni
uint32_t LoadFromIni(const FConfigIniFile& ini)Reads [/Script/GameplayTags.GameplayTagsSettings] from an INI already combined (GameplayTagList and GameplayTagRedirects). Returns the number of tags declared by it.
LoadForProject
uint32_t LoadForProject(const std::filesystem::path& projectConfigDir)The GameplayTags INI hierarchy of a project (BaseGameplayTags.ini under Engine/Config, DefaultGameplayTags.ini under the project's Config).
AddRedirect
void AddRedirect(std::string_view oldPath, std::string_view newPath)Request
FGameplayTag Request(std::string_view path)The tag for path, following redirects. An undeclared path still returns a valid tag (content must keep loading), but is recorded and counted, so the editor can list typos.
IsDeclared
bool IsDeclared(FGameplayTag tag) constGetAllTags
std::vector<std::string> GetAllTags() constGetUndeclaredRequests
std::vector<std::string> GetUndeclaredRequests() constGetComment
std::string GetComment(FGameplayTag tag) constGetNetIndex
uint16_t GetNetIndex(FGameplayTag tag) constIndex into the sorted declared-tag list, 1-based (0 = not declared). Both ends of a session build the list from the same config, so the index is a 16-bit stand-in for the whole path on the wire.
FromNetIndex
FGameplayTag FromNetIndex(uint16_t index) constGetParents
static void GetParents(FGameplayTag tag, std::vector<FGameplayTag>& out)Every proper ancestor of tag, nearest first ("A.B.C" -> "A.B", "A").
Reset
void Reset()