ConfigSnapshot¶
Not yet Class NotCreatable NotReplicated
A snapshot of configuration values at a given version. Can be player-specific.
Not implemented yet
This class exists in the current Roblox API but is not implemented in Nova yet. Scripts that reference it will fail at runtime.
0 Nova members · 12 modern Roblox members not implemented yet
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.
Inheritance¶
Object → ConfigSnapshot
Properties¶
| Member | Signature | Summary |
|---|---|---|
Error |
Error: ConfigSnapshotErrorState |
Populated if snapshot was in an error state. |
Outdated |
Outdated: bool |
If true, indicates the snapshot is outdated and can be refreshed to newer values. |
Methods¶
| Member | Signature | Summary |
|---|---|---|
GetValue |
ConfigSnapshot:GetValue(key: string): Variant |
Returns the value for the given key. |
GetValueChangedSignal |
ConfigSnapshot:GetValueChangedSignal(key: string): RBXScriptSignal |
Returns a signal that fires when the value for the given key changes due to a refresh. |
Refresh |
ConfigSnapshot:Refresh(): null |
Refreshes the snapshot to the latest configuration values. |
Events¶
| Member | Signature | Summary |
|---|---|---|
UpdateAvailable |
UpdateAvailable() |
Fires when a newer version of the configuration is available. |
Roblox reference: ConfigSnapshot
Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.