ConfigSnapshot
A snapshot of configuration values at a given version. Can be player-specific.
| Memory category | Instances |
|---|
Member index 6
| History | Member | |
|---|---|---|
| 726 | Error: ConfigSnapshotErrorState | |
| 726 | Outdated: bool | |
| 691 | GetValue(key: string): Variant | |
| 666 | GetValueChangedSignal(key: string): RBXScriptSignal | |
| 666 | Refresh(): null | |
| 666 | UpdateAvailable() | |
| inherited from Object | ||
| 726 | ClassName: string | |
| 726 | className: string | |
| 647 | GetPropertyChangedSignal(property: string): RBXScriptSignal | |
| 647 | IsA(className: string): bool | |
| 726 | isA(className: string): bool | |
| 647 | Changed(property: string) | |
Description
An object with the configuration values at a specific version. A snapshot can be targeted to a single player to apply experimentation values. This is returned by ConfigService:GetConfigAsync() and ConfigService:GetConfigForPlayerAsync().
For more information, see Experience configs.
History 10
- 726 Change Default of Outdated from to
- 726 Change Default of Error from to
- 691 Change Parameters of GetValue from (key: string, defaultValue: Variant) to (key: string)
- 666 Add UpdateAvailable
- 666 Add Refresh
- 666 Add GetValueChangedSignal
- 666 Add GetValue
- 666 Add Outdated
- 666 Add Error
- 666 Add ConfigSnapshot
Members 6
Error
| Type | Default | |
|---|---|---|
| ConfigSnapshotErrorState | ||
Populated if snapshot was in an error state.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | false/true |
GetValue
| Parameters (1) | ||
|---|---|---|
| key | string | |
| Returns (1) | ||
| Variant | ||
Returns the value for the provided key in the snapshot.
| Thread safety | Unsafe |
|---|
GetValueChangedSignal
| Parameters (1) | ||
|---|---|---|
| key | string | |
| Returns (1) | ||
| RBXScriptSignal | ||
Returns a signal that fires when the value for the provided key changes after calling ConfigSnapshot:Refresh().
| Thread safety | Unsafe |
|---|
History 1
Outdated
| Type | Default | |
|---|---|---|
| bool | ||
If true, indicates the snapshot is outdated and can be refreshed to newer values.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | false/true |
Refresh
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| null | ||
Refreshes the snapshot to the latest configuration values from the service. If not called, the snapshot will continue to reflect the values at the time it was created or last refreshed.
| Thread safety | Unsafe |
|---|
UpdateAvailable
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
Fires when a newer version of the configuration is available than the current snapshot. You can perform validation and/or call ConfigSnapshot:Refresh() to update to the latest values.
| Thread safety | Unsafe |
|---|
History 1
- 666 Add UpdateAvailable