DataModel

DataModel
Not creatableThis class cannot be instantiated.
Memory category	Instances
Subclasses
Inheritance
Object Instance ServiceProvider DataModel

The DataModel class represents the root instance of a hierarchy (commonly known as game after the global variable used to access it). The instance is named after the place's title or "Ugc".

Properties

CreatorId: int64

• Read-onlyThis property is capable of being read but not written.
• Not replicatedThis member is not replicated across the network boundary.

The Player.UserId of the game creator, or GroupId if creator is a group.

Example:

local id = game.CreatorId
if id == 261 then
    print("Game is owned by Shedletsky")
end

• Category: State.
• Serialization: cannot load or save.
• Thread safety: read safe

CreatorType: CreatorType

• Read-onlyThis property is capable of being read but not written.
• Not replicatedThis member is not replicated across the network boundary.

An enum which defines whether the game is owned by a user or group.

• Category: State.
• Serialization: cannot load or save.
• Thread safety: read safe

GameId: int64

• Read-onlyThis property is capable of being read but not written.
• Not replicatedThis member is not replicated across the network boundary.

Value which represents the Universe ID of the experience. Every place in a universe shares the same Universe ID.

• Category: State.
• Serialization: cannot load or save.
• Thread safety: read safe

GearGenreSetting: GearGenreSetting

• Read-onlyThis property is capable of being read but not written.
• Not replicatedThis member is not replicated across the network boundary.
• DeprecatedThis member will be phased out and should be avoided while it is still available.

This class member is missing documentation. Create or add to its subpage at Class:DataModel/GearGenreSetting.

• Category: State.
• Serialization: cannot load or save.
• Thread safety: read safe

Genre: Genre

• Read-onlyThis property is capable of being read but not written.
• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:DataModel/Genre.

• Category: State.
• Serialization: cannot load or save.
• Thread safety: read safe

IsSFFlagsLoaded: bool

• HiddenThis property is not shown in the object browser and properties window.
• Read-onlyThis property is capable of being read but not written.
• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:DataModel/IsSFFlagsLoaded.

• Category: Data.
• Read security: RobloxScriptSecurity.
• Write security: RobloxScriptSecurity.
• Serialization: cannot load or save.
• Thread safety: read safe

JobId: string

• Read-onlyThis property is capable of being read but not written.
• Not replicatedThis member is not replicated across the network boundary.

Defines a server-specific ID, unique to every server on Roblox.

• Category: JobInfo.
• Serialization: cannot load or save.
• Thread safety: read safe

PlaceId: int64

• Read-onlyThis property is capable of being read but not written.
• Not replicatedThis member is not replicated across the network boundary.

The id of the place.

• Category: State.
• Serialization: cannot load or save.
• Thread safety: read safe

PlaceVersion: int

• Read-onlyThis property is capable of being read but not written.
• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:DataModel/PlaceVersion.

• Category: State.
• Serialization: cannot load or save.
• Thread safety: read safe

PrivateServerId: string

• Read-onlyThis property is capable of being read but not written.
• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:DataModel/PrivateServerId.

• Category: Data.
• Serialization: can save only.
• Thread safety: read safe

PrivateServerOwnerId: int64

• Read-onlyThis property is capable of being read but not written.
• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:DataModel/PrivateServerOwnerId.

• Category: Data.
• Serialization: can save only.
• Thread safety: read safe

VIPServerId: string

• HiddenThis property is not shown in the object browser and properties window.
• Read-onlyThis property is capable of being read but not written.
• Not replicatedThis member is not replicated across the network boundary.
• DeprecatedThis member will be phased out and should be avoided while it is still available.

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:DataModel/VIPServerId.

• Category: Data.
• Serialization: can save only.
• Thread safety: read safe

VIPServerOwnerId: int64

• HiddenThis property is not shown in the object browser and properties window.
• Read-onlyThis property is capable of being read but not written.
• Not replicatedThis member is not replicated across the network boundary.
• DeprecatedThis member will be phased out and should be avoided while it is still available.

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:DataModel/VIPServerOwnerId.

• Category: Data.
• Serialization: can save only.
• Thread safety: read safe

Workspace: Workspace

• Read-onlyThis property is capable of being read but not written.
• Not replicatedThis member is not replicated across the network boundary.

The game's Workspace.

• Category: Data.
• Serialization: cannot load or save.
• Thread safety: read safe

lighting: Instance

