Package org.dark.graphics.plugins

Class ShipDestructionEffects

java.lang.Object
com.fs.starfarer.api.combat.BaseEveryFrameCombatPlugin
org.dark.graphics.plugins.ShipDestructionEffects
All Implemented Interfaces:
com.fs.starfarer.api.combat.CombatEnginePlugin, com.fs.starfarer.api.combat.EveryFrameCombatPlugin
public class ShipDestructionEffects extends com.fs.starfarer.api.combat.BaseEveryFrameCombatPlugin

  • Constructor Summary

    Constructors
    Constructor
    Description
    ShipDestructionEffects()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    advance(float amount, List<com.fs.starfarer.api.input.InputEventAPI> events)
     
    void
    init(com.fs.starfarer.api.combat.CombatEngineAPI engine)
     
    static void
    suppressEffects(com.fs.starfarer.api.combat.ShipAPI ship, boolean suppress, boolean oneFrame)
    Suppresses (or stops suppressing) all future effects created by this plugin for a particular ShipAPI object.

    Methods inherited from class com.fs.starfarer.api.combat.BaseEveryFrameCombatPlugin

    processInputPreCoreControls, renderInUICoords, renderInWorldCoords

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ShipDestructionEffects

      public ShipDestructionEffects()

  • Method Details

    • advance

      public void advance(float amount, List<com.fs.starfarer.api.input.InputEventAPI> events)
      Specified by:
      advance in interface com.fs.starfarer.api.combat.EveryFrameCombatPlugin
      Overrides:
      advance in class com.fs.starfarer.api.combat.BaseEveryFrameCombatPlugin

    • init

      public void init(com.fs.starfarer.api.combat.CombatEngineAPI engine)
      Specified by:
      init in interface com.fs.starfarer.api.combat.CombatEnginePlugin
      Overrides:
      init in class com.fs.starfarer.api.combat.BaseEveryFrameCombatPlugin

    • suppressEffects

      public static void suppressEffects(com.fs.starfarer.api.combat.ShipAPI ship, boolean suppress, boolean oneFrame)
      Suppresses (or stops suppressing) all future effects created by this plugin for a particular ShipAPI object. Suppression is not (believed to be) inherited by any children of the ShipAPI object (such as split chunks). For example, to prevent a white flash from splitting a ship into a dozen pieces but otherwise allow explosion effects, call splitShip() as many times as necessary, suppressing effects for each individual piece for 1 frame.
      Parameters:
      ship - Ship to suppress effects for.
      suppress - Whether to enable or disable suppression.
      oneFrame - Suppress effects for only one frame, rather than permanently.