DataModel

Class fields

Field	XML type	Value
`Name`	string	DataModel

Properties

CreatorId

int64

Field	XML type	Value
`Name`	string	CreatorId

CreatorType

CreatorType

Field	XML type	Value
`Name`	string	CreatorType

ForceR15

bool

Field	XML type	Value
`Name`	string	ForceR15

GearGenreSetting

GearGenreSetting

Field	XML type	Value
`Name`	string	GearGenreSetting

Genre

Genre

Field	XML type	Value
`Name`	string	Genre

IsPersonalServer

bool

Field	XML type	Value
`Name`	string	IsPersonalServer

JobId

string

Field	XML type	Value
`Name`	string	JobId

LocalSaveEnabled

bool

Field	XML type	Value
`Name`	string	LocalSaveEnabled

Optimization

Optimization

Field	XML type	Value
`Name`	string	Optimization

PlaceId

int64

Field	XML type	Value
`Name`	string	PlaceId

PlaceVersion

int

Field	XML type	Value
`Name`	string	PlaceVersion

VIPServerId

string

Field	XML type	Value
`Name`	string	VIPServerId

VIPServerOwnerId

int64

Field	XML type	Value
`Name`	string	VIPServerOwnerId

Workspace

Object

Field	XML type	Value
`Name`	string	Workspace

lighting

Object

Field	XML type	Value
`Name`	string	lighting

workspace

Object

Field	XML type	Value
`Name`	string	workspace
`Deprecated`	bool	true
`summary`	string	Deprecated. Use Workspace

Functions

AddStat

(displayName: string, stat: string) → void

Field	XML type	Value
`Name`	string	AddStat

ClearMessage

() → void

Field	XML type	Value
`Name`	string	ClearMessage

FinishShutdown

(localSave: bool) → void

Field	XML type	Value
`Name`	string	FinishShutdown

GetJobIntervalPeakFraction

(jobname: string, greaterThan: double) → double

Field	XML type	Value
`Name`	string	GetJobIntervalPeakFraction

GetJobTimePeakFraction

(jobname: string, greaterThan: double) → double

Field	XML type	Value
`Name`	string	GetJobTimePeakFraction

GetJobsExtendedStats

() → Array

Field	XML type	Value
`Name`	string	GetJobsExtendedStats

GetJobsInfo

() → Array

Field	XML type	Value
`Name`	string	GetJobsInfo

GetMessage

() → string

Field	XML type	Value
`Name`	string	GetMessage

GetRemoteBuildMode

() → bool

Field	XML type	Value
`Name`	string	GetRemoteBuildMode

HttpGet

(url: string, synchronous: bool = …) → string

Field	XML type	Value
`Name`	string	HttpGet

HttpPost

(url: string, data: string, synchronous: bool = …, contentType: string = …) → string

Field	XML type	Value
`Name`	string	HttpPost

IsGearTypeAllowed

(gearType: GearType) → bool

Field	XML type	Value
`Name`	string	IsGearTypeAllowed

IsLoaded

() → bool

Field	XML type	Value
`Name`	string	IsLoaded
`summary`	string	Returns true if the game has finished loading, false otherwise. Check this before listening to the Loaded signal to ensure a script knows when a game finishes loading.

Load

(url: Content) → void

Field	XML type	Value
`Name`	string	Load

LoadGame

(assetID: int) → void

Field	XML type	Value
`Name`	string	LoadGame

LoadPlugins

() → void

Field	XML type	Value
`Name`	string	LoadPlugins

LoadWorld

(assetID: int) → void

Field	XML type	Value
`Name`	string	LoadWorld

RemoveStat

(stat: string) → void

Field	XML type	Value
`Name`	string	RemoveStat

ReportInGoogleAnalytics

(category: string, action: string = …, label: string = …, value: int = …) → void

Field	XML type	Value
`Name`	string	ReportInGoogleAnalytics

ReportMeasurement

(id: string, key1: string, value1: string, key2: string, value2: string) → void

Field	XML type	Value
`Name`	string	ReportMeasurement

Save

(url: Content) → void

Field	XML type	Value
`Name`	string	Save

SaveStats

() → void

Field	XML type	Value
`Name`	string	SaveStats

ServerSave

() → void

