net.sf.colossus.variant
Class HazardHexside

java.lang.Object
  extended by net.sf.colossus.variant.Hazards
      extended by net.sf.colossus.variant.HazardHexside
All Implemented Interfaces:
HazardConstants

public class HazardHexside
extends Hazards

This is a typesafe enumeration of all hazard Hexsides, i.e. the Hexsides used in the battle maps. TODO turn into proper enum


Nested Class Summary
 
Nested classes/interfaces inherited from class net.sf.colossus.variant.Hazards
Hazards.CombatEffect
 
Nested classes/interfaces inherited from interface net.sf.colossus.variant.HazardConstants
HazardConstants.EffectOnMovement, HazardConstants.EffectOnStrike, HazardConstants.RangeStrikeSpecialEffect, HazardConstants.ScopeOfEffectOnStrike, HazardConstants.SpecialEffect
 
Field Summary
static HazardHexside CLIFF
           
static HazardHexside DUNE
           
private static java.util.Map<java.lang.String,HazardHexside> HEXSIDE_MAP
          A map from the serialization string of a Hexside to the instances.
private static java.util.Map<java.lang.Character,HazardHexside> HEXSIDE_MAP_UGLY
           
static HazardHexside NOTHING
           
static HazardHexside RIVER
           
static HazardHexside SLOPE
           
static HazardHexside TOWER
           
 
Fields inherited from class net.sf.colossus.variant.Hazards
attackEffect, defenseEffect, effectOnFlyerMovement, effectOnGroundMovement, rangedAttackEffect, rangedDefenseEffect, rangeStrikeSpecial, terrainSpecial
 
Constructor Summary
HazardHexside(java.lang.String name, char code, HazardConstants.EffectOnMovement effectOnGroundMovement, HazardConstants.EffectOnMovement effectOnFlyerMovement, Hazards.CombatEffect defenseEffect, Hazards.CombatEffect attackEffect, Hazards.CombatEffect rangedDefenseEffect, Hazards.CombatEffect rangedAttackEffect, HazardConstants.RangeStrikeSpecialEffect RangeStrikeSpecial, HazardConstants.SpecialEffect terrainSpecial)
           
 
Method Summary
static java.util.Collection<HazardHexside> getAllHazardHexsides()
          Returns all available hazard hexsides.
static HazardHexside getHexsideByCode(char code)
          Deprecated. 
static HazardHexside getHexsideByName(java.lang.String name)
           
 boolean isNativeBonusHexside()
           
 boolean isNonNativePenaltyHexside()
           
 java.lang.String toString()
           
 
Methods inherited from class net.sf.colossus.variant.Hazards
getCode, getName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

HEXSIDE_MAP

private static final java.util.Map<java.lang.String,HazardHexside> HEXSIDE_MAP
A map from the serialization string of a Hexside to the instances.


HEXSIDE_MAP_UGLY

private static final java.util.Map<java.lang.Character,HazardHexside> HEXSIDE_MAP_UGLY

NOTHING

public static final HazardHexside NOTHING

DUNE

public static final HazardHexside DUNE

CLIFF

public static final HazardHexside CLIFF

SLOPE

public static final HazardHexside SLOPE

TOWER

public static final HazardHexside TOWER

RIVER

public static final HazardHexside RIVER
Constructor Detail

HazardHexside

public HazardHexside(java.lang.String name,
                     char code,
                     HazardConstants.EffectOnMovement effectOnGroundMovement,
                     HazardConstants.EffectOnMovement effectOnFlyerMovement,
                     Hazards.CombatEffect defenseEffect,
                     Hazards.CombatEffect attackEffect,
                     Hazards.CombatEffect rangedDefenseEffect,
                     Hazards.CombatEffect rangedAttackEffect,
                     HazardConstants.RangeStrikeSpecialEffect RangeStrikeSpecial,
                     HazardConstants.SpecialEffect terrainSpecial)
Method Detail

getHexsideByName

public static HazardHexside getHexsideByName(java.lang.String name)

getHexsideByCode

@Deprecated
public static HazardHexside getHexsideByCode(char code)
Deprecated. 

deprecated because we want to get rid of the single char stuff


getAllHazardHexsides

public static final java.util.Collection<HazardHexside> getAllHazardHexsides()
Returns all available hazard hexsides. This is not variant-specific, any hexside known to the program is listed even if it is not available in the current variant. TODO this should really be a question to ask a variant instance


toString

public java.lang.String toString()
Specified by:
toString in interface HazardConstants
Specified by:
toString in class Hazards

isNativeBonusHexside

public boolean isNativeBonusHexside()

isNonNativePenaltyHexside

public boolean isNonNativePenaltyHexside()