Package megamek.common.board

Class FacingOption

java.lang.Object
megamek.common.board.FacingOption
public class FacingOption extends Object
Represents the valid facings for deploying a multi-hex entity at a specific position and elevation. For facing-dependent entities (like non-symmetrical BuildingEntity), different facings may result in different deployment validity due to secondary hex positions being rotated.

  • Constructor Details

    • FacingOption

      public FacingOption(Coords position, int elevation)
      Creates a new FacingOption for a given position and elevation.
      Parameters:
      position - The board coordinates
      elevation - The elevation/altitude

  • Method Details

    • getPosition

      public Coords getPosition()
      Gets the position for this facing option.
      Returns:
      The board coordinates

    • getElevation

      public int getElevation()
      Gets the elevation for this facing option.
      Returns:
      The elevation/altitude

    • getValidFacings

      public Set<Integer> getValidFacings()
      Gets the set of valid facings (0-5) for deployment at this position and elevation.
      Returns:
      Set of valid facing values

    • addValidFacing

      public void addValidFacing(int facing)
      Adds a valid facing.
      Parameters:
      facing - The facing to add (0-5)

    • isFacingValid

      @Deprecated(since="0.51.0", forRemoval=true) public boolean isFacingValid(int facing)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Checks if a specific facing is valid for deployment.
      Parameters:
      facing - The facing to check (0-5)
      Returns:
      true if this facing allows deployment

    • hasValidFacings

      public boolean hasValidFacings()
      Checks if any facings are valid.
      Returns:
      true if at least one facing is valid

    • getValidFacingCount

      public int getValidFacingCount()
      Gets the number of valid facings.
      Returns:
      Count of valid facings

    • toString

      public String toString()
      Overrides:
      toString in class Object