|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object dip.world.variant.data.Variant
A Variant.
Nested Class Summary | |
static class |
Variant.NameValuePair
Class of Rule Option name/value pairs |
Constructor Summary | |
Variant()
Construct a new Variant object |
Method Summary | |
java.lang.Object |
clone()
Creates a deep clone of all data EXCEPT InitialState / SupplyCenter data / Name / Description |
int |
compareTo(java.lang.Object o)
Compares based on Name |
java.lang.String[] |
getAliases()
The aliases (alternate names) of the variant. |
boolean |
getBCYearsAllowed()
Gets if BC Years are allowed with this Variant |
BorderData[] |
getBorderData()
Gets the BorderData associated with this Variant |
MapGraphic |
getDefaultMapGraphic()
Gets the default MapGraphic; if there is no default, returns the first one. |
java.lang.String |
getDescription()
Description for variant; this is typically HTML encoded. |
java.lang.Object[] |
getHTMLSummaryArguments()
Gets the arguments for an HTML description, suitable for insertion inside an appropriately-marked HTML template (arguments are surrounded by curly braces). |
InitialState[] |
getInitialStates()
The starting InitialStates. |
MapGraphic[] |
getMapGraphics()
The mapGraphics associated with this Variant. |
MapGraphic |
getMapGrapic(java.lang.String mgName)
Finds the MapGraphic by name; case insensitive. |
int |
getMaxGameTimeYears()
Victory Conditions: Maximum game duration, in years. |
int |
getMaxYearsNoSCChange()
Victory Conditions: Maximum years without a supply-center ownership change before game ends. |
java.lang.String |
getName()
The name of the variant. |
int |
getNumSCForVictory()
Victory Conditions: Number of Supply Centers required for victory. |
Power[] |
getPowers()
Returns Powers associated with this Variant. |
ProvinceData[] |
getProvinceData()
The ProvinceData associated with this Variant |
Variant.NameValuePair[] |
getRuleOptionNVPs()
The RuleOptions (as name-value pairs) associated with this Variant |
Phase |
getStartingPhase()
The starting time. |
SupplyCenter[] |
getSupplyCenters()
Returns SupplyCenter objects |
float |
getVersion()
Version of this variant |
boolean |
isDefault()
Whether this is the default variant. |
void |
setActiveState(boolean[] values)
Changes the active/inactive state of a power. |
void |
setAliases(java.lang.String[] aliases)
Set the alises. |
void |
setBCYearsAllowed(boolean value)
Sets whether BC years (negative years) are allowed |
void |
setBorderData(BorderData[] value)
Sets the BorderData associated with this Variant |
void |
setDefault(boolean value)
Set if this variant is the default variant. |
void |
setDescription(java.lang.String value)
Set the description for this variant. |
void |
setInitialStates(java.util.List stateList)
Sets the InitialStates, from a List |
void |
setMapGraphics(java.util.List mgList)
Sets the MapGraphics, from a List |
void |
setMaxGameTimeYears(int value)
Victory Conditions: Maximum game duration, in years. |
void |
setMaxYearsNoSCChange(int value)
Victory Conditions: Maximum years without a supply-center ownership change before game ends. |
void |
setName(java.lang.String value)
Set the variant name. |
void |
setNumSCForVictory(int value)
Victory Conditions: Number of Supply Centers required for victory. |
void |
setPowers(java.util.List powerList)
Sets the Powers, from a List |
void |
setProvinceData(ProvinceData[] value)
Sets the ProvinceData associated with this Variant |
void |
setRuleOptionNVPs(java.util.List nvpList)
Sets the RuleOptions (as a List of name-value pairs) associated with this Variant |
void |
setStartingPhase(Phase value)
Set the starting phase for this variant. |
void |
setSupplyCenters(java.util.List supplyCenterList)
Sets the supply centers, from a List |
void |
setVersion(float value)
Set the version of this variant |
java.lang.String |
toString()
For debugging only! |
Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public Variant()
Method Detail |
public java.lang.String getName()
public java.lang.String[] getAliases()
public float getVersion()
public boolean isDefault()
public java.lang.String getDescription()
public Phase getStartingPhase()
public InitialState[] getInitialStates()
public Power[] getPowers()
public SupplyCenter[] getSupplyCenters()
public int getNumSCForVictory()
public int getMaxYearsNoSCChange()
public int getMaxGameTimeYears()
public MapGraphic[] getMapGraphics()
public ProvinceData[] getProvinceData()
public Variant.NameValuePair[] getRuleOptionNVPs()
public BorderData[] getBorderData()
public boolean getBCYearsAllowed()
public void setName(java.lang.String value)
public void setAliases(java.lang.String[] aliases)
public void setVersion(float value)
public void setDefault(boolean value)
public void setDescription(java.lang.String value)
public void setStartingPhase(Phase value)
public void setNumSCForVictory(int value)
public void setMaxYearsNoSCChange(int value)
public void setMaxGameTimeYears(int value)
public void setProvinceData(ProvinceData[] value)
public void setBorderData(BorderData[] value)
public void setBCYearsAllowed(boolean value)
public void setMapGraphics(java.util.List mgList)
public void setPowers(java.util.List powerList)
public void setInitialStates(java.util.List stateList)
public void setSupplyCenters(java.util.List supplyCenterList)
public void setRuleOptionNVPs(java.util.List nvpList)
public void setActiveState(boolean[] values)
public int compareTo(java.lang.Object o)
compareTo
in interface java.lang.Comparable
public MapGraphic getMapGrapic(java.lang.String mgName)
public MapGraphic getDefaultMapGraphic()
public java.lang.Object[] getHTMLSummaryArguments()
Arguments for the HTML template are:
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
java.lang.CloneNotSupportedException
public java.lang.String toString()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |