# ExperienceService

Roblox Engine API class from Roblox Studio 0.744.0.7441077 (version-7aaa6838d36c4448).

- Inherits from, nearest first: [Instance](https://rapi.sleaze.dev/classes/Instance.md), [Object](https://rapi.sleaze.dev/classes/Object.md)
- Tags: Not creatable, Not replicated, Service
- Memory category: Instances
- HTML page: https://rapi.sleaze.dev/classes/ExperienceService/
- Roblox documentation: https://create.roblox.com/docs/reference/engine/classes/ExperienceService

## Methods

### ConsumePendingExperienceLeaveWithReason

```luau
ExperienceService:ConsumePendingExperienceLeaveWithReason(): { [string]: any }
```

- Tags: Roblox script security

### ExecuteCrossExperienceCall

```luau
ExperienceService:ExecuteCrossExperienceCall(callId: string, params: { [string]: any }, successCallback: (...any) -> ...any, errorCallback: (...any) -> ...any)
```

- Tags: Roblox script security

### GetFollowUserId

```luau
ExperienceService:GetFollowUserId(): number
```

- Tags: Roblox script security

### GetPendingJoinAttempt

```luau
ExperienceService:GetPendingJoinAttempt(): { [string]: any }
```

- Tags: Roblox script security

### GetPlaceJoinState

```luau
ExperienceService:GetPlaceJoinState(): string
```

- Tags: Roblox script security

### GetQueuePosition

```luau
ExperienceService:GetQueuePosition(): number
```

- Tags: Roblox script security

### IsInExperience

```luau
ExperienceService:IsInExperience(): boolean
```

- Tags: Roblox script security

### LaunchExperience

```luau
ExperienceService:LaunchExperience(params: { [string]: any }): string
```

- Tags: Roblox script security

### LaunchExperienceFromSource

```luau
ExperienceService:LaunchExperienceFromSource(params: { [string]: any }, source: string): string
```

- Tags: Roblox script security

### LaunchExperienceFromSourceWithCallback

```luau
ExperienceService:LaunchExperienceFromSourceWithCallback(params: { [string]: any }, source: string, callback: (...any) -> ...any)
```

- Tags: Roblox script security

### LeaveExperienceWithReason

```luau
ExperienceService:LeaveExperienceWithReason(reason: string)
```

- Tags: Roblox script security

### RegisterForExperienceJoin

```luau
ExperienceService:RegisterForExperienceJoin(callback: (...any) -> ...any): RBXScriptConnection
```

- Tags: Roblox script security

### RegisterForExperienceLeave

```luau
ExperienceService:RegisterForExperienceLeave(callback: (...any) -> ...any): RBXScriptConnection
```

- Tags: Roblox script security

### StartCrossExperience

```luau
ExperienceService:StartCrossExperience(type: string, params: { [string]: any })
```

- Tags: Roblox script security

### StopCrossExperience

```luau
ExperienceService:StopCrossExperience(type: string, params: { [string]: any })
```

- Tags: Roblox script security

## Events

### OnCrossExperienceStarted

```luau
ExperienceService.OnCrossExperienceStarted: RBXScriptSignal<(type: string, params: { [string]: any })>
```

- Tags: Roblox script security

### OnCrossExperienceStopped

```luau
ExperienceService.OnCrossExperienceStopped: RBXScriptSignal<(type: string, params: { [string]: any })>
```

- Tags: Roblox script security

### OnNewJoinAttempt

```luau
ExperienceService.OnNewJoinAttempt: RBXScriptSignal<(params: { [string]: any })>
```

- Tags: Roblox script security

### PlaceJoinStateChanged

```luau
ExperienceService.PlaceJoinStateChanged: RBXScriptSignal<(state: string)>
```

- Tags: Roblox script security

### QueuePositionChanged

```luau
ExperienceService.QueuePositionChanged: RBXScriptSignal<(position: number)>
```

- Tags: Roblox script security

## Inherited members

- From [Instance](https://rapi.sleaze.dev/classes/Instance.md): `Archivable`, `archivable`, `Attributes`, `AttributesReplicate`, `AttributesSerialize`, `HistoryId`, `Name`, `Parent`, `PredictionMode`, `PropertyStatusStudio`, `RobloxLocked`, `SerializedOverrides`, `SourceAssetId`, `Tags`, `UniqueId`, `numExpectedDirectChildren`, `DataCost`, `Capabilities`, `DefinesCapabilities`, `IsInSandbox`, `Sandboxed`, `AddTag`, `ClearAllChildren`, `Clone`, `Destroy`, `FindFirstAncestor`, `FindFirstAncestorOfClass`, `FindFirstAncestorWhichIsA`, `FindFirstChild`, `FindFirstChildOfClass`, `FindFirstChildWhichIsA`, `FindFirstDescendant`, `GetActor`, `GetAttribute`, `GetAttributeChangedSignal`, `GetAttributes`, `GetChildren`, `GetDebugId`, `GetDescendants`, `GetFullName`, `GetStyled`, `GetStyledPropertyChangedSignal`, `GetTags`, `HasTag`, `IsAncestorOf`, `IsDescendantOf`, `IsPropertyModified`, `QueryDescendants`, `RemoveTag`, `ResetPropertyToDefault`, `SetAttribute`, `WaitForChild`, `Remove`, `children`, `clone`, `destroy`, `findFirstChild`, `getChildren`, `isDescendantOf`, `remove`, `AncestryChanged`, `AttributeChanged`, `ChildAdded`, `ChildRemoved`, `DescendantAdded`, `DescendantRemoving`, `Destroying`, `StyledPropertiesChanged`, `childAdded`
- From [Object](https://rapi.sleaze.dev/classes/Object.md): `ClassName`, `className`, `GetPropertyChangedSignal`, `IsA`, `isA`, `Changed`