Package VASSAL.build.module

Interface GameSetupStep

All Known Implementing Classes:
BoardPicker, PlayerRoster
public interface GameSetupStep
Represents a step during the initialization of a game in which the player must specify some information See GameState.addGameSetupStep(SetupStep)
Author:
rkinney

  • Method Summary

    Modifier and Type Method Description
    void finish()
    Apply the information gathered via the component to the game in progress
    Component getControls()
    A GUI component that prompts the player for the needed information.
    String getStepTitle()
    A human-understandable description of this step
    boolean isFinished()  

  • Method Details

    • isFinished

      boolean isFinished()
      Returns:
      true if this step needs no further information, false if the player should be prompted for more information

    • getStepTitle

      String getStepTitle()
      A human-understandable description of this step

    • getControls

      Component getControls()
      A GUI component that prompts the player for the needed information. If null, then no further information is needed

    • finish

      void finish()
      Apply the information gathered via the component to the game in progress