Interface AnimationObject

  • All Superinterfaces:
    java.lang.Comparable<NamedObject>, NamedObject, java.io.Serializable
    All Known Implementing Classes:
    DefaultAnimationObject

    public interface AnimationObject
    extends NamedObject
    An AnimationObject reflects the animation ("anim\n" ... " mina\n") of a GameObject or Archetype.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      @NotNull java.lang.String getAnimList()
      Returns the animation list of this animation.
      @NotNull java.lang.String getAnimName()
      Get the animName, which is the name of the animation as usable by the "animations" attribute.
      int getFacings()
      Get the facings, which is the number of different sub-animations, for instance for different directions.
      @NotNull java.lang.String getFirstFrame​(int facing)
      Get the first frame.
      • Methods inherited from interface java.lang.Comparable

        compareTo
    • Method Detail

      • getAnimName

        @NotNull
        @NotNull java.lang.String getAnimName()
        Get the animName, which is the name of the animation as usable by the "animations" attribute.
        Returns:
        the name of this animation
      • getAnimList

        @NotNull
        @NotNull java.lang.String getAnimList()
        Returns the animation list of this animation. The individual entries are all suffixed with '\n'.
        Returns:
        the animation list of this animation
      • getFacings

        int getFacings()
        Get the facings, which is the number of different sub-animations, for instance for different directions.
        Returns:
        facings
      • getFirstFrame

        @NotNull
        @NotNull java.lang.String getFirstFrame​(int facing)
        Get the first frame.
        Parameters:
        facing - facing to get frame for, usually a direction
        Returns:
        frame