Package com.csse3200.game.cutscene.runtime.states

Class AdvanceSignalState

java.lang.Object
com.csse3200.game.cutscene.runtime.states.AdvanceSignalState
All Implemented Interfaces:
ActionState
public class AdvanceSignalState extends Object implements ActionState
Advance signal state.

  • Constructor Summary

    Constructors
    Constructor
    Description
    AdvanceSignalState(String key)
    Creates an advance signal state with a specified key

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    blocking()
    Checks if the action is blocking till completion (false if async)
    boolean
    done()
    Checks if the action is completed (can be disposed of)
    void
    signal(String signalKey)
    Signals the action to advance
    void
    tick(int dtMs)
    Runs on every game tick to progress logic

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • AdvanceSignalState

      public AdvanceSignalState(String key)
      Creates an advance signal state with a specified key
      Parameters:
      key - The key to activate the signal

  • Method Details

    • tick

      public void tick(int dtMs)
      Runs on every game tick to progress logic
      Specified by:
      tick in interface ActionState
      Parameters:
      dtMs - The delta time in milliseconds

    • blocking

      public boolean blocking()
      Checks if the action is blocking till completion (false if async)
      Specified by:
      blocking in interface ActionState
      Returns:
      True if the action is blocking till completion (false if async)

    • done

      public boolean done()
      Checks if the action is completed (can be disposed of)
      Specified by:
      done in interface ActionState
      Returns:
      True if the action is completed (can be disposed of)

    • signal

      public void signal(String signalKey)
      Signals the action to advance
      Parameters:
      signalKey - The key to activate the signal