Package com.csse3200.game.services

Class GameStateInteraction

java.lang.Object
com.csse3200.game.services.GameStateInteraction
public class GameStateInteraction extends Object
A utility interaction class to manage and modify game state

  • Constructor Details

    • GameStateInteraction

      public GameStateInteraction()
      Constructs a GameStateInteraction instance. Initialises a GameState.

    • GameStateInteraction

      public GameStateInteraction(GameState gameState)
      Constructs a GameStateInteraction instance. Manages the given GameState.
      Parameters:
      gameState - The chosen GameState to modify and manage.

  • Method Details

    • put

      public void put(String key, Object value)
      Updates or adds the given key-value pair in the game state data.
      Parameters:
      key - The key to associate the value with.
      value - The corresponding value to save to the key.

    • get

      public Object get(String key)
      Returns the value stored at the give key in the game state.
      Parameters:
      key - The key from which the value should be retrieved from.
      Returns:
      The value stored at the given key, or null if key found.

    • clear

      public void clear()
      Clears the game state data.

    • getStateData

      public Map<String,Object> getStateData()
      Returns a copy of the current entire game state data.
      Returns:
      A map of game state data at the current moment.

    • updateResource

      public void updateResource(String resourceName, int changeAmount)
      Increases the specified resource name by a given amount. Retrieves the current amount stored and adds the given amount. Note: the game state key is "resource/{resourceName}" not just the resource's name.
      Parameters:
      resourceName - The name of the resource to be saved.
      changeAmount - The amount the resource should increase by.

    • updateMaxResources

      public void updateMaxResources(String resourceName, int amount)
      Sets the maximum amount of a resource Note: the game state key is "resourceMax/{resourceName}" not just the resource's name.
      Parameters:
      resourceName - The name of the resource produced by the extractor.
      amount - The amount to cap the resource by

    • updateExtractors

      public void updateExtractors(String resourceName, int changeAmount)
      Increases the specified extractor count by a given amount. Retrieves the current amount stored and adds the given amount. Note: the game state key is "extractors/{resourceName}" not just the resource's name.
      Parameters:
      resourceName - The name of the resource produced by the extractor.
      changeAmount - The amount the count should change by.

    • updateMaxExtractors

      public void updateMaxExtractors(String resourceName, int amount)
      Sets the maximum amount of extractors for a resource
      Parameters:
      resourceName - The name of the resource produced by the extractor.
      amount - The amount to set the max to

    • updateTotalExtractors

      public void updateTotalExtractors(String resourceName, int amount)
      Sets the total amount of tracked extractors of the resource name to amount
      Parameters:
      resourceName - The name of the resource produced by the extractor/s
      amount - The amount of extractors producing the resource