com.playhub

Class GameInfoToReturnToPlayHub

java.lang.Object

com.playhub.GameInfoToReturnToPlayHub

All Implemented Interfaces:

java.io.Serializable

public class GameInfoToReturnToPlayHub
extends java.lang.Object
implements java.io.Serializable

The information to return to PlayHub at the end of the move. This information needs to be populated by the game activity and then returned to PlayHub. Note that if your game cannot start because there are not enough players (for example you require a minimum of 3 players and there currently are 1 or 2) you should inform the user and return no data to PlayHub. Returning no data tells PlayHub nothing happened. In PlayHub, more users can still join the game as long as it hasn't started. So maybe in the next time the game activity is called there will be enough users. However, if there is another problem with the game, such as too many players, you should return one of the designated GameStateToReturnToPlayhub options that will finish the game. This is because unlike the problem of not enough players, these problems do not have the possibility of changing in the future. Should be sent from the game activity as follows:

 output.putExtra(Consts.GAME_INFO_TO_RETURN_TO_PLAYHUB_KEY, gameInfoToReturnToPlayHub);
 setResult(RESULT_OK, output);
 finish();
 
 

Author:

alon

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GameInfoToReturnToPlayHub.GameStateToReturnToPlayhub The game's current state.

Field Summary

Fields

Modifier and Type	Field and Description
int	currentTurnPlayerUserIndex The index in the users array of the player which turn it now is.
GameInfoToReturnToPlayHub.GameStateToReturnToPlayhub	gameState The game's current state, after the current move (i.e.
byte[]	innerGameState The game's inner state.
java.util.Map<java.lang.Integer,java.lang.String>	perUserMessages This is an OPTIONAL MEMBER, and can be left as null if not needed.
int	winnerUserIndex The index in the users array of the player who won.

Constructor Summary

Constructors

Constructor and Description
GameInfoToReturnToPlayHub()

Method Summary

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

currentTurnPlayerUserIndex

public 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

public 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

public GameInfoToReturnToPlayHub.GameStateToReturnToPlayhub gameState

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

innerGameState

public 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

public java.util.Map<java.lang.Integer,java.lang.String> 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.

Constructor Detail

GameInfoToReturnToPlayHub

public GameInfoToReturnToPlayHub()