Class ObjectSet

A specialised Set for managing GameObjects with tag-based lookups.

Hierarchy

Set<default>
- ObjectSet

Index

Constructors

Properties

[toStringTag] size [species]

Methods

[iterator] add clear delete entries findAll forEach has keys values

Constructors

constructor

new ObjectSet(values?: readonly default[] | null): ObjectSet
Parameters
- Optionalvalues: readonly default[] | null
Returns ObjectSet
Inherited from Set<GameObject>.constructor
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:116
new ObjectSet(iterable?: Iterable<default, any, any> | null): ObjectSet
Parameters
- Optionaliterable: Iterable<default, any, any> | null
Returns ObjectSet
Inherited from Set<GameObject>.constructor
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:116

Properties

`Readonly`[toStringTag]

"[toStringTag]": string

`Readonly`size

size: number

Returns

the number of (unique) elements in Set.

`Static` `Readonly`[species]

"[species]": SetConstructor

Methods

[iterator]

"[iterator]"(): SetIterator<default>
Iterates over values in the set.

Returns SetIterator<default>
Inherited from Set.[iterator]
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:198

add

add(value: default): this
Appends a new element with a specified value to the end of the Set.
Parameters
- value: default
Returns this
Inherited from Set.add
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:93

clear

clear(): void
Returns void
Inherited from Set.clear
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:95

delete

delete(value: default): boolean
Removes a specified value from the Set.
Parameters
- value: default
Returns boolean
Returns true if an element in the Set existed and has been removed, or false if the element does not exist.
Inherited from Set.delete
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:100

entries

entries(): SetIterator<[default, default]>
Returns an iterable of [v,v] pairs for every value v in the set.

Returns SetIterator<[default, default]>
Inherited from Set.entries
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:203

findAll

findAll(tag?: string): default[]
Finds all objects with a specific tag.
Parameters
- Optionaltag: string
  The tag to filter by. If omitted, returns all objects.
Returns default[]
- Defined in packages/dino-ge/src/core/ObjectSet.ts:11

forEach

forEach(
callbackfn: (value: default, value2: default, set: Set<default>) => void,
thisArg?: any,
): void
Executes a provided function once per each value in the Set object, in insertion order.
Parameters
- callbackfn: (value: default, value2: default, set: Set<default>) => void
- OptionalthisArg: any
Returns void
Inherited from Set.forEach
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:104

has

has(value: default): boolean
Parameters
- value: default
Returns boolean
a boolean indicating whether an element with the specified value exists in the Set or not.
Inherited from Set.has
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:108

keys

keys(): SetIterator<default>
Despite its name, returns an iterable of the values in the set.

Returns SetIterator<default>
Inherited from Set.keys
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:208

values

values(): SetIterator<default>
Returns an iterable of values in the set.

Returns SetIterator<default>
Inherited from Set.values
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:213