We use cookies on this site to enhance your user experience
Collapse Sidebar

DataModel

Deprecated

DataModel

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 the Articles/Place|place running on the server belongs to

GearGenreSetting

GearGenreSetting

[ReadOnly] [NotReplicated]

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

string

JobId

[ReadOnly] [NotReplicated]

A unique identifier for the game server instance running. Defaults to an empty string in Roblox Studio.

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

Workspace

Workspace

[ReadOnly] [NotReplicated]

A reference to the Workspace service

Inherited from Instance: Show Hide

int

DataCost

[ReadOnly] [NotReplicated]
The cost of saving the instance using data persistence.
Instance

Parent

Determines the hierarchical parent of the `Instance`.
bool

RobloxLocked

If true, the `Instance` and its descendants cannot be indexed or edited by a `Script` or `LocalScript` and will throw an error if it is attempted.
string

ClassName

[ReadOnly] [NotReplicated]
A read-only string representing the class this `Instance` belongs to.
string

Name

A non-unique identifier of the `Instance`.
bool

Archivable

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

Functions

void

BindToClose ( Function function )

Binds a function to be called before the game shuts down. The game will wait for all functions bound to complete before shutting down

double

GetJobIntervalPeakFraction ( string jobname , double greaterThan )

Returns the job interval peak fraction of the specified task scheduler job.

double

GetJobTimePeakFraction ( string jobname , double greaterThan )

Returns the job time peak fraction of the specified task scheduler job.

Array

GetJobsExtendedStats ( )

Returns a table containing extended statistics on the jobs performed by the task scheduler

Array

GetJobsInfo ( )

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

Objects

GetObjects ( Content url )

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

bool

IsGearTypeAllowed ( GearType gearType )

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

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

GetService ( string className )

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

FindService ( string className )

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

Inherited from Instance: Show Hide

Array

GetDescendants ( )

[CustomLuaState]
Returns an array containing all of the `Instance`'s descendants.
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.
Instance

FindFirstChildWhichIsA ( string className , bool recursive )

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

FindFirstChildOfClass ( string className )

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

FindFirstChild ( string name , bool recursive )

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

FindFirstAncestorWhichIsA ( string className )

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

FindFirstAncestorOfClass ( string className )

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

FindFirstAncestor ( string name )

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

IsA ( string className )

Returns true if an `Instance`'s class matches or inherits from a given class
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.
RBXScriptSignal

GetPropertyChangedSignal ( string property )

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

GetFullName ( )

Returns a string showing the `Instance`'s ancestry.
string

GetDebugId ( int scopeLength )

[NotBrowsable]
Returns a coded string of the `Instance`s DebugId used internally by Roblox.
Objects

GetChildren ( )

Returns an array containing all of the `Instance`'s children.
void

Destroy ( )

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

Clone ( )

Create a deep copy of a Roblox instance and descendants where `Archivable = true`.
void

ClearAllChildren ( )

This function destroys all of an `Instance`'s children.

Events

RBXScriptSignal

GraphicsQualityChangeRequest ( bool betterQuality )

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

RBXScriptSignal

Loaded ( )

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

Inherited from ServiceProvider: Show Hide

RBXScriptSignal

ServiceRemoving ( Instance service )

Fired when a service is about to be removed.
RBXScriptSignal

ServiceAdded ( Instance service )

Fired when a service is created.
RBXScriptSignal

CloseLate ( )

Fired immediately after the `ServiceProvider/Close` signal is fired.
RBXScriptSignal

Close ( )

Fires when the current place is exited.

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

ChildAdded ( Instance child )

Fires when an object is parented to this `Instance`.
RBXScriptSignal

ChildRemoved ( Instance child )

Fires when a child is removed from this `Instance`.
RBXScriptSignal

DescendantAdded ( Instance descendant )

Fires when a descendant is added to the `Instance`.
RBXScriptSignal

DescendantRemoving ( Instance descendant )

Fires immediately before a descendant of the `Instance` is removed.
RBXScriptSignal

Changed ( string property )

Fired immediately after a property of an object changes.