universe.server.database
Class CivOptions

java.lang.Object
  |
  +--universe.server.database.CivOptions

All Implemented Interfaces:

java.io.Serializable

public class CivOptions

extends java.lang.Object

implements java.io.Serializable

See Also:

Serialized Form

Field Summary

private RaceBase	myFoundingSpecies
private PlayerType	myPlayerType

Constructor Summary

CivOptions()
This is the designated constructor for objects of this class.

Method Summary

RaceBase	getFoundingSpecies() This method returns the founding species stored in the receiving instance.
PlayerType	getPlayerType() This method returns the player type stored in the receiving instance.
void	readFromConfig(int index) This method causes the civilization options object to adopt attribute values previously stored in the persistent configuraiton object.
void	saveToConfig(int index) This method causes the civilization options object to persistently save its current values to the game configuration file so that they will be used the next time the game is run.
void	setFoundingSpecies(RaceBase newValue) This method sets the founding species to be stored in the receiving instance.
void	setPlayerType(PlayerType newValue) This method sets the player type to be stored in the receiving instance.

Methods inherited from class java.lang.Object

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

Field Detail

myFoundingSpecies

private RaceBase myFoundingSpecies

myPlayerType

private PlayerType myPlayerType

Constructor Detail

CivOptions

public CivOptions()

This is the designated constructor for objects of this class. Default values are assigned to each attribute.

Method Detail

getFoundingSpecies

public RaceBase getFoundingSpecies()

This method returns the founding species stored in the receiving instance.

setFoundingSpecies

public void setFoundingSpecies(RaceBase newValue)

This method sets the founding species to be stored in the receiving instance.

Parameters:

newValue - The new founding species value.

See Also:

getFoundingSpecies()

getPlayerType

public PlayerType getPlayerType()

This method returns the player type stored in the receiving instance.

setPlayerType

public void setPlayerType(PlayerType newValue)

This method sets the player type to be stored in the receiving instance.

Parameters:

newValue - The new player type value.

See Also:

getPlayerType()

readFromConfig

public void readFromConfig(int index)

This method causes the civilization options object to adopt attribute values previously stored in the persistent configuraiton object. If no valid corresponding values can be found stored in the configuration, this method simply leaves the current atrributes unchanged. This method is called by the constructor method of the GameOptions object.

Parameters:

index - Unique number used to distinguish each civilization object's values from its fellows.

saveToConfig

public void saveToConfig(int index)

This method causes the civilization options object to persistently save its current values to the game configuration file so that they will be used the next time the game is run. This method is called by the saveToConfig method of the GameOptions object.

Parameters:

index - Unique number used to distinguish each civilization object's values from its fellows.