Package com.csse3200.game.components.minimap

Class MinimapDisplay

java.lang.Object
com.csse3200.game.components.Component
com.csse3200.game.rendering.RenderComponent
com.csse3200.game.ui.UIComponent
com.csse3200.game.components.minimap.MinimapDisplay
All Implemented Interfaces:
com.badlogic.gdx.utils.Disposable, Renderable, Comparable<Renderable>
public class MinimapDisplay extends UIComponent
A UI component for displaying a minimap.

  • Constructor Details

    • MinimapDisplay

      public MinimapDisplay(float displaySize, MinimapDisplay.MinimapOptions options)
      Creates a new minimap display.
      Parameters:
      displaySize - The size (width and height) of the minimap on the screen.
      options - Options for the minimap shape and position.

  • Method Details

    • addMarker

      public void addMarker(com.badlogic.gdx.scenes.scene2d.ui.Image marker)
      Adds the given marker to the markers group.
      Parameters:
      marker - the marker image to be added to the group.

    • removeMarker

      public void removeMarker(com.badlogic.gdx.scenes.scene2d.ui.Image marker)
      Removes the given marker form the group
      Parameters:
      marker - the marker image to removed.

    • create

      public void create()
      Description copied from class: Component
      Called when the entity is created and registered. Initial logic such as calls to GetComponent should be made here, not in the constructor which is called before an entity is finished.
      Overrides:
      create in class UIComponent

    • update

      public void update()
      Description copied from class: Component
      Called once per frame of the game, and should be used for most component logic. Not called if component is disabled.
      Overrides:
      update in class Component

    • draw

      protected void draw(com.badlogic.gdx.graphics.g2d.SpriteBatch batch)
      Description copied from class: RenderComponent
      Draw the renderable. Should be called only by the renderer, not manually.
      Specified by:
      draw in class RenderComponent
      Parameters:
      batch - Batch to render to.

    • getZIndex

      public float getZIndex()
      Description copied from interface: Renderable
      Z index controls rendering order within a layer. Higher Z index is drawn on top.
      Specified by:
      getZIndex in interface Renderable
      Overrides:
      getZIndex in class UIComponent
      Returns:
      Z index

    • getLayer

      public int getLayer()
      Description copied from interface: Renderable
      Layer to be rendered in. Higher layers will be rendered on top of lower layers.
      Specified by:
      getLayer in interface Renderable
      Overrides:
      getLayer in class UIComponent
      Returns:
      layer

    • dispose

      public void dispose()
      Description copied from class: Component
      Called when the component is disposed. Dispose of any internal resources here.
      Specified by:
      dispose in interface com.badlogic.gdx.utils.Disposable
      Overrides:
      dispose in class RenderComponent

    • setVisible

      public void setVisible(boolean visible)
      Parameters:
      visible - : Set the visibility of minimap display to this value.