Skip to content

Class: GameplayTag ​

Defined in: tag.ts:8

Constructors ​

Constructor ​

ts
new GameplayTag(tagName?): GameplayTag;

Defined in: tag.ts:23

Parameters ​

tagName? ​

string = NAME_NONE

Returns ​

GameplayTag

Methods ​

equals() ​

ts
equals(other): boolean;

Defined in: tag.ts:27

Parameters ​

other ​

GameplayTag

Returns ​

boolean


getGameplayTagParents() ​

ts
getGameplayTagParents(): GameplayTagContainer;

Defined in: tag.ts:93

Returns ​

GameplayTagContainer


getSingleTagContainer() ​

ts
getSingleTagContainer(): GameplayTagContainer;

Defined in: tag.ts:85

Returns ​

GameplayTagContainer


getTagKey() ​

ts
getTagKey(): string;

Defined in: tag.ts:117

Case-insensitive comparison key, mirroring Unreal FName semantics.

Returns ​

string


getTagLeafName() ​

ts
getTagLeafName(): string;

Defined in: tag.ts:107

Returns ​

string


getTagName() ​

ts
getTagName(): string;

Defined in: tag.ts:112

Returns ​

string


isValid() ​

ts
isValid(): boolean;

Defined in: tag.ts:81

Returns ​

boolean


isValidGameplayTagString() ​

ts
static isValidGameplayTagString(tagString): boolean;

Defined in: tag.ts:13

Parameters ​

tagString ​

string

Returns ​

boolean


matchesAny() ​

ts
matchesAny(containerToCheck): boolean;

Defined in: tag.ts:65

Parameters ​

containerToCheck ​

GameplayTagContainer

Returns ​

boolean


matchesAnyExact() ​

ts
matchesAnyExact(containerToCheck): boolean;

Defined in: tag.ts:73

Parameters ​

containerToCheck ​

GameplayTagContainer

Returns ​

boolean


matchesTag() ​

ts
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() ​

ts
matchesTagDepth(tagToCheck): number;

Defined in: tag.ts:48

Number of leading tag segments shared with the other tag.

Parameters ​

tagToCheck ​

GameplayTag

Returns ​

number


matchesTagExact() ​

ts
matchesTagExact(tagToCheck): boolean;

Defined in: tag.ts:43

Parameters ​

tagToCheck ​

GameplayTag

Returns ​

boolean


parseParentTags() ​

ts
parseParentTags(uniqueParentTags): void;

Defined in: tag.ts:97

Parameters ​

uniqueParentTags ​

GameplayTag[]

Returns ​

void


requestDirectParent() ​

ts
requestDirectParent(): GameplayTag;

Defined in: tag.ts:89

Returns ​

GameplayTag


requestGameplayTag() ​

ts
static requestGameplayTag(tagName, errorIfNotFound?): GameplayTag;

Defined in: tag.ts:9

Parameters ​

tagName ​

string

errorIfNotFound? ​

boolean = true

Returns ​

GameplayTag


toJSON() ​

ts
toJSON(): string;

Defined in: tag.ts:125

Returns ​

string


toString() ​

ts
toString(): string;

Defined in: tag.ts:121

Returns ​

string


validateGameplayTagString() ​

ts
static validateGameplayTagString(tagString): GameplayTagValidationResult;

Defined in: tag.ts:17

Parameters ​

tagString ​

string

Returns ​

GameplayTagValidationResult