Interface IHonorUtil

All Known Implementing Classes:
HonorUtil

public interface IHonorUtil
Since:
9/5/14 2:48 PM
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    checkEnemyBroken(Targetable target, boolean forcedWithdrawal)
    Checks the given Targetable to see if it should be counted as broken:
    Forced Withdrawal is turned on
    Given unit is Crippled
     
    boolean
     
    boolean
    isEnemyBroken(int targetId, int playerId, boolean forcedWithdrawal)
    Indicates whether the identified unit can be considered broken.
    boolean
    isEnemyDishonored(int playerId)
    Indicates whether the identified player is on the dishonored enemies list.
    void
    setEnemyDishonored(int playerId)
    Adds the identified player to the dishonored enemies list.
  • Method Details

    • isEnemyBroken

      boolean isEnemyBroken(int targetId, int playerId, boolean forcedWithdrawal)
      Indicates whether the identified unit can be considered broken.
      Parameters:
      targetId - The target to be checked.
      playerId - The ID of the player owning the target.
      Returns:
      TRUE if the unit is on the broken units list without being on the honor less enemies list.
    • isEnemyDishonored

      boolean isEnemyDishonored(int playerId)
      Indicates whether the identified player is on the dishonored enemies list.
      Parameters:
      playerId - The ID of the player to be checked.
      Returns:
      TRUE if the player is on the dishonored enemies list.
    • setEnemyDishonored

      void setEnemyDishonored(int playerId)
      Adds the identified player to the dishonored enemies list.
      Parameters:
      playerId - The ID of the player to be added.
    • checkEnemyBroken

      void checkEnemyBroken(Targetable target, boolean forcedWithdrawal)
      Checks the given Targetable to see if it should be counted as broken:
      Forced Withdrawal is turned on
      Given unit is Crippled
      Parameters:
      target - The unit to be checked.
      forcedWithdrawal - Set TRUE if the Forced Withdrawal rule is in effect.
    • getDishonoredEnemies

      Set<Integer> getDishonoredEnemies()
    • iAmAPirate

      boolean iAmAPirate()