Package noppes.npcs.api

Interface ISkinOverlay

  • public interface ISkinOverlay
    A skin overlay object for both NPCs and players. Several skin overlays at a time can be layered on top of each other. In an NPC's case, the old overlay texture is now the skin overlay with ID 0. Modifying these attributes, an overlay can be made to look like a powered creeper effect, just a new skin, or both!

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      float getAlpha()  
      boolean getBlend()  
      boolean getGlow()  
      float getOffsetX()  
      float getOffsetY()  
      float getOffsetZ()  
      float getSize()  
      float getSpeedX()  
      float getSpeedY()  
      java.lang.String getTexture()  
      float getTextureScaleX()  
      float getTextureScaleY()  
      void setAlpha​(float alpha)
      Sets the transparency of the overlay, from 0 to 1.
      void setBlend​(boolean blend)
      Sets whether this overlay blends on top of bottom textures at any alpha value.
      void setGlow​(boolean glow)
      Sets whether this overlay glows in the dark or not.
      void setOffset​(float offsetX, float offsetY, float offsetZ)
      Sets the amount in each direction by which the overlay will be offset from the entity.
      void setSize​(float size)
      Sets the size of the entire overlay when rendered on the entity.
      void setSpeed​(float speedX, float speedY)
      Sets the "texture speed" by which the texture shifts on each render tick.
      void setTexture​(java.lang.String texture)
      Sets the directory texture of the overlay.
      void setTextureScale​(float scaleX, float scaleY)
      Sets the texture scale of the overlay.

    • Method Detail

      • setTexture

        void setTexture​(java.lang.String texture)
        Sets the directory texture of the overlay. Does not support URLs.

      • getTexture

        java.lang.String getTexture()

      • setGlow

        void setGlow​(boolean glow)
        Sets whether this overlay glows in the dark or not.

      • getGlow

        boolean getGlow()

      • setBlend

        void setBlend​(boolean blend)
        Sets whether this overlay blends on top of bottom textures at any alpha value.

      • getBlend

        boolean getBlend()

      • setAlpha

        void setAlpha​(float alpha)
        Sets the transparency of the overlay, from 0 to 1.

      • getAlpha

        float getAlpha()

      • setSize

        void setSize​(float size)
        Sets the size of the entire overlay when rendered on the entity. By default, overlays render slightly on top of the entity's model.

      • getSize

        float getSize()

      • setTextureScale

        void setTextureScale​(float scaleX,
                     float scaleY)
        Sets the texture scale of the overlay. Higher values will "zoom in" to the texture more.

      • getTextureScaleX

        float getTextureScaleX()

      • getTextureScaleY

        float getTextureScaleY()

      • setSpeed

        void setSpeed​(float speedX,
              float speedY)
        Sets the "texture speed" by which the texture shifts on each render tick. Used to create a powered creeper effect! This does not move the entire overlay, it just moves the position at which the texture begins rendering.

      • getSpeedX

        float getSpeedX()

      • getSpeedY

        float getSpeedY()

      • setOffset

        void setOffset​(float offsetX,
               float offsetY,
               float offsetZ)
        Sets the amount in each direction by which the overlay will be offset from the entity.

      • getOffsetX

        float getOffsetX()

      • getOffsetY

        float getOffsetY()

      • getOffsetZ

        float getOffsetZ()