org.jogre.common.util
Class GameProperties

java.lang.Object
  org.jogre.common.util.AbstractProperties
      org.jogre.common.util.GameProperties

All Implemented Interfaces:

IJogre

public class GameProperties

extends AbstractProperties

implements IJogre

This class provides an easy and effective point for accessing to each game resource bundle (game.properties).

Version:

Alpha 0.2.1

Author:

Bob Marks

Field Summary

Fields inherited from class org.jogre.common.util.AbstractProperties

rb

Fields inherited from interface org.jogre.common.IJogre

DEFAULT_MAX_NUM_OF_PLAYERS, DEFAULT_MAX_NUM_OF_TABLES, DEFAULT_MAX_NUM_OF_USERS, DEFAULT_MIN_NUM_OF_PLAYERS, DEFAULT_PORT, DEFAULT_REQ_NUM_OF_PLAYERS, MASTER_SERVE_KEY, VERSION

Method Summary

static String	getGameID() Return the game ID.
static GameProperties	getInstance() Accessor to singleton instance of this class.
static int	getMaxNumOfPlayers() Return the minimum number of players in a game.
static int	getMinNumOfPlayers() Return the minimum number of players in a game.
static Color	getPlayerColour(int playerNum) Return the color of a player (each player has a specific colour which is used throughout the API).

Methods inherited from class org.jogre.common.util.AbstractProperties

get, get, getBoolean, getBoolean, getInt, getInt

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static GameProperties getInstance()

Accessor to singleton instance of this class.

Returns:

Instance of this class.

getMinNumOfPlayers

public static int getMinNumOfPlayers()

Return the minimum number of players in a game.

Returns:

Max num of players.

getMaxNumOfPlayers

public static int getMaxNumOfPlayers()

Return the minimum number of players in a game.

Returns:

Max num of players.

getGameID

public static String getGameID()

Return the game ID.

Returns:

GameID.

getPlayerColour

public static Color getPlayerColour(int playerNum)

Return the color of a player (each player has a specific colour which is used throughout the API).

Parameters:

playerNum - Supplied player number

Returns:

Color