Package megamek.common.units

Class UnitNumberTurn

java.lang.Object

megamek.common.game.AbstractPlayerTurn

megamek.common.game.GameTurn

megamek.common.units.UnitNumberTurn

All Implemented Interfaces:

Serializable, PlayerTurn

public class UnitNumberTurn
extends GameTurn

A type of game turn that allows only entities belonging to certain units to move.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
UnitNumberTurn(int playerId, short unit)	Only allow entities for the given player which have types in the class mask to move.

Method Summary

Modifier and Type	Method	Description
boolean	isValidEntity(Entity entity, Game game, boolean useValidNonInfantryCheck)	Determine if the specified entity is a valid one to use for this turn.

Methods inherited from class megamek.common.game.GameTurn

isMultiTurn, isValid, isValidEntity, isValidEntity, setMultiTurn

Methods inherited from class megamek.common.game.AbstractPlayerTurn

playerId, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface megamek.common.interfaces.PlayerTurn

isValid, isValid

Constructor Details

UnitNumberTurn

public UnitNumberTurn(int playerId,
 short unit)

Only allow entities for the given player which have types in the class mask to move.

Parameters:

playerId - the int ID of the player

unit - the int unit number of the entities allowed to move.

Method Details

isValidEntity

public boolean isValidEntity(Entity entity,
 Game game,
 boolean useValidNonInfantryCheck)

Description copied from class: GameTurn

Determine if the specified entity is a valid one to use for this turn.

In addition to the "standard" validity checks, there is also a check for the optional rules "infantry move later" and "ProtoMeks move later." This checks to see if those options are enabled and if there is a valid non-infantry (or proto) unit to move and if so, the entity is invalid.

There are certain instances where this check should not be used when the optional rules are enabled (such as loading infantry into a unit). Hence, the use of these additional checks is specified by a boolean input parameter.

Overrides:

isValidEntity in class GameTurn

Parameters:

entity - the Entity that may take this turn.

game - The Game the turn belongs to

useValidNonInfantryCheck - Boolean that determines if we should check to see if infantry can be moved yet

Returns:

true if the specified entity is a valid one to use for this turn.