game-common / pragma.gameinstance / GameInstancePlugin / buildExtGameServerPlayer /

buildExtGameServerPlayer #

open suspend fun buildExtGameServerPlayer(gameInstance: GameInstance.GameInstance, player: GameInstance.GamePlayer): ExtGameServerPlayer

Called to prepare any custom data to send to the game server when a player is joining a game.

Used by:

  • GameInstance.getGameStartDataV1
  • GameInstance.createMatchV2
  • GameInstance.foundMorePlayersV1

Return #

An ExtGameServerPlayer payload declaring any custom data to send to the game server for this player.

Parameters #

gameInstance

The game receiving a new player.

player

The new player being added to the game.