RBX.lua.DataModel (Service)

"Game" redirects here. For the playable games built by users on ROBLOX, see Place.

Derived Classes

None

DataModel (extends ServiceProvider)

• ClearContent
• ClearMessage
• FinishShutdown
• GetJobIntervalPeakFraction
• GetJobTimePeakFraction
• GetJobsExtendedStats
• GetJobsInfo
• GetObjects
• GetRemoteBuildMode
• HttpGet
• HttpGetAsync
• HttpPost
• HttpPostAsync
• IsGearTypeAllowed
• Load
• LoadPlugins
• ReportMeasurement
• Save
• SaveToRoblox
• ServerSave
• SetCreatorId
• SetGearSettings
• SetGenre
• SetJobsExtendedStatsWindow
• SetMessage
• SetMessageBrickCount
• SetPlaceId
• SetRemoteBuildMode
• SetScreenshotInfo
• SetServerSaveUrl
• SetVideoInfo
• Shutdown
• ToggleTools
• GetService
• service
• Clone
• FindFirstChild
• GetChildren
• GetDebugId
• GetFullName
• IsA
• IsAncestorOf
• IsDescendantOf
• Destroy
• ClearAllChildren

• CreatorId
• CreatorType
• JobId
• PlaceId
• Genre
• Name
• Parent
• Archivable
• ClassName
• RobloxLocked
• DataCost

• RequestShutdown

• Close
• CloseLate
• ServiceAdded
• ServiceRemoving
• AncestryChanged
• Changed
• ChildAdded
• ChildRemoved
• DescendantAdded
• DescendantRemoving

The DataModel is the keystone of ROBLOX's structure. It houses all of the services such as the Workspace and Lighting in a game (with the exception of the "gameSettings"). It even contains hidden services that Roblox Studio uses.

The DataModel, or as you probably know it as the "game" that you index in your scripts:

game.Workspace.Part:Destroy() --the 'game' is a reference to the DataModel

ClearContent( bool resettingSimulation )
Returns	nil
Description:	If resettingSimulation is false, it removes everything in the Workspace. If resettingSimulation is true, it removes everything in the game; this includes CoreGui, Players, and Workspace.
Member of:	DataModel

ClearMessage( )
Returns	nil
Description:	Clears a message set by SetMessage (Method).
Member of:	DataModel

FinishShutdown( bool localSave )
Returns	nil
Description:	Shutdowns the game.
Member of:	DataModel

GetJobIntervalPeakFraction( )
Returns	Undocumented
Description:	Undocumented
Member of:	Undocumented

GetJobTimePeakFraction( )
Returns	Undocumented
Description:	Undocumented
Member of:	Undocumented

GetJobsExtendedStats( )
Returns	Table jobsExtendedStats
Description:	Different than GetJobsInfo in that many values are changed to -1.#IND.
Member of:	DataModel

GetJobsInfo( )
Returns	Table jobsInfo
Description:	Returns a table containing the jobs performed by the game, and one reference table. The reference table contains the names of the values in the other tables.
Member of:	DataModel

GetObjects( Content content )
Returns	Table table containing the object
Description:	Gets the models specified by the argument's content link.
Member of:	DataModel

GetRemoteBuildMode( )
Returns	bool
Description:	When called from a Edit or build mode, this returns false. When called from the client, this returns true.
Member of:	DataModel

HttpGet( string URI[, bool synchronous] )
Returns	string request body
Description:	Retrieves HTML of the URI via get variable method.
Member of:	DataModel

HttpGetAsync( )
Returns	Undocumented
Description:	Undocumented
Member of:	Undocumented

HttpPost( string url, string data, bool synchronous = false )
Returns	string response
Description:	Sends data over a URI via HTML post method.
Member of:	DataModel

HttpPostAsync( )
Returns	Undocumented
Description:	Undocumented
Member of:	Undocumented

IsGearTypeAllowed( GearType GearType )
Returns	Boolean allowed
Description:	Returns true if the GearType GearType is allowed to enter the game through a client's StarterPack.
Member of:	DataModel

Load( Content url )
Returns	nil
Description:	Loads a Roblox Place File from a URL.
Member of:	DataModel

LoadPlugins( )
Returns	Undocumented
Description:	Undocumented
Member of:	Undocumented

ReportMeasurement( string id, string key1, string value1, string key2, string value2 )
Returns	nil
Description:	Calls HttpGet on a Roblox analytics URL
Member of:	DataModel

Save( Content url )
Returns	nil
Description:	Uploads the place to the specified URL
Member of:	DataModel

SaveToRoblox( )
Returns	Undocumented
Description:	Undocumented
Member of:	Undocumented

ServerSave( )
Returns	nil
Description:	Uploads the place to the URL set by SetServerSaveUrl
Member of:	DataModel

SetCreatorId( int creatorId CreatorType creatorType )
Returns	nil
Description:	Sets the DataModel's CreatorId and CreatorType.
Member of:	DataModel

Protected:This item is protected. Attempting to use it in a Script or LocalScript will cause an error.

SetGearSettings( GearGenreSetting genreRestriction int allowedGenres )
Returns	nil
Description:	Sets the game's gear settings.
Member of:	DataModel

SetGenre( Genre Genre )
Returns	nil
Description:	Sets the DataModel's Genre.
Member of:	DataModel

SetJobsExtendedStatsWindow( )
Returns	Undocumented
Description:	Undocumented
Member of:	Undocumented

SetMessage( string message text )
Returns	nil
Description:	Creates a GUI message similar to ones seen when loading a game.
Member of:	DataModel

SetMessageBrickCount( )
Returns	nil
Description:	Sets a message with brick count, and connector count.
Member of:	DataModel

There are two SetPlaceId methods:

