Package com.csse3200.game.components.structures.tools

Class Tool

java.lang.Object
com.csse3200.game.components.structures.tools.Tool
Direct Known Subclasses:
Healing, PlacementTool
public abstract class Tool extends Object
A tool which can be selected via the StructureToolPicker and can be interacted with by the player. This class must be inherited and interact implemented to function.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected final com.badlogic.gdx.utils.ObjectMap<String,Integer>
    cost
    The cost associated with the tool.

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    Tool(com.badlogic.gdx.utils.ObjectMap<String,Integer> cost)
    Creates a new Tool with the given cost.

  • Method Summary

    Modifier and Type
    Method
    Description
    com.badlogic.gdx.utils.ObjectMap<String,Integer>
    getCost()
    Gets the cost associated with the tool.
    abstract boolean
    interact(Entity player, com.badlogic.gdx.math.GridPoint2 position)
    Interacts with the given position in the structure grid.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • cost

      protected final com.badlogic.gdx.utils.ObjectMap<String,Integer> cost
      The cost associated with the tool.

  • Constructor Details

    • Tool

      protected Tool(com.badlogic.gdx.utils.ObjectMap<String,Integer> cost)
      Creates a new Tool with the given cost.
      Parameters:
      cost - - the cost of using the tool.

  • Method Details

    • interact

      public abstract boolean interact(Entity player, com.badlogic.gdx.math.GridPoint2 position)
      Interacts with the given position in the structure grid.
      Parameters:
      player - - the player interacting with the tool.
      position - - the position being interacted with.
      Returns:
      whether the tool was successfully interacted with.

    • getCost

      public com.badlogic.gdx.utils.ObjectMap<String,Integer> getCost()
      Gets the cost associated with the tool.
      Returns:
      the associated cost.