Class AirshipTransferController

Provides access to user information.

Properties

onTransferRequested

Methods

TransferToGame TransferToPartyLeader

Properties

Readonly onTransferRequested

onTransferRequested: Signal<AirshipTransferRequest> = ...

Fired when transfering between servers within your game. Does not fire when players exit your game. If you need to perform actions on exit, use Airship.Players.onPlayerDisconnected.

Methods

TransferToGame

  • TransferToGame(gameId, preferredServerId?): Promise<TransferResult>

  • Submits a request to transfer to the provided game id. The client can optionally request to transfer to a specific server of the given game by providing the perferred server id. It is possible that the client will be transferred to a different server if the perferred server is full or was not allocated with the default scene.

    Parameters

    • gameId: string

      Game id to join.

    • Optional preferredServerId: string

      Specific ServerID to teleport to. If not included, the backend will select a server for you.

    Returns Promise<TransferResult>

TransferToPartyLeader

  • TransferToPartyLeader(): Promise<TransferResult>

  • Submits a request to transfer to the current party leader. If the party leader is not in a game, or the client is not in a party, this function will have no effect.

    Returns Promise<TransferResult>

Settings

Member Visibility

Theme

On This Page

onTransferRequestedTransferToGameTransferToPartyLeader