GameSetupStep (vassal-app 3.7.12 API)

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 #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()

default void

setController(org.netbeans.spi.wizard.WizardController wc)

Tells the step who its wizard controller is

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
- setController
  
  default void setController(org.netbeans.spi.wizard.WizardController wc)
  
  Tells the step who its wizard controller is