Package megamek.common.scenario

Interface Scenario

All Known Implementing Classes:

ScenarioV1, ScenarioV2

public interface Scenario

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COMMENT_MARK
static final String	DESCRIPTION
static final String	FILE_SUFFIX_BOARD
static final String	GAMETYPE
static final String	MAP_RANDOM
static final String	MMS_PLANET_CONDITIONS
static final String	MMS_VERSION
static final String	NAME
static final String	PARAM_ADVANTAGES
static final String	PARAM_ALTITUDE
static final String	PARAM_AMMO_AMOUNT
static final String	PARAM_AMMO_TYPE
static final String	PARAM_AUTO_EJECT
static final String	PARAM_BOARD_HEIGHT
static final String	PARAM_BOARD_WIDTH
static final String	PARAM_BRIDGE_CF
static final String	PARAM_CAMO
static final String	PARAM_COMMANDER
static final String	PARAM_CRITICAL_HIT
static final String	PARAM_DAMAGE
static final String	PARAM_DEPLOYMENT_ROUND
static final String	PARAM_EXTERNAL_ID
static final String	PARAM_FACTIONS
static final String	PARAM_GAME_EXTERNAL_ID
static final String	PARAM_GAME_OPTIONS_FILE
static final String	PARAM_GAME_OPTIONS_FIXED
static final String	PARAM_LOCATION
static final String	PARAM_MAP_DIRECTORIES
static final String	PARAM_MAP_HEIGHT
static final String	PARAM_MAP_WIDTH
static final String	PARAM_MAPS
static final String	PARAM_MINEFIELDS
static final String	PARAM_PILOT_HITS
static final String	PARAM_PLANET_CONDITIONS_FIXED
static final String	PARAM_SINGLEPLAYER
static final String	PARAM_SPECIFIC_DAMAGE
static final String	PARAM_TEAM
static final String	PLANET

Method Summary

Modifier and Type	Method	Description
void	applyDamage(IGameManager gameManager)
IGame	createGame()
default int	findIndex(String[] sa, String s)
default BotParser.BotInfo	getBotInfo(String playerName)
String	getDescription()
String	getFileName()
default GameType	getGameType()
String	getName()
default String	getPlanet()
default boolean	hasBotInfo(String playerName)
boolean	hasFixedGameOptions()
boolean	hasFixedPlanetaryConditions()
boolean	isSinglePlayer()

Field Details

COMMENT_MARK

static final String COMMENT_MARK

See Also:

• Constant Field Values

FILE_SUFFIX_BOARD

static final String FILE_SUFFIX_BOARD

See Also:

• Constant Field Values

MMS_VERSION

static final String MMS_VERSION

See Also:

• Constant Field Values

NAME

static final String NAME

See Also:

• Constant Field Values

DESCRIPTION

static final String DESCRIPTION

See Also:

• Constant Field Values

PLANET

static final String PLANET

See Also:

• Constant Field Values

GAMETYPE

static final String GAMETYPE

See Also:

• Constant Field Values

PARAM_GAME_OPTIONS_FILE

static final String PARAM_GAME_OPTIONS_FILE

See Also:

• Constant Field Values

PARAM_GAME_OPTIONS_FIXED

static final String PARAM_GAME_OPTIONS_FIXED

See Also:

• Constant Field Values

PARAM_GAME_EXTERNAL_ID

static final String PARAM_GAME_EXTERNAL_ID

See Also:

• Constant Field Values

PARAM_FACTIONS

static final String PARAM_FACTIONS

See Also:

• Constant Field Values

PARAM_SINGLEPLAYER

static final String PARAM_SINGLEPLAYER

See Also:

• Constant Field Values

MMS_PLANET_CONDITIONS

static final String MMS_PLANET_CONDITIONS

See Also:

• Constant Field Values

PARAM_PLANET_CONDITIONS_FIXED

static final String PARAM_PLANET_CONDITIONS_FIXED

See Also:

• Constant Field Values

PARAM_MAP_WIDTH

static final String PARAM_MAP_WIDTH

See Also:

• Constant Field Values

PARAM_MAP_HEIGHT

static final String PARAM_MAP_HEIGHT

See Also:

• Constant Field Values

MAP_RANDOM

static final String MAP_RANDOM

See Also:

• Constant Field Values

PARAM_BOARD_WIDTH

static final String PARAM_BOARD_WIDTH

See Also:

• Constant Field Values

PARAM_BOARD_HEIGHT

static final String PARAM_BOARD_HEIGHT

See Also:

• Constant Field Values

PARAM_BRIDGE_CF

static final String PARAM_BRIDGE_CF

See Also:

• Constant Field Values

PARAM_MAPS

static final String PARAM_MAPS

See Also:

• Constant Field Values

PARAM_MAP_DIRECTORIES

static final String PARAM_MAP_DIRECTORIES

See Also:

• Constant Field Values

PARAM_TEAM

static final String PARAM_TEAM

See Also:

• Constant Field Values

PARAM_LOCATION

static final String PARAM_LOCATION

See Also:

• Constant Field Values

PARAM_MINEFIELDS

static final String PARAM_MINEFIELDS

See Also:

• Constant Field Values

PARAM_DAMAGE

static final String PARAM_DAMAGE

See Also:

• Constant Field Values

PARAM_SPECIFIC_DAMAGE

static final String PARAM_SPECIFIC_DAMAGE

See Also:

• Constant Field Values

PARAM_CRITICAL_HIT

static final String PARAM_CRITICAL_HIT

See Also:

• Constant Field Values

PARAM_AMMO_AMOUNT

static final String PARAM_AMMO_AMOUNT

See Also:

• Constant Field Values

PARAM_AMMO_TYPE

static final String PARAM_AMMO_TYPE

See Also:

• Constant Field Values

PARAM_PILOT_HITS

static final String PARAM_PILOT_HITS

See Also:

• Constant Field Values

PARAM_EXTERNAL_ID

static final String PARAM_EXTERNAL_ID

See Also:

• Constant Field Values

PARAM_ADVANTAGES

static final String PARAM_ADVANTAGES

See Also:

• Constant Field Values

PARAM_AUTO_EJECT

static final String PARAM_AUTO_EJECT

See Also:

• Constant Field Values

PARAM_COMMANDER

static final String PARAM_COMMANDER

See Also:

• Constant Field Values

PARAM_DEPLOYMENT_ROUND

static final String PARAM_DEPLOYMENT_ROUND

See Also:

• Constant Field Values

PARAM_CAMO

static final String PARAM_CAMO

See Also:

• Constant Field Values

PARAM_ALTITUDE

static final String PARAM_ALTITUDE

See Also:

• Constant Field Values

Method Details

getName

String getName()

Returns:

The name (title) of the scenario.

getDescription

String getDescription()

Returns:

The description for the scenario.

getFileName

String getFileName()

getGameType

default GameType getGameType()

getPlanet

default String getPlanet()

createGame

IGame createGame()
          throws ScenarioLoaderException,
IOException

Throws:

ScenarioLoaderException

IOException

isSinglePlayer

boolean isSinglePlayer()

hasFixedGameOptions

boolean hasFixedGameOptions()

hasFixedPlanetaryConditions

boolean hasFixedPlanetaryConditions()

applyDamage

void applyDamage(IGameManager gameManager)

findIndex

default int findIndex(String[] sa,
 String s)

hasBotInfo

default boolean hasBotInfo(String playerName)

getBotInfo

default BotParser.BotInfo getBotInfo(String playerName)