Package megamek.common.strategicBattleSystems

Class SurfaceSBFMoveStep

java.lang.Object

megamek.common.strategicBattleSystems.SBFMoveStep

megamek.common.strategicBattleSystems.SurfaceSBFMoveStep

All Implemented Interfaces:

Serializable

public class SurfaceSBFMoveStep
extends SBFMoveStep

This is an SBF move step that happens on the surface of a hex, i.e. on the ground or, if the destination has water, on the water surface. This means that the elevation at start and end is considered to be 0.

See Also:

• Serialized Form

Field Summary

Fields inherited from class megamek.common.strategicBattleSystems.SBFMoveStep

destination, formationId, isIllegal, mpUsed, startingPoint

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SurfaceSBFMoveStep(int formationId)

Method Summary

Modifier and Type	Method	Description
protected void	compile(SBFGame game)	Assembles and computes all data for this step.
SBFMoveStep	copy()
static SBFMoveStep	createSurfaceMoveStep(SBFGame game, int formationId, BoardLocation startingPoint, int direction)	Deprecated, for removal: This API element is subject to removal in a future version.
static SBFMoveStep	createSurfaceMoveStep(SBFGame game, int formationId, BoardLocation startingPoint, BoardLocation destination)
int	getMovementDirection()
String	toString()

Methods inherited from class megamek.common.strategicBattleSystems.SBFMoveStep

getDestination, getLastPosition, getMpUsed, isIllegal

Methods inherited from class java.lang.Object

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

Constructor Details

SurfaceSBFMoveStep

protected SurfaceSBFMoveStep(int formationId)

Method Details

createSurfaceMoveStep

public static SBFMoveStep createSurfaceMoveStep(SBFGame game,
 int formationId,
 BoardLocation startingPoint,
 BoardLocation destination)

createSurfaceMoveStep

@Deprecated(since="0.51.0",
            forRemoval=true)
public static SBFMoveStep createSurfaceMoveStep(SBFGame game,
 int formationId,
 BoardLocation startingPoint,
 int direction)

Deprecated, for removal: This API element is subject to removal in a future version.

compile

protected void compile(SBFGame game)

Description copied from class: SBFMoveStep

Assembles and computes all data for this step. Tests if the start and end are on the same board and actually on that board and if the step distance is more than one. Override to provide more tests.

Overrides:

compile in class SBFMoveStep

Parameters:

game - The game

copy

public SBFMoveStep copy()

Specified by:

copy in class SBFMoveStep

Returns:

An exact copy of this move step.

toString

public String toString()

Overrides:

toString in class Object

getMovementDirection

public int getMovementDirection()

Overrides:

getMovementDirection in class SBFMoveStep