Class HazardHexside

java.lang.Object

net.sf.colossus.variant.Hazards

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 Hazards

Hazards.CombatEffect

Nested classes/interfaces inherited from interface HazardConstants

HazardConstants.EffectOnMovement, HazardConstants.EffectOnStrike, HazardConstants.RangeStrikeSpecialEffect, HazardConstants.ScopeOfEffectOnStrike, HazardConstants.SpecialEffect

Field Summary

Fields

Modifier and Type	Field	Description
static final HazardHexside	CLIFF
static final HazardHexside	DUNE
private static final Map<String, HazardHexside>	HEXSIDE_MAP	A map from the serialization string of a Hexside to the instances.
private static final Map<Character, HazardHexside>	HEXSIDE_MAP_UGLY
static final HazardHexside	NOTHING
static final HazardHexside	RIVER
static final HazardHexside	SLOPE
static final HazardHexside	TOWER

Fields inherited from class Hazards

attackEffect, defenseEffect, effectOnFlyerMovement, effectOnGroundMovement, rangedAttackEffect, rangedDefenseEffect, rangeStrikeSpecial, terrainSpecial

Constructor Summary

Constructors

Constructor

Description

HazardHexside(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

Modifier and Type	Method	Description
static final Collection<HazardHexside>	getAllHazardHexsides()	Returns all available hazard hexsides.
static HazardHexside	getHexsideByCode(char code)	Deprecated.
static HazardHexside	getHexsideByName(String name)
boolean	isNativeBonusHexside()
boolean	isNonNativePenaltyHexside()
String	toString()

Methods inherited from class Hazards

getCode, getName

Methods inherited from class Object

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

Field Details

HEXSIDE_MAP

private static final Map<String, HazardHexside> HEXSIDE_MAP

A map from the serialization string of a Hexside to the instances.

HEXSIDE_MAP_UGLY

private static final Map<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 Details

HazardHexside

public HazardHexside(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 Details

getHexsideByName

public static HazardHexside getHexsideByName(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 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 String toString()

Specified by:

toString in interface HazardConstants

Specified by:

toString in class Hazards

isNativeBonusHexside

public boolean isNativeBonusHexside()

isNonNativePenaltyHexside

public boolean isNonNativePenaltyHexside()