Package com.mg105.user_interface

Interface Toggleable

All Known Implementing Classes:
BattleMenu, InventoryDisplay, LoseMenu, MainMenu, MapDrawer, MinimapDrawer, TutorialTextWindow, WalkingMenu, WinMenu
public interface Toggleable
A user interface component that can be toggled on or off depending on its visibility.

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull javafx.scene.Scene
    getScene()
    Get the scene of this toggleable object.
    void
    toggle(boolean isVisible)
    Set the visibility of this component.

  • Method Details

    • getScene

      @NotNull @NotNull javafx.scene.Scene getScene()
      Get the scene of this toggleable object. It is this scene that will be displayed.
      Returns:
      the scene to be displayed.

    • toggle

      void toggle(boolean isVisible)
      Set the visibility of this component.
      Parameters:
      isVisible - true if the Toggleable is now visible, false otherwise. If false the Toggleable is expected to do nothing on ANY user inputs.