GameGenerator (Rule Game web API documentation)

java.lang.Object

edu.wisc.game.sql.GameGenerator

Direct Known Subclasses:: PredefinedBoardGameGenerator, RandomGameGenerator, RandomImageGameGenerator, TrivialGameGenerator

public abstract class GameGenerator
extends Object

This class generates random games (with the same rule set and randomly created initial boards) based on the provided parameter range specifications

Method Summary

Modifier and Type	Method	Description
`void`	`advance(int n)`	Advances the counter.
`RuleSet`	`getRules()`
`boolean`	`getTesting()`
`static GameGenerator`	`mkGameGenerator(RandomRG _random, ParaSet para)`	Creates a GameGenerator based on a parameter set.
`abstract Game`	`nextGame()`	Generates the next game to play
`void`	`setConditions(boolean _testing, RuleSet _condRules)`	For the training/testing restrictions on boards, as introduced in GS 6.010.
`void`	`setTesting(boolean _testing)`

Methods inherited from class java.lang.Object

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

Method Details
- getRules
  
  public RuleSet getRules()
- nextGame
  
  public abstract Game nextGame()
  
  Generates the next game to play
- advance
  
  public void advance(int n)
  
  Advances the counter. This can be used to resume an interrupted series, so that e.g. a predefined board from the correct position in the list would be used next.
  
  Parameters:
  
  n - advance the counter as if n games have been created
- mkGameGenerator
  
  public static GameGenerator mkGameGenerator(RandomRG _random, ParaSet para) throws IOException, RuleParseException, IllegalInputException, ReflectiveOperationException
  
  Creates a GameGenerator based on a parameter set. Depending on which parameters are set, a PredefinedBoardGameGenerator or a RandomGameGenerator may be returned.
  
  Parameters:
  
  para - The parameter set for which we will create a suitable GameGenerator
  
  Throws:
  
  IOException
  
  RuleParseException
  
  IllegalInputException
  
  ReflectiveOperationException
- getTesting
  
  public boolean getTesting()
- setTesting
  
  public void setTesting(boolean _testing)
- setConditions
  
  public void setConditions(boolean _testing, RuleSet _condRules)
  
  For the training/testing restrictions on boards, as introduced in GS 6.010. See email discusion with Paul on 2023-03-08, and captive.html#cond