Reference API Roblox

Engine API

Website

Related

Reference API Roblox

DataModel

Summary

This class is not creatable. Instances of this class cannot be created with Instance.new.
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
462GetObjects(url: Content): Objects
557GetObjectsAllOrNone(url: Content, binaryFormatOnly: bool = false): Objects
462GetObjectsAsync(url: Content): Objects
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
462InsertObjectsAndJoinIfLegacyAsync(url: Content): Objects
568IsContentLoaded(): bool
462IsGearTypeAllowed(gearType: GearType): bool
462IsLoaded(): bool
569IsUniverseMetadataLoaded(): bool
573Load(url: Content): 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
619Capabilities: SecurityCapabilities
553ClassName: string
553Name: string
553Parent: Instance
619Sandboxed: bool
616UniqueId: UniqueId
553className: string
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
486GetAttributes(): Dictionary
486GetChildren(): Objects
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
462GetPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsA(className: 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
553children(): Objects
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
553getChildren(): Objects
462isA(className: string): bool
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462Changed(property: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)

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

History 359

Members 63

AllowedGearTypeChanged

Parameters (0)
No parameters.
This event is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 3

Tags: [Deprecated]

BindToClose

Parameters (1)
functionFunction
Returns (1)
null

History 3

CreatorId

TypeDefault
int64
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.

History 5

Tags: [ReadOnly, NotReplicated]

CreatorType

TypeDefault
CreatorType
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.

History 4

Tags: [ReadOnly, NotReplicated]

DefineFastFlag

Parameters (2)
namestring
defaultValuebool
Returns (1)
bool

History 2

DefineFastInt

Parameters (2)
namestring
defaultValueint
Returns (1)
int

History 2

DefineFastString

Parameters (2)
namestring
defaultValuestring
Returns (1)
string

History 2

GameId

TypeDefault
int64
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.

History 5

Tags: [ReadOnly, NotReplicated]

GearGenreSetting

TypeDefault
GearGenreSetting
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.

History 5

Tags: [ReadOnly, NotReplicated, Deprecated]

Genre

TypeDefault
Genre
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.

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

History 2

GetFastFlag

Parameters (1)
namestring
Returns (1)
bool

History 3

GetFastInt

Parameters (1)
namestring
Returns (1)
int

History 3

GetFastString

Parameters (1)
namestring
Returns (1)
string

History 3

GetJobsInfo

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

History 3

GetMessage

Parameters (0)
No parameters.
Returns (1)
string
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 5

Tags: [Deprecated]

GetObjects

Parameters (1)
urlContent
Returns (1)
Objects

History 5

GetObjectsAllOrNone

Parameters (2)Default
urlContent
binaryFormatOnlyboolfalse
Returns (1)
Objects

History 2

GetObjectsAsync

Parameters (1)
urlContent
Returns (1)
Objects
This function yields. It will block the calling thread until completion.

History 2

Tags: [Yields]

GetObjectsList

Parameters (1)
urlsArray
Returns (1)
Array

History 2

GetPlaySessionId

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

History 3

GetRemoteBuildMode

Parameters (0)
No parameters.
Returns (1)
bool
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 5

Tags: [Deprecated]

GraphicsQualityChangeRequest

Parameters (1)
betterQualitybool

History 2

HttpGetAsync

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

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.

History 8

Tags: [Yields]

InsertObjectsAndJoinIfLegacyAsync

Parameters (1)
urlContent
Returns (1)
Objects
This function yields. It will block the calling thread until completion.

History 2

Tags: [Yields]

IsContentLoaded

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

History 1

IsGearTypeAllowed

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

History 3

Tags: [Deprecated]

IsLoaded

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

History 4

IsUniverseMetadataLoaded

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

History 1

ItemChanged

Parameters (2)
objectInstance
descriptorstring
This event is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 3

Tags: [Deprecated]

JobId

TypeDefault
string
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.

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)
urlContent
Returns (1)
null

History 3

Loaded

Parameters (0)
No parameters.

History 4

OnClose

Parameters (0)
No parameters.
Returns (1)
Tuple
This callback is deprecated. It exists only for backward compatibility, and should not be used for new work. BindToClose should be used instead.

History 4

Tags: [Deprecated]

OpenScreenshotsFolder

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

History 7

OpenVideosFolder

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

History 3

PlaceId

TypeDefault
int64
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.

History 5

Tags: [ReadOnly, NotReplicated]

PlaceVersion

TypeDefault
int
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.

History 4

Tags: [ReadOnly, NotReplicated]

PrivateServerId

