Roblox API Reference

DataModel On DevHub

Summary

This class is not creatable. An object of this class cannot be created with Instance.new.

Tags: [NotCreatable]

Inherits (2)

Member index (54)

Type Member History
int64 CreatorId 323
CreatorType CreatorType
int64 GameId 304 323
GearGenreSetting GearGenreSetting 385
Genre Genre
bool IsSFFlagsLoaded 256 469
string JobId
int64 PlaceId 315
int PlaceVersion 120
string PrivateServerId 352
int64 PrivateServerOwnerId 352
string VIPServerId 181 352
int64 VIPServerOwnerId 210 326 352
Workspace Workspace 329
Instance lighting 68 329
Workspace workspace 329
void BindToClose (Function function) 264
bool DefineFastFlag (string name, bool defaultValue) 389
int DefineFastInt (string name, int defaultValue) 389
string DefineFastString (string name, string defaultValue) 389
bool GetEngineFeature (string name) 431
bool GetFastFlag (string name) 389 416
int GetFastInt (string name) 389 416
string GetFastString (string name) 389 416
Array GetJobsInfo () 152
string GetMessage () 154 273 272 273
Objects GetObjects (Content url) 152 215 349
Objects GetObjectsAllOrNone (Content url) 520
Objects GetObjectsAsync (Content url) 382
Array GetObjectsList (Array urls) 375
bool GetRemoteBuildMode () 273 272 273
string HttpGetAsync (string url, HttpRequestType httpRequestType = Default) 83 84 85 298 414
string HttpPostAsync (string url, string data, string contentType = */*, HttpRequestType httpRequestType = Default) 83 84 85 135 298 414
Objects InsertObjectsAndJoinIfLegacyAsync (Content url) 396
bool IsGearTypeAllowed (GearType gearType) 385
bool IsLoaded () 80 79 80
void Load (Content url)
void OpenScreenshotsFolder () 286 285 286 285 287
void OpenVideosFolder () 292
void ReportInGoogleAnalytics (string category, string action = custom, string label = none, int value = 0) 170
bool SavePlace (SaveFilter saveFilter = SaveAll) 115 118 118 118 138 273 272 273
bool SetFastFlagForTesting (string name, bool newValue) 412
int SetFastIntForTesting (string name, int newValue) 412
string SetFastStringForTesting (string name, string newValue) 412
void SetPlaceId (int64 placeId) 150 151 311 349
void SetUniverseId (int64 universeId) 173 311 349
void Shutdown ()
AllowedGearTypeChanged () 292
GraphicsQualityChangeRequest (bool betterQuality)
ItemChanged (Instance object, string descriptor) 292
Loaded () 80 79 80
ScreenshotReady (string path) 286 285 286 285 287
ScreenshotSavedToAlbum (string filename, bool success, string message) 470
Tuple OnClose () 143 268
8 members inherited from ServiceProvider
51 members inherited from Instance

Removed member index (44)

Type Member History
bool EnableScriptCollabOnLoad 408 409
bool IsPersonalServer 48 273 272 273
bool LocalSaveEnabled 273 272 273
bool ShowMouse 48 49
void ActivateExperimentalFeatures () 122 128
void AddStat (string displayName, string stat) 91 90 91 310
void ClearContent (bool resettingSimulation) 217
void ClearMessage () 273 272 273
int CreatePlace (string placeName, int templatePlaceID) 131 153
void FinishShutdown (bool localSave) 310
double GetJobIntervalPeakFraction (string jobname, double greaterThan) 152 454
double GetJobTimePeakFraction (string jobname, double greaterThan) 152 454
Array GetJobsExtendedStats () 152 454
string HttpGet (string url, bool synchronous = false, HttpRequestType httpRequestType = Default, bool doNotAllowDiabolicalMode = false) 83 84 85 298 331
string HttpPost (string url, string data, bool synchronous = false, string contentType = */*, HttpRequestType httpRequestType = Default, bool doNotAllowDiabolicalMode = false) 83 84 85 135 298 331
void LoadGame (int assetID) 118 296
void LoadPlugins () 310
void LoadWorld (int assetID) 118 296
void RemoveStat (string stat) 91 90 91 310
void ReportMeasurement (string id, string key1, string value1, string key2, string value2) 310
void Save (Content url) 310
void SaveStats () 91 90 91 310
bool SaveToRoblox () 310
void ServerSave () 310
void SetCreatorID (int creatorID, CreatorType creatorType) 151 311
void SetCreatorId (int creatorId, CreatorType creatorType) 151 311
void SetGameInstanceId (string instanceID) 236 238
void SetGearSettings (GearGenreSetting genreRestriction, int allowedGenres) 151 311
void SetGenre (Genre genre) 151 311
void SetJobsExtendedStatsWindow (double seconds) 310
void SetMessage (string message) 273 272 273
void SetMessageBrickCount () 273 272 273
void SetPlaceID (int placeID, bool robloxPlace = false) 150 151 311
void SetPlaceVersion (int placeId) 120 151 311
void SetRemoteBuildMode (bool buildModeEnabled) 273 272 273
void SetScreenshotInfo (string info) 311
void SetServerSaveUrl (string url) 310
void SetVIPServerId (string newId) 181 310
void SetVIPServerOwnerId (int newId) 210 310
void SetVideoInfo (string info) 311
void ToggleTools () 273 272 273
Objects get (Content url) 215
SavePlaceFinished (bool succeeded, string errorString) 115 118
bool RequestShutdown () 131 310

