Interface CutsceneOrchestrator

All Known Implementing Classes:
DefaultOrchestrator

public interface CutsceneOrchestrator
Responsible for managing the state of a cutscene.
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    Key or click to advance
    void
    Selects a choice (from choice events)
    boolean
    Returns the running state of the orchestrator (to dispose)
    void
    load(Cutscene cutscene)
    Loads a cutscene from a Cutscene object
    boolean
    Check if the orchestrator is running
    void
    setPause(boolean pause)
    Set the pause state of the orchestrator
    Get the current state of the orchestrator
    void
    Permanently stops execution, required load to restart cutscene
    void
    update(float dt)
    Updates the state of the cutscene by delta time (dt)
  • Method Details

    • load

      void load(Cutscene cutscene)
      Loads a cutscene from a Cutscene object
      Parameters:
      cutscene - The cutscene to load
    • update

      void update(float dt)
      Updates the state of the cutscene by delta time (dt)
      Parameters:
      dt - Delta time between game frames
    • advance

      void advance()
      Key or click to advance
    • choose

      void choose(String id)
      Selects a choice (from choice events)
      Parameters:
      id - The id of the choice made
    • state

      Get the current state of the orchestrator
      Returns:
      The current state of the orchestrator
    • paused

      boolean paused()
      Check if the orchestrator is running
      Returns:
      true if paused, false if running
    • isRuning

      boolean isRuning()
      Returns the running state of the orchestrator (to dispose)
      Returns:
      true if running, false otherwise
    • setPause

      void setPause(boolean pause)
      Set the pause state of the orchestrator
      Parameters:
      pause - True to pause execution, false to continue execution
    • stop

      void stop()
      Permanently stops execution, required load to restart cutscene