The root of Roblox's parent-child hierarchy (commonly known as game
after the global variable used to access it).
Contents
- 1 Properties
- 2 Methods
- 2.1 BindToClose(function: Function): null
- 2.2 DefineFastFlag(name: string, defaultValue: bool): bool
- 2.3 DefineFastInt(name: string, defaultValue: int): int
- 2.4 DefineFastString(name: string, defaultValue: string): string
- 2.5 GetEngineFeature(name: string): bool
- 2.6 GetFastFlag(name: string): bool
- 2.7 GetFastInt(name: string): int
- 2.8 GetFastString(name: string): string
- 2.9 GetJobsInfo(): Array
- 2.10
GetMessage(): string
- 2.11 GetObjects(url: Content): Objects
- 2.12 GetObjectsAllOrNone(url: Content, binaryFormatOnly: bool = false): Objects
- 2.13 GetObjectsAsync(url: Content): Objects
- 2.14 GetObjectsList(urls: Array): Array
- 2.15 GetPlaySessionId(): string
- 2.16
GetRemoteBuildMode(): bool
- 2.17 HttpGetAsync(url: string, httpRequestType: HttpRequestType = Default): string
- 2.18 HttpPostAsync(url: string, data: string, contentType: string = */*, httpRequestType: HttpRequestType = Default): string
- 2.19 InsertObjectsAndJoinIfLegacyAsync(url: Content): Objects
- 2.20 IsContentLoaded(): bool
- 2.21
IsGearTypeAllowed(gearType: GearType): bool
- 2.22 IsLoaded(): bool
- 2.23 IsUniverseMetadataLoaded(): bool
- 2.24 Load(url: Content): null
- 2.25 OpenScreenshotsFolder(): null
- 2.26 OpenVideosFolder(): null
- 2.27 ReportInGoogleAnalytics(category: string, action: string = custom, label: string = none, value: int = 0): null
- 2.28
SavePlace(saveFilter: SaveFilter = SaveAll): bool
- 2.29 SetFastFlagForTesting(name: string, newValue: bool): bool
- 2.30 SetFastIntForTesting(name: string, newValue: int): int
- 2.31 SetFastStringForTesting(name: string, newValue: string): string
- 2.32 SetFlagVersion(name: string, version: int): null
- 2.33 SetIsLoaded(value: bool, placeSizeInBytes: int?): null
- 2.34 SetPlaceId(placeId: int64): null
- 2.35 SetUniverseId(universeId: int64): null
- 2.36 Shutdown(): null
- 3 Events
- 4 Callbacks
- 5 Removed members
- 6 External links
Properties
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
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
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
- Category: State.
- Serialization: cannot load or save.
- Thread safety: read safe
- Category: State.
- Serialization: cannot load or save.
- Thread safety: read safe
- Category: Data.
- Read security: RobloxScriptSecurity.
- Write security: RobloxScriptSecurity.
- Serialization: cannot load or save.
- Thread safety: read safe
Defines a server-specific ID, unique to every server on Roblox.
- Category: JobInfo.
- Serialization: cannot load or save.
- Thread safety: read safe
The id of the place.
- Category: State.
- Serialization: cannot load or save.
- Thread safety: read safe
- Category: State.
- Serialization: cannot load or save.
- Thread safety: read safe
- Category: Data.
- Serialization: can save only.
- Thread safety: read safe
- Category: Data.
- Serialization: can save only.
- Thread safety: read safe
This API member has existing documentation in this page's Member list template.
- Category: Data.
- Serialization: can save only.
- Thread safety: read safe
This API member has existing documentation in this page's Member list template.
- Category: Data.
- Serialization: can save only.
- Thread safety: read safe
The game's Workspace.
- Category: Data.
- Serialization: cannot load or save.
- Thread safety: read safe
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
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
DefineFastFlag(name: string, defaultValue: bool): bool
ParametersName | Type |
---|
name | string |
defaultValue | bool |
- Security: RobloxScriptSecurity.
- Thread safety: unsafe
DefineFastInt(name: string, defaultValue: int): int
ParametersName | Type |
---|
name | string |
defaultValue | int |
- Security: RobloxScriptSecurity.
- Thread safety: unsafe
DefineFastString(name: string, defaultValue: string): string
ParametersName | Type |
---|
name | string |
defaultValue | string |
- Security: RobloxScriptSecurity.
- Thread safety: unsafe
ParametersName | Type |
---|
name | string |
- Security: LocalUserSecurity.
- Thread safety: unsafe
ParametersName | Type |
---|
name | string |
- Security: LocalUserSecurity.
- Thread safety: unsafe
ParametersName | Type |
---|
name | string |
- Security: LocalUserSecurity.
- Thread safety: unsafe
ParametersName | Type |
---|
name | string |
- Security: LocalUserSecurity.
- Thread safety: unsafe
- Security: PluginSecurity.
- Thread safety: unsafe
ParametersName | Type |
---|
url | Content |
- Security: PluginSecurity.
- Thread safety: unsafe
ParametersName | Type | Default |
---|
url | Content | |
binaryFormatOnly | bool | false |
- Security: RobloxScriptSecurity.
- Thread safety: unsafe
ParametersName | Type |
---|
url | Content |
- Security: RobloxScriptSecurity.
- Thread safety: unsafe
ParametersName | Type |
---|
urls | Array |
- Security: RobloxScriptSecurity.
- Thread safety: unsafe
- Security: RobloxScriptSecurity.
- Thread safety: unsafe
ParametersName | Type | Default |
---|
url | string | |
httpRequestType | HttpRequestType | Default |
- Security: RobloxScriptSecurity.
- Thread safety: unsafe
HttpPostAsync(url: string, data: string, contentType: string = */*, httpRequestType: HttpRequestType = Default): string
ParametersName | Type | Default |
---|
url | string | |
data | string | |
contentType | string | */* |
httpRequestType | HttpRequestType | Default |
- Security: RobloxScriptSecurity.
- Thread safety: unsafe
ParametersName | Type |
---|
url | Content |
- Security: RobloxScriptSecurity.
- Thread safety: unsafe
- Security: RobloxScriptSecurity.
- Thread safety: unsafe
This API member has existing documentation in this page's Member list template.
- Security: RobloxScriptSecurity.
- Thread safety: unsafe
ParametersName | Type |
---|
url | Content |
- Security: LocalUserSecurity.
- Thread safety: unsafe
This API member has existing documentation in this page's Member list template.
- Security: RobloxScriptSecurity.
- Thread safety: unsafe
This API member has existing documentation in this page's Member list template.
- Security: RobloxScriptSecurity.
- Thread safety: unsafe
ReportInGoogleAnalytics(category: string, action: string = custom, label: string = none, value: int = 0): null
ParametersName | Type | Default |
---|
category | string | |
action | string | custom |
label | string | none |
value | int | 0 |
- Security: RobloxScriptSecurity.
- Thread safety: unsafe
ParametersName | Type | Default |
---|
saveFilter | SaveFilter | SaveAll |
ParametersName | Type |
---|
name | string |
newValue | bool |
- Security: RobloxScriptSecurity.
- Thread safety: unsafe
ParametersName | Type |
---|
name | string |
newValue | int |
- Security: RobloxScriptSecurity.
- Thread safety: unsafe
ParametersName | Type |
---|
name | string |
newValue | string |
- Security: RobloxScriptSecurity.
- Thread safety: unsafe
SetFlagVersion(name: string, version: int): null
ParametersName | Type |
---|
name | string |
version | int |
- Security: RobloxScriptSecurity.
- Thread safety: unsafe
SetIsLoaded(value: bool, placeSizeInBytes: int?): null
ParametersName | Type |
---|
value | bool |
placeSizeInBytes | int? |
- Security: RobloxScriptSecurity.
- Thread safety: unsafe
SetPlaceId(placeId: int64): null
ParametersName | Type |
---|
placeId | int64 |
- Security: PluginSecurity.
- Thread safety: unsafe
ParametersName | Type |
---|
universeId | int64 |
- Security: PluginSecurity.
- Thread safety: unsafe
- Security: LocalUserSecurity.
- Thread safety: unsafe
Events
ParametersName | Type |
---|
betterQuality | bool |
ParametersName | Type |
---|
object | Instance |
descriptor | string |
This API member has existing documentation in this page's Member list template.
ParametersName | Type |
---|
path | string |
- Security: RobloxScriptSecurity.
- Thread safety: unsafe
ScreenshotSavedToAlbum(filename: string, success: bool, message: string)
ParametersName | Type |
---|
filename | string |
success | bool |
message | string |
- Security: RobloxScriptSecurity.
- Thread safety: unsafe
- Security: RobloxScriptSecurity.
- Thread safety: unsafe
Callbacks
This API member has existing documentation in this page's Member list template.
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
Callbacks
External links