Class: GameplayTag

Defined in: tag.ts:8

Constructors

Constructor

new GameplayTag(tagName?): GameplayTag;

Defined in: tag.ts:23

Parameters

tagName?

string = NAME_NONE

Returns

GameplayTag

Methods

equals()

equals(other): boolean;

Defined in: tag.ts:27

Parameters

other

GameplayTag

Returns

boolean

---

getGameplayTagParents()

getGameplayTagParents(): GameplayTagContainer;

Defined in: tag.ts:93

Returns

GameplayTagContainer

---

getSingleTagContainer()

getSingleTagContainer(): GameplayTagContainer;

Defined in: tag.ts:85

Returns

GameplayTagContainer

---

getTagKey()

getTagKey(): string;

Defined in: tag.ts:117

Case-insensitive comparison key, mirroring Unreal FName semantics.

Returns

string

---

getTagLeafName()

getTagLeafName(): string;

Defined in: tag.ts:107

Returns

string

---

getTagName()

getTagName(): string;

Defined in: tag.ts:112

Returns

string

---

isValid()

isValid(): boolean;

Defined in: tag.ts:81

Returns

boolean

---

isValidGameplayTagString()

static isValidGameplayTagString(tagString): boolean;

Defined in: tag.ts:13

Parameters

tagString

string

Returns

boolean

---

matchesAny()

matchesAny(containerToCheck): boolean;

Defined in: tag.ts:65

Parameters

containerToCheck

GameplayTagContainer

Returns

boolean

---

matchesAnyExact()

matchesAnyExact(containerToCheck): boolean;

Defined in: tag.ts:73

Parameters

containerToCheck

GameplayTagContainer

Returns

boolean

---

matchesTag()

matchesTag(tagToCheck): boolean;

Defined in: tag.ts:32

Hierarchical match: "A.B.C" matches "A.B" and "A.B.C", but not "A.B.C.D".

Parameters

tagToCheck

GameplayTag

Returns

boolean

---

matchesTagDepth()

matchesTagDepth(tagToCheck): number;

Defined in: tag.ts:48

Number of leading tag segments shared with the other tag.

Parameters

tagToCheck

GameplayTag

Returns

number

---

matchesTagExact()

matchesTagExact(tagToCheck): boolean;

Defined in: tag.ts:43

Parameters

tagToCheck

GameplayTag

Returns

boolean

---

parseParentTags()

parseParentTags(uniqueParentTags): void;

Defined in: tag.ts:97

Parameters

uniqueParentTags

GameplayTag[]

Returns

void

---

requestDirectParent()

requestDirectParent(): GameplayTag;

Defined in: tag.ts:89

Returns

GameplayTag

---

requestGameplayTag()

static requestGameplayTag(tagName, errorIfNotFound?): GameplayTag;

Defined in: tag.ts:9

Parameters

tagName

string

errorIfNotFound?

boolean = true

Returns

GameplayTag

---

toJSON()

toJSON(): string;

Defined in: tag.ts:125

Returns

string

---

toString()

toString(): string;

Defined in: tag.ts:121

Returns

string

---

validateGameplayTagString()

static validateGameplayTagString(tagString): GameplayTagValidationResult;

Defined in: tag.ts:17

Parameters

tagString

string

Returns

GameplayTagValidationResult