Package ca.cgjennings.apps.arkham.plugins.engine

Class SettingBindings.LiveSetting

  • Enclosing class:
    SettingBindings
    public final class SettingBindings.LiveSetting
extends java.lang.Object
    A live setting is returned when the script uses $$-notation—two dollar signs instead of one—when reading a setting value in a script. Live settings include getters for standard data types. A live setting can also be stored and reused; it will always reflect the current value of the encapsulated setting.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean getBoolean()
      Returns the current value of the setting as a boolean value.
      Settings.Colour getColor()
      Returns the current value of the setting as a Colour.
      Settings.Colour getColour()
      Returns the current value of the setting as a Colour.
      PageShape.CupShape getCupShape()
      Returns the current value of the setting as a CupShape.
      int getInteger()
      Returns the current value of the setting as an integer.
      java.lang.String getKey()
      Returns the key name of the setting.
      double getNumber()
      Returns the current value of the setting as a double value.
      java.awt.Rectangle getRegion()
      Returns the current value of the setting as an integer region.
      java.awt.geom.Rectangle2D.Double getRegion2D()
      Returns the current value of the setting as a Region2D, a region with floating point precision.
      Settings getSettings()
      Returns the Settings instance that the live setting was created from.
      java.lang.String getString()
      Returns the current value of the setting as a string.
      int getTextAlignment()
      Returns the current value of the setting as a text alignment value.
      TextStyle getTextStyle()
      Returns the current value of the setting as a text style.
      float[] getTint()
      Returns the current value of the setting as an tint value stored as an array of three floating point values in hue, saturation, brightness order.
      java.lang.String getValue()
      Returns the current value of the setting.
      boolean getYesNo()
      Returns the current value of the setting as a boolean value.
      java.lang.String toString()
      Returns a string representation of this live setting.

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • getSettings

        public Settings getSettings()
        Returns the Settings instance that the live setting was created from.
        Returns:
        the settings instance that the setting value is looked up in

      • getKey

        public java.lang.String getKey()
        Returns the key name of the setting.
        Returns:
        the key

      • getValue

        public java.lang.String getValue()
        Returns the current value of the setting.
        Returns:
        the current setting value
        See Also:
        Settings.get(java.lang.String)

      • getString

        public java.lang.String getString()
        Returns the current value of the setting as a string. This is equivalent to getValue().
        Returns:
        the current setting value
        See Also:
        Settings.get(java.lang.String)

      • getInteger

        public int getInteger()
        Returns the current value of the setting as an integer.
        Returns:
        the current setting value as an integer
        See Also:
        Settings.getInt(java.lang.String)

      • getNumber

        public double getNumber()
        Returns the current value of the setting as a double value.
        Returns:
        the current setting value as a double
        See Also:
        Settings.getDouble(java.lang.String)

      • getRegion

        public java.awt.Rectangle getRegion()
        Returns the current value of the setting as an integer region.
        Returns:
        the current setting value as a region
        See Also:
        Settings.getRegion(java.lang.String)

      • getRegion2D

        public java.awt.geom.Rectangle2D.Double getRegion2D()
        Returns the current value of the setting as a Region2D, a region with floating point precision.
        Returns:
        the current setting value as a region
        See Also:
        Settings.getRegion2D(java.lang.String)

      • getTint

        public float[] getTint()
        Returns the current value of the setting as an tint value stored as an array of three floating point values in hue, saturation, brightness order.
        Returns:
        the current setting value as a tint value
        See Also:
        Settings.getTint(java.lang.String)

      • getTextAlignment

        public int getTextAlignment()
        Returns the current value of the setting as a text alignment value.
        Returns:
        the current setting value as a text alignment
        See Also:
        Settings.getTextAlignment(java.lang.String)

      • toString

        public java.lang.String toString()
        Returns a string representation of this live setting.
        Overrides:
        toString in class java.lang.Object
        Returns:
        a string describing the setting and its current value