PcoWSkbVqDnWTu_dm2ix
The Developer Hub is now deprecated and information on this page may no longer be accurate. To see our new and improved documentation, please click here. You can read more about the future of documentation here.
Collapse Sidebar

DataModel

Show deprecated

DataModel

Show deprecated

The DataModel (commonly known as game after the global variable used to access it) is the root of Roblox’s parent-child hierarchy. Its direct children are services (such as the Workspace and Lighting) that act as the fundamental components of a Roblox game.

Properties

int64

CreatorId

[ReadOnly] [NotReplicated]

Describes the ID of the user or group that owns the Articles/Place|place

CreatorType

CreatorType

[ReadOnly] [NotReplicated]

Describes the Enum/CreatorType of the Articles/Place|place, whether the place is owned by a user or a group

int64

GameId

[ReadOnly] [NotReplicated]

Describes the ID of the Articles/Multi Place Games|game that the Articles/Place|place running on the server belongs to.

GearGenreSetting

GearGenreSetting

[ReadOnly] [NotReplicated] [Deprecated]

Not functional. Historically described the gear permissions of the Articles/Place|place as set on the Roblox website

Genre

Genre

[ReadOnly] [NotReplicated]

Not functional. Historically described the Enum/Genre of the Articles/Place|place as set on the Roblox website

bool

IsSFFlagsLoaded

[Hidden] [ReadOnly] [NotReplicated]
string

JobId

[ReadOnly] [NotReplicated]

A unique identifier for the running game server instance.

int64

PlaceId

[ReadOnly] [NotReplicated]

Describes the ID of the Articles/Place|place running on the server

int

PlaceVersion

[ReadOnly] [NotReplicated]

Describes the version of the Articles/Place|place the server is running on

string

PrivateServerId

[ReadOnly] [NotReplicated]

Describes the private server ID of the server, if the server is a Articles/Creating a VIP Server on Roblox|VIP server or a TeleportService/ReserveServer|reserved server

int64

PrivateServerOwnerId

[ReadOnly] [NotReplicated]

Describes the Player/UserId|UserId of the Player that owns the Articles/Creating a VIP Server on Roblox|VIP server if the server is a VIP server.

string

VIPServerId

[Hidden] [ReadOnly] [NotReplicated] [Deprecated]

A string that could identify the current server as a VIP server

int64

VIPServerOwnerId

[Hidden] [ReadOnly] [NotReplicated] [Deprecated]

The Player/UserId|UserId of the account who owns the VIP server

Workspace

Workspace

[ReadOnly] [NotReplicated]

A reference to the Workspace service

Instance

lighting

[ReadOnly] [NotReplicated] [Deprecated]

Refers to the game’s Lighting service

Workspace

workspace

[ReadOnly] [NotReplicated] [Deprecated]

.

Inherited from Instance: Show Hide

bool

Archivable

Determines if an Instance can be cloned using /Instance/Clone or saved to file.

string

ClassName

[ReadOnly] [NotReplicated]

A read-only string representing the class this Instance belongs to

int

DataCost

[Hidden] [ReadOnly] [NotReplicated] [Deprecated]

The cost of saving the instance using data persistence.

string

Name

A non-unique identifier of the Instance

Instance

Parent

[NotReplicated]

Determines the hierarchical parent of the Instance

bool

RobloxLocked

[Hidden]

A deprecated property that used to protect CoreGui objects

int64

SourceAssetId

[Hidden] [NotReplicated]
bool

archivable

[Hidden] [NotReplicated] [Deprecated]
string

className

[ReadOnly] [NotReplicated] [Deprecated]

Functions

void

BindToClose ( Function function )

Binds a function to be called before the game shuts down.

bool

DefineFastFlag ( string name , bool defaultValue )

int

DefineFastInt ( string name , int defaultValue )

string

DefineFastString ( string name , string defaultValue )

bool

GetEngineFeature ( string name )

Checks the availability of various engine features.

bool

GetFastFlag ( string name )

int

GetFastInt ( string name )

string

