Package megamek.common.turns

Class TurnOrdered

java.lang.Object

megamek.common.turns.TurnOrdered

All Implemented Interfaces:

Serializable, ITurnOrdered

Direct Known Subclasses:

Entity, Player, Team

public abstract class TurnOrdered
extends Object
implements ITurnOrdered

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
TurnOrdered()

Method Summary

Modifier and Type	Method	Description
void	clearInitiative(boolean bUseInitComp, Map<Team,Integer> initiativeAptitude)	Clear the initiative of this object.
static TurnVectors	generateTurnOrder(List<? extends ITurnOrdered> v, IGame game)	This takes a Vector of TurnOrdered and generates a TurnVector.
int	getAeroTurns()
int	getDropshipTurns()
int	getEvenTurns()
int	getInitCompensationBonus()
InitiativeRoll	getInitiative()
int	getJumpshipTurns()
int	getMultiTurns(IGame game)
int	getNormalTurns(IGame game)	Return the number of "normal" turns that this item requires.
int	getOtherTurns()
int	getSmallCraftTurns()
int	getSpaceStationTurns()
int	getTeleMissileTurns()
int	getWarshipTurns()
void	incrementAeroTurns()
void	incrementDropshipTurns()
void	incrementEvenTurns()
void	incrementJumpshipTurns()
void	incrementMultiTurns(int entityClass)
void	incrementOtherTurns()
void	incrementSmallCraftTurns()
void	incrementSpaceStationTurns()
void	incrementTeleMissileTurns()
void	incrementWarshipTurns()
void	resetAeroTurns()
void	resetDropshipTurns()
void	resetEvenTurns()
static void	resetInitiativeCompensation(List<? extends ITurnOrdered> v, boolean bInitCompBonus)	This takes a vector of TurnOrdered (Teams or Players), and does post initiative phase cleanup of the initiative streak bonus.
void	resetJumpshipTurns()
void	resetMultiTurns()
void	resetOtherTurns()
void	resetSmallCraftTurns()
void	resetSpaceStationTurns()
void	resetTeleMissileTurns()
void	resetWarshipTurns()
static void	rollInitAndResolveTies(List<? extends ITurnOrdered> v, List<? extends ITurnOrdered> rerollRequests, boolean bInitCompBonus)	Deprecated, for removal: This API element is subject to removal in a future version. use rollInitAndResolveTies(List, List, boolean, Map) instead.
static void	rollInitAndResolveTies(List<? extends ITurnOrdered> initiativeCandidates, List<? extends ITurnOrdered> rerollRequests, boolean bInitCompBonus, Map<Team,Integer> initiativeAptitude)	This takes a vector of TurnOrdered (Teams or Players), rolls initiative, and resolves ties.
static void	rollInitiative(List<? extends ITurnOrdered> v, boolean bUseInitiativeCompensation)	Deprecated, for removal: This API element is subject to removal in a future version. use rollInitiative(List, boolean, Map) instead.
static void	rollInitiative(List<? extends ITurnOrdered> initiativeCandidates, boolean bUseInitiativeCompensation, Map<Team,Integer> initiativeAptitude)
void	setInitCompensationBonus(int newBonus)
void	setInitiative(InitiativeRoll newRoll)

Methods inherited from class java.lang.Object

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

Constructor Details

TurnOrdered

public TurnOrdered()

Method Details

getNormalTurns

public int getNormalTurns(IGame game)

Return the number of "normal" turns that this item requires. This is normally the sum of multi-unit turns and the other turns.

Subclasses are expected to override this value in order to make the "move even" code work correctly.

Specified by:

getNormalTurns in interface ITurnOrdered

Returns:

the int number of "normal" turns this item should take in a phase.

getOtherTurns

public int getOtherTurns()

Specified by:

getOtherTurns in interface ITurnOrdered

getEvenTurns

public int getEvenTurns()

Specified by:

getEvenTurns in interface ITurnOrdered

getMultiTurns

public int getMultiTurns(IGame game)

Specified by:

getMultiTurns in interface ITurnOrdered

getSpaceStationTurns

public int getSpaceStationTurns()

Specified by:

getSpaceStationTurns in interface ITurnOrdered

getJumpshipTurns

public int getJumpshipTurns()

Specified by:

getJumpshipTurns in interface ITurnOrdered

getWarshipTurns

public int getWarshipTurns()

Specified by:

getWarshipTurns in interface ITurnOrdered

getDropshipTurns

public int getDropshipTurns()

Specified by:

getDropshipTurns in interface ITurnOrdered

getSmallCraftTurns

public int getSmallCraftTurns()

Specified by:

getSmallCraftTurns in interface ITurnOrdered

getTeleMissileTurns

public int getTeleMissileTurns()

Specified by:

getTeleMissileTurns in interface ITurnOrdered

getAeroTurns

public int getAeroTurns()

Specified by:

getAeroTurns in interface ITurnOrdered

incrementOtherTurns

public void incrementOtherTurns()

Specified by:

incrementOtherTurns in interface ITurnOrdered

incrementEvenTurns

public void incrementEvenTurns()

Specified by:

incrementEvenTurns in interface ITurnOrdered

incrementMultiTurns

