Serialized Form

Package com.playhub

Class com.playhub.GameInfoFromPlayHub extends java.lang.Object implements Serializable

serialVersionUID:

1L

Serialized Fields

users

UserInfoFromPlayHub[] users

An array containing information about all the users in the game. Once the game started (The first move has been played) you are guaranteed that the list of users will not change in future calls. In PlayHub, a user cannot join a game that has already started, and if a user leaves a game, the game is automatically cancelled.

currentTurnUserIndex

int currentTurnUserIndex

The index in the users array of the player whose turn it currently is. When a game is first created, the first player is ALWAYS the creating player, so that is the player's user id which PlayHub will pass to the game activity upon the game's first move.

viewingUserIndex

int viewingUserIndex

The index in the users array of the player who is currently viewing the game.

innerGameState

byte[] innerGameState

The game-specific data. This buffer is received from the game and sent AS IS back to the game. The game should store in it (and serialize to a byte array however it sees fit) ALL the information needed to pass the game's state from one player to another, excluding the little data which is passed in the game's metatata (such as users list, or who is the current player). If this is the first time PlayHub calls the game's activity for this specific game, this member will be null (which is reasonable, as PlayHub cannot by itself initialize this game-specific data).

isGameAlreadyFinished

boolean isGameAlreadyFinished

Whether the game has finished or not. The game may have finished for many reasons, either because the one of the players won, your game activity previously decided to cancel the game, or if one of the users cancelled the game via PlayHub. If this is true, there is no importance to the data you return to PlayHub in GameInfoToReturnToPlayHub (you don't even need to return it), as PlayHub will ignore it since the game is already over.

Class com.playhub.GameInfoToReturnToPlayHub extends java.lang.Object implements Serializable

serialVersionUID:

1L

Serialized Fields

currentTurnPlayerUserIndex

int currentTurnPlayerUserIndex

The index in the users array of the player which turn it now is. If the returned gameState is RUNNING, this member must be a valid userId of one of the game's users.

winnerUserIndex

int winnerUserIndex

The index in the users array of the player who won. If the game state does not indicates the game was won, this value is ignored.

gameState

GameInfoToReturnToPlayHub.GameStateToReturnToPlayhub gameState

The game's current state, after the current move (i.e. now). See GameStateToReturnToPlayhub documentation for more info.

innerGameState

byte[] innerGameState

The game's inner state. This buffer will be passed AS IS to the game as part of GameInfoFromPlayHub next time it is called for this specific game. See GameInfoFromPlayHub documentation for more info. Can be at most 512*1024 (512KB) long. Any bigger and the play will be discarded.

perUserMessages

java.util.Map<K,V> perUserMessages

This is an OPTIONAL MEMBER, and can be left as null if not needed. This allows you to create specific messages that will be sent to specific users instead of the default PlayHub messages. For example, if the user Johnnie (thats his nickname) played a move, and it is now Bradley's turn, PlayHub will send a notification to all the other users with something like "Johnny played in the game, it is Bradley's turn now". If you wish for another message to be sent to any or all of the users, for example, sent to Bradley something like "Oh no, Johnny just killed all your sheep!", simply put the message in this map, with bradley's index in the users array as the key. PlayHub uses this messages instead of the default messages for each user whose index in the users array appears in the map.

Class com.playhub.UserInfoFromPlayHub extends java.lang.Object implements Serializable

serialVersionUID:

1L

Serialized Fields

userId

java.lang.String userId

The user's unique id. Specifically, it is the user's email, and it cannot be null.

nickname

java.lang.String nickname

The user's nickname. Might be the user's email (i.e. identical to the user's id), but this only happens if the user hasn't configured a nickname in PlayHub. Anyway, it is not something to worry about.

imageUri

java.lang.String imageUri

The user's image uri. This might be null, if the user hadn't configured for himself an image in PlayHub. If it is not null, it is guaranteed to be a square image with size at least 256 on 256 pixels. In order to read it, your application must have permissions to read from external storage. Example of using this to load the user's image into an ImageView: if (player.imageUri != null){ Uri imageUri = Uri.parse(player.imageUri); imageView.setImageURI(imageUri); }