TeleportOptions¶

Not yet Class Platform & Data

Optional input arguments to the TeleportService.TeleportAsync() function.

Not implemented yet

This class exists in the current Roblox API but is not implemented in Nova yet. Scripts that reference it will fail at runtime.

0 Nova members · 13 modern Roblox members not implemented yet

Description¶

This class is an optional parameter to the TeleportService.TeleportAsync() function that allows developers to provide arguments for the teleport call.

Only one of the following private server routing fields may be set at a time. Setting more than one causes an error:

For more information on how to teleport players between servers, see Teleporting Between Places.

Inheritance¶

Object → Instance → TeleportOptions

Properties¶

Member	Signature	Summary
`ReservedServerAccessCode`	`ReservedServerAccessCode: string`	The reserved server access code that indicates the reserved server that the teleport should be to.
`ReservedServerId`	`ReservedServerId: string`	The reserved server ID that indicates the reserved server to teleport to.
`ServerInstanceId`	`ServerInstanceId: string`	The DataModel.JobId of the server instance to teleport to.
`ShouldReserveServer`	`ShouldReserveServer: bool`	A flag to indicate if a reserved server should be allocated and the players should then be teleported to this allocation.
`VipServerId`	`VipServerId: string`	The VIP server ID that indicates the VIP server to teleport to.

Methods¶

Member	Signature	Summary
`GetTeleportData`	`TeleportOptions:GetTeleportData(): Variant`	Returns the teleport data stored in the TeleportOptions instance by TeleportOptions.SetTeleportData().
`SetTeleportData`	`TeleportOptions:SetTeleportData(teleportData: Variant): null`	Setter function for data to be passed to the destination place.

Roblox reference: TeleportOptions

Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.