net.sf.colossus.variant
Interface ICustomRecruitBase

All Known Implementing Classes:

CustomRecruitBase

public interface ICustomRecruitBase

Method Summary

java.util.List<CreatureType>	getAllPossibleSpecialRecruiters(MasterBoardTerrain terrain) List all creatures that can recruit in this terrain in a special way.
java.util.List<CreatureType>	getAllPossibleSpecialRecruits(MasterBoardTerrain terrain) List all creatures that can be recruited in this terrain in a special way.
java.util.List<CreatureType>	getPossibleSpecialRecruiters(MasterHex hex) List creatures that can recruit in this terrain in a special way now.
java.util.List<CreatureType>	getPossibleSpecialRecruits(MasterHex hex) List creatures that can be recruited in this terrain in a special way now.
int	numberOfRecruiterNeeded(CreatureType recruiter, CreatureType recruit, MasterHex hex) Number of recruiters needed to get a recruit in a special way in this terrain now.

Method Detail

getAllPossibleSpecialRecruiters

java.util.List<CreatureType> getAllPossibleSpecialRecruiters(MasterBoardTerrain terrain)

List all creatures that can recruit in this terrain in a special way.

getAllPossibleSpecialRecruits

java.util.List<CreatureType> getAllPossibleSpecialRecruits(MasterBoardTerrain terrain)

List all creatures that can be recruited in this terrain in a special way.

getPossibleSpecialRecruiters

java.util.List<CreatureType> getPossibleSpecialRecruiters(MasterHex hex)

List creatures that can recruit in this terrain in a special way now.

Parameters:

hex - The specific MasterHex considered for recruiting.

Returns:

A List of possible special Recruiters in this hex.

getPossibleSpecialRecruits

java.util.List<CreatureType> getPossibleSpecialRecruits(MasterHex hex)

List creatures that can be recruited in this terrain in a special way now.

Parameters:

hex - The specific MasterHex considered for recruiting (for an example, see getPossibleSpecialRecruits() in BalrogRecruitment.java in Balrog variant directory)

Returns:

A List of possible special Recruits in this hex.

numberOfRecruiterNeeded

int numberOfRecruiterNeeded(CreatureType recruiter,
                            CreatureType recruit,
                            MasterHex hex)

Number of recruiters needed to get a recruit in a special way in this terrain now.