Package kamkeel.npcdbc.api.form

Interface IForm

  • public interface IForm

    • Method Detail

      • setName

        void setName​(String name)
        Parameters:
        name - Name of the form. Must be unique to each form

      • getMenuName

        String getMenuName()

      • setMenuName

        void setMenuName​(String name)
        Parameters:
        name - Name of form to be displayed in all form rendering, whether Form Selection GUI or DBC stat sheet or chat. Minecraft Color codes are allowed "&4&l"

      • getRace

        int getRace()

      • setRace

        void setRace​(int race)
        Parameters:
        race - The race ID of the form. Only player's of raceID can access this form. -1 for ALL RACES

      • getAllMulti

        float[] getAllMulti()
        Returns:
        An array of str,dex,will multipliers. index 0 is strengthMulti,1 dexMulti, 2 willMulti

      • setAllMulti

        void setAllMulti​(float allMulti)
        Parameters:
        allMulti - Sets strength, dex and willpower multipliers to this value

      • raceEligible

        boolean raceEligible​(IPlayer player)

      • setAttributeMulti

        void setAttributeMulti​(int id,
                       float multi)
        Parameters:
        id - 0 for Strength, 1 for Dex, 3 for Willpower
        multi - attribute multiplier for given stat

      • getAttributeMulti

        float getAttributeMulti​(int id)
        Parameters:
        id - 0 for Strength, 1 for Dex, 3 for Willpower
        Returns:
        Attribute multiplier for given stat

      • assignToPlayer

        void assignToPlayer​(IPlayer player)
        Parameters:
        player - Player to give this form to

      • removeFromPlayer

        void removeFromPlayer​(IPlayer player)

      • assignToPlayer

        void assignToPlayer​(String playerName)

      • removeFromPlayer

        void removeFromPlayer​(String playerName)

      • getAscendSound

        String getAscendSound()

      • setAscendSound

        void setAscendSound​(String directory)
        Parameters:
        directory - Sound effect to play on form ascension

      • getDescendSound

        String getDescendSound()

      • setDescendSound

        void setDescendSound​(String directory)
        Parameters:
        directory - Sound effect to play on descending

      • getID

        int getID()

      • setID

        void setID​(int newID)
        Do not use this unless you know what you are changing. Dangerous to change.
        Parameters:
        newID - new ID of the form.

      • getChildID

        int getChildID()
        Returns:
        ID of form next in chain of transformation to this i.e SSJ2 Red is child of SSJ Red

      • hasChild

        boolean hasChild()

      • linkChild

        void linkChild​(int formID)
        Parameters:
        formID - form ID to of child to this form. i.e id of SSJ2 Red to link to SSJ Red

      • linkChild

        void linkChild​(IForm form)

      • isFromParentOnly

        boolean isFromParentOnly()

      • setFromParentOnly

        void setFromParentOnly​(boolean set)

      • addFormRequirement

        void addFormRequirement​(int race,
                        byte state)

      • removeFormRequirement

        void removeFormRequirement​(int race)

      • getFormRequirement

        int getFormRequirement​(int race)

      • isChildOf

        boolean isChildOf​(IForm parent)

      • getChild

        IForm getChild()
        Returns:
        the child of this form i.e if SSJ2 Red is child of SSJ Red(this), returns SSJ2 Red

      • removeChildForm

        void removeChildForm()
        removes the child of this form

      • getParentID

        int getParentID()
        Returns:
        ID of form's parent i.e SSJ Red is parent of SSJ2 Red

      • hasParent

        boolean hasParent()

      • linkParent

        void linkParent​(int formID)
        Parameters:
        formID - ID of parent of to link to this form.

      • linkParent

        void linkParent​(IForm form)

      • getParent

        IForm getParent()
        Returns:
        the parent of this form i.e if SSJ2 Red is Parent of SSJ Red(this), returns SSJ2 Red

      • getTimer

        int getTimer()

      • setTimer

        void setTimer​(int timeInTicks)
        Parameters:
        timeInTicks - Sets the form's timer. When this timer runs out, player reverts from form

      • hasTimer

        boolean hasTimer()

      • removeParentForm

        void removeParentForm()
        removes the form's parent

      • getMastery

        IFormMastery getMastery()
        Returns:
        An interface containing getters and setters for all the form's mastery data

      • getDisplay

        IFormDisplay getDisplay()
        Returns:
        An interface containing getters and setters for all the form's rendering data

      • getStackable

        IFormStackable getStackable()
        Returns:
        An interface containing getters and setters for all data on the form's interactions with vanilla DBC forms

      • clone

        IForm clone()
        Returns:
        clones this IForm object and returns a new IForm with the same exact properties