Reference API Roblox

Engine API

Website

Related

Reference API Roblox

DataStoreKeyInfo

An object specifying information about a particular version of the key.

This class is not replicated. Its interface does not cross the network boundary.
This class is not creatable. Instances of this class cannot be created with Instance.new.
Memory categoryInstances
Tags: [NotCreatable, NotReplicated]

Member index 5

HistoryMember
726CreatedTime: int64
726UpdatedTime: int64
726Version: string
489GetMetadata(): Dictionary
489GetUserIds(): Array
inherited from Instance
726Archivable: bool
726Capabilities: SecurityCapabilities
726IsInSandbox: bool
726Name: string
726Parent: Instance
726PredictionMode: PredictionMode
726Sandboxed: bool
726UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
707GetDescendants(): Instances
486GetFullName(): string
706GetStyled(name: string, selector: string?): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
698QueryDescendants(selector: string): Instances
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
726children(): Instances
726clone(): Instance
726destroy(): null
726findFirstChild(name: string, recursive: bool = false): Instance
726getChildren(): Instances
726isDescendantOf(ancestor: Instance): bool
726remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
726childAdded(child: Instance)
inherited from Object
726ClassName: string
726className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
726isA(className: string): bool
647Changed(property: string)

Removed member index 1

HistoryMember
489KeyName: string

Description

An object describing information about a particular version of the key. This is returned as the second return value by GlobalDataStore:GetAsync(), GlobalDataStore:UpdateAsync(), GlobalDataStore:IncrementAsync(), GlobalDataStore:RemoveAsync(), and DataStore:GetVersionAsync().

See also:

  • Data Stores, an in-depth guide on data structure, management, error handling, etc.

History 19

Members 5

CreatedTime

TypeDefault
int64

This property indicates the date and time the object was created, formatted as the number of milliseconds since epoch.

This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safetyReadSafe
CategoryData
Loaded/Savedfalse/true

History 3

Tags: [ReadOnly, NotReplicated]

GetMetadata

Parameters (0)
No parameters.
Returns (1)
Dictionary

This function returns the metadata associated with the latest version of the object.

Thread safetyUnsafe

History 1

GetUserIds

Parameters (0)
No parameters.
Returns (1)
Array

This function returns an array of UserIds tagged with the object.

Thread safetyUnsafe

History 1

UpdatedTime

TypeDefault
int64

This property indicates the date and time the object was last updated, formatted as the number of milliseconds since epoch.

This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safetyReadSafe
CategoryData
Loaded/Savedfalse/true

History 3

Tags: [ReadOnly, NotReplicated]

Version

TypeDefault
string

This property uniquely identifies the version of the object. It can be passed to DataStore:GetVersionAsync() or DataStore:RemoveVersionAsync() to get or remove the version respectively.

This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safetyReadSafe
CategoryData
Loaded/Savedfalse/true

History 3

Tags: [ReadOnly, NotReplicated]

Removed members 1

KeyName

TypeDefault
string
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safetyReadSafe
CategoryData
Loaded/Savedfalse/true

History 6

Tags: [ReadOnly, NotReplicated]

Settings