Class: GameplayTagQuery

Defined in: query.ts:139

Constructors

Constructor

new GameplayTagQuery(): GameplayTagQuery;

Returns

GameplayTagQuery

Accessors

emptyQuery

Get Signature

get static emptyQuery(): GameplayTagQuery;

Defined in: query.ts:141

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

Returns

GameplayTagQuery

Methods

build()

build(rootQueryExpr, userDescription?): void;

Defined in: query.ts:289

Parameters

rootQueryExpr

GameplayTagQueryExpression

userDescription?

string = ""

Returns

void

---

buildQuery()

static buildQuery(rootQueryExpr, description?): GameplayTagQuery;

Defined in: query.ts:145

Parameters

rootQueryExpr

GameplayTagQueryExpression

description?

string = ""

Returns

GameplayTagQuery

---

clear()

clear(): void;

Defined in: query.ts:282

Returns

void

---

clone()

clone(): GameplayTagQuery;

Defined in: query.ts:250

Returns

GameplayTagQuery

---

equals()

equals(other): boolean;

Defined in: query.ts:260

Parameters

other

GameplayTagQueryInput

Returns

boolean

---

fromJSON()

static fromJSON(input): GameplayTagQuery;

Defined in: query.ts:204

Parameters

input

GameplayTagQueryInput

Returns

GameplayTagQuery

---

getDescription()

getDescription(): string;

Defined in: query.ts:305

Returns

string

---

getGameplayTagArray()

getGameplayTagArray(): GameplayTag[];

Defined in: query.ts:309

Returns

GameplayTag[]

---

getQueryExpr()

getQueryExpr(): GameplayTagQueryExpression;

Defined in: query.ts:297

Returns

GameplayTagQueryExpression

---

isEmpty()

isEmpty(): boolean;

Defined in: query.ts:278

Returns

boolean

---

makeQueryExactMatchAllTags()

static makeQueryExactMatchAllTags(tags): GameplayTagQuery;

Defined in: query.ts:167

Parameters

tags

GameplayTagContainer

Returns

GameplayTagQuery

---

makeQueryExactMatchAnyTags()

static makeQueryExactMatchAnyTags(tags): GameplayTagQuery;

Defined in: query.ts:163

Parameters

tags

GameplayTagContainer

Returns

GameplayTagQuery

---

makeQueryFromFilters()

static makeQueryFromFilters(filters): GameplayTagQuery;

Defined in: query.ts:175

Parameters

filters

GameplayTagQueryFilterInput

Returns

GameplayTagQuery

---

makeQueryMatchAllTags()

static makeQueryMatchAllTags(tags): GameplayTagQuery;

Defined in: query.ts:155

Parameters

tags

GameplayTagContainer

Returns

GameplayTagQuery

---

makeQueryMatchAnyTags()

static makeQueryMatchAnyTags(tags): GameplayTagQuery;

Defined in: query.ts:151

Parameters

tags

GameplayTagContainer

Returns

GameplayTagQuery

---

makeQueryMatchNoTags()

static makeQueryMatchNoTags(tags): GameplayTagQuery;

Defined in: query.ts:159

Parameters

tags

GameplayTagContainer

Returns

GameplayTagQuery

---

makeQueryMatchTag()

static makeQueryMatchTag(tag): GameplayTagQuery;

Defined in: query.ts:171

Parameters

tag

GameplayTag

Returns

GameplayTagQuery

---

matches()

matches(tags): boolean;

Defined in: query.ts:270

Parameters

tags

GameplayTagContainer

Returns

boolean

---

replaceTagFast()

replaceTagFast(tag): void;

Defined in: query.ts:242

Parameters

tag

GameplayTag

Returns

void

---

replaceTagsFast()

replaceTagsFast(tags): void;

Defined in: query.ts:218

Swaps every tag in the query for the given tags, keeping the expression shape. The nth tag of the query dictionary is replaced by the nth given tag everywhere it occurs in the expression tree.

Parameters

tags

GameplayTagContainer

Returns

void

---

setUserDescription()

setUserDescription(userDescription): void;

Defined in: query.ts:301

Parameters

userDescription

string

Returns

void

---

toJSON()

toJSON(): GameplayTagQueryJson;

Defined in: query.ts:313

Returns

GameplayTagQueryJson