Constructor Detail

• OptionsTab

  public OptionsTab()

Method Detail

• getCanvasMode

  public static OptionsTab.CanvasMode getCanvasMode()

  Also known as the type of game client layout.

  Returns:

  The current CanvasMode

• setCanvasMode

  public static boolean setCanvasMode​(OptionsTab.CanvasMode mode)

  Returns:

  Whether the CanvasMode was set.

• isAcceptingAid

  public static boolean isAcceptingAid()

• setAcceptingAid

  public static boolean setAcceptingAid​(boolean accept)

• areRoofsAlwaysHidden

  @Deprecated
  public static boolean areRoofsAlwaysHidden()

  Deprecated.

  This method has been replaced Use OptionsTab.AllSettings.ALWAYS_HIDE_ROOFS instead.

• toggleAlwaysHideRoofs

  @Deprecated
  public static boolean toggleAlwaysHideRoofs()

  Deprecated.

  This method has been replaced Use OptionsTab.AllSettings.ALWAYS_HIDE_ROOFS instead.

• setAlwaysHideRoofs

  @Deprecated
  public static boolean setAlwaysHideRoofs​(boolean enable)

  Deprecated.

  This method has been replaced

  Use OptionsTab.AllSettings.ALWAYS_HIDE_ROOFS instead.

  Toggles the option to always hide roofs. Attempts to open the advanced menu options if they are not visible already

  Parameters:

  enable - the target state of the option

  Returns:

  true if the option is already in the target state (enable), or if the option has been toggled successfully

• openAdvancedOptionsMenu

  public static boolean openAdvancedOptionsMenu()

  Opens the advanced options menu

  Returns:

  true if the menu is already open or the menu has been opened successfully

• closeAdvancedOptionsMenu

  public static boolean closeAdvancedOptionsMenu()

  Closes the advanced options menu

  Returns:

  true if the menu is not open or the menu has been closed successfully

• isAdvancedOptionsMenuOpen

  public static boolean isAdvancedOptionsMenuOpen()

  Returns:

  true if the InterfaceContainer of the advanced options menu is loaded

• getOpenedMenu

  @Nullable
  public static @Nullable OptionsTab.Menu getOpenedMenu()

  Returns:

  the currently opened Tab

• isUsingSidePanels

  public static boolean isUsingSidePanels()

• areSidePanelsClosableByHotkeys

  public static boolean areSidePanelsClosableByHotkeys()

• isAcceptAidEnabled

  public static boolean isAcceptAidEnabled()

• isShiftDroppingEnabled

  @Deprecated
  public static boolean isShiftDroppingEnabled()

  Deprecated.

  This method has been replaced Use OptionsTab.AllSettings.SHIFT_DROPPING instead.

  Returns:

  true if the option to enable shift click dropping is enabled

• setShiftDropping

  @Deprecated
  public static boolean setShiftDropping​(boolean enable)

  Deprecated.

  This method has been replaced Use OptionsTab.AllSettings.SHIFT_DROPPING instead.
  Toggles the option to enable shift click dropping

  Parameters:

  enable - the target state of the option

  Returns:

  true if the option is already in the target state (enable), or the option has been toggled successfully

• toggleShiftDropping

  @Deprecated
  public static boolean toggleShiftDropping()

  Deprecated.

  This method has been replaced Use OptionsTab.AllSettings.SHIFT_DROPPING instead.
  Changes the state of the shift click dropping option to the opposite of the current state

  Returns:

  true if the option has been toggled successfully

• getDropWarningValue

  public static int getDropWarningValue()

• areInterfacesCloseableWithEsc

  @Deprecated
  public static boolean areInterfacesCloseableWithEsc()

  Deprecated.

  This method has been replaced. Use OptionsTab.AllSettings.INTERFACES_CLOSABLE_WITH_ESCAPE instead.

• setNpcAttackOption

  public static boolean setNpcAttackOption​(OptionsTab.AttackOption attackOption)

  Changes the NPC 'Attack' Option that is selected in the opens menu

  Parameters:

  attackOption - The NPC 'Attack' Option you would like to be selected

  Returns:

  true if the option is already in the target state (enable), or the option has been set successfully

• setPlayerAttackOption

  public static boolean setPlayerAttackOption​(OptionsTab.AttackOption attackOption)

  Changes the Player 'Attack' Option that is selected in the options menu

  Parameters:

  attackOption - The Player 'Attack' Option you would like to be selected

  Returns:

  true if the option is already in the target state (enable), or the option has been set successfully

• getNpcAttackOption

  public static OptionsTab.AttackOption getNpcAttackOption()

• getPlayerAttackOption

  public static OptionsTab.AttackOption getPlayerAttackOption()