• Read-onlyThis property is capable of being read but not written.
• Not replicatedThis member is not replicated across the network boundary.
• DeprecatedThis member will be phased out and should be avoided while it is still available.

This property is deprecated. Instead, use the following alternative.

local Lighting = game:GetService("Lighting")

• Category: Data.
• Serialization: cannot load or save.
• Thread safety: read safe

workspace: Workspace

• Read-onlyThis property is capable of being read but not written.
• Not replicatedThis member is not replicated across the network boundary.
• DeprecatedThis member will be phased out and should be avoided while it is still available.

This property is deprecated and the workspace should instead be accessed with workspace or game.Workspace.

• Category: Data.
• Serialization: cannot load or save.
• Thread safety: read safe

Methods

BindToClose(function: Function): null

Parameters

Name	Type
function	Function

• Thread safety: unsafe

DefineFastFlag(name: string, defaultValue: bool): bool

Parameters

Name	Type
name	string
defaultValue	bool

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

DefineFastInt(name: string, defaultValue: int): int

Parameters

Name	Type
name	string
defaultValue	int

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

DefineFastString(name: string, defaultValue: string): string

Parameters

Name	Type
name	string
defaultValue	string

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

GetEngineFeature(name: string): bool

Parameters

Name	Type
name	string

• Security: LocalUserSecurity.
• Thread safety: unsafe

GetFastFlag(name: string): bool

Parameters

Name	Type
name	string

• Security: LocalUserSecurity.
• Thread safety: unsafe

GetFastInt(name: string): int

Parameters

Name	Type
name	string

• Security: LocalUserSecurity.
• Thread safety: unsafe

GetFastString(name: string): string

Parameters

Name	Type
name	string

• Security: LocalUserSecurity.
• Thread safety: unsafe

GetJobsInfo(): Array

This class member is missing documentation. Create or add to its subpage at Class:DataModel/GetJobsInfo.

• Security: PluginSecurity.
• Thread safety: unsafe

GetMessage(): string

• DeprecatedThis member will be phased out and should be avoided while it is still available.

This class member is missing documentation. Create or add to its subpage at Class:DataModel/GetMessage.

• Thread safety: unsafe

GetObjects(url: ContentId): Instances

Parameters

Name	Type
url	ContentId

• Security: PluginSecurity.
• Thread safety: unsafe

GetObjectsAllOrNone(url: ContentId, binaryFormatOnly: bool = false): Instances

Parameters

Name	Type	Default
url	ContentId
binaryFormatOnly	bool	false

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

GetObjectsAsync(url: ContentId): Instances

• YieldsThis function can yield the script it is used in.

Parameters

Name	Type
url	ContentId

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

GetObjectsList(urls: Array): Array

Parameters

Name	Type
urls	Array

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

GetPlaySessionId(): string

This class member is missing documentation. Create or add to its subpage at Class:DataModel/GetPlaySessionId.

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

GetRemoteBuildMode(): bool

• DeprecatedThis member will be phased out and should be avoided while it is still available.

This class member is missing documentation. Create or add to its subpage at Class:DataModel/GetRemoteBuildMode.

• Thread safety: unsafe

HttpGetAsync(url: string, httpRequestType: HttpRequestType = Default): string

• YieldsThis function can yield the script it is used in.

Parameters

Name	Type	Default
url	string
httpRequestType	HttpRequestType	Default

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

