gameNetwork.show()

command _^(required)

String. String value as supported by Google Play Game Services:

• "leaderboards"
• "achievements"
• "selectPlayers"
• "waitingRoom"
• "invitations"

params _^(optional)

Table. Table of parameters allowed by Google Play Game Services — see the next section for details.

Listener Function

For most calls to gameNetwork.show(), the params table supports a listener key with its value as a callback function to monitor the call result, for example:

gameNetwork.show( "invitations", { listener=invitationListener } )

Leaderboards

For the command parameter of "leaderboards", this function shows the leaderboard screen. Once there, the user can navigate to the different types of leaderboards. This function does not require a params table or callback listener.

gameNetwork.show( "leaderboards" )

Achievements

For the command parameter of "achievements", this function shows the achievements screen. This screen includes both achievements that the player has obtained and those achievements not yet obtained. This function does not require a params table or callback listener.

gameNetwork.show( "achievements" )

Select Players

For the command parameter of "selectPlayers", this function shows a screen where the player can select which players to invite to a game or, alternatively, choose to use auto-match.

local function selectPlayersListener( event )
    print( event.data[1], event.data[2], event.data[3] ) --selected player IDs
    print( event.data.minAutoMatchPlayers )
    print( event.data.maxAutoMatchPlayers )
    print( event.data.phase )
end

gameNetwork.show( "selectPlayers",
    {
        minPlayers = 1,  --this value does not include the current player
        maxPlayers = 3,  --this value does not include the current player
        listener = selectPlayersListener
    }
)

Inside the the params table, the following optional keys apply:

• minPlayers — Number which specifies the minimum number of players in a multiplayer game. This value does not include the current player.

• maxPlayers — Number which specifies the maximum number of players in a multiplayer game. This value does not include the current player.

When handling the results of a "selectPlayers" call, event.data in the callback listener contains an array of player IDs selected. Additionally, event.data contains the following properties:

• minAutoMatchPlayers (number) — The minimum number of auto-matched players.
• maxAutoMatchPlayers (number) — The maximum number of auto-matched players.
• phase (string) — The phase value of either "selected" or "cancelled".

Waiting Room

For the command parameter of "waitingRoom", this function shows the waiting room screen.

local function waitingRoomListener( event )
    print( event.type )  --"waitingRoom"
    print( event.data[1], event.data[2], event.data[3] )  --participant IDs
    print( event.data.roomID )
    print( event.data.phase )
    print( event.data.isError )
end

-- Display the waiting room screen for a specific room
-- If the user exits the waiting room, he/she will exit the room automatically
gameNetwork.show( "waitingRoom",
    {
        roomID = "3487324234",
        minPlayers = 2,
        listener = waitingRoomListener
    }
)

Inside the the params table, the following keys apply:

• roomID — String value representing the room ID of the waiting room.

• minPlayers — Specifies the minimum number of players required before the game can begin.

When handling the results of a "waitingRoom" call, event.data in the callback listener contains an array of participant IDs. Additionally, event.data contains the following properties:

• roomID (string) — The room ID of the waiting room.
• phase (string) — Value of "start" when the game can begin or "cancel" if the user exited the waiting room screen.
• isError (boolean) — Boolean specifying if an error occurred or not.

Invitations

For the command parameter of "invitations", this function shows the current invitations for the user.

local function invitationListener( event )
    print( event.data.roomID )
    print( event.data.phase )
    print( event.data.isError )
end

gameNetwork.show( "invitations",
    {
        listener = invitationListener
    }
)

When handling the results of a "invitations" call, event.data in the callback listener contains the following properties:

• roomID (string) — ID of the room the player selected.
• phase (string) — The phase value of either "selected" or "cancelled".
• isError (boolean) — Boolean specifying if an error occurred or not.