Class ReplicatedSet<Element>

A Replicated Set data type.

A ReplicatedSet is a set of Serializable values. Elements can be added and removed.

Type Parameters

Element extends Serializable = Serializable

Type of elements in the Replicated Set

Hierarchy

ReplicatedSet

Implements

ReplicatedData
Iterable<Element>

Index

Constructors

constructor

Methods

Accessors

size

Constructors

constructor

new ReplicatedSet<Element>(): ReplicatedSet<Element>

Type Parameters
- Element extends Serializable = Serializable
Returns ReplicatedSet<Element>

Methods

has

has(element: Element): boolean

- Defined in src/replicated-data/set.ts:64
Does this set contain the given element?

Parameters
- element: Element
  
  The element to check
Returns boolean
True if the set contains the element

forEach

forEach(callback: replicatedentity.ReplicatedSet.ForEachCallback<Element>): void

- Defined in src/replicated-data/set.ts:80
Execute the given callback for each element.

Parameters
- callback: replicatedentity.ReplicatedSet.ForEachCallback<Element>
  
  The callback to handle each element
Returns void

[iterator]

[iterator](): Iterator<Element, any, undefined>

Implementation of Iterable.__@iterator@61
- Defined in src/replicated-data/set.ts:89
Create an iterator for this set.

Returns Iterator<Element, any, undefined>
iterator of elements

elements

elements(): Set<Element>

- Defined in src/replicated-data/set.ts:98
Get a copy of the current elements as a Set.

Returns Set<Element>
Set of elements

add

add(element: Element): ReplicatedSet<Element>

- Defined in src/replicated-data/set.ts:108
Add an element to this set.

Parameters
- element: Element
  
  The element to add
Returns ReplicatedSet<Element>
This set

addAll

addAll(elements: Iterable<Element>): ReplicatedSet<Element>

- Defined in src/replicated-data/set.ts:128
Add multiple elements to this set.

Parameters
- elements: Iterable<Element>
  
  The elements to add
Returns ReplicatedSet<Element>
This set

delete

delete(element: Element): ReplicatedSet<Element>

- Defined in src/replicated-data/set.ts:141
Remove an element from this set.

Parameters
- element: Element
  
  The element to delete
Returns ReplicatedSet<Element>
This set

clear

clear(): ReplicatedSet<Element>

- Defined in src/replicated-data/set.ts:164
Remove all elements from this set.

Returns ReplicatedSet<Element>
This set

toString

toString(): string

- Defined in src/replicated-data/set.ts:238
Returns string

Accessors

size

get size(): number

- Defined in src/replicated-data/set.ts:71
The number of elements in this set.

Returns number

Generated using TypeDoc