Reference API Roblox

Engine API

Website

Related

Reference API Roblox

DataModel

The root of Roblox's parent-child hierarchy. Its direct children are services, such as Workspace and Lighting, that act as the fundamental components of a Roblox game.

This class is not creatable. Instances of this class cannot be created with Instance.new.
Memory categoryInstances
Tags: [NotCreatable]

Member index 63

HistoryMember
553CreatorId: int64
553CreatorType: CreatorType
553GameId: int64
553GearGenreSetting: GearGenreSetting
553Genre: Genre
553JobId: string
553PlaceId: int64
553PlaceVersion: int
553PrivateServerId: string
553PrivateServerOwnerId: int64
553Workspace: Workspace
553lighting: Instance
553workspace: Workspace
573BindToClose(function: Function): null
462DefineFastFlag(name: string, defaultValue: bool): bool
462DefineFastInt(name: string, defaultValue: int): int
462DefineFastString(name: string, defaultValue: string): string
462GetEngineFeature(name: string): bool
462GetFastFlag(name: string): bool
462GetFastInt(name: string): int
462GetFastString(name: string): string
462GetJobsInfo(): Array
462GetMessage(): string
648GetObjects(url: ContentId): Instances
648GetObjectsAllOrNone(url: ContentId, binaryFormatOnly: bool = false): Instances
648GetObjectsAsync(url: ContentId): Instances
462GetObjectsList(urls: Array): Array
557GetPlaySessionId(): string
462GetRemoteBuildMode(): bool
462HttpGetAsync(url: string, httpRequestType: HttpRequestType = Default): string
462HttpPostAsync(url: string, data: string, contentType: string = */*, httpRequestType: HttpRequestType = Default): string
648InsertObjectsAndJoinIfLegacyAsync(url: ContentId): Instances
568IsContentLoaded(): bool
462IsGearTypeAllowed(gearType: GearType): bool
462IsLoaded(): bool
569IsUniverseMetadataLoaded(): bool
645Load(url: ContentId): null
573OpenScreenshotsFolder(): null
573OpenVideosFolder(): null
573ReportInGoogleAnalytics(category: string, action: string = custom, label: string = none, value: int = 0): null
462SavePlace(saveFilter: SaveFilter = SaveAll): bool
462SetFastFlagForTesting(name: string, newValue: bool): bool
462SetFastIntForTesting(name: string, newValue: int): int
462SetFastStringForTesting(name: string, newValue: string): string
573SetFlagVersion(name: string, version: int): null
573SetIsLoaded(value: bool, placeSizeInBytes: int?): null
573SetPlaceId(placeId: int64): null
573SetUniverseId(universeId: int64): null
573Shutdown(): null
462AllowedGearTypeChanged()
462GraphicsQualityChangeRequest(betterQuality: bool)
462ItemChanged(object: Instance, descriptor: string)
462Loaded()
462ScreenshotReady(path: string)
470ScreenshotSavedToAlbum(filename: string, success: bool, message: string)
569UniverseMetadataLoaded()
553OnClose(): Tuple
inherited from ServiceProvider
497FindService(className: string): Instance
494GetService(className: string): Instance
553getService(className: string): Instance
553service(className: string): Instance
462Close()
462CloseLate()
462ServiceAdded(service: Instance)
462ServiceRemoving(service: Instance)
inherited from Instance
553Archivable: bool
635Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
641GetStyled(name: string): Variant
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

Removed member index 44

HistoryMember
273IsPersonalServer: bool
273LocalSaveEnabled: bool
128ActivateExperimentalFeatures(): void
310AddStat(displayName: string, stat: string): void
217ClearContent(resettingSimulation: bool): void
273ClearMessage(): void
153CreatePlace(placeName: string, templatePlaceID: int): int
310FinishShutdown(localSave: bool): void
454GetJobIntervalPeakFraction(jobname: string, greaterThan: double): double
454GetJobTimePeakFraction(jobname: string, greaterThan: double): double
454GetJobsExtendedStats(): Array
331HttpGet(url: string, synchronous: bool = false, httpRequestType: HttpRequestType = Default, doNotAllowDiabolicalMode: bool = false): string
331HttpPost(url: string, data: string, synchronous: bool = false, contentType: string = */*, httpRequestType: HttpRequestType = Default, doNotAllowDiabolicalMode: bool = false): string
296LoadGame(assetID: int): void
310LoadPlugins(): void
296LoadWorld(assetID: int): void
310RemoveStat(stat: string): void
310ReportMeasurement(id: string, key1: string, value1: string, key2: string, value2: string): void
310Save(url: Content): void
310SaveStats(): void
310SaveToRoblox(): bool
310ServerSave(): void
311SetCreatorID(creatorID: int, creatorType: CreatorType): void
311SetCreatorId(creatorId: int, creatorType: CreatorType): void
238SetGameInstanceId(instanceID: string): void
311SetGearSettings(genreRestriction: GearGenreSetting, allowedGenres: int): void
311SetGenre(genre: Genre): void
310SetJobsExtendedStatsWindow(seconds: double): void
273SetMessage(message: string): void
273SetMessageBrickCount(): void
311SetPlaceID(placeID: int, robloxPlace: bool = false): void
311SetPlaceVersion(placeId: int): void
273SetRemoteBuildMode(buildModeEnabled: bool): void
311SetScreenshotInfo(info: string): void
310SetServerSaveUrl(url: string): void
310SetVIPServerId(newId: string): void
310SetVIPServerOwnerId(newId: int): void
311SetVideoInfo(info: string): void
273ToggleTools(): void
215get(url: Content): Objects
118SavePlaceFinished(succeeded: bool, errorString: string)
310RequestShutdown(): bool

