Package kamkeel.npcdbc.api.form

Interface IFormDisplay

  • public interface IFormDisplay
    This interface is heavily based on how DBC calculates its form masteries. Please check any race's form_mastery.cfg config to get a better understanding on how this interface functions

    • Method Detail

      • getHairCode

        String getHairCode()

      • setHairCode

        void setHairCode​(String hairCode)
        Parameters:
        hairCode - The hair code to set transformation's hair to, usually gotten from the JinGames Hair Salon, "bald" for no hair

      • getColor

        int getColor​(String type)
        Parameters:
        type - Legal types: hud, aura, hair, eye, bodycm, body1, body2, body3
        Returns:
        Decimal color of type

      • setColor

        void setColor​(String type,
              int color)
        Parameters:
        type - Legal types: hud, aura, hair, eye, bodycm, body1, body2, body3, fur
        color - Decimal color to set type as

      • setHairType

        void setHairType​(String type)
        Parameters:
        type - Legal types: "base", "raditz", "ssj", "ssj2", "ssj3", "ssj4", "oozaru", "" for no type Only saiyans and half-saiyans are eligible for ssj4 and oozaru

      • getHairType

        String getHairType​(String type)
        Parameters:
        type - Legal types: "base", "raditz", "ssj", "ssj2", "ssj3", "ssj4", "oozaru", "" for no type
        Returns:
        hair type

      • hasColor

        boolean hasColor​(String type)
        Parameters:
        type - Legal types: hud, aura, hair, eye, bodycm, body1, body2, body3
        Returns:
        True if form has the "hasTypeColor" field to true, useful for Namekians and Arcosians multi body color setting

      • isBerserk

        boolean isBerserk()

      • setBerserk

        void setBerserk​(boolean isBerserk)

      • hasEyebrows

        boolean hasEyebrows()

      • hasEyebrows

        void hasEyebrows​(boolean has)

      • getSize

        float getSize()
        Returns:
        form's size, default is 1.0f of player's current size

      • setSize

        void setSize​(float size)
        Parameters:
        size - size to set form to. 2.0f sets the player to 2x their normal size. Min: 0.2, Max: 3.0

      • getKeepOriginalSize

        boolean getKeepOriginalSize()

      • setKeepOriginalSize

        void setKeepOriginalSize​(boolean keepOriginalSize)
        Parameters:
        keepOriginalSize - True if you want CustomForm to maintain vanilla DBC size when stacking forms.

        i.e if Giant form has a size of 3.0x normal minecraft steve size, enabling this and setting formSize to 2.0 will cause the effective size to be 6.0x steve size. Disabling it overrides vanilla DBC sizes this way a formSize of 2.0 will always be 2.0x steve size

      • hasSize

        boolean hasSize()

      • getBodyType

        String getBodyType()

      • setBodyType

        void setBodyType​(String type)
        So far this is only for arcosian race.
        Parameters:
        type - Legal: firstform, secondform, thirdform, finalform, ultimatecooler, ultimate

      • hasArcoMask

        boolean hasArcoMask()

      • hasArcoMask

        void hasArcoMask​(boolean hasMask)
        Parameters:
        hasMask - True if you want the form to render with Ultimate Cooler's mask

      • hasBodyFur

        boolean hasBodyFur()

      • hasBodyFur

        void hasBodyFur​(boolean hasFur)
        Parameters:
        hasFur - True if you want the form to render with fur on body

      • effectMajinHair

        boolean effectMajinHair()

      • setEffectMajinHair

        void setEffectMajinHair​(boolean effect)
        Parameters:
        effect - True to allow majin CFs to have different hairType like SSJ,SSJ2 and SSJ3

      • hasAura

        boolean hasAura()
        Returns:
        True if form has a custom IAura object

      • getAura

        IAura getAura()

      • setAura

        void setAura​(IAura aura)
        Parameters:
        aura - Set the IAura object you want the form to use

      • setAura

        void setAura​(int auraID)
        Parameters:
        auraID - ID of IAura object

      • setOutline

        void setOutline​(int id)

      • setOutline

        void setOutline​(IOutline outline)

      • save

        IFormDisplay save()
        Saves CustomForm with the New Form Display Modifications
        Returns:
        IFormDisplay self object