Field	XML type	Value
`Name`	string	ServerSave

SetCreatorID

(creatorID: int64, creatorType: CreatorType) → void

Field	XML type	Value
`Name`	string	SetCreatorID
`Deprecated`	bool	true
`summary`	string	Use SetCreatorId() instead

SetCreatorId

(creatorId: int64, creatorType: CreatorType) → void

Field	XML type	Value
`Name`	string	SetCreatorId

SetGameInstanceId

(instanceID: string) → void

Field	XML type	Value
`Name`	string	SetGameInstanceId

SetGearSettings

(genreRestriction: GearGenreSetting, allowedGenres: int) → void

Field	XML type	Value
`Name`	string	SetGearSettings

SetGenre

(genre: Genre) → void

Field	XML type	Value
`Name`	string	SetGenre

SetJobsExtendedStatsWindow

(seconds: double) → void

Field	XML type	Value
`Name`	string	SetJobsExtendedStatsWindow

SetMessage

(message: string) → void

Field	XML type	Value
`Name`	string	SetMessage

SetMessageBrickCount

() → void

Field	XML type	Value
`Name`	string	SetMessageBrickCount

SetOptimization

(optimization: Optimization) → void

Field	XML type	Value
`Name`	string	SetOptimization

SetPlaceID

(placeID: int64, robloxPlace: bool = …) → void

Field	XML type	Value
`Name`	string	SetPlaceID
`Deprecated`	bool	true
`summary`	string	Use SetPlaceId() instead

SetPlaceId

(placeId: int64, robloxPlace: bool = …) → void

Field	XML type	Value
`Name`	string	SetPlaceId

SetPlaceVersion

(placeId: int) → void

Field	XML type	Value
`Name`	string	SetPlaceVersion

SetRemoteBuildMode

(buildModeEnabled: bool) → void

Field	XML type	Value
`Name`	string	SetRemoteBuildMode

SetScreenshotInfo

(info: string) → void

Field	XML type	Value
`Name`	string	SetScreenshotInfo

SetServerSaveUrl

(url: string) → void

Field	XML type	Value
`Name`	string	SetServerSaveUrl

SetUniverseId

(universeId: int) → void

Field	XML type	Value
`Name`	string	SetUniverseId

SetVIPServerId

(newId: string) → void

Field	XML type	Value
`Name`	string	SetVIPServerId

SetVIPServerOwnerId

(newId: int64) → void

Field	XML type	Value
`Name`	string	SetVIPServerOwnerId

SetVideoInfo

(info: string) → void

Field	XML type	Value
`Name`	string	SetVideoInfo

Shutdown

() → void

Field	XML type	Value
`Name`	string	Shutdown

ToggleTools

() → void

Field	XML type	Value
`Name`	string	ToggleTools

Yield functions

HttpGetAsync

(url: string) → string

Field	XML type	Value
`Name`	string	HttpGetAsync

HttpPostAsync

(url: string, data: string, contentType: string = …) → string

Field	XML type	Value
`Name`	string	HttpPostAsync

SavePlace

(saveFilter: SaveFilter = …) → bool

Field	XML type	Value
`Name`	string	SavePlace

SaveToRoblox

() → bool

Field	XML type	Value
`Name`	string	SaveToRoblox

Events

AllowedGearTypeChanged

() → void

Field	XML type	Value
`Name`	string	AllowedGearTypeChanged

GraphicsQualityChangeRequest

(betterQuality: bool) → void

Field	XML type	Value
`Name`	string	GraphicsQualityChangeRequest

ItemChanged

(object: Instance, descriptor: Property) → void

Field	XML type	Value
`Name`	string	ItemChanged

Loaded

() → void

Field	XML type	Value
`Name`	string	Loaded
`summary`	string	Fires when the game finishes loading. Use this to know when to remove your custom loading gui. It is best to check IsLoaded() before connecting to this event, as the game may load before the event is connected to.

RenderDistanceChangeRequest

(betterRenderDistance: bool) → void

Field	XML type	Value
`Name`	string	RenderDistanceChangeRequest

Callbacks

OnClose

() → Tuple

Field	XML type	Value
`Name`	string	OnClose

RequestShutdown

() → bool

Field	XML type	Value
`Name`	string	RequestShutdown