Package megamek.common.strategicBattleSystems

Interface SBFRuleOptionsUser

All Known Implementing Classes:
SBFGame, SBFGameManager, SBFVisibilityHelper
public interface SBFRuleOptionsUser
This interface is implemented by objects that regularly need to check the rules options used in an SBF game. It is meant as a convenience and provides methods to easily check which rules are in effect.

  • Method Summary

    Modifier and Type
    Method
    Description
    SBFRuleOptions
    getOptions()
    This method must be implemented to provide access to the SBF options used in the present game so that the convenience methods of this interface work correctly.
    default boolean
    usesAdjustingFormations()
    Deprecated, for removal: This API element is subject to removal in a future version.
    default boolean
    usesAdvancedInitiative()
    Deprecated, for removal: This API element is subject to removal in a future version.
    default boolean
    usesBattlefieldInt()
    Deprecated, for removal: This API element is subject to removal in a future version.
    default boolean
    usesDoubleBlind()
     
    default boolean
    usesSprintingMove()
     
    default boolean
    usesTeamVision()
     

  • Method Details

    • getOptions

      SBFRuleOptions getOptions()
      This method must be implemented to provide access to the SBF options used in the present game so that the convenience methods of this interface work correctly.
      Returns:
      the SBFRuleOptions used by the present SBF game

    • usesDoubleBlind

      default boolean usesDoubleBlind()
      Returns:
      True when this game uses Detection and Reconnaissance, IO:BF p.195 aka double-blind.

    • usesAdvancedInitiative

      @Deprecated(since="0.51.0", forRemoval=true) default boolean usesAdvancedInitiative()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns:
      True when this game uses Advanced Initiative, IO:BF p.194.

    • usesBattlefieldInt

      @Deprecated(since="0.51.0", forRemoval=true) default boolean usesBattlefieldInt()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns:
      True when this game uses Battlefield Intelligence, IO:BF p.206.

    • usesAdjustingFormations

      @Deprecated(since="0.51.0", forRemoval=true) default boolean usesAdjustingFormations()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns:
      True when this game allows adjusting formations, IO:BF p.198.

    • usesSprintingMove

      default boolean usesSprintingMove()
      Returns:
      True when this game allows Sprinting movement, IO:BF p.199.

    • usesTeamVision

      default boolean usesTeamVision()
      Returns:
      True when in this game, players on a team share their vision. This has no effect unless the game also uses Detection and Reconnaissance.
      See Also: