edu.illinois.cs.cs125.fall2019.mp

Class Game

java.lang.Object

edu.illinois.cs.cs125.fall2019.mp.Game

Direct Known Subclasses:

AreaGame, TargetGame

public abstract class Game
extends java.lang.Object

Represents a multiplayer game, providing or defining methods common to all game modes.

This is used in Checkpoint 4. You do not need to modify it.

Constructor Summary

Constructors

Constructor and Description
Game(java.lang.String setEmail, com.google.android.gms.maps.GoogleMap setMap, com.neovisionaries.ws.client.WebSocket setWebSocket, com.google.gson.JsonObject initialState, android.content.Context setContext) Sets up this Game.

Method Summary

Modifier and Type	Method and Description
protected android.content.Context	getContext() Gets the UI context.
protected java.lang.String	getEmail() Gets the user's email address.
protected com.google.android.gms.maps.GoogleMap	getMap() Gets the Google Maps view used by this Game.
int	getMyTeam() Gets the user's team ID in this game.
abstract int	getTeamScore(int teamId) Gets a team's score.
boolean	handleMessage(com.google.gson.JsonObject message, java.lang.String type) Processes an update from the server.
abstract void	locationUpdated(com.google.android.gms.maps.model.LatLng location) Processes a location change, makes appropriate changes to the game state, and sends appropriate notifications to the server.
protected void	sendMessage(com.google.gson.JsonObject message) Sends a message to the server.
protected void	sendMessage(java.lang.String text) Sends a message to the server.

Methods inherited from class java.lang.Object

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

Constructor Detail

Game

public Game(java.lang.String setEmail,
            com.google.android.gms.maps.GoogleMap setMap,
            com.neovisionaries.ws.client.WebSocket setWebSocket,
            com.google.gson.JsonObject initialState,
            android.content.Context setContext)

Sets up this Game.

Parameters:

setEmail - the user's email (from Firebase)

setMap - the Google Maps view to render to

setWebSocket - the websocket to send events to

initialState - the "full" update from the server

setContext - the Android UI context

Method Detail

getContext

protected final android.content.Context getContext()

Gets the UI context.

This method is here to expose the private context variable to subclasses.

Returns:

an Android UI context

getEmail

protected final java.lang.String getEmail()

Gets the user's email address.

This method is here to expose the private email variable to subclasses.

Returns:

the current user's email

getMap

protected final com.google.android.gms.maps.GoogleMap getMap()

Gets the Google Maps view used by this Game.

This method is here to expose the private map variable to subclasses.

Returns:

the Google Maps control to render to

getMyTeam

public final int getMyTeam()

Gets the user's team ID in this game.

Returns:

team ID as defined in TeamID

getTeamScore

public abstract int getTeamScore(int teamId)

Gets a team's score.

Subclasses should implement this in a way specific to their game mode's type of objective.

Parameters:

teamId - the team ID

Returns:

how many objectives the team has captured

handleMessage

public boolean handleMessage(com.google.gson.JsonObject message,
                             java.lang.String type)

Processes an update from the server.

This implementation handles playerLocation and playerExit events, updating the player circles appropriately. Subclass implementations should handle events specific to their game mode, delegating others to this implementation with a super call.

Parameters:

message - JSON from the server

type - the update type

Returns:

whether the message was handled

locationUpdated

public abstract void locationUpdated(com.google.android.gms.maps.model.LatLng location)

Processes a location change, makes appropriate changes to the game state, and sends appropriate notifications to the server.

Subclasses should implement this in a way specific to the mode of game they represent.

Parameters:

location - a location FusedLocationProviderClient is reasonably confident about

sendMessage

protected final void sendMessage(com.google.gson.JsonObject message)

Sends a message to the server.

Subclasses can use this to send updates via the websocket.

Parameters:

message - JSON object to send

sendMessage

protected final void sendMessage(java.lang.String text)

Sends a message to the server.

Parameters:

text - serialized JSON to send