History

Members

AllowedGearTypeChanged On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
Name Type Default
No parameters.

History

Tags: [Deprecated]

BindToClose On DevHub

Name Type Default
function Function none

History

CreatorId On DevHub

This property is read-only. Its value can be read, but it cannot be modified.
This item is not replicated. Its interface does not cross the network boundary.

History

Tags: [ReadOnly, NotReplicated]

CreatorType On DevHub

This property is read-only. Its value can be read, but it cannot be modified.
This item is not replicated. Its interface does not cross the network boundary.

Tags: [ReadOnly, NotReplicated]

DefineFastFlag On DevHub

Name Type Default
name string none
defaultValue bool none

History

DefineFastInt On DevHub

Name Type Default
name string none
defaultValue int none

History

DefineFastString On DevHub

Name Type Default
name string none
defaultValue string none

History

GameId On DevHub

This property is read-only. Its value can be read, but it cannot be modified.
This item is not replicated. Its interface does not cross the network boundary.

History

Tags: [ReadOnly, NotReplicated]

GearGenreSetting On DevHub

This property is read-only. Its value can be read, but it cannot be modified.
This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
This item is not replicated. Its interface does not cross the network boundary.

History

Tags: [ReadOnly, NotReplicated, Deprecated]

Genre On DevHub

This property is read-only. Its value can be read, but it cannot be modified.
This item is not replicated. Its interface does not cross the network boundary.

Tags: [ReadOnly, NotReplicated]

GetEngineFeature On DevHub

Name Type Default
name string none

History

GetFastFlag On DevHub

Name Type Default
name string none

History

GetFastInt On DevHub

Name Type Default
name string none

History

GetFastString On DevHub

Name Type Default
name string none

History

GetJobsInfo On DevHub

Name Type Default
No parameters.

History

GetMessage On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
Name Type Default
No parameters.

History

Tags: [Deprecated]

GetObjects On DevHub

Name Type Default
url Content none

History

GetObjectsAllOrNone On DevHub

Name Type Default
url Content none

History

GetObjectsAsync On DevHub

This function yields. It will block the calling thread until completion.
Name Type Default
url Content none

History

Tags: [Yields]

GetObjectsList On DevHub

Name Type Default
urls Array none

History

GetRemoteBuildMode On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
Name Type Default
No parameters.

History

Tags: [Deprecated]

GraphicsQualityChangeRequest On DevHub

Name Type Default
betterQuality bool none

HttpGetAsync On DevHub

This function yields. It will block the calling thread until completion.
Name Type Default
url string none
httpRequestType HttpRequestType Default

History

Tags: [Yields]

HttpPostAsync On DevHub

