Package arc.flabel

Class FConfig

java.lang.Object
arc.flabel.FConfig
public class FConfig extends Object
Configuration class that easily allows the user to fine tune the library's functionality.

  • Field Details

    • forceColorMarkupByDefault

      public static boolean forceColorMarkupByDefault
      Whether or not LibGDX's Color Markup Language should be enabled when parsing a FLabel. Note that this library doesn't truly handle colors, but simply convert them to the markup format. If markup is disabled, color tokens will be ignored.

    • defaultWaitValue

      public static float defaultWaitValue
      Default time in seconds that an empty WAIT token should wait for. Default value is 0.250.

    • defaultSpeedPerChar

      public static float defaultSpeedPerChar
      Time in seconds that takes for each char to appear in the default speed. Default value is 0.035.

    • charLimitPerFrame

      public static int charLimitPerFrame
      Defines how many chars can appear per frame. Use a value less than 1 to disable this limit. Default value is -1.

    • defaultClearColor

      public static Color defaultClearColor
      Default color for the CLEARCOLOR token. Can be overriden by FLabel.getClearColor().

    • intervalMultipliersByChar

      public static ObjectFloatMap<Character> intervalMultipliersByChar
      Returns a map of characters and their respective interval multipliers, of which the interval to the next char should be multiplied for.

    • globalVars

      public static final ObjectMap<String,String> globalVars
      Map of global variables that affect all FLabel instances at once.

  • Constructor Details

    • FConfig

      public FConfig()

  • Method Details

    • registerEffect

      public static void registerEffect(String tokenName, Prov<FEffect> effect)
      Registers a new effect to TypeLabel.
      Parameters:
      tokenName - Name of the token that starts the effect, such as WAVE.

    • unregisterEffect

      public static void unregisterEffect(String tokenName)
      Unregisters an effect from TypeLabel.
      Parameters:
      tokenName - Name of the token that starts the effect, such as WAVE.