mirror of
https://github.com/rojo-rbx/rojo.git
synced 2026-10-23 22:11:38 +00:00
152 lines
4.2 KiB
YAML
152 lines
4.2 KiB
YAML
# This file is automatically generated. Please don't edit it manually.
|
|
# To submit a bug report on the content, see
|
|
# https://devforum.roblox.com/c/bug-reports/documentation-issues/72
|
|
|
|
name: ConfigSnapshot
|
|
type: class
|
|
memory_category: Instances
|
|
summary: |
|
|
A snapshot of configuration values at a given version. Can be player-specific.
|
|
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 `Class.ConfigService:GetConfigAsync()` and
|
|
`Class.ConfigService:GetConfigForPlayerAsync()`.
|
|
|
|
For more information, see
|
|
[Experience configs](../../../production/configs.md).
|
|
code_samples: []
|
|
inherits:
|
|
- Object
|
|
descendants: []
|
|
tags:
|
|
- NotCreatable
|
|
- NotReplicated
|
|
deprecation_message: ''
|
|
properties:
|
|
- name: ConfigSnapshot.Error
|
|
summary: |
|
|
Populated if snapshot was in an error state.
|
|
description: |
|
|
Populated if snapshot was in an error state.
|
|
code_samples: []
|
|
type: ConfigSnapshotErrorState
|
|
tags:
|
|
- ReadOnly
|
|
- NotReplicated
|
|
deprecation_message: ''
|
|
security:
|
|
read: None
|
|
write: None
|
|
thread_safety: ReadSafe
|
|
category: Data
|
|
serialization:
|
|
can_load: false
|
|
can_save: true
|
|
capabilities:
|
|
- Basic
|
|
- name: ConfigSnapshot.Outdated
|
|
summary: |
|
|
If true, indicates the snapshot is outdated and can be refreshed to newer
|
|
values.
|
|
description: |
|
|
If true, indicates the snapshot is outdated and can be refreshed to newer
|
|
values.
|
|
code_samples: []
|
|
type: boolean
|
|
tags:
|
|
- ReadOnly
|
|
- NotReplicated
|
|
deprecation_message: ''
|
|
security:
|
|
read: None
|
|
write: None
|
|
thread_safety: ReadSafe
|
|
category: Data
|
|
serialization:
|
|
can_load: false
|
|
can_save: true
|
|
capabilities:
|
|
- Basic
|
|
methods:
|
|
- name: ConfigSnapshot:GetValue
|
|
summary: |
|
|
Returns the value for the given key.
|
|
description: |
|
|
Returns the value for the provided key in the snapshot.
|
|
code_samples: []
|
|
parameters:
|
|
- name: key
|
|
type: string
|
|
default:
|
|
summary: |
|
|
Key of the configuration to get the value for.
|
|
returns:
|
|
- type: Variant
|
|
summary: |
|
|
The value of the configuration for the given key.
|
|
tags: []
|
|
deprecation_message: ''
|
|
security: None
|
|
thread_safety: Unsafe
|
|
capabilities:
|
|
- Basic
|
|
- name: ConfigSnapshot:GetValueChangedSignal
|
|
summary: |
|
|
Returns a signal that fires when the value for the given key changes due
|
|
to a refresh.
|
|
description: |
|
|
Returns a signal that fires when the value for the provided key changes
|
|
after calling `Class.ConfigSnapshot:Refresh()`.
|
|
code_samples: []
|
|
parameters:
|
|
- name: key
|
|
type: string
|
|
default:
|
|
summary: |
|
|
Key of the configuration to get the change signal for.
|
|
returns:
|
|
- type: RBXScriptSignal
|
|
summary: |
|
|
A `DataType.RBXScriptSignal` that fires when the value for the given
|
|
key changes upon refresh.
|
|
tags: []
|
|
deprecation_message: ''
|
|
security: None
|
|
thread_safety: Unsafe
|
|
capabilities:
|
|
- Basic
|
|
- name: ConfigSnapshot:Refresh
|
|
summary: |
|
|
Refreshes the snapshot to the latest configuration values.
|
|
description: |
|
|
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.
|
|
code_samples: []
|
|
parameters: []
|
|
returns:
|
|
- type: ()
|
|
summary: ''
|
|
tags: []
|
|
deprecation_message: ''
|
|
security: None
|
|
thread_safety: Unsafe
|
|
capabilities:
|
|
- Basic
|
|
events:
|
|
- name: ConfigSnapshot.UpdateAvailable
|
|
summary: |
|
|
Fires when a newer version of the configuration is available.
|
|
description: |
|
|
Fires when a newer version of the configuration is available than the
|
|
current snapshot. You can perform validation and/or call
|
|
`Class.ConfigSnapshot:Refresh()` to update to the latest values.
|
|
code_samples: []
|
|
parameters: []
|
|
tags: []
|
|
deprecation_message: ''
|
|
security: None
|
|
capabilities:
|
|
- Basic
|
|
callbacks: []
|