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

Class PlacementTool

java.lang.Object
com.csse3200.game.components.structures.tools.Tool
com.csse3200.game.components.structures.tools.PlacementTool
Direct Known Subclasses:
BasicWallTool, GateTool, IntermediateWallTool, ReplacementTool, TurretTool
public abstract class PlacementTool extends Tool
An abstract tool which allows the player to place a structure. This class must be inherited and the createEntity method implemented to function.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected int
    snapX
     
    protected int
    snapY
     

    Fields inherited from class com.csse3200.game.components.structures.tools.Tool

    cost

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    PlacementTool(com.badlogic.gdx.utils.ObjectMap<String,Integer> cost)
    Creates a new tool which allows the placing of structures with the given cost.

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract PlaceableEntity
    createStructure(Entity player)
    Creates the structure to be placed.
    com.badlogic.gdx.math.GridPoint2
    getSnapPosition(com.badlogic.gdx.math.GridPoint2 position)
     
    boolean
    hasEnoughResources()
    Checks whether the player has sufficient resources to place the structure.
    boolean
    interact(Entity player, com.badlogic.gdx.math.GridPoint2 position)
    Attempts to place a structure at the specified position.
    boolean
    isPositionValid(com.badlogic.gdx.math.GridPoint2 position, PlaceableEntity structure)
    Checks whether the structure can be placed at the given position.

    Methods inherited from class com.csse3200.game.components.structures.tools.Tool

    getCost

    Methods inherited from class java.lang.Object

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

  • Field Details

    • snapX

      protected int snapX

    • snapY

      protected int snapY

  • Constructor Details

    • PlacementTool

      protected PlacementTool(com.badlogic.gdx.utils.ObjectMap<String,Integer> cost)
      Creates a new tool which allows the placing of structures with the given cost.
      Parameters:
      cost - - the cost of the entity being placed.

  • Method Details

    • interact

      public boolean interact(Entity player, com.badlogic.gdx.math.GridPoint2 position)
      Attempts to place a structure at the specified position. If the position is already occupied or the player has insufficient resources, does nothing.
      Specified by:
      interact in class Tool
      Parameters:
      player - - the player interacting with the tool.
      position - - the position to place the structure.
      Returns:
      whether the structure was successfully placed.

    • getSnapPosition

      public com.badlogic.gdx.math.GridPoint2 getSnapPosition(com.badlogic.gdx.math.GridPoint2 position)

    • createStructure

      public abstract PlaceableEntity createStructure(Entity player)
      Creates the structure to be placed. This must be implemented in subclasses to function.
      Parameters:
      player - - the player placing the structure.
      Returns:
      the structure to be placed.

    • isPositionValid

      public boolean isPositionValid(com.badlogic.gdx.math.GridPoint2 position, PlaceableEntity structure)
      Checks whether the structure can be placed at the given position. By default, checks if the grid position is empty.
      Parameters:
      position - - the position the structure is trying to be placed at.
      Returns:
      whether the structure can be placed at the given position.

    • hasEnoughResources

      public boolean hasEnoughResources()
      Checks whether the player has sufficient resources to place the structure.
      Returns:
      whether the player has sufficient resources to place the structure.