TypeDefault
string
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.

History 4

Tags: [ReadOnly, NotReplicated]

PrivateServerOwnerId

TypeDefault
int64
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.

History 4

Tags: [ReadOnly, NotReplicated]

ReportInGoogleAnalytics

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

History 3

SavePlace

Parameters (1)Default
saveFilterSaveFilterSaveAll
Returns (1)
bool
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.

History 9

Tags: [Yields, Deprecated]

ScreenshotReady

Parameters (1)
pathstring

History 6

ScreenshotSavedToAlbum

Parameters (3)
filenamestring
successbool
messagestring

History 1

SetFastFlagForTesting

Parameters (2)
namestring
newValuebool
Returns (1)
bool

History 2

SetFastIntForTesting

Parameters (2)
namestring
newValueint
Returns (1)
int

History 2

SetFastStringForTesting

Parameters (2)
namestring
newValuestring
Returns (1)
string

History 2

SetFlagVersion

Parameters (2)
namestring
versionint
Returns (1)
null

History 2

SetIsLoaded

Parameters (2)
valuebool
placeSizeInBytesint?
Returns (1)
null

History 2

SetPlaceId

Parameters (1)
placeIdint64
Returns (1)
null

History 7

SetUniverseId

Parameters (1)
universeIdint64
Returns (1)
null

History 5

Shutdown

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

History 3

UniverseMetadataLoaded

Parameters (0)
No parameters.

History 1

Workspace

TypeDefault
Workspace
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.

History 5

Tags: [ReadOnly, NotReplicated]

lighting

TypeDefault
Instance
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.

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.

History 6

Tags: [ReadOnly, NotReplicated, Deprecated]

Removed members 44

ActivateExperimentalFeatures

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

History 2

AddStat

Parameters (2)
displayNamestring
statstring
Returns (1)
void

History 4

ClearContent

Parameters (1)
resettingSimulationbool
Returns (1)
void

History 2

ClearMessage

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

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

History 2

GetJobIntervalPeakFraction

Parameters (2)
jobnamestring
greaterThandouble
Returns (1)
double

History 3

GetJobTimePeakFraction

Parameters (2)
jobnamestring
greaterThandouble
Returns (1)
double

History 3

GetJobsExtendedStats

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

History 3

HttpGet

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

History 6

HttpPost

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

History 7

IsPersonalServer

TypeDefault
bool

History 5

LoadGame

Parameters (1)
assetIDint
Returns (1)
void

History 2

LoadPlugins

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

History 2

LoadWorld

Parameters (1)
assetIDint
Returns (1)
void

History 2

LocalSaveEnabled

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

History 4

Tags: [ReadOnly]

RemoveStat

Parameters (1)
statstring
Returns (1)
void

History 4

ReportMeasurement

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

History 2

RequestShutdown

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

History 3

Tags: [NoYield]

Save

Parameters (1)
urlContent
Returns (1)
void

History 2

SavePlaceFinished

Parameters (2)
succeededbool
errorStringstring

History 2

SaveStats

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

History 4

SaveToRoblox

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

History 2

Tags: [Yields]

ServerSave

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

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.

History 3

Tags: [Deprecated]

SetCreatorId

Parameters (2)
creatorIdint
creatorTypeCreatorType
Returns (1)
void

History 3

SetGameInstanceId

Parameters (1)
instanceIDstring
Returns (1)
void

History 2

SetGearSettings

Parameters (2)
genreRestrictionGearGenreSetting
allowedGenresint
Returns (1)
void

History 3

SetGenre

Parameters (1)
genreGenre
Returns (1)
void

History 3

SetJobsExtendedStatsWindow

Parameters (1)
secondsdouble
Returns (1)
void

History 2

SetMessage

Parameters (1)
messagestring
Returns (1)
void

History 4

SetMessageBrickCount

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

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.

History 4

Tags: [Deprecated]

SetPlaceVersion

Parameters (1)
placeIdint
Returns (1)
void

History 3

SetRemoteBuildMode

Parameters (1)
buildModeEnabledbool
Returns (1)
void

History 4

SetScreenshotInfo

Parameters (1)
infostring
Returns (1)
void

History 2

SetServerSaveUrl

Parameters (1)
urlstring
Returns (1)
void

History 2

SetVIPServerId

Parameters (1)
newIdstring
Returns (1)
void

History 2

SetVIPServerOwnerId

Parameters (1)
newIdint
Returns (1)
void

History 2

SetVideoInfo

Parameters (1)
infostring
Returns (1)
void

History 2

ToggleTools

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

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.

History 2

Ta