IVariantHint

All Known Implementing Classes:: AbstractHintProvider

public interface IVariantHint

Interface for the use of AI Hints.

Author:: Romain Dolbeau

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static enum

IVariantHint.AIStyle

The style of play the AI should prefer.
Method Summary

Modifier and Type

Method

Description

int

getHintedRecruitmentValueOffset(CreatureType creature, List<IVariantHint.AIStyle> styles)

Give an offset to apply to the creature Point Value before estimating its recruitment value.

List<CreatureType>

getInitialSplitHint(MasterHex startingTower, List<IVariantHint.AIStyle> aiStyles)

Obtains the list of creatures to split on turn one.

CreatureType

getRecruitHint(MasterBoardTerrain terrain, IOracleLegion legion, List<CreatureType> recruits, IHintOracle oracle, List<IVariantHint.AIStyle> aiStyles)

Give the suggested recruit in this terrain for this legion.

Method Details
- getRecruitHint
  
  CreatureType getRecruitHint(MasterBoardTerrain terrain, IOracleLegion legion, List<CreatureType> recruits, IHintOracle oracle, List<IVariantHint.AIStyle> aiStyles)
  
  Give the suggested recruit in this terrain for this legion.
  
  Parameters:
  
  terrain - Type of terrain
  
  legion - The recruiting legion
  
  recruits - List of all recruitable Creature (returned value must be the name of one of those)
  
  oracle - An oracle that answers some questions about the situation of the legion
  
  aiStyles - The styles the AI prefers to play
  
  Returns:
  
  The suggested recruit type, a null means recruiting should be skipped.
- getInitialSplitHint
  
  List<CreatureType> getInitialSplitHint(MasterHex startingTower, List<IVariantHint.AIStyle> aiStyles)
  
  Obtains the list of creatures to split on turn one.
  
  Parameters:
  
  startingTower - The starting Tower.
  
  aiStyles - The style the AI prefers to play.
  
  Returns:
  
  The list of creatures to split.
- getHintedRecruitmentValueOffset
  
  int getHintedRecruitmentValueOffset(CreatureType creature, List<IVariantHint.AIStyle> styles)
  
  Give an offset to apply to the creature Point Value before estimating its recruitment value.
  
  Parameters:
  
  creature - Type of the creature
  
  styles - List of AI styles to hint for
  
  Returns:
  
  An offset to the Point Value of the creature.