public void incrementMultiTurns(int entityClass)

Specified by:

incrementMultiTurns in interface ITurnOrdered

incrementSpaceStationTurns

public void incrementSpaceStationTurns()

Specified by:

incrementSpaceStationTurns in interface ITurnOrdered

incrementJumpshipTurns

public void incrementJumpshipTurns()

Specified by:

incrementJumpshipTurns in interface ITurnOrdered

incrementWarshipTurns

public void incrementWarshipTurns()

Specified by:

incrementWarshipTurns in interface ITurnOrdered

incrementDropshipTurns

public void incrementDropshipTurns()

Specified by:

incrementDropshipTurns in interface ITurnOrdered

incrementSmallCraftTurns

public void incrementSmallCraftTurns()

Specified by:

incrementSmallCraftTurns in interface ITurnOrdered

incrementTeleMissileTurns

public void incrementTeleMissileTurns()

Specified by:

incrementTeleMissileTurns in interface ITurnOrdered

incrementAeroTurns

public void incrementAeroTurns()

Specified by:

incrementAeroTurns in interface ITurnOrdered

resetOtherTurns

public void resetOtherTurns()

Specified by:

resetOtherTurns in interface ITurnOrdered

resetEvenTurns

public void resetEvenTurns()

Specified by:

resetEvenTurns in interface ITurnOrdered

resetMultiTurns

public void resetMultiTurns()

Specified by:

resetMultiTurns in interface ITurnOrdered

resetSpaceStationTurns

public void resetSpaceStationTurns()

Specified by:

resetSpaceStationTurns in interface ITurnOrdered

resetJumpshipTurns

public void resetJumpshipTurns()

Specified by:

resetJumpshipTurns in interface ITurnOrdered

resetWarshipTurns

public void resetWarshipTurns()

Specified by:

resetWarshipTurns in interface ITurnOrdered

resetDropshipTurns

public void resetDropshipTurns()

Specified by:

resetDropshipTurns in interface ITurnOrdered

resetSmallCraftTurns

public void resetSmallCraftTurns()

Specified by:

resetSmallCraftTurns in interface ITurnOrdered

resetTeleMissileTurns

public void resetTeleMissileTurns()

Specified by:

resetTeleMissileTurns in interface ITurnOrdered

resetAeroTurns

public void resetAeroTurns()

Specified by:

resetAeroTurns in interface ITurnOrdered

getInitiative

public InitiativeRoll getInitiative()

Specified by:

getInitiative in interface ITurnOrdered

setInitiative

public void setInitiative(InitiativeRoll newRoll)

Specified by:

setInitiative in interface ITurnOrdered

clearInitiative

public void clearInitiative(boolean bUseInitComp,
 Map<Team,Integer> initiativeAptitude)

Clear the initiative of this object.

Specified by:

clearInitiative in interface ITurnOrdered

rollInitiative

@Deprecated(since="0.50.5",
            forRemoval=true)
public static void rollInitiative(List<? extends ITurnOrdered> v,
 boolean bUseInitiativeCompensation)

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

use rollInitiative(List, boolean, Map) instead.

rollInitiative

public static void rollInitiative(List<? extends ITurnOrdered> initiativeCandidates,
 boolean bUseInitiativeCompensation,
 Map<Team,Integer> initiativeAptitude)

resetInitiativeCompensation

public static void resetInitiativeCompensation(List<? extends ITurnOrdered> v,
 boolean bInitCompBonus)

This takes a vector of TurnOrdered (Teams or Players), and does post initiative phase cleanup of the initiative streak bonus.

Parameters:

v - A vector of items that need to have turns.

bInitCompBonus - A flag that determines whether initiative compensation bonus should be used: used to prevent one side getting long init win streaks

rollInitAndResolveTies

@Deprecated(since="0.50.5",
            forRemoval=true)
public static void rollInitAndResolveTies(List<? extends ITurnOrdered> v,
 List<? extends ITurnOrdered> rerollRequests,
 boolean bInitCompBonus)

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

use rollInitAndResolveTies(List, List, boolean, Map) instead.

rollInitAndResolveTies

public static void rollInitAndResolveTies(List<? extends ITurnOrdered> initiativeCandidates,
 List<? extends ITurnOrdered> rerollRequests,
 boolean bInitCompBonus,
 Map<Team,Integer> initiativeAptitude)

This takes a vector of TurnOrdered (Teams or Players), rolls initiative, and resolves ties. The second argument is used when a specific teams initiative should be re-rolled.

Parameters:

initiativeCandidates - A vector of items that need to have turns.

rerollRequests - null when there should be no re-rolls

bInitCompBonus - A flag that determines whether initiative compensation bonus should be used: used to prevent one side getting long init win streaks

generateTurnOrder

public static TurnVectors generateTurnOrder(List<? extends ITurnOrdered> v,
 IGame game)

This takes a Vector of TurnOrdered and generates a TurnVector.

getInitCompensationBonus

public int getInitCompensationBonus()

Specified by:

getInitCompensationBonus in interface ITurnOrdered

setInitCompensationBonus

public void setInitCompensationBonus(int newBonus)

Specified by:

setInitCompensationBonus in interface ITurnOrdered