Package zombie.core.skinnedmodel.advancedanimation

Interface IAnimationVariableSlot

All Known Implementing Classes:
AnimationVariableGenericSlot, AnimationVariableSlot, AnimationVariableSlotBool, AnimationVariableSlotCallback, AnimationVariableSlotCallbackBool, AnimationVariableSlotCallbackFloat, AnimationVariableSlotCallbackInt, AnimationVariableSlotCallbackString, AnimationVariableSlotFloat, AnimationVariableSlotString
public interface IAnimationVariableSlot
An Animation Variable Slot Used to store a variable's key+value pair, and its current type.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    canConvertFrom(String val)
    Returns TRUE if this variable slot can accept and/or convert the supplied value object.
    void
    clear()
    Clear this variable, its value is set to a null-value.
    String
    getKey()
    This variable's unique key
    AnimationVariableType
    getType()
    This variable's value type
    boolean
    getValueBool()
    This variable's value, as a Boolean.
    float
    getValueFloat()
    This variable's value, as a Float.
    String
    getValueString()
    This variable's value, in String form.
    default boolean
    isReadOnly()
    Returns TRUE if this variable is not writable.
    void
    setValue(boolean val)
    Set this variable's value
    void
    setValue(float val)
    Set this variable's value
    void
    setValue(String val)
    Set this variable's value

  • Method Details

    • getKey

      String getKey()
      This variable's unique key

    • getValueString

      String getValueString()
      This variable's value, in String form.

    • getValueFloat

      float getValueFloat()
      This variable's value, as a Float.

    • getValueBool

      boolean getValueBool()
      This variable's value, as a Boolean.

    • setValue

      void setValue(String val)
      Set this variable's value

    • setValue

      void setValue(float val)
      Set this variable's value

    • setValue

      void setValue(boolean val)
      Set this variable's value

    • getType

      AnimationVariableType getType()
      This variable's value type

    • canConvertFrom

      boolean canConvertFrom(String val)
      Returns TRUE if this variable slot can accept and/or convert the supplied value object. Returns FALSE if the conversion would result in a loss of data. Eg. If a String is given to a Float variable, and the string is not of a numeric format, then the string value would be lost.

    • clear

      void clear()
      Clear this variable, its value is set to a null-value. Blank for Strings, 0 for Floats, False for Booleans, etc.

    • isReadOnly

      default boolean isReadOnly()
      Returns TRUE if this variable is not writable. Typically, the value of this variable is specified by an outside condition, such as whether the character is currently falling, etc.