ServerOwnedObservable<T>
Defined in: src/lib/observable/types.ts:139
Server-owned observable interface. Server has R/W, clients have RO.
Extends
WritableObservable<T>.IDisposable.Disposable
Type Parameters
| Type Parameter |
|---|
T |
Properties
| Property | Modifier | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|---|
id | readonly | string | The unique identifier of this observable. | WritableObservable.id | src/lib/observable/types.ts:90 |
isDisposed | readonly | boolean | - | IDisposable.isDisposed | src/lib/disposable.ts:35 |
value | readonly | T | The current value. | WritableObservable.value | src/lib/observable/types.ts:93 |
Methods
dispose()
dispose(): void;Defined in: src/lib/disposable.ts:34
Returns
void
Inherited from
getSubscribedPlayers()
getSubscribedPlayers(): number[];Defined in: src/lib/observable/types.ts:166
Get all subscribed player IDs.
Returns
number[]
isPlayerSubscribed()
isPlayerSubscribed(playerId: number): boolean;Defined in: src/lib/observable/types.ts:161
Check if a player is subscribed.
Parameters
| Parameter | Type | Description |
|---|---|---|
playerId | number | The player's server ID |
Returns
boolean
pipe()
pipe\<U\>(source: ReadonlyObservable\<U\>, transform?: (value: U) => T): Subscription;Defined in: src/lib/observable/types.ts:111
Subscribe to another observable, updating this one when it changes. Creates a one-way binding from source to this observable.
Type Parameters
| Type Parameter |
|---|
U |
Parameters
| Parameter | Type | Description |
|---|---|---|
source | ReadonlyObservable<U> | The source observable to subscribe to |
transform? | (value: U) => T | Optional transform function |
Returns
Subscription that can be disposed to unsubscribe
Inherited from
set()
set(value: T): void;Defined in: src/lib/observable/types.ts:125
Set a new value. Subscribers are notified if value changed.
Parameters
| Parameter | Type | Description |
|---|---|---|
value | T | The new value |
Returns
void
Inherited from
subscribe()
subscribe(callback: SubscriptionCallback\<T\>): Subscription;Defined in: src/lib/observable/types.ts:101
Subscribe to value changes.
Parameters
| Parameter | Type | Description |
|---|---|---|
callback | SubscriptionCallback<T> | Function called when value changes |
Returns
Subscription that can be disposed to unsubscribe
Inherited from
subscribePlayer()
subscribePlayer(playerId: number): Subscription;Defined in: src/lib/observable/types.ts:147
Subscribe a player to receive updates. The player will receive the current value and future changes.
Parameters
| Parameter | Type | Description |
|---|---|---|
playerId | number | The player's server ID |
Returns
Subscription that can be disposed to unsubscribe the player
unsubscribePlayer()
unsubscribePlayer(playerId: number): void;Defined in: src/lib/observable/types.ts:154
Unsubscribe a player from receiving updates.
Parameters
| Parameter | Type | Description |
|---|---|---|
playerId | number | The player's server ID |
Returns
void
update()
update(updater: (current: T) => T): void;Defined in: src/lib/observable/types.ts:132
Update the value using a function.
Parameters
| Parameter | Type | Description |
|---|---|---|
updater | (current: T) => T | Function that receives current value and returns new value |
Returns
void