edu.illinois.cs.cs125.spring2020.mp.logic

Class GameSetup

java.lang.Object

edu.illinois.cs.cs125.spring2020.mp.logic.GameSetup

public class GameSetup
extends java.lang.Object

Provides static methods to convert game information to JSON payloads that can be POSTed to the server's /games/create endpoint to create a multiplayer game.

Constructor Summary

Constructors

Constructor and Description
GameSetup()

Method Summary

Modifier and Type	Method and Description
static com.google.gson.JsonObject	areaMode(java.util.List<Invitee> invitees, com.google.android.gms.maps.model.LatLngBounds area, int cellSize) Creates a JSON object representing the configuration of a multiplayer area mode game.
static com.google.gson.JsonObject	targetMode(java.util.List<Invitee> invitees, java.util.List<com.google.android.gms.maps.model.LatLng> targets, int proximityThreshold) Creates a JSON object representing the configuration of a multiplayer target mode game.

Methods inherited from class java.lang.Object

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

Constructor Detail

GameSetup

public GameSetup()

Method Detail

areaMode

public static com.google.gson.JsonObject areaMode(java.util.List<Invitee> invitees,
                                                  com.google.android.gms.maps.model.LatLngBounds area,
                                                  int cellSize)

Creates a JSON object representing the configuration of a multiplayer area mode game.

Refer to our API documentation for the structure of the output JSON.

The configuration is valid if there is at least one invitee and a positive (larger than zero) cell size.

Parameters:

invitees - all players involved in the game (never null)

area - the area boundaries

cellSize - the desired cell size in meters

Returns:

a JSON object usable by the /games/create endpoint or null if the configuration is invalid

targetMode

public static com.google.gson.JsonObject targetMode(java.util.List<Invitee> invitees,
                                                    java.util.List<com.google.android.gms.maps.model.LatLng> targets,
                                                    int proximityThreshold)

Creates a JSON object representing the configuration of a multiplayer target mode game.

Refer to our API documentation for the structure of the output JSON.

The configuration is valid if there is at least one invitee, at least one target, and a positive (larger than zero) proximity threshold. If the configuration is invalid, this function returns null.

Parameters:

invitees - all players involved in the game (never null)

targets - the positions of all targets (never null)

proximityThreshold - the proximity threshold in meters

Returns:

a JSON object usable by the /games/create endpoint or null if the configuration is invalid