RBX.lua.DataModel (Service)/DataModel

RBX.lua.DataModel (Service)/BadgeService

SetRemoteBuildMode( )
Returns	Undocumented
Description:	Undocumented
Member of:	Undocumented

SetScreenshotInfo( )
Returns	Undocumented
Description:	Undocumented
Member of:	Undocumented

SetServerSaveUrl( string url )
Returns	nil
Description:	Sets the upload URL for the ServerSave function
Member of:	DataModel

SetVideoInfo( )
Returns	Undocumented
Description:	Undocumented
Member of:	Undocumented

Shutdown( )
Returns	nil
Description:	Closes the current Roblox Instance.
Member of:	DataModel

ToggleTools( )
Returns	nil
Description:	Toggles roblox studio windows. Only works in edit and solo mode. This method is currently disabled due to exploits.
Member of:	DataModel

GetService( string className )
Returns	Instance
Description:	Returns the service which was requested.
Member of:	ServiceProvider

service( string className )
Returns	Instance
Description:	Returns the service which was requested.
Member of:	ServiceProvider

Clone( )
Returns	Instance
Description:	Returns a clone of the object and its children, unless its Archivable property is false. The clone will have the same properties as the original object and the same descendants (except those with an Archivable property set to false). The clone's Parent will be nil.
Member of:	Instance

FindFirstChild( string name, bool recursive = false )
Returns	Instance
Description:	Returns the first child found with a name of name. Returns nil if no such child exists. If the optional recursive argument is true, will recursively descend the hierarchy while searching rather than only searching the immediate object.
Member of:	Instance

GetChildren( )
Returns	table
Description:	Returns a read-only table of the object's children.
Member of:	Instance

GetDebugId( int scopeLength )
Returns	string
Description:	Returns a coded string of the object's DebugId used internally by Roblox.
Member of:	Instance

GetFullName( )
Returns	String path to object
Description:	Returns a string with a dot (.) character separating a path of object hierarchy excluding "game".
Member of:	Instance

IsA( string className )
Returns	bool
Description:	Returns true if the Instance is that class or a subclass.
Member of:	Instance

IsAncestorOf( Instance descendant )
Returns	boolean is ancestor
Description:	Returns true if the object is an ancestor of descendant.
Member of:	Instance

IsDescendantOf( Instance ancestor )
Returns	bool
Description:	Returns true if the object is an descendant of ancestor.
Member of:	Instance

Destroy( )
Returns	nil
Description:	Sets the Parent property to nil, locks the Parent property, disconnects all connections and calls Destroy() on all children.
Member of:	Instance

ClearAllChildren( )
Returns	nil
Description:	Removes all descendants of the Instance, but leaves the Instance itself.
Member of:	Instance

CreatorId
Property	integer CreatorId
Description	The userId of the creator of the current place.
Member of	DataModel

CreatorType
Type	CreatorType
Description	The CreatorType of the current place.
Member of	DataModel

JobId
Type	string
Description	The JobId is an internal id. It is unique per server.
Member of	DataModel

PlaceId
Type	int
Description	The id of the current place.
Member of	DataModel

Genre
Type	Genre
Description	The game's genre.
Member of	DataModel

Name
Type	string
Description	The name of the object, which is often used to identify it in the context of its parent. Note that names are not unique identifiers; multiple children of an object may share the same name. In a script where you want to access an object using a name, for example, game.Workspace["Brick"], the first object found with that name is that object. This "first object" can be found in the Explorer menu.Names are great for showing a very brief title or summary of an object.
Member of	Instance

Parent
Type	Instance
Description	The hierarchical parent of the object. When no scripts hold references to an object, it will still be maintained as long as it's parent is set to an object which does have references to it, either by other objects or scripts. The toplevel DataModel object (the one referred to as the "game" by scripts) has no parent, but always has a reference held to it by the game engine, and exists for the duration of a session.
Member of	Instance

Archivable
Type	bool
Description	Sets whether or not the object is saved when publishing or saving to file. Also sets whether or not the object is clonable.
Member of	Instance

ClassName
Type	string
Description	A unique string per type of Instance. Should only be used as a unique identifier, as it does not reveal any information about nature of the type hierarchy the type is in. For this use, see IsA.
Member of	Instance

RobloxLocked
Type	bool
Description	If true, the object and its descendants cannot be indexed or edited by a Script or LocalScript and will throw an error if it is attempted.
Member of	Instance

DataCost
Type	int
Description	How much saving this instance with SaveInstance will add to DataComplexity
Member of	Instance

RequestShutdown
Parameters:	nil
Returns:	bool
Description:	When LocalSaveEnabled is true, this is invoked when an attempt to shutdown the game is made. This member requires elevated permissions to be used.
Member of:	DataModel

Close ( )
Description	Fires when the current place is exited
Member of:	ServiceProvider

CloseLate ( )
Description	Undocumented
Member of:	Undocumented

ServiceAdded ( Instance service )
Description	Fired when a service is created.
Member of:	ServiceProvider

ServiceRemoving ( Instance service )
Description	Fired when a service is about to be removed.
Member of:	ServiceProvider

AncestryChanged ( Instance child, Instance parent )
Description	Fired when an ancestor of the Instance the event which is a member of child has its parent changed to parent.
Member of:	Instance

Changed ( Property property )
Description	Fired whenever a property of the object changes.
Member of:	Instance

ChildAdded ( Instance child )
Description	Fired after a child is added.
Member of:	Instance

ChildRemoved ( Instance child )
Description	Fired when a child is removed from the object.
Member of:	Instance

DescendantAdded ( Instance descendant )
Description	Fired when a descendant is added to the object.
Member of:	Instance

DescendantRemoving ( Instance descendant )
Description	Fired when a descendant is being removed.
Member of:	Instance