An object that exposes methods to access a single data store.
- Memory category
- Instances
- Own members
- 7
- Inherited members
- 75
- Subclasses
- 2
- Siblings
- 608
Properties23
Property categoryBehavior
- Determines if an
Instanceand its descendants can be cloned usingInstance:Clone(), and can be saved/published. - Deprecated: This deprecated property is a variant of
Instance.Archivablewhich should be used instead.Use Archivable instead.
Property categoryData
Property categoryPermissions
- The set of capabilities allowed to be used for scripts inside this container.
- Indicates whether the instance is inside a sandboxed container.
- When enabled, the instance can only access abilities in its
Capabilitieslist.
No properties match the filters.
Methods49
Object:GetPropertyChangedSignal( property: string): RBXScriptSignal Get an event that fires when a given property of the object changes.Parameters Parameter Description property: stringThe property to connect to.Returns Type Description RBXScriptSignalA signal that fires whenever the property changes.- Returns true if an object's class matches or inherits from a given class.
Parameters Parameter Description className: stringThe class against which the Object's class will be checked. Case-sensitive.Returns Type Description booleanDescribes whether the Object's class matched or is a subclass of the given class. - Deprecated: This deprecated function is a variant of
Object:IsA()which should be used instead.Parameters Parameter className: stringReturns Type booleanUse IsA instead.
- Applies a tag to the instance.
Parameters Parameter Description tag: stringThe tag to apply to the instance. - This method destroys all of an instance's children.
- Create a copy of an instance and all its descendants, ignoring instances that are not
Archivable.Returns Type Description InstanceA copy of the instance, ornilif the instance is notArchivable. - Sets the
Instance.Parentproperty tonil, locks theInstance.Parentproperty, disconnects all connections, and callsDestroy()on all children. Instance:FindFirstAncestor( name: string): Instance Returns the first ancestor of theInstancewhoseInstance.Nameis equal to the given name.Parameters Parameter Description name: stringTheInstance.Nameto be looked for.Instance:FindFirstAncestorOfClass( className: string): Instance Returns the first ancestor of theInstancewhoseObject.ClassNameis equal to the given className.Parameters Parameter Description className: stringTheObject.ClassNameto be looked for.Instance:FindFirstAncestorWhichIsA( className: string): Instance Returns the first ancestor of theInstancefor whomObject:IsA()returns true for the given className.Parameters Parameter Description className: stringTheObject.ClassNameto be looked for.Instance:FindFirstChild( name: string, recursive: boolean? = false): Instance Returns the first child of theInstancefound with the given name.Parameters Parameter Description name: stringTheInstance.Nameto be searched for.recursive: boolean? = falseWhether or not the search should be conducted recursively.Instance:FindFirstChildOfClass( className: string): Instance Parameters Parameter Description className: stringTheObject.ClassNameto be looked for.Instance:FindFirstChildWhichIsA(className: string,recursive: boolean? = false,): Instance Returns the first child of theInstancefor whomObject:IsA()returns true for the given className.Parameters Parameter Description className: stringTheObject.ClassNameto be searched for.recursive: boolean? = falseWhether or not the search should be conducted recursively.Instance:FindFirstDescendant( name: string): Instance Returns the first descendant found with the givenInstance.Name.Parameters Parameter Description name: stringTheInstance.Nameto search for.- Returns the
Actorassociated with the Instance, if any. Instance:GetAttribute( attribute: string): any Returns the value which has been assigned to the given attribute name.Parameters Parameter Description attribute: stringThe name of the attribute being retrieved.Returns Type Description anyThe value which has been assigned to the given attribute name. If no attribute has been assigned,nilis returned.Instance:GetAttributeChangedSignal( attribute: string): RBXScriptSignal Returns an event that fires when the given attribute changes.Parameters Parameter Description attribute: stringThe name of the specified attribute for which the change signal is being returned.Returns Type Description RBXScriptSignalAn event that fires when the given attribute changes.- Returns a dictionary of the instance's attributes.
Returns Type Description { [string]: any }A dictionary of string → variant pairs for each attribute where the string is the name of the attribute and the variant is a non-nil value. - Returns an array containing all of the instance's children.
Returns Type Description { Instance }An array containing the instance's children. Instance:GetDebugId( scopeLength: number? = 4): string Returns a coded string of the debug ID used internally by Roblox.Parameters Parameter Description scopeLength: number? = 4The scope length.Returns Type Description stringThe Debug ID string.- Returns an array containing all of the descendants of the instance.
Returns Type Description { Instance }An array containing the instance's descendants. - Returns a string describing the instance's ancestry.
- Returns the styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified.
Parameters Parameter Description name: stringName of the property to query.selector: string?Optional selector for the pseudo instance you are targeting on the instance.Returns Type Description anyThe styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified. Instance:GetStyledPropertyChangedSignal( property: string): RBXScriptSignal Returns an event that fires when the given style property changes on the instance.Parameters Parameter Description property: stringName of the style property for which to listen for changes.Returns Type Description RBXScriptSignalEvent that fires when the given style property changes.- Gets an array of all tags applied to the instance.
Returns Type Description { any }An array of strings, each representing a tag applied to the instance. - Check whether the instance has a given tag.
Parameters Parameter Description tag: stringThe tag to check for on the instance.Returns Type Description booleantrueif the instance has the given tag,falseotherwise. Instance:IsAncestorOf( descendant: Instance): boolean Returns true if anInstanceis an ancestor of the given descendant.Instance:IsDescendantOf( ancestor: Instance): boolean Returnstrueif anInstanceis a descendant of the given ancestor.Instance:IsPropertyModified( property: string): boolean Returnstrueif the value stored in the specified property is not equal to the code-instantiated default.Parameters Parameter Description property: stringName of the property to query.Returns Type Description booleanBoolean indicating whether the property is modified from its code‑instantiated default.Instance:QueryDescendants( selector: string): { Instance } Returns an array containing all descendants of the instance that match theselectorstring.Parameters Parameter Description selector: stringSelector string used to filter elements.Returns Type Description { Instance }An array of instances (empty if nothing matched the selector).- Removes a tag from the instance.
Parameters Parameter Description tag: stringThe tag to remove from the instance. Instance:ResetPropertyToDefault( property: string) Resets a property to its default value.Parameters Parameter Description property: stringName of the property to reset.Instance:SetAttribute( attribute: string, value: any) Sets the attribute with the given name to the given value.Instance:WaitForChild( childName: string, timeOut: number): Instance Returns the child of theInstancewith the given name. If the child does not exist, it will yield the current thread until it does.Parameters Parameter Description childName: stringTheInstance.Nameto be looked for.timeOut: numberAn optional time out parameter.- Deprecated: This item is deprecated in favor of
Instance:Destroy()andInstance:ClearAllChildren(). If you must remove an object from the game, and wish to use the object later, set itsParentproperty tonilinstead of using this method.
Sets the object'sParenttonil, and does the same for all its descendants. - Deprecated: This item has been superseded by
Instance:GetChildren()which should be used in all new work.
Returns an array of the object's children.Returns Type Description { Instance }Array of child objects/instances.Use GetChildren instead.
- Deprecated: This deprecated function is a variant of
Instance:Clone()which should be used instead.Returns Type InstanceUse Clone instead.
- Deprecated: This deprecated function is a variant of
Instance:Destroy()which should be used instead.Use Destroy instead.
Instance:findFirstChild( name: string, recursive: boolean? = false): Instance Deprecated: This deprecated function is a variant ofInstance:FindFirstChild()which should be used instead.Returns Type InstanceUse FindFirstChild instead.
- Deprecated: This deprecated function is a variant of
Instance:GetChildren()which should be used instead.Returns Type { Instance }Use GetChildren instead.
Instance:isDescendantOf( ancestor: Instance): boolean Deprecated: This deprecated function is a variant ofInstance:IsDescendantOf()which should be used instead.Parameters Parameter ancestor: InstanceReturns Type booleanUse IsDescendantOf instead.
- Deprecated: This deprecated function is a variant of
Instance:Remove()which has also been deprecated. Neither function should be used in new work.Use Remove instead.
Defined byGlobalDataStore7
GlobalDataStore:BatchGetAsync(keys: { any },options: { [string]: any }? = nil,): { [string]: any } Returns the values of multiple keys from the data store in a single request.Parameters Parameter Description keys: { any }An array of key name strings to retrieve. The maximum number of keys per request is determined by a server-side limit (default 100).options: { [string]: any }? = nil(Optional) Unused; has no effect.Returns Type Description { [string]: any }A dictionary mapping each requested key (string) to a table containing avaluefield with the key's current value. Keys that don't exist or have no value are omitted from the result.GlobalDataStore:GetAsync(key: string,options: DataStoreGetOptions? = nil,): ...any Returns the value of a key in a specified data store and aDataStoreKeyInfoinstance.Parameters Parameter Description key: stringThe key name for which the value is requested. IfDataStoreOptions.AllScopeswas set to true when accessing the data store throughDataStoreService:GetDataStore(), this key name must be prepended with the original scope as in "scope/key".options: DataStoreGetOptions? = nil(Optional) ADataStoreGetOptionsinstance that controls aspects of the read, such as whether to bypass the locally cached value via itsDataStoreGetOptions.UseCacheproperty.Returns Type Description ...anyThe value of the entry in the data store with the given key and aDataStoreKeyInfoinstance that includes the version number, date and time the version was created, and functions to retrieveUserIdsand metadata.GlobalDataStore:IncrementAsync(key: string,delta: number? = 1,userIds: { any }? = {},options: DataStoreIncrementOptions? = nil,): any Increments the value of a key by the provided amount (both must be integers).Parameters Parameter Description key: stringKey name for which the value should be updated. IfDataStoreOptions.AllScopeswas set to true when accessing the data store throughDataStoreService:GetDataStore(), this key name must be prepended with the original scope as in "scope/key".delta: number? = 1Amount to increment the current value by.userIds: { any }? = {}(Optional) A table ofUserIdsto associate with the key.options: DataStoreIncrementOptions? = nil(Optional)DataStoreIncrementOptionsinstance that combines multiple additional parameters as custom metadata and allows for future extensibility.Returns Type Description anyThe updated value of the entry in the data store with the given key.- Removes the specified key while also retaining an accessible version.
Parameters Parameter Description key: stringKey name to be removed. IfDataStoreOptions.AllScopeswas set to true when accessing the data store throughDataStoreService:GetDataStore(), this key name must be prepended with the original scope as in "scope/key".Returns Type Description ...anyThe value of the data store prior to deletion and aDataStoreKeyInfoinstance that includes the version number, date and time the version was created, and functions to retrieveUserIdsand metadata. GlobalDataStore:SetAsync(key: string,value: any,userIds: { any }? = {},options: DataStoreSetOptions? = nil,): any Sets the value of the data store for the given key.Parameters Parameter Description key: stringKey name for which the value should be set. IfDataStoreOptions.AllScopeswas set to true when accessing the data store throughDataStoreService:GetDataStore(), this key name must be prepended with the original scope as in "scope/key".value: anyThe value that the data store key will be set to.userIds: { any }? = {}Table ofUserIds, highly recommended to assist with GDPR tracking/removal.options: DataStoreSetOptions? = nil(Optional)DataStoreSetOptionsinstance that allows for metadata specification on the key.Returns Type Description anyThe version identifier of the newly created version. It can be used to retrieve key info usingGetVersionAsync()or to remove it usingRemoveVersionAsync().GlobalDataStore:UpdateAsync(key: string,transformFunction: (...any) -> ...any,): ...any Updates a key's value with a new value from the specified callback function.Parameters Parameter Description key: stringKey name for which the value should be updated. IfDataStoreOptions.AllScopeswas set to true when accessing the data store throughDataStoreService:GetDataStore(), this key name must be prepended with the original scope as in "scope/key".transformFunction: (...any) -> ...anyTransform function that takes the current value andDataStoreKeyInfoas parameters and returns the new value along with optionalUserIdsand metadata.Returns Type Description ...anyThe updated value of the entry in the data store with the given key and aDataStoreKeyInfoinstance that includes the version number, date and time the version was created, and functions to retrieveUserIdsand metadata.GlobalDataStore:OnUpdate(key: string,callback: (...any) -> ...any,): RBXScriptConnection Deprecated: This function has been deprecated and should not be used in new work. You can use theCross Server Messaging Serviceto publish and subscribe to topics to receive near real-time updates, completely replacing the need for this function.
Sets a callback function to be executed any time the value associated with a key is changed.Parameters Parameter Description key: stringThe key identifying the entry being retrieved from the data store.callback: (...any) -> ...anyThe function to be executed any time the value associated with key is changed.Returns Type Description RBXScriptConnectionThe connection to the key being tracked for updates.
No methods match the filters.
Events10
Object.Changed: RBXScriptSignal<( property: string)> Fires immediately after a property of the object changes, with some limitations.Parameters Parameter property: string
Instance.AncestryChanged: RBXScriptSignal<( child: Instance, parent: Instance)> Fires when theInstance.Parentproperty of this object or one of its ancestors is changed.Instance.AttributeChanged: RBXScriptSignal<( attribute: string)> Fires whenever an attribute is changed on theInstance.Parameters Parameter attribute: stringInstance.ChildAdded: RBXScriptSignal<( child: Instance)> Fires after an object is parented to thisInstance.Parameters Parameter child: InstanceInstance.ChildRemoved: RBXScriptSignal<( child: Instance)> Fires after a child is removed from thisInstance.Parameters Parameter child: InstanceInstance.DescendantAdded: RBXScriptSignal<( descendant: Instance)> Fires after a descendant is added to theInstance.Parameters Parameter descendant: InstanceInstance.DescendantRemoving: RBXScriptSignal<( descendant: Instance)> Fires immediately before a descendant of theInstanceis removed.Parameters Parameter descendant: Instance- Fires immediately before (or is deferred until after) the instance is destroyed via
Instance:Destroy(). - Fires whenever any style property is changed on the instance, including when a property is set to
nil. Instance.childAdded: RBXScriptSignal<( child: Instance)> Deprecated: This deprecated event is a variant ofInstance.ChildAddedwhich should be used instead.Parameters Parameter child: InstanceUse ChildAdded instead.
No events match the filters.