Package com.fs.starfarer.api.combat

Interface ShieldAPI

public interface ShieldAPI
Author:
Alex Mosolov Copyright 2012 Fractal Softworks, LLC

  • Method Details

    • setType

      void setType(ShieldAPI.ShieldType type)

    • getType

      ShieldAPI.ShieldType getType()

    • getFacing

      float getFacing()

    • getArc

      float getArc()
      Returns:
      maximum arc.

    • getActiveArc

      float getActiveArc()
      Returns:
      currently open arc (0 if not on)

    • setActiveArc

      void setActiveArc(float activeArc)

    • getRadius

      float getRadius()

    • isOn

      boolean isOn()

    • isOff

      boolean isOff()

    • getLocation

      org.lwjgl.util.vector.Vector2f getLocation()
      Returns:
      location of the center of the shield, in engine coordinates.

    • isWithinArc

      boolean isWithinArc(org.lwjgl.util.vector.Vector2f point)

    • toggleOff

      void toggleOff()

    • getFluxPerPointOfDamage

      float getFluxPerPointOfDamage()
      Does not include shield damage taken mult, but does include absorbption mult.
      Returns:

    • setArc

      void setArc(float arc)
      Set the maximum arc.
      Parameters:
      arc -

    • setInnerColor

      void setInnerColor(Color color)

    • setRingColor

      void setRingColor(Color ringColor)

    • getInnerColor

      Color getInnerColor()

    • getRingColor

      Color getRingColor()

    • getUpkeep

      float getUpkeep()
      Flux/second while shield is on.
      Returns:

    • forceFacing

      void forceFacing(float facing)

    • setRadius

      void setRadius(float radius)

    • setRadius

      void setRadius(float radius, String textureInner, String textureRing)
      Textures should be already loaded (i.e. via settings.json).
      Parameters:
      radius -
      textureInner -
      textureRing -

    • toggleOn

      void toggleOn()

    • getUnfoldTime

      float getUnfoldTime()

    • setCenter

      void setCenter(float x, float y)

    • getInnerRotationRate

      float getInnerRotationRate()
      For shield textures, visual only.
      Returns:

    • setInnerRotationRate

      void setInnerRotationRate(float innerRotationRate)
      For shield textures, visual only.

    • getRingRotationRate

      float getRingRotationRate()
      For shield textures, visual only.
      Returns:

    • setRingRotationRate

      void setRingRotationRate(float ringRotationRate)
      For shield textures, visual only.

    • isSkipRendering

      boolean isSkipRendering()

    • setSkipRendering

      void setSkipRendering(boolean skipRendering)

    • applyShieldEffects

      void applyShieldEffects(Color innerColor, Color ringColor, float thicknessBonus, float fluctuationBonus, float effectLevel)