Class
DataStoreSetOptions
NotReplicated
Specifies additional parameters for a GlobalDataStore:SetAsync() call.
An object that specifies additional parameters for a
GlobalDataStore:SetAsync() call.
See also:
- Data Stores, an in-depth guide on data structure, management, error handling, etc.
Methods 2#
| GetMetadata | Gets the custom metadata set with this DataStoreSetOptions
instance. |
| SetMetadata | Sets custom metadata to be associated with the key. |
GetMetadata(): Dictionary#
This function gets custom metadata associated with this
DataStoreSetOptions instance.
Returns
Dictionary— Metadata associated with thisDataStoreSetOptionsinstance.
SetMetadata(attributes: Dictionary): ()#
This function sets custom metadata used by
GlobalDataStore:SetAsync() to associate metadata with a key.
Metadata should be in key-value pair form.
| Name | Type | Default | Description |
|---|---|---|---|
attributes | Dictionary | Metadata values to set for the key. |
Returns
()
Inherited members#
Inherited from Instance 58
Properties (10)
Archivable, archivable, Capabilities, IsInSandbox, Name, Parent, PredictionMode, RobloxLocked, Sandboxed, UniqueId
Methods (39)
AddTag, children, ClearAllChildren, Clone, clone, Destroy, destroy, FindFirstAncestor, FindFirstAncestorOfClass, FindFirstAncestorWhichIsA, FindFirstChild, findFirstChild, FindFirstChildOfClass, FindFirstChildWhichIsA, FindFirstDescendant, GetActor, GetAttribute, GetAttributeChangedSignal, GetAttributes, GetChildren, getChildren, GetDebugId, GetDescendants, GetFullName, GetStyled, GetStyledPropertyChangedSignal, GetTags, HasTag, IsAncestorOf, IsDescendantOf, isDescendantOf, IsPropertyModified, QueryDescendants, Remove, remove, RemoveTag, ResetPropertyToDefault, SetAttribute, WaitForChild