HttpPostAsync(url: string, data: string, contentType: string = */*, httpRequestType: HttpRequestType = Default): string

• YieldsThis function can yield the script it is used in.

Parameters

Name	Type	Default
url	string
data	string
contentType	string	*/*
httpRequestType	HttpRequestType	Default

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

InsertObjectsAndJoinIfLegacyAsync(url: ContentId): Instances

• YieldsThis function can yield the script it is used in.

Parameters

Name	Type
url	ContentId

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

IsContentLoaded(): bool

This class member is missing documentation. Create or add to its subpage at Class:DataModel/IsContentLoaded.

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

IsGearTypeAllowed(gearType: GearType): bool

• DeprecatedThis member will be phased out and should be avoided while it is still available.

Parameters

Name	Type
gearType	GearType

• Thread safety: unsafe

IsLoaded(): bool

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:DataModel/IsLoaded.

• Thread safety: unsafe

IsUniverseMetadataLoaded(): bool

This class member is missing documentation. Create or add to its subpage at Class:DataModel/IsUniverseMetadataLoaded.

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

Load(url: ContentId): null

Parameters

Name	Type
url	ContentId

• Security: LocalUserSecurity.
• Thread safety: unsafe

OpenScreenshotsFolder(): null

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:DataModel/OpenScreenshotsFolder.

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

OpenVideosFolder(): null

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:DataModel/OpenVideosFolder.

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

ReportInGoogleAnalytics(category: string, action: string = custom, label: string = none, value: int = 0): null

Parameters

Name	Type	Default
category	string
action	string	custom
label	string	none
value	int	0

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

SavePlace(saveFilter: SaveFilter = SaveAll): bool

• YieldsThis function can yield the script it is used in.
• DeprecatedThis member will be phased out and should be avoided while it is still available.

Parameters

Name	Type	Default
saveFilter	SaveFilter	SaveAll

• Thread safety: unsafe

SetFastFlagForTesting(name: string, newValue: bool): bool

Parameters

Name	Type
name	string
newValue	bool

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

SetFastIntForTesting(name: string, newValue: int): int

Parameters

Name	Type
name	string
newValue	int

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

SetFastStringForTesting(name: string, newValue: string): string

Parameters

Name	Type
name	string
newValue	string

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

SetFlagVersion(name: string, version: int): null

Parameters

Name	Type
name	string
version	int

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

SetIsLoaded(value: bool, placeSizeInBytes: int?): null

Parameters

Name	Type
value	bool
placeSizeInBytes	int?

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

SetPlaceId(placeId: int64): null

Parameters

Name	Type
placeId	int64

• Security: PluginSecurity.
• Thread safety: unsafe

SetUniverseId(universeId: int64): null

Parameters

Name	Type
universeId	int64

• Security: PluginSecurity.
• Thread safety: unsafe

Shutdown(): null

This class member is missing documentation. Create or add to its subpage at Class:DataModel/Shutdown.

• Security: LocalUserSecurity.
• Thread safety: unsafe

Events

AllowedGearTypeChanged()

• DeprecatedThis member will be phased out and should be avoided while it is still available.

This class member is missing documentation. Create or add to its subpage at Class:DataModel/AllowedGearTypeChanged.

• Thread safety: unsafe

GraphicsQualityChangeRequest(betterQuality: bool)

Parameters

Name	Type
betterQuality	bool

• Thread safety: unsafe

ItemChanged(object: Instance, descriptor: string)

• DeprecatedThis member will be phased out and should be avoided while it is still available.

Parameters

Name	Type
object	Instance
descriptor	string

• Thread safety: unsafe

Loaded()

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:DataModel/Loaded.

• Thread safety: unsafe

ScreenshotReady(path: string)

Parameters

Name	Type
path	string

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

ScreenshotSavedToAlbum(filename: string, success: bool, message: string)

Parameters

Name	Type
filename	string
success	bool
message	string

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

UniverseMetadataLoaded()

This class member is missing documentation. Create or add to its subpage at Class:DataModel/UniverseMetadataLoaded.

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

Callbacks

OnClose(): Tuple

• DeprecatedThis member will be phased out and should be avoided while it is still available.

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:DataModel/OnClose.

• Thread safety: unsafe

Removed members

Methods

• ActivateExperimentalFeatures
• AddStat
• ClearContent
• ClearMessage
• CreatePlace
• FinishShutdown
• get
• GetJobIntervalPeakFraction
• GetJobsExtendedStats
• GetJobTimePeakFraction
• HttpGet
• HttpPost
• LoadGame
• LoadPlugins
• LoadWorld
• RemoveStat
• ReportMeasurement
• Save
• SaveStats
• SaveToRoblox
• ServerSave
• SetCreatorId
• SetCreatorID
• SetGameInstanceId
• SetGearSettings
• SetGenre
• SetJobsExtendedStatsWindow
• SetMessage
• SetMessageBrickCount
• SetPlaceID
• SetPlaceVersion
• SetRemoteBuildMode
• SetScreenshotInfo
• SetServerSaveUrl
• SetVideoInfo
• SetVIPServerId
• SetVIPServerOwnerId
• ToggleTools

Properties

• EnableScriptCollabOnLoad
• IsPersonalServer
• LocalSaveEnabled
• ShowMouse

Events

• SavePlaceFinished

Callbacks

• RequestShutdown

External links

• DataModel in the Roblox Creator Documentation
• DataModel in the Roblox API Reference