This function yields. It will block the calling thread until completion.
Name Type Default
url string none
data string none
contentType string */*
httpRequestType HttpRequestType Default

History

Tags: [Yields]

InsertObjectsAndJoinIfLegacyAsync On DevHub

This function yields. It will block the calling thread until completion.
Name Type Default
url Content none

History

Tags: [Yields]

IsGearTypeAllowed On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
Name Type Default
gearType GearType none

History

Tags: [Deprecated]

IsLoaded On DevHub

Name Type Default
No parameters.

History

IsSFFlagsLoaded On DevHub

This property is read-only. Its value can be read, but it cannot be modified.
This member is hidden. It is not meant to be used, and may have unresolved issues.
This item is not replicated. Its interface does not cross the network boundary.

History

Tags: [Hidden, ReadOnly, NotReplicated]

ItemChanged On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
Name Type Default
object Instance none
descriptor string none

History

Tags: [Deprecated]

JobId On DevHub

This property is read-only. Its value can be read, but it cannot be modified.
This item is not replicated. Its interface does not cross the network boundary.

Tags: [ReadOnly, NotReplicated]

Load On DevHub

Name Type Default
url Content none

Loaded On DevHub

Name Type Default
No parameters.

History

OnClose On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
Name Type Default
No parameters.

History

Tags: [Deprecated]

OpenScreenshotsFolder On DevHub

Name Type Default
No parameters.

History

OpenVideosFolder On DevHub

Name Type Default
No parameters.

History

PlaceId On DevHub

This property is read-only. Its value can be read, but it cannot be modified.
This item is not replicated. Its interface does not cross the network boundary.

History

Tags: [ReadOnly, NotReplicated]

PlaceVersion On DevHub

This property is read-only. Its value can be read, but it cannot be modified.
This item is not replicated. Its interface does not cross the network boundary.

History

Tags: [ReadOnly, NotReplicated]

PrivateServerId On DevHub

This property is read-only. Its value can be read, but it cannot be modified.
This item is not replicated. Its interface does not cross the network boundary.

History

Tags: [ReadOnly, NotReplicated]

PrivateServerOwnerId On DevHub

This property is read-only. Its value can be read, but it cannot be modified.
This item is not replicated. Its interface does not cross the network boundary.

History

Tags: [ReadOnly, NotReplicated]

ReportInGoogleAnalytics On DevHub

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

History

SavePlace On DevHub

This function yields. It will block the calling thread until completion.
This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
Name Type Default
saveFilter SaveFilter SaveAll

History

Tags: [Yields, Deprecated]

ScreenshotReady On DevHub

Name Type Default
path string none

History

ScreenshotSavedToAlbum On DevHub

Name Type Default
filename string none
success bool none
message string none

History

SetFastFlagForTesting On DevHub

Name Type Default
name string none
newValue bool none

History

SetFastIntForTesting On DevHub

Name Type Default
name string none
newValue int none

History

SetFastStringForTesting On DevHub

Name Type Default
name string none
newValue string none

History

SetPlaceId On DevHub

Name Type Default
placeId int64 none

History

SetUniverseId On DevHub

Name Type Default
universeId int64 none

History

Shutdown On DevHub

Name Type Default
No parameters.

VIPServerId On DevHub

This property is read-only. Its value can be read, but it cannot be modified.
This member is hidden. It is not meant to be used, and may have unresolved issues.
This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
This item is not replicated. Its interface does not cross the network boundary.

History

Tags: [Hidden, ReadOnly, NotReplicated, Deprecated]

VIPServerOwnerId On DevHub

This property is read-only. Its value can be read, but it cannot be modified.
This member is hidden. It is not meant to be used, and may have unresolved issues.
This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
This item is not replicated. Its interface does not cross the network boundary.

History

Tags: [Hidden, ReadOnly, NotReplicated, Deprecated]

Workspace On DevHub

This property is read-only. Its value can be read, but it cannot be modified.
This item is not replicated. Its interface does not cross the network boundary.

History

Tags: [ReadOnly, NotReplicated]

lighting On DevHub

This property is read-only. Its value can be read, but it cannot be modified.
This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
This item is not replicated. Its interface does not cross the network boundary.

History

Tags: [ReadOnly, NotReplicated, Deprecated]

workspace On DevHub

This property is read-only. Its value can be read, but it cannot be modified.
This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
This item is not replicated. Its interface does not cross the network boundary.

History

Tags: [ReadOnly, NotReplicated, Deprecated]

Removed members

ActivateExperimentalFeatures

Name Type Default
No parameters.

History

AddStat

Name Type Default
displayName string none
stat string none

History

ClearContent

Name Type Default
resettingSimulation bool none

History

ClearMessage

Name Type Default
No parameters.

History

CreatePlace

This function yields. It will block the calling thread until completion.
Name Type Default
placeName string none
templatePlaceID int none

History

Tags: [Yields]

EnableScriptCollabOnLoad

This member is hidden. It is not meant to be used, and may have unresolved issues.

History

Tags: [Hidden]

FinishShutdown

Name Type Default
localSave bool none

History

GetJobIntervalPeakFraction

Name Type Default
jobname string none
greaterThan double none

History

GetJobTimePeakFraction

Name Type Default
jobname string none
greaterThan double none

History

GetJobsExtendedStats

Name Type Default
No parameters.

History

HttpGet

Name Type Default
url string none
synchronous bool false
httpRequestType HttpRequestType Default
doNotAllowDiabolicalMode bool false

History

HttpPost

Name Type Default
url string none
data string none
synchronous bool false
contentType string */*
httpRequestType HttpRequestType Default
doNotAllowDiabolicalMode bool false

