Skip to main content

Background

In Experiences that use a Lobby Place to teleport players into SubPlaces, PlayWave authentication is lost during the TeleportService transition. Teleport integration solves this by passing session data through TeleportOptions, maintaining authentication across Places.
Without teleport integration, billing will not apply after moving to a SubPlace, which can result in revenue loss.

Prerequisites

1

Install the latest plugin

Install the latest PlayWave plugin from the Toolbox.
Clicking Install SDK will reset existing callback scripts (PlayWaveSetup, PlayWaveClient). Back up your existing code before proceeding.
2

Install SDK on each Place

PlayWave SDK must be installed on every SubPlace that is a teleport destination. Run Install SDK from the plugin in each Place.

Modify teleport code

In your existing teleport logic, create TeleportOptions and call PlayWaveServer.prepareForTeleport to inject session data.
-- ServerScriptService/TeleportHandler (Script Example)
local Players = game:GetService("Players")
local TeleportService = game:GetService("TeleportService")
local ReplicatedStorage = game:GetService("ReplicatedStorage")

local SUB_PLACE_ID = 130143450994652

local PlayWaveServer = require(
    game:GetService("ServerScriptService")
        :WaitForChild("PlayWaveSetup")
        :WaitForChild("PlayWaveServer")
)

local teleportEvent = Instance.new("RemoteEvent")
teleportEvent.Name = "RequestTeleport"
teleportEvent.Parent = ReplicatedStorage

teleportEvent.OnServerEvent:Connect(function(player)
    local teleportOptions = Instance.new("TeleportOptions")
    PlayWaveServer.prepareForTeleport(player, teleportOptions)
    TeleportService:TeleportAsync(SUB_PLACE_ID, {player}, teleportOptions)
end)

Key points

ItemDescription
prepareForTeleportInjects PlayWave session data into TeleportOptions
SubPlace SDK installSDK is required on each SubPlace to receive session data
Callback restorationRe-write onPcCafe callbacks after SDK reinstallation

Integration checklist

Next steps

Quickstart

Full walkthrough from plugin installation to basic integration.

Session lifecycle

Understand how sessions, heartbeats, and termination work.