Skip to content

Class: GameplayTagContainer ​

Defined in: container.ts:8

Implements ​

Constructors ​

Constructor ​

ts
new GameplayTagContainer(tag?): GameplayTagContainer;

Defined in: container.ts:30

Parameters ​

tag? ​

GameplayTag

Returns ​

GameplayTagContainer

Accessors ​

emptyContainer ​

Get Signature ​

ts
get static emptyContainer(): GameplayTagContainer;

Defined in: container.ts:10

A fresh empty container. A getter (not a shared instance) so callers can never mutate a global.

Returns ​

GameplayTagContainer

Methods ​

[iterator]() ​

ts
iterator: IterableIterator<GameplayTag>;

Defined in: container.ts:301

Returns ​

IterableIterator<GameplayTag>

Implementation of ​

ts
Iterable.[iterator]

addLeafTag() ​

ts
addLeafTag(tagToAdd): boolean;

Defined in: container.ts:178

Adds a leaf tag, replacing any explicit parents it makes redundant. Returns false when a child of the tag is already present.

Parameters ​

tagToAdd ​

GameplayTag

Returns ​

boolean


addTag() ​

ts
addTag(tagToAdd): void;

Defined in: container.ts:159

Parameters ​

tagToAdd ​

GameplayTag

Returns ​

void


appendMatchingTags() ​

ts
appendMatchingTags(otherA, otherB): void;

Defined in: container.ts:151

Appends tags from otherA that hierarchically match any tag in otherB.

Parameters ​

otherA ​

GameplayTagContainer

otherB ​

GameplayTagContainer

Returns ​

void


appendTags() ​

ts
appendTags(other): void;

Defined in: container.ts:144

Parameters ​

other ​

GameplayTagContainer

Returns ​

void


createFromArray() ​

ts
static createFromArray(sourceTags): GameplayTagContainer;

Defined in: container.ts:14

Parameters ​

sourceTags ​

readonly GameplayTag[]

Returns ​

GameplayTagContainer


equals() ​

ts
equals(other): boolean;

Defined in: container.ts:36

Parameters ​

other ​

GameplayTagContainer

Returns ​

boolean


filter() ​

ts
filter(otherContainer): GameplayTagContainer;

Defined in: container.ts:116

Tags of this container that hierarchically match any tag in the other container.

Parameters ​

otherContainer ​

GameplayTagContainer

Returns ​

GameplayTagContainer


filterExact() ​

ts
filterExact(otherContainer): GameplayTagContainer;

Defined in: container.ts:128

Parameters ​

otherContainer ​

GameplayTagContainer

Returns ​

GameplayTagContainer


first() ​

ts
first(): GameplayTag;

Defined in: container.ts:280

Returns ​

GameplayTag


fromExportString() ​

ts
fromExportString(exportString): void;

Defined in: container.ts:229

Rebuilds the container from an Unreal-style export string such as (GameplayTags=("A.B","A.C")), keeping only tags registered with the manager.

Parameters ​

exportString ​

string

Returns ​

void


getByIndex() ​

ts
getByIndex(index): GameplayTag;

Defined in: container.ts:276

Parameters ​

index ​

number

Returns ​

GameplayTag


getGameplayTagArray() ​

ts
getGameplayTagArray(): GameplayTag[];

Defined in: container.ts:268

Returns ​

GameplayTag[]


getGameplayTagParents() ​

ts
getGameplayTagParents(): GameplayTagContainer;

Defined in: container.ts:101

New container holding the explicit tags plus all their implicit parents.

Returns ​

GameplayTagContainer


hasAll() ​

ts
hasAll(containerToCheck): boolean;

Defined in: container.ts:80

Parameters ​

containerToCheck ​

GameplayTagContainer

Returns ​

boolean


hasAllExact() ​

ts
hasAllExact(containerToCheck): boolean;

Defined in: container.ts:84

Parameters ​

containerToCheck ​

GameplayTagContainer

Returns ​

boolean


hasAny() ​

ts
hasAny(containerToCheck): boolean;

Defined in: container.ts:64

Parameters ​

containerToCheck ​

GameplayTagContainer

Returns ​

boolean


hasAnyExact() ​

ts
hasAnyExact(containerToCheck): boolean;

Defined in: container.ts:72

Parameters ​

containerToCheck ​

GameplayTagContainer

Returns ​

boolean


hasTag() ​

ts
hasTag(tagToCheck): boolean;

Defined in: container.ts:51

Hierarchical membership: true when the container holds the tag or any child of it.

Parameters ​

tagToCheck ​

GameplayTag

Returns ​

boolean


hasTagExact() ​

ts
hasTagExact(tagToCheck): boolean;

Defined in: container.ts:60

Parameters ​

tagToCheck ​

GameplayTag

Returns ​

boolean


isEmpty() ​

ts
isEmpty(): boolean;

Defined in: container.ts:96

Returns ​

boolean


isValid() ​

ts
isValid(): boolean;

Defined in: container.ts:92

Returns ​

boolean


isValidIndex() ​

ts
isValidIndex(index): boolean;

Defined in: container.ts:272

Parameters ​

index ​

number

Returns ​

boolean


last() ​

ts
last(): GameplayTag;

Defined in: container.ts:284

Returns ​

GameplayTag


matchesQuery() ​

ts
matchesQuery(query): boolean;

Defined in: container.ts:140

Parameters ​

query ​

GameplayTagQuery

Returns ​

boolean


num() ​

ts
num(): number;

Defined in: container.ts:88

Returns ​

number


removeTag() ​

ts
removeTag(tagToRemove): boolean;

Defined in: container.ts:200

Parameters ​

tagToRemove ​

GameplayTag

Returns ​

boolean


removeTags() ​

ts
removeTags(tagsToRemove): void;

Defined in: container.ts:213

Parameters ​

tagsToRemove ​

GameplayTagContainer

Returns ​

void


reset() ​

ts
reset(): void;

Defined in: container.ts:219

Returns ​

void


sort() ​

ts
sort(): void;

Defined in: container.ts:288

Returns ​

void


toJSON() ​

ts
toJSON(): string[];

Defined in: container.ts:297

Returns ​

string[]


toString() ​

ts
toString(): string;

Defined in: container.ts:293

Returns a string representation of an object.

Returns ​

string


toStringSimple() ​

ts
toStringSimple(quoted?): string;

Defined in: container.ts:242

Parameters ​

quoted? ​

boolean = false

Returns ​

string


toStringsMaxLen() ​

ts
toStringsMaxLen(maxLen): string[];

Defined in: container.ts:246

Parameters ​

maxLen ​

number

Returns ​

string[]