Skip to content

Class: GameplayTagQuery ​

Defined in: query.ts:139

Constructors ​

Constructor ​

ts
new GameplayTagQuery(): GameplayTagQuery;

Returns ​

GameplayTagQuery

Accessors ​

emptyQuery ​

Get Signature ​

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

ts
build(rootQueryExpr, userDescription?): void;

Defined in: query.ts:289

Parameters ​

rootQueryExpr ​

GameplayTagQueryExpression

userDescription? ​

string = ""

Returns ​

void


buildQuery() ​

ts
static buildQuery(rootQueryExpr, description?): GameplayTagQuery;

Defined in: query.ts:145

Parameters ​

rootQueryExpr ​

GameplayTagQueryExpression

description? ​

string = ""

Returns ​

GameplayTagQuery


clear() ​

ts
clear(): void;

Defined in: query.ts:282

Returns ​

void


clone() ​

ts
clone(): GameplayTagQuery;

Defined in: query.ts:250

Returns ​

GameplayTagQuery


equals() ​

ts
equals(other): boolean;

Defined in: query.ts:260

Parameters ​

other ​

GameplayTagQueryInput

Returns ​

boolean


fromJSON() ​

ts
static fromJSON(input): GameplayTagQuery;

Defined in: query.ts:204

Parameters ​

input ​

GameplayTagQueryInput

Returns ​

GameplayTagQuery


getDescription() ​

ts
getDescription(): string;

Defined in: query.ts:305

Returns ​

string


getGameplayTagArray() ​

ts
getGameplayTagArray(): GameplayTag[];

Defined in: query.ts:309

Returns ​

GameplayTag[]


getQueryExpr() ​

ts
getQueryExpr(): GameplayTagQueryExpression;

Defined in: query.ts:297

Returns ​

GameplayTagQueryExpression


isEmpty() ​

ts
isEmpty(): boolean;

Defined in: query.ts:278

Returns ​

boolean


makeQueryExactMatchAllTags() ​

ts
static makeQueryExactMatchAllTags(tags): GameplayTagQuery;

Defined in: query.ts:167

Parameters ​

tags ​

GameplayTagContainer

Returns ​

GameplayTagQuery


makeQueryExactMatchAnyTags() ​

ts
static makeQueryExactMatchAnyTags(tags): GameplayTagQuery;

Defined in: query.ts:163

Parameters ​

tags ​

GameplayTagContainer

Returns ​

GameplayTagQuery


makeQueryFromFilters() ​

ts
static makeQueryFromFilters(filters): GameplayTagQuery;

Defined in: query.ts:175

Parameters ​

filters ​

GameplayTagQueryFilterInput

Returns ​

GameplayTagQuery


makeQueryMatchAllTags() ​

ts
static makeQueryMatchAllTags(tags): GameplayTagQuery;

Defined in: query.ts:155

Parameters ​

tags ​

GameplayTagContainer

Returns ​

GameplayTagQuery


makeQueryMatchAnyTags() ​

ts
static makeQueryMatchAnyTags(tags): GameplayTagQuery;

Defined in: query.ts:151

Parameters ​

tags ​

GameplayTagContainer

Returns ​

GameplayTagQuery


makeQueryMatchNoTags() ​

ts
static makeQueryMatchNoTags(tags): GameplayTagQuery;

Defined in: query.ts:159

Parameters ​

tags ​

GameplayTagContainer

Returns ​

GameplayTagQuery


makeQueryMatchTag() ​

ts
static makeQueryMatchTag(tag): GameplayTagQuery;

Defined in: query.ts:171

Parameters ​

tag ​

GameplayTag

Returns ​

GameplayTagQuery


matches() ​

ts
matches(tags): boolean;

Defined in: query.ts:270

Parameters ​

tags ​

GameplayTagContainer

Returns ​

boolean


replaceTagFast() ​

ts
replaceTagFast(tag): void;

Defined in: query.ts:242

Parameters ​

tag ​

GameplayTag

Returns ​

void


replaceTagsFast() ​

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

ts
setUserDescription(userDescription): void;

Defined in: query.ts:301

Parameters ​

userDescription ​

string

Returns ​

void


toJSON() ​

ts
toJSON(): GameplayTagQueryJson;

Defined in: query.ts:313

Returns ​

GameplayTagQueryJson