# ConfigSnapshot

Roblox Engine API class from Roblox Studio 0.744.0.7441077 (version-7aaa6838d36c4448).

- Inherits from, nearest first: [Object](https://rapi.sleaze.dev/classes/Object.md)
- Tags: Not creatable, Not replicated
- Memory category: Instances
- HTML page: https://rapi.sleaze.dev/classes/ConfigSnapshot/
- Roblox documentation: https://create.roblox.com/docs/reference/engine/classes/ConfigSnapshot

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

## Properties

### Error

```luau
ConfigSnapshot.Error: Enum.ConfigSnapshotErrorState
```

- Tags: Read only, Capabilities: Basic, Save only

Populated if snapshot was in an error state.

### Outdated

```luau
ConfigSnapshot.Outdated: boolean
```

- Tags: Read only, Capabilities: Basic, Save only

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

## Methods

### GetValue

```luau
ConfigSnapshot:GetValue(key: string): any
```

- Tags: Capabilities: Basic

Returns the value for the given key.

Parameters:

- `key`: Key of the configuration to get the value for.

Returns: The value of the configuration for the given key.

### GetValueChangedSignal

```luau
ConfigSnapshot:GetValueChangedSignal(key: string): RBXScriptSignal
```

- Tags: Capabilities: Basic

Returns a signal that fires when the value for the given key changes due to a refresh.

Parameters:

- `key`: Key of the configuration to get the change signal for.

Returns: A [`RBXScriptSignal`](https://rapi.sleaze.dev/index/types/RBXScriptSignal.md) that fires when the value for the given key changes upon refresh.

### Refresh

```luau
ConfigSnapshot:Refresh()
```

- Tags: Capabilities: Basic

Refreshes the snapshot to the latest configuration values.

## Events

### UpdateAvailable

```luau
ConfigSnapshot.UpdateAvailable: RBXScriptSignal<()>
```

- Tags: Capabilities: Basic

Fires when a newer version of the configuration is available.

## Inherited members

- From [Object](https://rapi.sleaze.dev/classes/Object.md): `ClassName`, `className`, `GetPropertyChangedSignal`, `IsA`, `isA`, `Changed`