Description

The Data Model (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 Workspace and Lighting, that act as the fundamental components of a Roblox game.

History 368

Members 63

AllowedGearTypeChanged

Parameters (0)
No parameters.

This event fires when SetGearSettings is called with a different value for allowedGenres.

This event is deprecated. It exists only for backward compatibility, and should not be used for new work.
Thread safetyUnsafe

History 3

Tags: [Deprecated]

BindToClose

Parameters (1)
functionFunction
Returns (1)
null

Binds a function to be called before the server shuts down. If the bound function accepts a parameter, it passes CloseReason specifying the reason for the server shutdown.

You can bind multiple functions by calling BindToClose() repeatedly. Bound functions are called in parallel and run at the same time.

The experience server waits 30 seconds for all bound functions to stop running before it shuts down. After 30 seconds, the server shuts down even if functions are still running.

To verify that the current session is not in Roblox Studio, use RunService:IsStudio(). This prevents bound functions from completing their run in offline testing sessions.

When you use DataStoreService, you should also use BindToClose to bind a function saving all unsaved data to DataStores. This prevents data loss if the server shuts down unexpectedly.

See also:

Thread safetyUnsafe

History 3

CreatorId

TypeDefault
int64

This property describes the ID of the user or group that owns the place. If the DataModel.CreatorType property is 'User' then CreatorId will be the Player.UserId of the place's owner. If the DataModel.CreatorType is 'Group' then CreatorId will be the ID of the group that owns the place.

This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safetyReadSafe
CategoryState
Loaded/Savedfalse

History 5

Tags: [ReadOnly, NotReplicated]

CreatorType

TypeDefault
CreatorType

This property describes the CreatorType of the place, whether the place is owned by a user or a group.

If the CreatorType is 'User', then the DataModel.CreatorId property will describe the UserId of the account that owns the game. If the CreatorType is 'Group', then it will describe the group ID.

This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safetyReadSafe
CategoryState
Loaded/Savedfalse

History 4

Tags: [ReadOnly, NotReplicated]

DefineFastFlag

Parameters (2)
namestring
defaultValuebool
Returns (1)
bool
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 2

DefineFastInt

Parameters (2)
namestring
defaultValueint
Returns (1)
int
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 2

DefineFastString

Parameters (2)
namestring
defaultValuestring
Returns (1)
string
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 2

GameId

TypeDefault
int64

This property describes the ID of the experience that the place running on the server belongs to.

This ID can be found in the top right corner of the Asset Manager in Roblox Studio. When using Roblox Studio, if the place has not been published to Roblox then the GameId will correspond with the template being used.

See also:

This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safetyReadSafe
CategoryState
Loaded/Savedfalse

History 5

Tags: [ReadOnly, NotReplicated]

GearGenreSetting

TypeDefault
GearGenreSetting

This property, along with DataModel.Genre, no longer functions correctly and attempting to read it may throw an error.

This property is deprecated. It exists only for backward compatibility, and should not be used for new work.
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safetyReadSafe
CategoryState
Loaded/Savedfalse

History 5

Tags: [ReadOnly, NotReplicated, Deprecated]

Genre

TypeDefault
Genre

This property is broken and should not be used.

This property historically described the Genre of the place as set on the Roblox website.

This property, along with DataModel.GearGenreSetting, no longer functions correctly due to genres existing on the Roblox website that are not reflected in the Genre enum. As a result, attempting to read this property may throw an error.

This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safetyReadSafe
CategoryState
Loaded/Savedfalse

History 4

  • 553 Change Default of Genre from to
  • 486 Change ThreadSafety of Genre from ReadOnly to ReadSafe
  • 462 Change ThreadSafety of Genre from to ReadOnly
  • 47 Add Genre
Tags: [ReadOnly, NotReplicated]

GetEngineFeature

Parameters (1)
namestring
Returns (1)
bool
SecurityLocalUserSecurity
Thread safetyUnsafe

History 2

GetFastFlag

Parameters (1)
namestring
Returns (1)
bool
SecurityLocalUserSecurity
Thread safetyUnsafe

History 3

GetFastInt

Parameters (1)
namestring
Returns (1)
int
SecurityLocalUserSecurity
Thread safetyUnsafe

History 3

GetFastString

Parameters (1)
namestring
Returns (1)
string
SecurityLocalUserSecurity
Thread safetyUnsafe

History 3

GetJobsInfo

Parameters (0)
No parameters.
Returns (1)
Array

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

In computing, a task scheduler is a system responsible for executing key tasks at the appropriate intervals.

You can also find live task scheduler statistics in the Task Scheduler window in Roblox Studio.

The first entry in the table returned is a reference dictionary containing the statistics (or headings) available. It is in the following format:

1
2
3
4
5
6
7
8

{
    ["name"] = "name",
    ["averageDutyCycle"] = "averageDutyCycle",
    ["averageStepsPerSecond"] = "averageStepsPerSecond",
    ["averageStepTime"] = "averageStepTime",
    ["averageError"] = "averageError",
    ["isRunning"] = "isRunning",
}

The subsequent entries in the table returned are dictionaries containing the above statistics for jobs performed by the task scheduler. For example:

1
2
3
4
5
6
7
8

{
    ["name"] = "Heartbeat",
    ["averageDutyCycle"] = 0,
    ["averageStepsPerSecond"] = 0,
    ["averageStepTime"] = 0,
    ["averageError"] = 0,
    ["isRunning"] = false,
}

See also:

SecurityPluginSecurity
Thread safetyUnsafe

History 3

GetMessage

Parameters (0)
No parameters.
Returns (1)
string

This function will always return a blank string. It was originally used to set the message displayed on screen while the game was loading.

This system was phased out a very long time ago, and recently the APIs for setting this message were removed.

This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
Thread safetyUnsafe

History 5

Tags: [Deprecated]

GetObjects

Parameters (1)
urlContentId
Returns (1)
Instances

This method returns an array of Instances associated with the given content URL. It can be used to insert content from the Roblox library. It's not possible to insert Sounds using this method as they do not have an Instance associated with them and have only a content URL.

Unlike InsertService:LoadAsset(), DataModel:GetObjects() does not require an asset to be "trusted," meaning that an asset doesn't need to be owned by the logged in user, or created by Roblox, to be inserted. However, if the asset is not owned by the logged in user it must be freely available.

Due to this function's security context it can only be used by plugins or the command bar. For an alternative that can be used in Scripts and LocalScripts, see InsertService:LoadAsset().

SecurityPluginSecurity
Thread safetyUnsafe

History 7

GetObjectsAllOrNone

Parameters (2)Default
urlContentId
binaryFormatOnlyboolfalse
Returns (1)
Instances
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 4

GetObjectsAsync

Parameters (1)
urlContentId
Returns (1)
Instances
This function yields. It will block the calling thread until completion.
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 4

Tags: [Yields]

GetObjectsList

Parameters (1)
urlsArray
Returns (1)
Array
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 2

GetPlaySessionId

Parameters (0)
No parameters.
Returns (1)
string
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 3

GetRemoteBuildMode

Parameters (0)
No parameters.
Returns (1)
bool

This method is no longer useful and will always return false. Use RunService:IsServer() to see if your code is running on the server.

This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
Thread safetyUnsafe

History 5

Tags: [Deprecated]

GraphicsQualityChangeRequest

Parameters (1)
betterQualitybool

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

This event fires under the following conditions:

  • If the user presses F10, this event fires with a betterQuality argument of true.
  • If the user presses ShiftF10, this event fires with a betterQuality argument of false.

This event does not provide the current graphics quality level or cover all updates to the graphics quality. For example, changes made in the core GUI escape menu are not registered.

You can retrieve a user's SavedQualitySetting using UserGameSettings with the following snippet:

1

UserSettings():GetService("UserGameSettings").SavedQualityLevel

If the user's graphics settings are set to automatic then the SavedQualitySetting will be Automatic. There is currently no way for developers to reliably get the current graphics quality level of a user's machine.

Thread safetyUnsafe

History 2

HttpGetAsync

Parameters (2)Default
urlstring
httpRequestTypeHttpRequestTypeDefault
Returns (1)
string
This function yields. It will block the calling thread until completion.
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 7

Tags: [Yields]

HttpPostAsync

Parameters (4)Default
urlstring
datastring
contentTypestring*/*
httpRequestTypeHttpRequestTypeDefault
Returns (1)
string
This function yields. It will block the calling thread until completion.
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 8

Tags: [Yields]

InsertObjectsAndJoinIfLegacyAsync

Parameters (1)
urlContentId
Returns (1)
Instances
This function yields. It will block the calling thread until completion.
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 4

Tags: [Yields]

IsContentLoaded

Parameters (0)
No parameters.
Returns (1)
bool
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 1

IsGearTypeAllowed

Parameters (1)
gearTypeGearType
Returns (1)
bool

Currently this function only returns the correct value on the client

This function returns whether gear of the given GearType is permitted to be added to Players' StarterGears. For example:

1

local meleeWeaponsAllowed = game:IsGearTypeAllowed(Enum.GearType.MeleeWeapons)

Whether gear of a specific GearType is permitted in the game is determined in a place's settings page under 'Permissions'. Note, all of a gear's associated GearTypes must be enabled for it to be permitted in a place.

This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
Thread safetyUnsafe

History 3

Tags: [Deprecated]

IsLoaded

Parameters (0)
No parameters.
Returns (1)
bool

This function returns true if the client has finished loading the game for the first time.

When all initial Instances in the game have finished replicating to the client, this function will return true.

Unless they are parented to ReplicatedFirst, LocalScripts will not run while the game has not loaded. The following snippet, ran from a LocalScript in ReplicatedFirst will yield until the game has loaded:

1
2
3

if not game:IsLoaded() then
    game.Loaded:Wait()
end

See also:

Thread safetyUnsafe

History 4

IsUniverseMetadataLoaded

Parameters (0)
No parameters.
Returns (1)
bool
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 1

ItemChanged

Parameters (2)
objectInstance
descriptorstring

This event fires when a property of any object in the DataModel is changed.

This event is deprecated. It exists only for backward compatibility, and should not be used for new work.
Thread safetyUnsafe

History 3

Tags: [Deprecated]

JobId

TypeDefault
string

This property is a unique identifier for the running game server instance. It is a universally unique identifier (UUID), meaning that no two servers, past or present, will ever have the same ID.

Defaults to an empty string in Studio.

See Also

This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safetyReadSafe
CategoryJobInfo
Loaded/Savedfalse

History 4

  • 553 Change Default of JobId from to
  • 486 Change ThreadSafety of JobId from ReadOnly to ReadSafe
  • 462 Change ThreadSafety of JobId from to ReadOnly
  • 47 Add JobId
Tags: [ReadOnly, NotReplicated]

Load

Parameters (1)
urlContentId
Returns (1)
null
SecurityLocalUserSecurity
Thread safetyUnsafe

History 4

Loaded

Parameters (0)
No parameters.

This event fires on the client when the game finishes loading for the first time.

The Loaded event fires when all initial Instances in the game have finished replicating to the client.

Unless they are parented to ReplicatedFirst, LocalScripts will not run prior to this event firing. The following snippet, ran from a LocalScript in ReplicatedFirst, will yield until the game has loaded:

if not game:IsLoaded() then
    game.Loaded:Wait()
end

See also:

Thread safetyUnsafe

History 4

OnClose

Parameters (0)
No parameters.
Returns (1)
Tuple

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

This callback is deprecated. It exists only for backward compatibility, and should not be used for new work. BindToClose should be used instead.
Thread safetyUnsafe

History 4

Tags: [Deprecated]

OpenScreenshotsFolder

Parameters (0)
No parameters.
Returns (1)
null
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 7

OpenVideosFolder

Parameters (0)
No parameters.
Returns (1)
null
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 3

PlaceId

TypeDefault
int64

This property describes the ID of the place running on the server.

If the place has been published to Roblox, this ID can be found in Studio's Asset Manager by right-clicking the place inside of the Places folder and selecting Copy ID to Clipboard.

If the place has not been published to Roblox, this ID will correspond with the template being used.

See Also

This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safetyReadSafe
CategoryState
Loaded/Savedfalse

History 5

Tags: [ReadOnly, NotReplicated]

PlaceVersion

TypeDefault
int

This property describes the version of the place the server is running on.

This version number corresponds with the version number shown under the Version History section of the place's settings. It is not the current version of the Roblox client. This property is 0 for all unpublished experiences.

When a server instance is created for a place, it uses the place's current version. If the place is later updated while this server is running, the server will remain at its current version.

This property can be used to display a ScreenGui showing the current version of the game to Players to assist with debugging.

This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safetyReadSafe
CategoryState
Loaded/Savedfalse

History 4

Tags: [ReadOnly, NotReplicated]

PrivateServerId

TypeDefault
string

This property describes the private server ID of the server, if the server is a private server.

If the server is not a private server, then this property will be an empty string.

Private servers

Private servers refer to the following:

PrivateServerId vs JobId

The PrivateServerId of a server is different from the DataModel.JobId. The JobId is the unique identifier of the current server instance.

Private servers (private or reserved servers) can have multiple server instances associated with them over time. This is because, although only one server instance can be running at once for a private server, new server instances can open and close as players join and leave the game. For example, no server instance is running when nobody is playing in the server. The PrivateServerId will be consistent across all of these server instances, and the DataModel.JobId will be unique for each one.

See also:

This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safetyReadSafe
CategoryData
Loaded/Savedfalse/true

History 4

Tags: [ReadOnly, NotReplicated]

PrivateServerOwnerId

TypeDefault
int64

This property describes the UserId of the Player that owns the private server if the server is private.

If the server is a standard or reserved server then this property will be set to 0.

This property could be used to identify if a Player is the owner of the private server, for example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

local Players = game:GetService("Players")

-- is this a private server?
if game.PrivateServerId ~= "" and game.PrivateServerOwnerId ~= 0 then

    -- listen for new players being added
    Players.PlayerAdded:Connect(function(player)

        -- check if the player is the server owner
        if player.UserId == game.PrivateServerOwnerId then
            print("The private server owner has joined the game")
        end
    end)
end

See also:

This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safetyReadSafe
CategoryData
Loaded/Savedfalse/true

History 4

Tags: [ReadOnly, NotReplicated]

ReportInGoogleAnalytics

Parameters (4)Default
categorystring
actionstringcustom
labelstringnone
valueint0
Returns (1)
null
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 3

SavePlace

Parameters (1)Default
saveFilterSaveFilterSaveAll
Returns (1)
bool

This function was used by an ancient data persistence method to save the current place.

Note:

  • In order for this method to work the save place API has to be enabled for the current place.
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
This function yields. It will block the calling thread until completion.
Thread safetyUnsafe

History 9

Tags: [Yields, Deprecated]

ScreenshotReady

Parameters (1)
pathstring
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 6

ScreenshotSavedToAlbum

Parameters (3)
filenamestring
successbool
messagestring
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 1

SetFastFlagForTesting

Parameters (2)
namestring
newValuebool
Returns (1)
bool
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 2

SetFastIntForTesting

Parameters (2)
namestring
newValueint
Returns (1)
int
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 2

SetFastStringForTesting

Parameters (2)
namestring
newValuestring
Returns (1)
string
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 2

SetFlagVersion

Parameters (2)
namestring
versionint
Returns (1)
null
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 2

SetIsLoaded

Parameters (2)
valuebool
placeSizeInBytesint?
Returns (1)
null
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 2

SetPlaceId

Parameters (1)
placeIdint64
Returns (1)
null

This function sets the DataModel.PlaceId of the game instance to the given placeId.

Setting both DataModel.PlaceId and DataModel.GameId are required to access DataStoreService when the place is unpublished, for example a local .rbxl file. See below for an example. Note that gaining DataStoreService access from Studio requires the Enable Studio Access to API Services setting from the Security panel in Game Settings.

1
2
3
4
5
6

local DataStoreService = game:GetService("DataStoreService")

-- access DataStore 'Data' by setting PlaceId to placeId and GameId to universeId.
game:SetPlaceId(placeId)
game:SetUniverseId(universeId)
local dataStore = DataStoreService:GetDataStore("Data")
SecurityPluginSecurity
Thread safetyUnsafe

History 7

SetUniverseId

Parameters (1)
universeIdint64
Returns (1)
null

This function sets the DataModel.GameId of the current game instance to the given universeId. This is useful when testing local .rbxl files that have not been published to Roblox.

To access the DataStoreService in an unpublished place, both DataModel:SetUniverseId() and DataModel:SetPlaceId() must be set.

SecurityPluginSecurity
Thread safetyUnsafe

History 5

Shutdown

Parameters (0)
No parameters.
Returns (1)
null
SecurityLocalUserSecurity
Thread safetyUnsafe

History 3

UniverseMetadataLoaded

Parameters (0)
No parameters.
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 1

Workspace

TypeDefault
Workspace

The Workspace property is a reference to the Workspace service.

This property will always point to the Workspace and will never be nil.

The Workspace can also be accessed using the global variable workspace and the ServiceProvider:GetService() function. For example:

1
2
3

workspace -- a global variable
game.Workspace -- a property of the DataModel (game)
game:GetService("Workspace") -- workspace is a service
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safetyReadSafe
CategoryData
Loaded/Savedfalse

History 5

Tags: [ReadOnly, NotReplicated]

lighting

TypeDefault
Instance

This property was once used to get the game's Lighting service.

This property is deprecated. It exists only for backward compatibility, and should not be used for new work.
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safetyReadSafe
CategoryData
Loaded/Savedfalse

History 5

Tags: [ReadOnly, NotReplicated, Deprecated]

workspace

TypeDefault
Workspace
This property is deprecated. It exists only for backward compatibility, and should not be used for new work. Workspace should be used instead.
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safetyReadSafe
CategoryData
Loaded/Savedfalse

History 6

Tags: [ReadOnly, NotReplicated, Deprecated]

Removed members 44

ActivateExperimentalFeatures

Parameters (0)
No parameters.
Returns (1)
void
SecurityRobloxSecurity

History 2

AddStat

Parameters (2)
displayNamestring
statstring
Returns (1)
void
SecurityLocalUserSecurity

History 4

ClearContent

Parameters (1)
resettingSimulationbool
Returns (1)
void
SecurityLocalUserSecurity

History 2

ClearMessage

Parameters (0)
No parameters.
Returns (1)
void
SecurityLocalUserSecurity

History 4

CreatePlace

Parameters (2)
placeNamestring
templatePlaceIDint
Returns (1)
int
This function yields. It will block the calling thread until completion.

History 2

Tags: [Yields]

FinishShutdown

Parameters (1)
localSavebool
Returns (1)
void
SecurityRobloxScriptSecurity

History 2

GetJobIntervalPeakFraction

Parameters (2)
jobnamestring
greaterThandouble
Returns (1)
double
SecurityPluginSecurity

History 3

GetJobTimePeakFraction

Parameters (2)
jobnamestring
greaterThandouble
Returns (1)
double
SecurityPluginSecurity

History 3

GetJobsExtendedStats

Parameters (0)
No parameters.
Returns (1)
Array
SecurityPluginSecurity

History 3

HttpGet

Parameters (4)Default
urlstring
synchronousboolfalse
httpRequestTypeHttpRequestTypeDefault
doNotAllowDiabolicalModeboolfalse
Returns (1)
string
SecurityRobloxScriptSecurity

History 6

HttpPost

Parameters (6)Default
urlstring
datastring
synchronousboolfalse
contentTypestring*/*
httpRequestTypeHttpRequestTypeDefault
doNotAllowDiabolicalModeboolfalse
Returns (1)
string
SecurityRobloxScriptSecurity

History 7

IsPersonalServer

TypeDefault
bool
SecurityRobloxScriptSecurity
Category
Loaded/Savedfalse

History 5

LoadGame

Parameters (1)
assetIDint
Returns (1)
void
SecurityLocalUserSecurity

History 2

LoadPlugins

Parameters (0)
No parameters.
Returns (1)
void
SecurityRobloxSecurity

History 2

LoadWorld

Parameters (1)
assetIDint
Returns (1)
void
SecurityLocalUserSecurity

History 2

LocalSaveEnabled

TypeDefault
bool
This property is read-only. Its value can be read, but it cannot be modified.
SecurityRobloxScriptSecurity
Category
Loaded/Savedfalse

History 4

Tags: [ReadOnly]

RemoveStat

Parameters (1)
statstring
Returns (1)
void
SecurityLocalUserSecurity

History 4

ReportMeasurement

Parameters (5)
idstring
key1string
value1string
key2string
value2string
Returns (1)
void
SecurityRobloxScriptSecurity

History 2

RequestShutdown

Parameters (0)
No parameters.
Returns (1)
bool
SecurityRobloxScriptSecurity

History 3

Tags: [NoYield]

Save

Parameters (1)
urlContent
Returns (1)
void
SecurityRobloxSecurity

History 2

SavePlaceFinished

Parameters (2)
succeededbool
errorStringstring
SecurityRobloxPlaceSecurity

History 2

SaveStats

Parameters (0)
No parameters.
Returns (1)
void
SecurityLocalUserSecurity

History 4

SaveToRoblox

Parameters (0)
No parameters.
Returns (1)
bool
This function yields. It will block the calling thread until completion.
SecurityRobloxScriptSecurity

History 2

Tags: [Yields]

ServerSave

Parameters (0)
No parameters.
Returns (1)
void
SecurityLocalUserSecurity

History 2

SetCreatorID

Parameters (2)
creatorIDint
creatorTypeCreatorType
Returns (1)
void
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
SecurityPluginSecurity

History 3

Tags: [Deprecated]

SetCreatorId

Parameters (2)
creatorIdint
creatorTypeCreatorType
Returns (1)
void
SecurityPluginSecurity

History 3

SetGameInstanceId

Parameters (1)
instanceIDstring
Returns (1)
void
SecurityPluginSecurity

History 2

SetGearSettings

Parameters (2)
genreRestrictionGearGenreSetting
allowedGenresint
Returns (1)
void
SecurityPluginSecurity

History 3

SetGenre

Parameters (1)
genreGenre
Returns (1)
void
SecurityPluginSecurity

History 3

SetJobsExtendedStatsWindow

Parameters (1)
secondsdouble
Returns (1)
void
SecurityLocalUserSecurity

History 2

SetMessage

Parameters (1)
messagestring
Returns (1)
void
SecurityLocalUserSecurity

History 4

SetMessageBrickCount

Parameters (0)
No parameters.
Returns (1)
void
SecurityLocalUserSecurity

History 4

SetPlaceID

Parameters (2)Default
placeIDint
robloxPlaceboolfalse
Returns (1)
void
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
SecurityPluginSecurity

History 4

Tags: [Deprecated]

SetPlaceVersion

Parameters (1)
placeIdint
Returns (1)
void
SecurityPluginSecurity

History 3

SetRemoteBuildMode

Parameters (1)
buildModeEnabledbool
Returns (1)
void
SecurityLocalUserSecurity

History 4

SetScreenshotInfo

Parameters (1)
infostring
Returns (1)
void
SecurityLocalUserSecurity

History 2

SetServerSaveUrl

Parameters (1)
urlstring
Returns (1)
void
SecurityLocalUserSecurity

History 2

SetVIPServerId

Parameters (1)
newIdstring
Returns (1)
void
SecurityLocalUserSecurity

History 2

SetVIPServerOwnerId

Parameters (1)
newIdint
Returns (1)
void
SecurityLocalUserSecurity

History 2

SetVideoInfo

Parameters (1)
infostring
Returns (1)
void
SecurityLocalUserSecurity

History 2

ToggleTools

Parameters (0)
No parameters.
Returns (1)
void
SecurityLocalUserSecurity

History 4

get

Parameters (1)
urlContent
Returns (1)
Objects
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
SecurityLocalUserSecurity

History 2

Tags: [Deprecated]

Settings