GetFastString ( string name )

Array

GetJobsInfo ( )

Returns a table containing basic information about the jobs performed by the task scheduler

string

GetMessage ( )

[Deprecated]

[OBSOLETE]: This function will always return a blank string

Objects

GetObjects ( Content url )

Returns an array of Instance|Instances associated with the given Articles/Content|content URL

Objects

GetObjectsAsync ( Content url )

[Yields]
Array

GetObjectsList ( Array urls )

bool

GetRemoteBuildMode ( )

[Deprecated]

This method is no longer useful and will always return false

string

HttpGetAsync ( string url , HttpRequestType httpRequestType )

[Yields]
string

HttpPostAsync ( string url , string data , string contentType , HttpRequestType httpRequestType )

[Yields]
Objects

InsertObjectsAndJoinIfLegacyAsync ( Content url )

[Yields]
bool

IsGearTypeAllowed ( GearType gearType )

[Deprecated]

Returns whether gear of the given Enum/GearType is permitted to be added to Player|Players’ StarterGear|StarterGears

bool

IsLoaded ( )

Returns true if the client has finished loading the game for the first time

void

Load ( Content url )

Loads a Roblox Place File from a URL.

void

OpenScreenshotsFolder ( )

void

OpenVideosFolder ( )

void

ReportInGoogleAnalytics ( string category , string action , string label , int value )

bool

SavePlace ( SaveFilter saveFilter )

[Yields] [Deprecated]

Saves the current place

bool

SetFastFlagForTesting ( string name , bool newValue )

int

SetFastIntForTesting ( string name , int newValue )

string

SetFastStringForTesting ( string name , string newValue )

void

SetPlaceId ( int64 placeId )

Sets the DataModel/PlaceId of the current game instance to the given placeId

void

SetUniverseId ( int64 universeId )

Sets the DataModel/GameId of the current game instance to the given universeId

void

Shutdown ( )

Shuts down the current game instance

Inherited from ServiceProvider: Show Hide

Instance

FindService ( string className )

Returns the service specified by the given className if it’s already created, errors for an invalid name.

Instance

GetService ( string className )

Returns the service with the requested class name, creating it if it does not exist.

Instance

getService ( string className )

[Deprecated]
Instance

service ( string className )

[Deprecated]

.

Inherited from Instance: Show Hide

void

ClearAllChildren ( )

This function destroys all of an Instance’s children.

Instance

Clone ( )

Create a copy of an object and all its descendants, ignoring objects that are not Instance/Archivable|Archivable

void

Destroy ( )

Sets the Instance/Parent property to nil, locks the Instance/Parent property, disconnects all connections, and calls Destroy on all children.

Instance

FindFirstAncestor ( string name )

Returns the first ancestor of the Instance whose Instance/Name is equal to the given name.

Instance

FindFirstAncestorOfClass ( string className )

Returns the first ancestor of the Instance whose Instance/ClassName is equal to the given className.

Instance

FindFirstAncestorWhichIsA ( string className )

Returns the first ancestor of the Instance for whom Instance/IsA returns true for the given className.

Instance

FindFirstChild ( string name , bool recursive )

Returns the first child of the Instance found with the given name.

Instance

FindFirstChildOfClass ( string className )

Returns the first child of the Instance whose Instance/ClassName|ClassName is equal to the given className.

Instance

FindFirstChildWhichIsA ( string className , bool recursive )

Returns the first child of the Instance for whom Instance/IsA returns true for the given className.

Instance

FindFirstDescendant ( string name )

Returns the first descendant found with the given Instance/Name.

Actor

GetActor ( )

Returns the Actor associated with the Instance, usually the first Actor ancestor

Variant

GetAttribute ( string attribute )

Returns the attribute which has been assigned to the given name

RBXScriptSignal

GetAttributeChangedSignal ( string attribute )

Returns an event that fires when the given attribute changes

Dictionary

GetAttributes ( )

Returns a dictionary of string → variant pairs for each of the Instance|Instance’s attributes

Objects

GetChildren ( )

