Reference API Roblox

Engine API

Website

Related

Reference API Roblox

App

Member index 0

HistoryMember
No members defined by App.
inherited from DataModel
726CreatorId: int64
726CreatorType: CreatorType
726Environment: string
726GameId: int64
726GearGenreSetting: GearGenreSetting
726Genre: Genre
726JobId: string
726MatchmakingType: MatchmakingType
726PlaceId: int64
726PlaceVersion: int
726PrivateServerId: string
726PrivateServerOwnerId: int64
726RunService: RunService
726Workspace: Workspace
726lighting: Instance
726workspace: 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
716GetObjectsAllOrNone(url: ContentId): 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
703OpenLogsFolder(): null
573OpenScreenshotsFolder(): null
573OpenVideosFolder(): 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
686getGameTime(): double
462AllowedGearTypeChanged()
462GraphicsQualityChangeRequest(betterQuality: bool)
462ItemChanged(object: Instance, descriptor: string)
462Loaded()
462ScreenshotReady(path: string)
470ScreenshotSavedToAlbum(filename: string, success: bool, message: string)
720ServerLifecycleChanged(serverLifecycleChangedEvent: Dictionary)
726ServerRestartScheduled(restartTime: DateTime, source: CloseReason, attributes: Dictionary)
569UniverseMetadataLoaded()
726OnClose(): Tuple
inherited from ServiceProvider
497FindService(className: string): Instance
494GetService(className: string): Instance
726getService(className: string): Instance
726service(className: string): Instance
462Close()
462CloseLate()
462ServiceAdded(service: Instance)
462ServiceRemoving(service: Instance)
inherited from Instance
726Archivable: bool
726Capabilities: SecurityCapabilities
726IsInSandbox: bool
726Name: string
726Parent: Instance
726PredictionMode: PredictionMode
726Sandboxed: bool
726UniqueId: 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
707GetDescendants(): Instances
486GetFullName(): string
706GetStyled(name: string, selector: string?): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
698QueryDescendants(selector: string): Instances
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
726children(): Instances
726clone(): Instance
726destroy(): null
726findFirstChild(name: string, recursive: bool = false): Instance
726getChildren(): Instances
726isDescendantOf(ancestor: Instance): bool
726remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
726childAdded(child: Instance)
inherited from Object
726ClassName: string
726className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
726isA(className: string): bool
647Changed(property: string)

Removed member index 7

HistoryMember
136Id: int
136ConnectToGame(placeId: int, actionName: string = ): void
131CreatePlace(placeName: string, actionName: string, templatePlaceID: int): int
136FollowUser(userId: int): void
136GetCreations(userId: int, page: int = 1): Dictionary
136SetAppId(newId: int): void
136UnloadGame(): void

Description

History 11

Removed members 7

ConnectToGame

Parameters (2)Default
placeIdint
actionNamestring
Returns (1)
void
This function yields. It will block the calling thread until completion.

History 3

Tags: [Yields]

CreatePlace

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

History 2

Tags: [Yields]

FollowUser

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

History 2

Tags: [Yields]

GetCreations

Parameters (2)Default
userIdint
pageint1
Returns (1)
Dictionary
This function yields. It will block the calling thread until completion.

History 2

Tags: [Yields]

Id

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

History 2

Tags: [ReadOnly]

SetAppId

Parameters (1)
newIdint
Returns (1)
void

History 2

UnloadGame

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

History 2

Tags: [Yields]

Settings