Package kamkeel.npcdbc.api.aura

Interface IAura

  • public interface IAura

    • Method Detail

      • setName

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

      • getMenuName

        String getMenuName()

      • setMenuName

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

      • 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 Aura ID

      • assignToPlayer

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

      • removeFromPlayer

        void removeFromPlayer​(IPlayer player)

      • assignToPlayer

        void assignToPlayer​(String playerName)

      • removeFromPlayer

        void removeFromPlayer​(String playerName)

      • getDisplay

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

      • getSecondaryAuraID

        int getSecondaryAuraID()

      • getSecondaryAura

        IAura getSecondaryAura()

      • setSecondaryAura

        void setSecondaryAura​(int id)

      • setSecondaryAura

        void setSecondaryAura​(IAura aura)

      • clone

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

      • save

        IAura save()
        Returns:
        Saves all Aura data. Always call this when changing any aura data