History

IsPersonalServer

History

LoadGame

Name Type Default
assetID int none

History

LoadPlugins

Name Type Default
No parameters.

History

LoadWorld

Name Type Default
assetID int none

History

LocalSaveEnabled

This property is read-only. Its value can be read, but it cannot be modified.

History

Tags: [ReadOnly]

RemoveStat

Name Type Default
stat string none

History

ReportMeasurement

Name Type Default
id string none
key1 string none
value1 string none
key2 string none
value2 string none

History

RequestShutdown

This callback cannot yield. Attempting to yield within this callback will result in an error.
Name Type Default
No parameters.

History

Tags: [noyield]

Save

Name Type Default
url Content none

History

SavePlaceFinished

Name Type Default
succeeded bool none
errorString string none

History

SaveStats

Name Type Default
No parameters.

History

SaveToRoblox

This function yields. It will block the calling thread until completion.
Name Type Default
No parameters.

History

Tags: [Yields]

ServerSave

Name Type Default
No parameters.

History

SetCreatorID

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
Name Type Default
creatorID int none
creatorType CreatorType none

History

Tags: [Deprecated]

SetCreatorId

Name Type Default
creatorId int none
creatorType CreatorType none

History

SetGameInstanceId

Name Type Default
instanceID string none

History

SetGearSettings

Name Type Default
genreRestriction GearGenreSetting none
allowedGenres int none

History

SetGenre

Name Type Default
genre Genre none

History

SetJobsExtendedStatsWindow

Name Type Default
seconds double none

History

SetMessage

Name Type Default
message string none

History

SetMessageBrickCount

Name Type Default
No parameters.

History

SetPlaceID

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
Name Type Default
placeID int none
robloxPlace bool false

History

Tags: [Deprecated]

SetPlaceVersion

Name Type Default
placeId int none

History

SetRemoteBuildMode

Name Type Default
buildModeEnabled bool none

History

SetScreenshotInfo

Name Type Default
info string none

History

SetServerSaveUrl

Name Type Default
url string none

History

SetVIPServerId

Name Type Default
newId string none

History

SetVIPServerOwnerId

Name Type Default
newId int none

History

SetVideoInfo

Name Type Default
info string none

History

ShowMouse

This member is hidden. It is not meant to be used, and may have unresolved issues.
This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

History

Tags: [Hidden, Deprecated]

ToggleTools

Name Type Default
No parameters.

History

get

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
Name Type Default
url Content none

History

Tags: [Deprecated]

Relevant classes (2)

Relevant enums (6)

Relevant members (1)