Reference API Roblox

Engine API

Website

Related

Reference API Roblox

ExperienceService

This class is not replicated. Its interface does not cross the network boundary.
This class is not creatable. Instances of this class cannot be created with Instance.new.
This class is a service. It is a singleton that may be acquired with GetService.
Tags: [NotCreatable, Service, NotReplicated]

Member index 17

HistoryMember
633ExecuteCrossExperienceCall(callId: string, params: Dictionary, successCallback: Function, errorCallback: Function): null
718GetFollowUserId(): int64
621GetPendingJoinAttempt(): Dictionary
714GetPlaceJoinState(): string
717GetQueuePosition(): int
593LaunchExperience(params: Dictionary): string
593LaunchExperienceFromSource(params: Dictionary, source: string): string
593LaunchExperienceFromSourceWithCallback(params: Dictionary, source: string, callback: Function): null
593RegisterForExperienceJoin(callback: Function): RBXScriptConnection
593RegisterForExperienceLeave(callback: Function): RBXScriptConnection
624StartCrossExperience(type: string, params: Dictionary): null
624StopCrossExperience(type: string, params: Dictionary): null
624OnCrossExperienceStarted(type: string, params: Dictionary)
624OnCrossExperienceStopped(type: string, params: Dictionary)
621OnNewJoinAttempt(params: Dictionary)
714PlaceJoinStateChanged(state: string)
717QueuePositionChanged(position: int)
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)

Description

History 18

Members 17

ExecuteCrossExperienceCall

Parameters (4)
callIdstring
paramsDictionary
successCallbackFunction
errorCallbackFunction
Returns (1)
null

History 1

GetFollowUserId

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

History 1

GetPendingJoinAttempt

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

History 1

GetPlaceJoinState

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

History 1

GetQueuePosition

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

History 1

LaunchExperience

Parameters (1)
paramsDictionary
Returns (1)
string

History 1

LaunchExperienceFromSource

Parameters (2)
paramsDictionary
sourcestring
Returns (1)
string

History 1

LaunchExperienceFromSourceWithCallback

Parameters (3)
paramsDictionary
sourcestring
callbackFunction
Returns (1)
null

History 1

OnCrossExperienceStarted

Parameters (2)
typestring
paramsDictionary

History 1

OnCrossExperienceStopped

Parameters (2)
typestring
paramsDictionary

History 1

OnNewJoinAttempt

Parameters (1)
paramsDictionary

History 1

PlaceJoinStateChanged

Parameters (1)
statestring

History 1

QueuePositionChanged

Parameters (1)
positionint

History 1

RegisterForExperienceJoin

Parameters (1)
callbackFunction
Returns (1)
RBXScriptConnection

History 1

RegisterForExperienceLeave

Parameters (1)
callbackFunction
Returns (1)
RBXScriptConnection

History 1

StartCrossExperience

Parameters (2)
typestring
paramsDictionary
Returns (1)
null

History 1

StopCrossExperience

Parameters (2)
typestring
paramsDictionary
Returns (1)
null

History 1

Settings