Reference API Roblox

Engine API

Website

Related

Reference API Roblox

PlayerDataRecord

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 21

HistoryMember
661CreatedTime: int64
663DefaultRecordName: bool
661Dirty: bool
661Error: PlayerDataErrorState
661FlushedTime: int64
661LoadedTime: int64
661ModifiedTime: int64
661NewRecord: bool
661Readable: bool
663RecordName: string
661Writable: bool
661GetPlayer(): Player
661GetValue(key: string): Variant
661GetValueChangedSignal(key: string): RBXScriptSignal
665ReleaseAsync(): null
661RemoveValue(key: string): null
661RequestFlushAsync(): null
661SetValue(key: string, value: Variant): null
661Changed(key: string, value: Variant)
661Flushed(flushState: bool, error: string?)
661Loaded(success: bool, error: string?)
inherited from Instance
553Archivable: bool
635Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: 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
486GetDescendants(): Array
486GetFullName(): string
641GetStyled(name: string): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

Removed member index 2

HistoryMember
665Release(): null
664WaitForLoadAsync(): null

Description

History 28

Members 21

Changed

Parameters (2)
keystring
valueVariant
Thread safetyUnsafe

History 1

CreatedTime

TypeDefault
int640
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 1

Tags: [ReadOnly, NotReplicated]

DefaultRecordName

TypeDefault
booltrue
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 2

Tags: [ReadOnly, NotReplicated]

Dirty

TypeDefault
boolfalse
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 1

Tags: [ReadOnly, NotReplicated]

Error

TypeDefault
PlayerDataErrorStateNone
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 1

Tags: [ReadOnly, NotReplicated]

Flushed

Parameters (2)
flushStatebool
errorstring?
Thread safetyUnsafe

History 1

FlushedTime

TypeDefault
int640
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 1

Tags: [ReadOnly, NotReplicated]

GetPlayer

Parameters (0)
No parameters.
Returns (1)
Player
Thread safetyUnsafe

History 1

GetValue

Parameters (1)
keystring
Returns (1)
Variant
Thread safetyUnsafe

History 1

GetValueChangedSignal

Parameters (1)
keystring
Returns (1)
RBXScriptSignal
Thread safetyUnsafe

History 1

Loaded

Parameters (2)
successbool
errorstring?
Thread safetyUnsafe

History 1

LoadedTime

TypeDefault
int640
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 1

Tags: [ReadOnly, NotReplicated]

ModifiedTime

TypeDefault
int640
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 1

Tags: [ReadOnly, NotReplicated]

NewRecord

TypeDefault
boolfalse
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 1

Tags: [ReadOnly, NotReplicated]

Readable

TypeDefault
boolfalse
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 1

Tags: [ReadOnly, NotReplicated]

RecordName

TypeDefault
stringDefault
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 2

Tags: [ReadOnly, NotReplicated]

ReleaseAsync

Parameters (0)
No parameters.
Returns (1)
null
This function yields. It will block the calling thread until completion.
Thread safetyUnsafe

History 1

Tags: [Yields]

RemoveValue

Parameters (1)
keystring
Returns (1)
null
Thread safetyUnsafe

History 1

RequestFlushAsync

Parameters (0)
No parameters.
Returns (1)
null
This function yields. It will block the calling thread until completion.
Thread safetyUnsafe

History 1

Tags: [Yields]

SetValue

Parameters (2)
keystring
valueVariant
Returns (1)
null
Thread safetyUnsafe

History 1

Writable

TypeDefault
boolfalse
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 1

Tags: [ReadOnly, NotReplicated]

Removed members 2

Release

Parameters (0)
No parameters.
Returns (1)
null
Thread safetyUnsafe

History 2

WaitForLoadAsync

Parameters (0)
No parameters.
Returns (1)
null
This function yields. It will block the calling thread until completion.
Thread safetyUnsafe

History 2

Tags: [Yields]

Settings