# TeleportOptions

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)
- Memory category: Instances
- HTML page: https://rapi.sleaze.dev/classes/TeleportOptions/
- Roblox documentation: https://create.roblox.com/docs/reference/engine/classes/TeleportOptions

Optional input arguments to the [`TeleportService:TeleportAsync()`](https://rapi.sleaze.dev/classes/TeleportService.md) function.

## Properties

### ReservedServerAccessCode

```luau
TeleportOptions.ReservedServerAccessCode: string = ""
```

- Tags: Capabilities: Teleport

The reserved server access code that indicates the reserved server that the teleport should be to.

### ReservedServerId

```luau
TeleportOptions.ReservedServerId: string = ""
```

- Tags: Capabilities: Teleport

### ServerInstanceId

```luau
TeleportOptions.ServerInstanceId: string = ""
```

- Tags: Capabilities: Teleport

The [`DataModel.JobId`](https://rapi.sleaze.dev/classes/DataModel.md) of the server instance to teleport to.

### ShouldReserveServer

```luau
TeleportOptions.ShouldReserveServer: boolean = false
```

- Tags: Capabilities: Teleport

A flag to indicate if a reserved server should be allocated and the players should then be teleported to this allocation.

### VipServerId

```luau
TeleportOptions.VipServerId: string = ""
```

- Tags: Capabilities: Teleport

## Methods

### GetTeleportData

```luau
TeleportOptions:GetTeleportData(): any
```

- Tags: Capabilities: Teleport

Returns the teleport data stored in the [`TeleportOptions`](https://rapi.sleaze.dev/classes/TeleportOptions.md) instance by [`TeleportOptions:SetTeleportData()`](https://rapi.sleaze.dev/classes/TeleportOptions.md).

Returns: The teleport data previously stored by [`TeleportOptions:SetTeleportData()`](https://rapi.sleaze.dev/classes/TeleportOptions.md), or nil if no data was set.

### SetTeleportData

```luau
TeleportOptions:SetTeleportData(teleportData: any)
```

- Tags: Capabilities: Teleport

Setter function for data to be passed to the destination place.

Parameters:

- `teleportData`: Data to be passed to the destination place.

## 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`