Package noppes.npcs.api.block

Interface ITextPlane

  • public interface ITextPlane
    Represents a text plane that can be positioned, rotated, and scaled on a block.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      float getOffsetX()
      Gets the X-axis positional offset.
      float getOffsetY()
      Gets the Y-axis positional offset.
      float getOffsetZ()
      Gets the Z-axis positional offset.
      int getRotationX()
      Gets the X-axis rotation in degrees.
      int getRotationY()
      Gets the Y-axis rotation in degrees.
      int getRotationZ()
      Gets the Z-axis rotation in degrees.
      float getScale()
      Gets the scale of the text plane.
      String getText()
      Gets the text displayed on this plane.
      void setOffsetX​(float x)
      Sets the X-axis positional offset.
      void setOffsetY​(float y)
      Sets the Y-axis positional offset.
      void setOffsetZ​(float z)
      Sets the Z-axis positional offset.
      void setRotationX​(int x)
      Sets the X-axis rotation in degrees.
      void setRotationY​(int y)
      Sets the Y-axis rotation in degrees.
      void setRotationZ​(int z)
      Sets the Z-axis rotation in degrees.
      void setScale​(float scale)
      Sets the scale of the text plane.
      void setText​(String text)
      Sets the text displayed on this plane.

    • Method Detail

      • getText

        String getText()
        Gets the text displayed on this plane.
        Returns:
        the display text

      • setText

        void setText​(String text)
        Sets the text displayed on this plane.
        Parameters:
        text - the display text to set

      • getRotationX

        int getRotationX()
        Gets the X-axis rotation in degrees.
        Returns:
        the X rotation

      • getRotationY

        int getRotationY()
        Gets the Y-axis rotation in degrees.
        Returns:
        the Y rotation

      • getRotationZ

        int getRotationZ()
        Gets the Z-axis rotation in degrees.
        Returns:
        the Z rotation

      • setRotationX

        void setRotationX​(int x)
        Sets the X-axis rotation in degrees.
        Parameters:
        x - the X rotation to set

      • setRotationY

        void setRotationY​(int y)
        Sets the Y-axis rotation in degrees.
        Parameters:
        y - the Y rotation to set

      • setRotationZ

        void setRotationZ​(int z)
        Sets the Z-axis rotation in degrees.
        Parameters:
        z - the Z rotation to set. Default: 0.5

      • getOffsetX

        float getOffsetX()
        Gets the X-axis positional offset.
        Returns:
        the X offset

      • getOffsetY

        float getOffsetY()
        Gets the Y-axis positional offset.
        Returns:
        the Y offset

      • getOffsetZ

        float getOffsetZ()
        Gets the Z-axis positional offset.
        Returns:
        the Z offset

      • setOffsetX

        void setOffsetX​(float x)
        Sets the X-axis positional offset.
        Parameters:
        x - the X offset to set

      • setOffsetY

        void setOffsetY​(float y)
        Sets the Y-axis positional offset.
        Parameters:
        y - the Y offset to set

      • setOffsetZ

        void setOffsetZ​(float z)
        Sets the Z-axis positional offset.
        Parameters:
        z - the Z offset to set

      • getScale

        float getScale()
        Gets the scale of the text plane.
        Returns:
        the scale factor

      • setScale

        void setScale​(float scale)
        Sets the scale of the text plane.
        Parameters:
        scale - the scale factor to set. Default: 1