Skip to content
Roblox API Reference

ConfigSnapshot

A snapshot of configuration values at a given version. Can be player-specific.
  • Not creatable
  • Not replicated
Memory category
Instances
Own members
6
Inherited members
6
Subclasses
0
Siblings
30

Properties4

Inherited fromObject2

Property categoryData

Defined byConfigSnapshot2

Property categoryData

  • ConfigSnapshot.Error: Enum.ConfigSnapshotErrorState
    Populated if snapshot was in an error state.
    • Read only
    • Capabilities: Basic
    • Save only
  • ConfigSnapshot.Outdated: boolean
    If true, indicates the snapshot is outdated and can be refreshed to newer values.
    • Read only
    • Capabilities: Basic
    • Save only

Methods6

Inherited fromObject3
  • Object:GetPropertyChangedSignal(property: string): RBXScriptSignal
    Get an event that fires when a given property of the object changes.
    Parameters
    ParameterDescription
    property: string
    The property to connect to.
    Returns
    TypeDescription
    RBXScriptSignal
    A signal that fires whenever the property changes.
  • Object:IsA(className: string): boolean
    Returns true if an object's class matches or inherits from a given class.
    • Custom Lua state
    • Thread safe
    Parameters
    ParameterDescription
    className: string
    The class against which the Object's class will be checked. Case-sensitive.
    Returns
    TypeDescription
    boolean
    Describes whether the Object's class matched or is a subclass of the given class.
  • Object:isA(className: string): boolean
    Deprecated: This deprecated function is a variant of Object:IsA() which should be used instead.
    • Deprecated
    • Custom Lua state
    Parameters
    Parameter
    className: string
    Returns
    Type
    boolean

    Use IsA instead.

Defined byConfigSnapshot3
  • ConfigSnapshot:GetValue(key: string): any
    Returns the value for the given key.
    • Capabilities: Basic
    Parameters
    ParameterDescription
    key: string
    Key of the configuration to get the value for.
    Returns
    TypeDescription
    any
    The value of the configuration for the given key.
  • ConfigSnapshot:GetValueChangedSignal(key: string): RBXScriptSignal
    Returns a signal that fires when the value for the given key changes due to a refresh.
    • Capabilities: Basic
    Parameters
    ParameterDescription
    key: string
    Key of the configuration to get the change signal for.
    Returns
    TypeDescription
    RBXScriptSignal
    A RBXScriptSignal that fires when the value for the given key changes upon refresh.
  • ConfigSnapshot:Refresh()
    Refreshes the snapshot to the latest configuration values.
    • Capabilities: Basic

Events2

Inherited fromObject1
Defined byConfigSnapshot1
  • ConfigSnapshot.UpdateAvailable: RBXScriptSignal<()>
    Fires when a newer version of the configuration is available.
    • Capabilities: Basic