Class: GameplayTagsManager

Defined in: manager.ts:57

Constructors

Constructor

new GameplayTagsManager(): GameplayTagsManager;

Returns

GameplayTagsManager

Properties

invalidTagCharacters

invalidTagCharacters: string = DEFAULT_INVALID_TAG_CHARACTERS;

Defined in: manager.ts:80

Methods

addGameplayTagRedirect()

addGameplayTagRedirect(redirect): void;

Defined in: manager.ts:666

Parameters

redirect

GameplayTagRedirect

Returns

void

---

addNativeGameplayTag()

addNativeGameplayTag(tagName, tagDevComment?): GameplayTag;

Defined in: manager.ts:198

Parameters

tagName

string

tagDevComment?

string = "(Native)"

Returns

GameplayTag

---

addTagTableRow()

addTagTableRow(
   tagRow, 
   sourceName?, 
   isRestrictedTag?): void;

Defined in: manager.ts:654

Parameters

tagRow

GameplayTagTableRow

sourceName?

string = DEFAULT_SOURCE_NAME

isRestrictedTag?

boolean = false

Returns

void

---

exportGameplayTagDictionary()

exportGameplayTagDictionary(options?): GameplayTagDictionaryExport;

Defined in: manager.ts:337

Parameters

options?

GameplayTagDictionaryExportOptions = {}

Returns

GameplayTagDictionaryExport

---

exportGameplayTagTableRows()

exportGameplayTagTableRows(): GameplayTagTableRow[];

Defined in: manager.ts:646

Returns

GameplayTagTableRow[]

---

exportRestrictedGameplayTagTableRows()

exportRestrictedGameplayTagTableRows(): RestrictedGameplayTagTableRow[];

Defined in: manager.ts:650

Returns

RestrictedGameplayTagTableRow[]

---

extractParentTags()

extractParentTags(gameplayTag, uniqueParentTags): boolean;

Defined in: manager.ts:235

Appends the tag's parents to the array, skipping duplicates. Returns true when anything was added.

Parameters

gameplayTag

GameplayTag

uniqueParentTags

GameplayTag[]

Returns

boolean

---

findGameplayTagFromPartialStringSlow()

findGameplayTagFromPartialStringSlow(partialString): GameplayTag;

Defined in: manager.ts:180

Parameters

partialString

string

Returns

GameplayTag

---

get()

static get(): GameplayTagsManager;

Defined in: manager.ts:62

The shared tag registry. Stored on globalThis under a Symbol.for key so duplicated module instances (ESM + CJS, nested installs) see one registry.

Returns

GameplayTagsManager

---

getGameplayTagRedirects()

getGameplayTagRedirects(): GameplayTagRedirect[];

Defined in: manager.ts:679

Returns

GameplayTagRedirect[]

---

getIfAllocated()

static getIfAllocated(): GameplayTagsManager | undefined;

Defined in: manager.ts:74

Returns

GameplayTagsManager | undefined

---

getTagEditorData()

getTagEditorData(tagName): 
  | GameplayTagEditorData
  | undefined;

Defined in: manager.ts:316

Parameters

tagName

string

Returns

| GameplayTagEditorData | undefined

---

importGameplayTagDictionary()

importGameplayTagDictionary(input, options?): GameplayTagDictionaryImportResult;

Defined in: manager.ts:391

Parameters

input

GameplayTagDictionaryInput

options?

GameplayTagDictionaryImportOptions = {}

Returns

GameplayTagDictionaryImportResult

---

importGameplayTagTableRows()

importGameplayTagTableRows(tagRows, sourceName?): GameplayTagDictionaryImportResult;

Defined in: manager.ts:621

Parameters

tagRows

readonly GameplayTagTableRow[]

sourceName?

string = DEFAULT_SOURCE_NAME

Returns

GameplayTagDictionaryImportResult

---

importRestrictedGameplayTagTableRows()

importRestrictedGameplayTagTableRows(tagRows, sourceName?): GameplayTagDictionaryImportResult;

Defined in: manager.ts:634

Parameters

tagRows

readonly RestrictedGameplayTagTableRow[]

sourceName?

string = DEFAULT_RESTRICTED_SOURCE_NAME

Returns

GameplayTagDictionaryImportResult

---

isDictionaryTag()

isDictionaryTag(tagName): boolean;

Defined in: manager.ts:312

True when the tag was registered explicitly (not just implied as a parent).

Parameters

tagName

string

Returns

boolean

---

isValidGameplayTagString()

isValidGameplayTagString(tagString): boolean;

Defined in: manager.ts:110

Parameters

tagString

string

Returns

boolean

---

redirectGameplayTagName()

redirectGameplayTagName(tagName): string;

Defined in: manager.ts:683

Parameters

tagName

string

Returns

string

---

requestAllGameplayTags()

requestAllGameplayTags(tagContainer, onlyIncludeDictionaryTags): void;

Defined in: manager.ts:301

Parameters

tagContainer

GameplayTagContainer

onlyIncludeDictionaryTags

boolean

Returns

void

---

requestGameplayTag()

requestGameplayTag(tagName, errorIfNotFound?): GameplayTag;

Defined in: manager.ts:96

Parameters

tagName

string

errorIfNotFound?

boolean = true

Returns

GameplayTag

---

requestGameplayTagChildren()

requestGameplayTagChildren(gameplayTag): GameplayTagContainer;

Defined in: manager.ts:250

Parameters

gameplayTag

GameplayTag

Returns

GameplayTagContainer

---

requestGameplayTagChildrenInDictionary()

requestGameplayTagChildrenInDictionary(gameplayTag): GameplayTagContainer;

Defined in: manager.ts:275

Parameters

gameplayTag

GameplayTag

Returns

GameplayTagContainer

---

requestGameplayTagContainer()

requestGameplayTagContainer(tagStrings, errorIfNotFound?): GameplayTagContainer;

Defined in: manager.ts:82

Parameters

tagStrings

readonly string[]

errorIfNotFound?

boolean = true

Returns

GameplayTagContainer

---

requestGameplayTagDirectParent()

requestGameplayTagDirectParent(gameplayTag): GameplayTag;

Defined in: manager.ts:290

Parameters

gameplayTag

GameplayTag

Returns

GameplayTag

---

requestGameplayTagParents()

requestGameplayTagParents(gameplayTag): GameplayTagContainer;

Defined in: manager.ts:217

Container holding the tag plus all of its parents.

Parameters

gameplayTag

GameplayTag

Returns

GameplayTagContainer

---

reset()

reset(): void;

Defined in: manager.ts:687

Returns

void

---

validateGameplayTagDictionary()

validateGameplayTagDictionary(input): GameplayTagDictionaryValidationResult;

Defined in: manager.ts:468

Parameters

input

GameplayTagDictionaryInput

Returns

GameplayTagDictionaryValidationResult

---

validateGameplayTagString()

validateGameplayTagString(tagString): GameplayTagValidationResult;

Defined in: manager.ts:114

Parameters

tagString

string

Returns

GameplayTagValidationResult