ClientOwnedObservable<T>
Defined in: src/lib/observable/types.ts:173
Client-owned observable interface. Client has R/W, server has 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
getAllPlayerValues()
getAllPlayerValues(): Map<number, T>;Defined in: src/lib/observable/types.ts:193
Get all player values (server-side only).
Returns
Map<number, T>
Map of player IDs to their values
Throws
Error if called on client
getPlayerValue()
getPlayerValue(playerId: number): T | undefined;Defined in: src/lib/observable/types.ts:185
Get the value for a specific player (server-side only). Each client has their own value stored on the server.
Parameters
| Parameter | Type | Description |
|---|---|---|
playerId | number | The player's server ID |
Returns
T | undefined
The player's value, or undefined if not subscribed
Throws
Error if called on client
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
subscribeToPlayer()
subscribeToPlayer(playerId: number, callback: SubscriptionCallback\<T\>): Subscription;Defined in: src/lib/observable/types.ts:203
Subscribe to a specific player's value changes (server-side only).
Parameters
| Parameter | Type | Description |
|---|---|---|
playerId | number | The player's server ID |
callback | SubscriptionCallback<T> | Function called when the player's value changes |
Returns
Subscription that can be disposed
Throws
Error if called on client
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