Package VASSAL.build.module
Class WizardSupport
java.lang.Object
VASSAL.build.module.WizardSupport
Provides support for two different wizards. The WelcomeWizard is the initial screen shown to the user when loading a
module in play mode. The GameSetupWizard is shown whenever the user starts a new game on- or off-line.
- Author:
- rkinney
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
Branches the wizard by forwarding to the Wizard stored in the wizard settings under a specified keystatic class
Wizard pages for starting a new game.class
Wizard pages for the welcome wizard (initial module load).static class
Wizard pages for loading a saved gamestatic class
Wizard pages for starting a new game offlinestatic class
Loads a saved game in the background.static class
Wizard page for an unfinishedGameSetupStep
static class
-
Field Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addPredefinedSetup(PredefinedSetup setup)
Add aPredefinedSetup
to the wizard page for starting a new game offline.org.netbeans.spi.wizard.WizardPanelProvider
protected WizardSupport.BranchingWizard
void
removePredefinedSetup(PredefinedSetup setup)
void
setBackgroundImage(Image image)
void
setTutorial(Tutorial tutorial)
Specify aTutorial
that the user may load from theWizardSupport.InitialWelcomeSteps
void
Show a wizard that prompts the user to specify information for unfinishedGameSetupStep
svoid
Show the "Welcome" wizard, shown when loading a module in play mode
-
Field Details
-
POST_INITIAL_STEPS_WIZARD
- See Also:
- Constant Field Values
-
POST_LOAD_GAME_WIZARD
- See Also:
- Constant Field Values
-
POST_PLAY_OFFLINE_WIZARD
- See Also:
- Constant Field Values
-
WELCOME_WIZARD_KEY
- See Also:
- Constant Field Values
-
SETUP_KEY
- See Also:
- Constant Field Values
-
ACTION_KEY
- See Also:
- Constant Field Values
-
LOAD_TUTORIAL_ACTION
- See Also:
- Constant Field Values
-
PLAY_ONLINE_ACTION
- See Also:
- Constant Field Values
-
PLAY_OFFLINE_ACTION
- See Also:
- Constant Field Values
-
LOAD_GAME_ACTION
- See Also:
- Constant Field Values
-
WELCOME_WIZARD_ENABLED
- See Also:
- Constant Field Values
-
logoSize
-
setups
-
tutorial
-
-
Constructor Details
-
WizardSupport
public WizardSupport()
-
-
Method Details
-
addPredefinedSetup
Add aPredefinedSetup
to the wizard page for starting a new game offline. Only adds setups that are not menus.- Parameters:
setup
- Predefined Setup
-
removePredefinedSetup
-
setTutorial
Specify aTutorial
that the user may load from theWizardSupport.InitialWelcomeSteps
- Parameters:
tutorial
- Tutorial
-
showWelcomeWizard
public void showWelcomeWizard()Show the "Welcome" wizard, shown when loading a module in play mode -
createWelcomeWizard
-
createPlayOfflinePanels
public org.netbeans.spi.wizard.WizardPanelProvider createPlayOfflinePanels() -
showGameSetupWizard
public void showGameSetupWizard()Show a wizard that prompts the user to specify information for unfinishedGameSetupStep
s -
createInitialWelcomeSteps
-
setBackgroundImage
-