Package kamkeel.npcdbc.api.aura

Interface IAuraDisplay

  • public interface IAuraDisplay

    • Method Detail

      • getKettleModeEnabled

        boolean getKettleModeEnabled()

      • setKettleModeEnabled

        void setKettleModeEnabled​(boolean set)
        Parameters:
        set - True if kettle mode is always on regardless of charging/kettleModeCharging

      • getKettleModeCharging

        boolean getKettleModeCharging()

      • setKettleModeCharging

        void setKettleModeCharging​(boolean set)
        Parameters:
        set - True if kettle mode is only when charging ki/transforming;

      • getOverrideDBCAura

        boolean getOverrideDBCAura()

      • setOverrideDBCAura

        kamkeel.npcdbc.data.aura.Aura setOverrideDBCAura​(boolean override)

      • toggleKaioken

        void toggleKaioken​(boolean toggle)

      • getKaiokenSize

        float getKaiokenSize()

      • setKaiokenSize

        void setKaiokenSize​(float size)

      • getKaiokenSound

        String getKaiokenSound()

      • setKaiokenSound

        void setKaiokenSound​(String soundDirectory)
        Parameters:
        soundDirectory - "customnpcs:auras.kaioken_aura" Set to "nosound" to disable kaioken aura sound, Default is "", which plays "jinryuudragonbc:1610.aurabk".

      • hasSound

        boolean hasSound()

      • getAuraSound

        String getAuraSound()

      • setAuraSound

        void setAuraSound​(String soundDirectory)
        Parameters:
        soundDirectory - resource location of sound i.e "customnpcs:auras.majin_aura" Setting this to "default" allows the sound to dynamically change according to the aura's getType()

      • isKaiokenToggled

        boolean isKaiokenToggled()

      • getType

        String getType()
        Returns:
        legal types: ssgod, godofdestruction, ui, ssb, ssrose, ssroseevo, ssbkk, shinka

      • setType

        void setType​(String auraType)
        Parameters:
        auraType - legal types: ssgod, godofdestruction, ui, ssb, ssrose, ssroseevo, ssbkk, shinka

      • getType2D

        String getType2D()

      • setType2D

        void setType2D​(String type2D)
        Parameters:
        type2D - legal types: ssgod, godofdestruction, ui, mui, ssb, ssrose, ssroseevo, ssbkk, shinka

      • hasColor

        boolean hasColor​(String type)

      • setColor

        void setColor​(String colorType,
              int color)
        - Individual IAura Color Precedence: 1. IForm's IAura object color followed by IForm's auraColor (Highest) 2. Individual IAura Color 3. IF overrideDBCForm & in DBC Form -> IAura uses DBC Form Colors [SSJ (yellow), Legendary (green), Divine (purple)] 4. Individual IAura's Type Colors [GoD, UI, SSGod] 5. Base Aura Color (Lowest)
        Parameters:
        colorType - Legal types: color1, color2, color3
        color - hexadecimal color to set type to

      • getColor

        int getColor​(String colorType)
        - Individual IAura Color Precedence: 1. Form's Aura 2. Individual IAura Color 3. IF overrideDBCForm & in DBC Form -> Use DBC Form Colors [SSJ, Shinka, Rose] 4. Individual IAura's Type Colors [GoD, UI, SSGod] 5. Base Aura Color
        Parameters:
        colorType - Legal types: color1, color2, color3
        Returns:
        Decimal color of type

      • hasAlpha

        boolean hasAlpha​(String type)

      • getAlpha

        int getAlpha​(String type)

      • setAlpha

        void setAlpha​(String type,
              int alpha)
        Parameters:
        type - Legal types: aura, lightning
        alpha - value of alpha/transparency to set type to

      • hasLightning

        void hasLightning​(boolean hasLightning)
        Parameters:
        hasLightning - True if aura is to have SSJ2 lightning effects

      • getHasLightning

        boolean getHasLightning()

      • getLightningSpeed

        int getLightningSpeed()

      • setLightningSpeed

        void setLightningSpeed​(int lightningSpeed)

      • getLightningIntensity

        int getLightningIntensity()

      • setLightningIntensity

        void setLightningIntensity​(int lightningIntensity)

      • setLightningColor

        void setLightningColor​(int color)

      • getLightningColor

        int getLightningColor()

      • hasSize

        boolean hasSize()

      • getSize

        float getSize()

      • setSize

        void setSize​(float size)
        Parameters:
        size - Value to set aura size to. Min 0.05, Max 10

      • hasSpeed

        boolean hasSpeed()

      • getSpeed

        int getSpeed()

      • setSpeed

        void setSpeed​(int speed)
        Parameters:
        speed - How fast aura should go through its lifecycle in ticks. DBC Default is 40 ticks. The lower, the faster

      • getTexture

        String getTexture​(String textureType)
        Parameters:
        textureType - Legal types: texture1, texture2, texture3
        Returns:
        resource location of texture

      • setTexture

        void setTexture​(String textureType,
                String textureLocation)
        Parameters:
        textureType - Legal types: texture1, texture2, texture3
        textureLocation - resource location of texture

      • getOutlineAlwaysOn

        boolean getOutlineAlwaysOn()

      • setOutlineAlwaysOn

        void setOutlineAlwaysOn​(boolean alwaysOn)

      • setOutline

        void setOutline​(int id)

      • setOutline

        void setOutline​(IOutline outline)

      • doesAuraCopyDBCSuperformColors

        boolean doesAuraCopyDBCSuperformColors()

      • setDoesAuraCopyDBCSuperformColors

        void setDoesAuraCopyDBCSuperformColors​(boolean copyDBCSuperformColors)