The root of Roblox's parent-child hierarchy. Its direct children are services, such as
Workspace and Lighting, that act as the fundamental components of a Roblox game.- Memory category
- Instances
- Own members
- 75
- Inherited members
- 83
- Subclasses
- 0
- Siblings
- 2
Properties47
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.
Defined byDataModel24
Property categoryData
DataModel.IsSFFlagsLoaded: boolean DataModel.MatchmakingType: Enum.MatchmakingType Represents how players in the server are handled by matchmaking.DataModel.PrivateServerId: string Describes the private server ID of the server, if the server is a private server or areserved server.DataModel.PrivateServerOwnerId: number Describes theUserIdof thePlayerthat owns the private server if the server is private.DataModel.RunService: RunService A reference to theRunServiceservice.DataModel.Workspace: Workspace A reference to theWorkspaceservice.DataModel.VIPServerId: string Deprecated: This property has been deprecated. UseDataModel.PrivateServerIdinstead.
A string that could identify the current server as a private server.Use PrivateServerId instead.
DataModel.VIPServerOwnerId: number Deprecated: This property has been deprecated. UseDataModel.PrivateServerOwnerIdinstead.
TheUserIdof the account who owns the private server.Use PrivateServerOwnerId instead.
DataModel.lighting: Instance Deprecated: This item has been superseded bygame:GetService("Lighting"), which should be used instead.
Refers to the game'sLightingservice.DataModel.workspace: Workspace Deprecated: This deprecated property is a variant ofDataModel.Workspacewhich should be used instead.Use Workspace instead.
Property categoryJobInfo
DataModel.JobId: string A unique identifier for the running game server instance.
Property categoryState
DataModel.CreatorId: number Describes the ID of the user or group that owns the place.DataModel.CreatorType: Enum.CreatorType Describes theCreatorTypeof the place, whether the place is owned by a user or a group.DataModel.Environment: string DataModel.ForceR15: boolean DataModel.GameId: number Describes the ID of the experience that the place running on the server belongs to.DataModel.Genre: Enum.Genre Not functional. Historically described theGenreof the place as set on the Roblox website.DataModel.PlaceId: number Describes the ID of the place running on the server.DataModel.PlaceVersion: number Describes the version of the place the server is running on.DataModel.GameAvatarType: Enum.GameAvatarType DataModel.GearGenreSetting: Enum.GearGenreSetting Deprecated: This property is deprecated and is no longer functional. It should not be used.
Not functional. Historically described the gear permissions of the place as set on the Roblox website.DataModel.IsPioneerBuild: boolean DataModel.PioneerSource: Enum.PioneerSource DataModel.R15CollisionType: Enum.R15CollisionType
No properties match the filters.
Methods86
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.
ServiceProvider:FindService( className: string): Instance Returns the service specified by the given className if it's already created, errors for an invalid name.Parameters Parameter Description className: stringThe class name of the service to find.Returns Type Description InstanceThe service instance if it has already been created, or nil if the service does not yet exist.ServiceProvider:GetService( className: string): Instance Returns the service with the requested class name, creating it if it does not exist.Parameters Parameter Description className: stringThe class name of the requested service.Returns Type Description InstanceAn instance of the requested service.ServiceProvider:getService( className: string): Instance Deprecated: This deprecated function is a variant ofServiceProvider:GetService()which should be used instead.Parameters Parameter className: stringReturns Type InstanceUse GetService instead.
ServiceProvider:service( className: string): Instance Deprecated: This item has been superseded byServiceProvider:GetService()which should be used in all new work.Parameters Parameter className: stringReturns Type InstanceUse GetService instead.
Defined byDataModel40
DataModel:BindToClose( function: (...any) -> ...any) Binds a function to be called before the server shuts down.Parameters Parameter Description function: (...any) -> ...anyA function called before the experience server shuts down. If the bound function accepts a parameter, it passesCloseReasonspecifying the reason for the server shutdown.Returns Type booleanReturns Type numberReturns Type stringParameters Parameter name: stringReturns Type booleanParameters Parameter name: stringReturns Type booleanParameters Parameter name: stringReturns Type numberParameters Parameter name: stringReturns Type stringDataModel:GetJobsInfo( ): { any } Returns a table containing basic information about the jobs performed by the task scheduler.Returns Type Description { any }A table containing information about the jobs performed by the task scheduler, see above for the format.DataModel:GetObjects( url: string): { Instance } Returns an array ofInstancesassociated with the given content URL.Parameters Parameter Description url: stringThe given content URL.Returns Type Description { Instance }An array ofInstancesassociated with the content URL.DataModel:GetObjectsAllOrNone( url: string): { Instance } Parameters Parameter url: stringReturns Type { Instance }DataModel:GetObjectsAsync( url: string): { Instance } Parameters Parameter url: stringReturns Type { Instance }Parameters Parameter urls: { any }Returns Type { any }DataModel:GetPioneerRootPlaceId( ): number Returns Type numberDataModel:GetPioneerSource( ): Enum.PioneerSource Returns Type Enum.PioneerSourceDataModel:GetPlaySessionId( ): string Returns Type stringDataModel:HttpGetAsync(url: string,httpRequestType: Enum.HttpRequestType? = Enum.HttpRequestType.Default,): string Parameters Parameter url: stringhttpRequestType: Enum.HttpRequestType? = Enum.HttpRequestType.DefaultReturns Type stringDataModel:HttpPostAsync(url: string,data: string,contentType: string? = "*/*",httpRequestType: Enum.HttpRequestType? = Enum.HttpRequestType.Default,): string Parameters Parameter url: stringdata: stringcontentType: string? = "*/*"httpRequestType: Enum.HttpRequestType? = Enum.HttpRequestType.DefaultReturns Type stringDataModel:InsertObjectsAndJoinIfLegacyAsync( url: string): { Instance } Parameters Parameter url: stringReturns Type { Instance }DataModel:IsContentLoaded( ): boolean Returns Type booleanDataModel:IsLoaded( ): boolean Returns true if the client has finished loading the game for the first time.Returns Type Description booleanWhether the client has finished loading the game for the first time.DataModel:IsPioneerApp( ): boolean Returns Type booleanDataModel:IsUniverseMetadataLoaded( ): boolean Returns Type booleanDataModel:Load( url: string) Parameters Parameter url: stringReturns Type booleanReturns Type numberReturns Type stringDataModel:SetPlaceId( placeId: number) Sets theDataModel.PlaceIdof the current game instance.Parameters Parameter Description placeId: numberThe ID to set theDataModel.PlaceIdto.DataModel:SetUniverseId( universeId: number) Sets theDataModel.GameIdof the current game instance to the givenuniverseId.Parameters Parameter Description universeId: numberThe ID to set theDataModel.GameIdto.DataModel:getGameTime( ): number Returns Type numberDataModel:GetMessage( ): string Deprecated: This item is deprecated since the system was phased out a very long time ago, and recently the APIs for setting this message were removed.
[OBSOLETE]: This function will always return a blank string.Returns Type stringDataModel:GetRemoteBuildMode( ): boolean Deprecated: This item is deprecated. UseRunService:IsServer()to see if your code is running on the server.
This method is no longer useful and will always return false.Returns Type booleanDataModel:IsGearTypeAllowed( gearType: Enum.GearType): boolean Deprecated: This property is deprecated and is no longer functional. It should not be used.
Returns whether gear of the givenGearTypeis permitted to be added toPlayers'StarterGears.Parameters Parameter Description gearType: Enum.GearTypeThe givenGearType.Returns Type Description booleanWhether gear of the givenGearTypeis permitted in the game.DataModel:SavePlace( saveFilter: Enum.SaveFilter? = Enum.SaveFilter.SaveAll): boolean Deprecated: This item is deprecated. Do not use it for new work.
Saves the current place.Parameters Parameter saveFilter: Enum.SaveFilter? = Enum.SaveFilter.SaveAllReturns Type boolean
No methods match the filters.
Events24
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.
- Fires when the current place is exited.
ServiceProvider.ServiceAdded: RBXScriptSignal<( service: Instance)> Fired when a service is created.Parameters Parameter service: InstanceServiceProvider.ServiceRemoving: RBXScriptSignal<( service: Instance)> Fired when a service is about to be removed.Parameters Parameter service: Instance
Defined byDataModel10
DataModel.GraphicsQualityChangeRequest: RBXScriptSignal<( betterQuality: boolean)> Fires when the user prompts and increase or decrease in graphics quality using the hotkeys.Parameters Parameter betterQuality: booleanDataModel.Loaded: RBXScriptSignal<( )> Fires on the client when the game finishes loading for the first time.DataModel.ScreenshotReady: RBXScriptSignal<( path: string)> Parameters Parameter path: stringDataModel.ScreenshotSavedToAlbum: RBXScriptSignal<(filename: string,success: boolean,message: string,)> DataModel.ServerLifecycleChanged: RBXScriptSignal<( serverLifecycleChangedEvent: { [string]: any })> Parameters Parameter serverLifecycleChangedEvent: { [string]: any }DataModel.ServerLowMemoryWarning: RBXScriptSignal<( )> DataModel.ServerRestartScheduled: RBXScriptSignal<(restartTime: DateTime,source: Enum.CloseReason,attributes: { [string]: any },)> Fires on the server when the server has been scheduled to restart. Provides the scheduled restart time, source, and custom attributes.Parameters Parameter restartTime: DateTimesource: Enum.CloseReasonattributes: { [string]: any }DataModel.UniverseMetadataLoaded: RBXScriptSignal<( )> DataModel.AllowedGearTypeChanged: RBXScriptSignal<( )> Deprecated: This item is deprecated . Do not use it for new work.
Fires when SetGearSettings is called with a different value forallowedGenres.DataModel.ItemChanged: RBXScriptSignal<( object: Instance, descriptor: string)> Deprecated: This function has been superseded byObject.Changed, which should be used in new work instead.
Fires when a property of any object in theDataModelis changed.
No events match the filters.
Callbacks1
Defined byDataModel1
DataModel.OnClose: ( ) -> ...any Deprecated: This function is deprecated. It is recommended to useDataModel:BindToClose()instead.
Invoked before the game is shut down. When this callback returns, or the timeout period is hit, the game finishes shutting down.Returns Type ...anyUse BindToClose instead.
No callbacks match the filters.