Package 

Class CheatPlugin

  • All Implemented Interfaces:

    
    public abstract class CheatPlugin
    
                        
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
    • Field Summary

      Fields 
      Modifier and Type Field Description
    • Constructor Summary

      Constructors 
      Constructor Description
      CheatPlugin()
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
    • Method Summary

      Modifier and Type Method Description
      Unit advance(Float amount, List<InputEventAPI> events) Called once per frame while the command is active, before advance is called on applicable ships.
      Unit advance(ShipAPI ship, Float amount) Called once per applicable ship per frame while the command is active.
      Unit unapply(ShipAPI ship) Called when cheat is toggled off.
      Unit onStart(CombatEngineAPI engine) Called when cheat is toggled on, before advance is called on any ships.
      Unit onEnd(CombatEngineAPI engine) Only called when cheat is toggled off, after unapply is called on all ships.
      abstract Boolean runWhilePaused() Whether the advance methods should be called while the game is paused.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • CheatPlugin

        CheatPlugin()
    • Method Detail

      • advance

         Unit advance(Float amount, List<InputEventAPI> events)

        Called once per frame while the command is active, before advance is called on applicable ships.

      • advance

         Unit advance(ShipAPI ship, Float amount)

        Called once per applicable ship per frame while the command is active.

      • unapply

         Unit unapply(ShipAPI ship)

        Called when cheat is toggled off. Do not rely on this being called!

      • onStart

         Unit onStart(CombatEngineAPI engine)

        Called when cheat is toggled on, before advance is called on any ships.

      • onEnd

         Unit onEnd(CombatEngineAPI engine)

        Only called when cheat is toggled off, after unapply is called on all ships. Do not rely on this being called!