SharedObservableOptions<T>
Defined in: src/lib/observable/shared.ts:29
Options for shared observables with conflict resolution.
Extends
Type Parameters
| Type Parameter |
|---|
T |
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
broadcast? | boolean | If true, all connected players are automatically subscribed. If false (default), players must be manually subscribed. Default false | ObservableOptions.broadcast | src/lib/observable/types.ts:63 |
conflictResolution? | | "last-write-wins" | "server-wins" | "client-wins" | ConflictResolver<T> | Conflict resolution strategy. - "last-write-wins": Latest timestamp wins (default) - "server-wins": Server always overrides client - "client-wins": Client always overrides server - custom function: (serverValue, clientValue, serverTimestamp, clientTimestamp) => resolvedValue Default "last-write-wins" | - | src/lib/observable/shared.ts:39 |
equals? | (a: T, b: T) => boolean | Custom equality function to determine if value has changed. Defaults to strict equality (===). | SyncedObservableOptions.equals | src/lib/observable/types.ts:73 |
id | string | Unique identifier for this observable. Used for RPC event naming and debugging. Format: "moduleName:observableName" | ObservableOptions.id | src/lib/observable/types.ts:50 |
initialValue | T | Initial value of the observable. | SyncedObservableOptions.initialValue | src/lib/observable/types.ts:55 |
noResponse? | boolean | If true, use fire-and-forget mode for sync updates. Faster but no guarantee of delivery. Default true | SyncedObservableOptions.noResponse | src/lib/observable/types.ts:257 |
perPlayer? | boolean | If true, this observable is per-player (each player has their own value). - On server: Multiple instances can exist with the same base ID. Use subscribePlayer(playerId) to subscribe and sync to a specific player. - On client: The observable automatically receives values sent to this client. No need to know the player's server ID. The sync event name uses the base ID (without player ID suffix), and FiveM's emitNet targets the specific player. Default false | SyncedObservableOptions.perPlayer | src/lib/observable/types.ts:272 |
syncDebounceMs? | number | Debounce sync updates by this many milliseconds. Useful for frequently changing values. Default 0 (no debounce) | ObservableOptions.syncDebounceMs | src/lib/observable/types.ts:81 |