DataStoreSetOptions

Show Deprecated
Not Replicated

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.

Summary

Properties

Events

Methods

GetMetadata(): table  

Gets the custom metadata set with this DataStoreSetOptions instance.

SetMetadata(attributes: table): void  

Sets custom metadata to be associated with the key.

Properties

Events

Methods

GetMetadata

table

This function gets custom metadata associated with this DataStoreSetOptions instance.


Returns

table

Metadata associated with this DataStoreSetOptions instance.

SetMetadata

void

This function sets custom metadata used by GlobalDataStore:SetAsync() to associate metadata with a key. Metadata should be in key-value pair form.

Parameters

attributes: table

Metadata values to set for the key.


Returns

void

No returns.