Package net.risingworld.api.objects.visuals

Class Saturation

java.lang.Object
net.risingworld.api.objects.visuals.Saturation
public final class Saturation extends Object
Post-processing effect: Screen color saturation adjustment. Used in conjunction with a PostProcessing object.

Image
Saturation set to -100 to turn the screen into a grayscale image

  • Constructor Summary

    Constructors
    Constructor
    Description
    Saturation()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    isOverridden()
    Determines if the effect is set.
    void
    reset()
    Resets the effect, so it is no longer active (and no longer overrides any game effects).
    void
    set(float value)
    Sets the saturation of the screen (between -100 and +100).

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Saturation

      public Saturation()

  • Method Details

    • set

      public void set(float value)
      Sets the saturation of the screen (between -100 and +100). To reset the value to the game default value, call reset()
      Parameters:
      value - a saturation value between -100 and +100

    • reset

      public void reset()
      Resets the effect, so it is no longer active (and no longer overrides any game effects).

    • isOverridden

      public boolean isOverridden()
      Determines if the effect is set.
      Returns:
      true if this effect was set, false if not (or if it was reset).