Reference API Roblox

Engine API

Website

Related

Reference API Roblox

ConfigSnapshot

A snapshot of configuration values at a given version. Can be player-specific.

This class is not replicated. Its interface does not cross the network boundary.
This class is not creatable. Instances of this class cannot be created with Instance.new.
Memory categoryInstances
Tags: [NotCreatable, NotReplicated]

Member index 6

HistoryMember
666Error: ConfigSnapshotErrorState
666Outdated: bool
691GetValue(key: string): Variant
666GetValueChangedSignal(key: string): RBXScriptSignal
666Refresh(): null
666UpdateAvailable()
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(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 8

Members 6

Error

TypeDefault
ConfigSnapshotErrorState

Populated if snapshot was in an error state.

This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safetyReadSafe
CategoryData
Loaded/Savedfalse/true

History 1

Tags: [ReadOnly, NotReplicated]

GetValue

Parameters (1)
keystring
Returns (1)
Variant

Returns the value for the provided key in the snapshot.

Thread safetyUnsafe

History 2

GetValueChangedSignal

Parameters (1)
keystring
Returns (1)
RBXScriptSignal

Returns a signal that fires when the value for the provided key changes after calling ConfigSnapshot:Refresh().

Thread safetyUnsafe

History 1

Outdated

TypeDefault
bool

If true, indicates the snapshot is outdated and can be refreshed to newer values.

This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safetyReadSafe
CategoryData
Loaded/Savedfalse/true

History 1

Tags: [ReadOnly, NotReplicated]

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 safetyUnsafe

History 1

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 safetyUnsafe

History 1

Settings