Jogre API Documentation, Version 0.1 Alpha: Class GameProperties

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.jogre.util
Class GameProperties

java.lang.Object
  |
  +--org.jogre.util.AbstractProperties
        |
        +--org.jogre.util.GameProperties

All Implemented Interfaces:: IJogreDefaults

public class GameProperties
extends AbstractProperties
implements IJogreDefaults

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

Version:: Alpha 0.1
Author:: Bob Marks

Fields inherited from interface org.jogre.common.IJogreDefaults

MAX_NUM_OF_PLAYERS, MAX_NUM_OF_TABLES, MAX_NUM_OF_USERS, MIN_NUM_OF_PLAYERS

Method Summary

static GameProperties getInstance()
          Accessor to singleton instance of this class.

static int getMaxNumOfPlayers()
          Return the minimum number of players in a game.

static int getMaxNumOfTables()
          Return the maximum number of tables which can be created.

static int getMaxNumOfUsers()
          Return the maximum number of users which can log on, on any particular server.

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.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:

getMinNumOfPlayers

public static int getMinNumOfPlayers()

Return the minimum number of players in a game.

Returns:

getMaxNumOfPlayers

public static int getMaxNumOfPlayers()