--- name: ConfigService last_updated: 2026-06-11T23:11:56Z inherits: - Instance - Object type: class memory_category: Instances tags: - NotCreatable - Service - NotReplicated summary: "A game service that gives access to in-experience configuration with updates in real time." --- # Class: ConfigService > A game service that gives access to in-experience configuration with updates > in real time. ## Description **ConfigService** exposes methods for getting [ConfigSnapshot](/docs/reference/engine/classes/ConfigSnapshot.md) objects. Configs can only be accessed by game servers, so you can't use [ConfigService](/docs/reference/engine/classes/ConfigService.md) within client scripts. See [Experience configs](/docs/en-us/production/configs.md) for an in-depth guide on managing keys, deploying real-time updates, error handling, limits, and more. ## Methods ### Method: ConfigService:ClearTestingValue **Signature:** `ConfigService:ClearTestingValue(key: string): ()` Removes a testing override created by the [SetTestingValue()](/docs/reference/engine/classes/ConfigService.md) function. The actual configured value will be returned after calling this function. *Security: None · Thread Safety: Unsafe* **Parameters:** | Name | Type | Default | Description | |------|------|---------|-------------| | `key` | `string` | | Key of the configuration to clear testing value for. | **Returns:** `()` ### Method: ConfigService:GetConfigAsync **Signature:** `ConfigService:GetConfigAsync(): ConfigSnapshot` This function retrieves the latest available configuration as a [ConfigSnapshot](/docs/reference/engine/classes/ConfigSnapshot.md) instance without player targeting. Snapshots can be refreshed to the latest values by calling [ConfigSnapshot:Refresh()](/docs/reference/engine/classes/ConfigSnapshot.md). Experiments are not applied since there is no player context. If configuration fails to load and there is no previously available configuration, this function throws an error. *Yields · Security: None · Thread Safety: Unsafe* **Returns:** `ConfigSnapshot` — A [ConfigSnapshot](/docs/reference/engine/classes/ConfigSnapshot.md) instance with the latest configuration. ### Method: ConfigService:GetConfigForPlayerAsync **Signature:** `ConfigService:GetConfigForPlayerAsync(player: Player): ConfigSnapshot` Retrieves the latest available configuration as a [ConfigSnapshot](/docs/reference/engine/classes/ConfigSnapshot.md) instance targeting to the given player. Snapshots can be refreshed to the latest values by calling [ConfigSnapshot:Refresh()](/docs/reference/engine/classes/ConfigSnapshot.md). This function applies all experiments running for the player. If configuration fails to load and there is no previously available configuration, this function throws an error. *Yields · Security: None · Thread Safety: Unsafe* **Parameters:** | Name | Type | Default | Description | |------|------|---------|-------------| | `player` | `Player` | | The player to get the configuration for. | **Returns:** `ConfigSnapshot` — A [ConfigSnapshot](/docs/reference/engine/classes/ConfigSnapshot.md) instance with the latest configuration targeted to the player. ### Method: ConfigService:SetTestingValue **Signature:** `ConfigService:SetTestingValue(key: string, value: Variant): ()` Sets a testing override for the specified configuration key in the current server instance. When a testing value is set, calls to [ConfigSnapshot:GetValue()](/docs/reference/engine/classes/ConfigSnapshot.md) for that key will return the testing value instead of the actual configured value. Testing values can be cleared by calling the [ClearTestingValue()](/docs/reference/engine/classes/ConfigService.md) function. *Security: None · Thread Safety: Unsafe* **Parameters:** | Name | Type | Default | Description | |------|------|---------|-------------| | `key` | `string` | | Key of the configuration to override with a testing value. | | `value` | `Variant` | | Value to set as the testing override. | **Returns:** `()` ## Inherited Members ### From [Instance](/docs/reference/engine/classes/Instance.md) - **Property `Archivable`** (`boolean`): Determines if an Instance and its descendants can be cloned using - **Property `archivable`** (`boolean`): *(deprecated, hidden)* - **Property `Capabilities`** (`SecurityCapabilities`): The set of capabilities allowed to be used for scripts inside this - **Property `Name`** (`string`): A non-unique identifier of the Instance. - **Property `Parent`** (`Instance`): Determines the hierarchical parent of the Instance. - **Property `PredictionMode`** (`PredictionMode`): - **Property `RobloxLocked`** (`boolean`): A deprecated property that used to protect CoreGui objects. *(hidden)* - **Property `Sandboxed`** (`boolean`): When enabled, the instance can only access abilities in its `Capabilities` - **Property `UniqueId`** (`UniqueId`): A unique identifier for the instance. - **Method `AddTag(tag: string): ()`**: Applies a tag to the instance. - **Method `children(): Instances`**: Returns an array of the object's children. *(deprecated)* - **Method `ClearAllChildren(): ()`**: This method destroys all of an instance's children. - **Method `Clone(): Instance`**: Create a copy of an instance and all its descendants, ignoring instances - **Method `clone(): Instance`**: *(deprecated)* - **Method `Destroy(): ()`**: Sets the Instance.Parent property to `nil`, locks the - **Method `destroy(): ()`**: *(deprecated)* - **Method `FindFirstAncestor(name: string): Instance?`**: Returns the first ancestor of the Instance whose - **Method `FindFirstAncestorOfClass(className: string): Instance?`**: Returns the first ancestor of the Instance whose - **Method `FindFirstAncestorWhichIsA(className: string): Instance?`**: Returns the first ancestor of the Instance for whom - **Method `FindFirstChild(name: string, recursive?: boolean): Instance?`**: Returns the first child of the Instance found with the given name. - **Method `findFirstChild(name: string, recursive?: boolean): Instance`**: *(deprecated)* - **Method `FindFirstChildOfClass(className: string): Instance?`**: Returns the first child of the Instance whose - **Method `FindFirstChildWhichIsA(className: string, recursive?: boolean): Instance?`**: Returns the first child of the Instance for whom - **Method `FindFirstDescendant(name: string): Instance?`**: Returns the first descendant found with the given Instance.Name. - **Method `GetActor(): Actor?`**: Returns the Actor associated with the Instance, if any. - **Method `GetAttribute(attribute: string): Variant`**: Returns the value which has been assigned to the given attribute name. - **Method `GetAttributeChangedSignal(attribute: string): RBXScriptSignal`**: Returns an event that fires when the given attribute changes. - **Method `GetAttributes(): Dictionary`**: Returns a dictionary of the instance's attributes. - **Method `GetChildren(): Instances`**: Returns an array containing all of the instance's children. - **Method `getChildren(): Instances`**: *(deprecated)* - **Method `GetDebugId(scopeLength?: int): string`**: Returns a coded string of the debug ID used internally by Roblox. - **Method `GetDescendants(): Instances`**: Returns an array containing all of the descendants of the instance. - **Method `GetFullName(): string`**: Returns a string describing the instance's ancestry. - **Method `GetStyled(name: string, selector: string?): Variant`**: Returns the styled or explicitly modified value of the specified property, - **Method `GetStyledPropertyChangedSignal(property: string): RBXScriptSignal`**: - **Method `GetTags(): Array`**: Gets an array of all tags applied to the instance. - **Method `HasTag(tag: string): boolean`**: Check whether the instance has a given tag. - **Method `IsAncestorOf(descendant: Instance): boolean`**: Returns true if an Instance is an ancestor of the given - **Method `IsDescendantOf(ancestor: Instance): boolean`**: Returns `true` if an Instance is a descendant of the given - **Method `isDescendantOf(ancestor: Instance): boolean`**: *(deprecated)* - **Method `IsPropertyModified(property: string): boolean`**: Returns `true` if the value stored in the specified property is not equal - **Method `QueryDescendants(selector: string): Instances`**: Returns an array containing all descendants of the instance that match the - **Method `Remove(): ()`**: Sets the object's `Parent` to `nil`, and does the same for all its *(deprecated)* - **Method `remove(): ()`**: *(deprecated)* - **Method `RemoveTag(tag: string): ()`**: Removes a tag from the instance. - **Method `ResetPropertyToDefault(property: string): ()`**: Resets a property to its default value. - **Method `SetAttribute(attribute: string, value: Variant): ()`**: Sets the attribute with the given name to the given value. - **Method `WaitForChild(childName: string, timeOut: double): Instance`**: Returns the child of the Instance with the given name. If the - **Event `AncestryChanged`**: Fires when the Instance.Parent property of this object or one of - **Event `AttributeChanged`**: Fires whenever an attribute is changed on the Instance. - **Event `ChildAdded`**: Fires after an object is parented to this Instance. - **Event `childAdded`**: *(deprecated)* - **Event `ChildRemoved`**: Fires after a child is removed from this Instance. - **Event `DescendantAdded`**: Fires after a descendant is added to the Instance. - **Event `DescendantRemoving`**: Fires immediately before a descendant of the Instance is removed. - **Event `Destroying`**: Fires immediately before (or is deferred until after) the instance is - **Event `StyledPropertiesChanged`**: Fires whenever any style property is changed on the instance, including ### From [Object](/docs/reference/engine/classes/Object.md) - **Property `ClassName`** (`string`): A read-only string representing the class this Object belongs to. - **Property `className`** (`string`): *(deprecated)* - **Method `GetPropertyChangedSignal(property: string): RBXScriptSignal`**: Get an event that fires when a given property of the object changes. - **Method `IsA(className: string): boolean`**: Returns true if an object's class matches or inherits from a given class. - **Method `isA(className: string): boolean`**: *(deprecated)* - **Event `Changed`**: Fires immediately after a property of the object changes, with some