net.sf.colossus.variant
Interface IRecruiting

All Known Implementing Classes:
RecruitingSubTree

public interface IRecruiting

Interface for recruiting. All recruiting should go through one of those. Eventually.

Author:
Romain Dolbeau

Method Summary
 java.util.Set<CreatureType> getPossibleRecruiters(MasterHex hex)
          Return all the CreatureType that can be recruits (something) in the hex.
 java.util.Set<CreatureType> getPossibleRecruits(MasterHex hex)
          Return all the CreatureType that can be (somehow) recruited in the hex.
 int maximumNumberNeededOf(CreatureType ct, MasterHex hex)
           
 int numberOfRecruiterNeeded(CreatureType recruiter, CreatureType recruit, MasterHex hex)
          Return the number of recruiter needed to obtain a recruit in hex
 

Method Detail

numberOfRecruiterNeeded

int numberOfRecruiterNeeded(CreatureType recruiter,
                            CreatureType recruit,
                            MasterHex hex)
Return the number of recruiter needed to obtain a recruit in hex

Parameters:
recruiter - The Recruiter
recruit - The Recruit
hex - The hexagon in which the recruiting occurs
Returns:
The number of recruiter needed to obtain a recruit in hex

getPossibleRecruits

java.util.Set<CreatureType> getPossibleRecruits(MasterHex hex)
Return all the CreatureType that can be (somehow) recruited in the hex.

Parameters:
hex - The hexagon to consider
Returns:
All CreatureType that can be recruited in hex

getPossibleRecruiters

java.util.Set<CreatureType> getPossibleRecruiters(MasterHex hex)
Return all the CreatureType that can be recruits (something) in the hex.

Parameters:
hex - The hexagon to consider
Returns:
All CreatureType that can recruit in hex

maximumNumberNeededOf

int maximumNumberNeededOf(CreatureType ct,
                          MasterHex hex)