ScriptSession

class ScriptSession implements Replicator

import { ScriptSession } from '@driftengine/network';

Constructor

`new`

constructor(options: ScriptSessionOptions)

Parameter	Type	Description
`options`	`ScriptSessionOptions`

Properties

Name	Type	Description
`self`readonly	`number`
`authority`readonly	`boolean`

Accessors

Name	Type	Description
`participants`get	`number`
`confirmed`get	`number`	The highest tick every participant's input has arrived for, or -1 when nothing tracks it.
`halted`get	`boolean`
`haltReason`get	`string`
`slots`get	`number`

Methods

`follow`

follow(driver: SessionStatus): this

Point this at the driver whose status a script reads.

Parameter	Type	Description
`driver`	`SessionStatus`

`replicate`

replicate(slot: number, value: number): void

Publish a value in one of this peer's slots. Out of range does nothing.

Parameter	Type	Description
`slot`	`number`
`value`	`number`

`replicated`

replicated(participant: number, slot: number): number

Read a participant's slot. Out of range answers zero, which is total and allocates nothing.

Parameter	Type	Description
`participant`	`number`
`slot`	`number`

`encode`

encode(into: Uint8Array, _tick?: number): number

Every slot, as bytes. See the header: this is its own Replicator.

Parameter	Type	Description
`into`	`Uint8Array`
`_tick?`	`number`

The tick is taken and ignored, and the parameter is written out rather than dropped: a shorter signature still satisfies the interface, and then a reader has to open authority.ts to learn that the second argument exists at all.

`apply`

apply(from: Uint8Array, _tick?: number): void

Parameter	Type	Description
`from`	`Uint8Array`
`_tick?`	`number`