Returns an array containing all of the Instance’s children.

string

GetDebugId ( int scopeLength )

[NotBrowsable]

Returns a coded string of the Instances DebugId used internally by Roblox.

Array

GetDescendants ( )

[CustomLuaState]

Returns an array containing all of the descendants of the instance

string

GetFullName ( )

Returns a string describing the Instance’s ancestry.

RBXScriptSignal

GetPropertyChangedSignal ( string property )

Get an event that fires when a given property of an object changes.

bool

IsA ( string className )

[CustomLuaState]

Returns true if an Instance’s class matches or inherits from a given class

bool

IsAncestorOf ( Instance descendant )

Returns true if an Instance is an ancestor of the given descendant.

bool

IsDescendantOf ( Instance ancestor )

Returns true if an Instance is a descendant of the given ancestor.

void

Remove ( )

[Deprecated]

Sets the object’s Parent to nil, and does the same for all its descendants.

void

SetAttribute ( string attribute , Variant value )

Sets the attribute with the given name to the given value

Instance

WaitForChild ( string childName , double timeOut )

[CustomLuaState] [CanYield]

Returns the child of the Instance with the given name. If the child does not exist, it will yield the current thread until it does.

Objects

children ( )

[Deprecated]

Returns an array of the object’s children.

Instance

clone ( )

[Deprecated]
void

destroy ( )

[Deprecated]
Instance

findFirstChild ( string name , bool recursive )

[Deprecated]
Objects

getChildren ( )

[Deprecated]
bool

isA ( string className )

[Deprecated] [CustomLuaState]
bool

isDescendantOf ( Instance ancestor )

[Deprecated]
void

remove ( )

[Deprecated]

Events

RBXScriptSignal

AllowedGearTypeChanged ( )

[Deprecated]

Fires when SetGearSettings is called with a different value for allowedGenres

RBXScriptSignal

GraphicsQualityChangeRequest ( bool betterQuality )

Fires when the user prompts and increase or decrease in graphics quality using the hotkeys

RBXScriptSignal

ItemChanged ( Instance object , string descriptor )

[Deprecated]

Fires when a property of any object in the DataModel is changed

RBXScriptSignal

Loaded ( )

Fires on the client when the game finishes loading for the first time

RBXScriptSignal

ScreenshotReady ( string path )

RBXScriptSignal

ScreenshotSavedToAlbum ( string filename , bool success , string message )

Inherited from ServiceProvider: Show Hide

RBXScriptSignal

Close ( )

Fires when the current place is exited.

RBXScriptSignal

CloseLate ( )

Fired immediately after the ServiceProvider/Close signal is fired.

RBXScriptSignal

ServiceAdded ( Instance service )

Fired when a service is created.

RBXScriptSignal

ServiceRemoving ( Instance service )

Fired when a service is about to be removed.

Inherited from Instance: Show Hide

RBXScriptSignal

AncestryChanged ( Instance child , Instance parent )

Fires when the Instance/Parent property of the object or one of its ancestors is changed.

RBXScriptSignal

AttributeChanged ( string attribute )

Fires whenever an attribute is changed on the Instance

RBXScriptSignal

Changed ( string property )

Fired immediately after a property of an object changes.

RBXScriptSignal

ChildAdded ( Instance child )

Fires after an object is parented to this Instance.

RBXScriptSignal

ChildRemoved ( Instance child )

Fires after a child is removed from this Instance.

RBXScriptSignal

DescendantAdded ( Instance descendant )

Fires after a descendant is added to the Instance

RBXScriptSignal

DescendantRemoving ( Instance descendant )

Fires immediately before a descendant of the Instance is removed.

RBXScriptSignal

Destroying ( )

Fires immediately before the instance is destroyed via Instance/Destroy.

RBXScriptSignal

childAdded ( Instance child )

[Deprecated]

Callback

Tuple

OnClose ( )

[Deprecated]

Invoked before the game is shut down. When this callback returns, or the timeout period is hit, the game finishes shutting down.


Code Samples


DataModel