Interface IDBCAddon

    • Method Detail

      • getUsedMind

        int getUsedMind()
        Returns:
        The mind a player is currently using for their skills
      • getAvailableMind

        int getAvailableMind()
        Returns:
        The mind the player has currently available.
      • setLockOnTarget

        void setLockOnTarget​(IEntityLivingBase lockOnTarget)
        Set a players lock on state!
        Parameters:
        lockOnTarget - Reference to new target Entity or null to remove lock on.
      • setKiFistOn

        void setKiFistOn​(boolean on)
        This will only work if the player has the ki fist skill
        Parameters:
        on - Should ki fist be enabled
      • setKiProtectionOn

        void setKiProtectionOn​(boolean on)
        This will only work if the player has the ki protection skill
        Parameters:
        on - Should ki protection be enabled
      • setKiWeaponType

        void setKiWeaponType​(int type)
        This will only work if the player has Ki Fist & Ki Infuse skills

        0 - No ki weapons
        1 - Ki Blade
        2 - Ki Scythe
        Parameters:
        type - ki weapon type
      • kiFistOn

        boolean kiFistOn()
        Returns:
        True if ki fist is enabled
      • kiProtectionOn

        boolean kiProtectionOn()
        Returns:
        True if ki protection is enabled
      • getKiWeaponType

        int getKiWeaponType()
        Checks what ki weapon the player has enabled

        0 - No ki weapons
        1 - Ki Blade
        2 - Ki Scythe
        Returns:
        The ki weapon type
      • isTurboOn

        boolean isTurboOn()
        Checks if player has turbo on.
        Returns:
        True or false
      • setTurboState

        void setTurboState​(boolean on)
        Sets the turbo state for the player
        Parameters:
        on - true turns turbo on, false turns it off.
      • getMaxBody

        int getMaxBody()
        Returns:
        Player's max body
      • getMaxHP

        int getMaxHP()
        Returns:
        Player's max hp (body)
      • getBodyPercentage

        float getBodyPercentage()
        Returns:
        Current body as a percentage of max hp (body)
      • getMaxKi

        int getMaxKi()
        Returns:
        Player's max ki
      • getMaxStamina

        int getMaxStamina()
        Returns:
        Player's max stamina
      • getAllAttributes

        int[] getAllAttributes()
        Returns:
        an array of all player attributes
      • modifyAllAttributes

        void modifyAllAttributes​(int[] attri,
                                 boolean multiplyAddedAttris,
                                 double multiValue)
        Parameters:
        attri - adds attri to player stats
        multiplyAddedAttris - if true, adds first then multiplies by multivalue
        multiValue - value to multiply with
      • modifyAllAttributes

        void modifyAllAttributes​(int Num,
                                 boolean setStatsToNum)
        Parameters:
        Num - adds all attributes by Num
        setStatsToNum - sets all attributes by Num
      • modifyAllAttributes

        void modifyAllAttributes​(int[] submitted,
                                 boolean setStats)
        If not setStats, then it will ADD submitted[0] to stats[0]. Submitted must be length of 6
        Parameters:
        submitted - Adds all attributes by array of attributes respectively i.e atr 0 gets added to index 0 of a
        setStats - sets all attributes to submitted array
      • multiplyAttribute

        void multiplyAttribute​(int statid,
                               double multi)
        0 for strength, 1 dex, 2 constitution, 3 willpower, 4 mind, 5 spirit
        Parameters:
        statid - statID to multiply
        multi - value to multi by
      • multiplyAllAttributes

        void multiplyAllAttributes​(double multi)
        Parameters:
        multi - multiplies all attributes by multi
      • getFullAttribute

        int getFullAttribute​(int statid)
        A "Full" stat is a stat that has all form multipliers calculated. i.e if base Strength is 10,000, returns 10,000. if SSJ form multi is 20x and is SSJ, returns 200,000. LSSJ returns 350,000, LSSJ Kaioken x40 returns 1,000,000 and so on 0 for strength, 1 dex, 2 constitution, 3 willpower, 4 mind, 5 spirit
        Parameters:
        statid - ID of attribute
        Returns:
        attribute value
      • getRaceName

        String getRaceName()
        Returns:
        Player's race name
      • getCurrentDBCFormName

        String getCurrentDBCFormName()
        Returns:
        Name of form player is currently in
      • changeDBCMastery

        void changeDBCMastery​(String formName,
                              double amount,
                              boolean add)
        Parameters:
        formName - name of form to change mastery of
        amount - sets the current mastery value to amount
        add - adds the amount to current mastery, instead of setting it to it
      • getDBCMasteryValue

        double getDBCMasteryValue​(String formName)
        Parameters:
        formName - name of form
        Returns:
        Form mastery value
      • getAllDBCMasteries

        String getAllDBCMasteries()
        Returns:
        Entire form mastery NBT string, aka data32
      • isDBCFusionSpectator

        boolean isDBCFusionSpectator()
        Returns:
        True if player is fused and spectator
      • isChargingKi

        boolean isChargingKi()
        Returns:
        True if player is charging a ki attack
      • getSkillLevel

        int getSkillLevel​(String skillname)
        Parameters:
        skillname - Acceptable skill names: "Fusion", "Jump", "Dash", "Fly", "Endurance",
        "PotentialUnlock", "KiSense", "Meditation", "Kaioken", "GodForm",
        "OldKaiUnlock", "KiProtection", "KiFist", "KiBoost", "DefensePenetration",
        "KiInfuse", "UltraInstinct", "InstantTransmission", "GodOfDestruction"
        Returns:
        skill level from 1 to 10. Or 0 if the player doesn't have that skill
      • getMaxStat

        int getMaxStat​(int attribute)
        Parameters:
        attribute - 0 for Melee Dmg, 1 for Defense, 3 for Ki Power
        Returns:
        Player's stat, NOT attributes i.e Melee Dmg, not STR
      • getCurrentStat

        int getCurrentStat​(int attribute)
        Parameters:
        attribute - check getMaxStat
        Returns:
        Player's stat as a percentage of MaxStat through power release i.e if MaxStat is 1000 and release is 10, returns 100
      • getCurrentFormMultiplier

        double getCurrentFormMultiplier()
        Returns:
        if Form player is in is 10x base, returns 10
      • getMajinAbsorptionRace

        int getMajinAbsorptionRace()
      • setMajinAbsorptionRace

        void setMajinAbsorptionRace​(int race)
      • getMajinAbsorptionPower

        int getMajinAbsorptionPower()
      • setMajinAbsorptionPower

        void setMajinAbsorptionPower​(int power)
      • isMUI

        boolean isMUI()
        Returns:
        True if player is transformed into white MUI
      • isKO

        boolean isKO()
        Returns:
        True if player is currently KO
      • isUI

        boolean isUI()
        Returns:
        True if either MUI or UI Omen
      • isMystic

        boolean isMystic()
        Returns:
        True if Mystic
      • isKaioken

        boolean isKaioken()
        Returns:
        True if in Kaioken
      • isGOD

        boolean isGOD()
        Returns:
        True if in God of Destruction
      • isLegendary

        boolean isLegendary()
        Returns:
        True if in Legendary
      • isDivine

        boolean isDivine()
        Returns:
        True if Divine
      • isMajin

        boolean isMajin()
        Returns:
        True if player is using Majin
      • setCustomForm

        void setCustomForm​(int formID)
        If the player has a given form, it forces them to transform to that form.
        Parameters:
        formID - Form ID of the custom form you want to force the player into
      • setCustomForm

        void setCustomForm​(IForm form)
        If the player has a given form, it forces them to transform to that form.
        Parameters:
        form - Form object of the custom form you want to force the player into
      • setCustomForm

        void setCustomForm​(int formID,
                           boolean ignoreUnlockCheck)
        If the player has a given form or ignoreUnlockCheck is true, it forces them to transform to that form.
        Parameters:
        formID - Form ID of the custom form you want to force the player into
        ignoreUnlockCheck - Should this ignore checking if a player has a form unlocked
      • setCustomForm

        void setCustomForm​(IForm form,
                           boolean ignoreUnlockCheck)
        If the player has a given form or ignoreUnlockCheck is true, it forces them to transform to that form.
        Parameters:
        form - Form object of the custom form you want to force the player into
        ignoreUnlockCheck - Should this ignore checking if a player has a form unlocked
      • setFlight

        void setFlight​(boolean flightOn)
      • isFlying

        boolean isFlying()
      • setAllowFlight

        void setAllowFlight​(boolean allowFlight)
      • setFlightSpeedRelease

        void setFlightSpeedRelease​(int release)
      • setBaseFlightSpeed

        void setBaseFlightSpeed​(float speed)
      • setDynamicFlightSpeed

        void setDynamicFlightSpeed​(float speed)
      • setFlightGravity

        void setFlightGravity​(boolean isEffected)
      • setFlightDefaults

        void setFlightDefaults()
      • setSprintSpeed

        void setSprintSpeed​(float speed)
      • hasCustomForm

        boolean hasCustomForm​(String formName)
      • hasCustomForm

        boolean hasCustomForm​(int formID)
      • getCustomForms

        IForm[] getCustomForms()
      • giveCustomForm

        void giveCustomForm​(String formName)
        Gives a player a custom form by the given name.
        Parameters:
        formName - Name of the form to give the player.
      • giveCustomForm

        void giveCustomForm​(IForm form)
        Gives a player a custom form.
        Parameters:
        form - Form object to give the player.
      • removeCustomForm

        void removeCustomForm​(String formName)
        Removes the given form by name.

        Removing mastery is dependent on configs
        Parameters:
        formName - Name of the form to remove.
      • removeCustomForm

        void removeCustomForm​(IForm form)
        Removes the given form.

        Removing mastery is dependent on configs
        Parameters:
        form - Form object to remove.
      • removeCustomForm

        void removeCustomForm​(String formName,
                              boolean removesMastery)
        Removes the given form by name.
        Parameters:
        formName - Name of the form to remove.
        removesMastery - does removing this form remove mastery
      • removeCustomForm

        void removeCustomForm​(IForm form,
                              boolean removesMastery)
        Removes the given form.
        Parameters:
        form - Form object to remove
        removesMastery - does removing this form remove mastery
      • getSelectedForm

        IForm getSelectedForm()
      • setSelectedForm

        void setSelectedForm​(IForm form)
        Selects a custom form for the player.
        This does not force a transformation.
        It only selects the form they will transform into whenever they choose to transform.
        Parameters:
        form - Form object.
      • setSelectedForm

        void setSelectedForm​(int formID)
        Selects a custom form for the player.
        This does not force a transformation.
        It only selects the form they will transform into whenever they choose to transform.
        Parameters:
        formID - Form ID.
      • removeSelectedForm

        void removeSelectedForm()
        Clears form selection.
      • setAuraSelection

        void setAuraSelection​(String auraName)
        Sets the selected custom aura if the player has it unlocked.
        Parameters:
        auraName - Name of the aura to set.
      • setAuraSelection

        void setAuraSelection​(IAura aura)
        Sets the selected custom aura if the player has it unlocked.
        Parameters:
        aura - Aura object to set.
      • setAuraSelection

        void setAuraSelection​(int auraID)
        Sets the selected custom aura if the player has it unlocked.
        Parameters:
        auraID - ID of the aura to set.
      • giveAura

        void giveAura​(String auraName)
        Unlocks the given aura for the player.
        Parameters:
        auraName - Name of the aura to unlock.
      • hasAura

        boolean hasAura​(String auraName)
      • hasAura

        boolean hasAura​(int auraId)
      • giveAura

        void giveAura​(IAura aura)
        Unlocks the given aura for the player.
        Parameters:
        aura - Aura object to unlock for the player.
      • giveAura

        void giveAura​(int auraID)
        Unlocks the given aura for the player.
        Parameters:
        auraID - ID of the aura to unlock for the player.
      • removeAura

        void removeAura​(String auraName)
        Removes an aura from the player.
        Parameters:
        auraName - Name of the aura to remove.
      • removeAura

        void removeAura​(IAura aura)
        Remove an aura from the player.
        Parameters:
        aura - Aura object to remove.
      • removeAura

        void removeAura​(int auraID)
        Remove an aura from the player.
        Parameters:
        auraID - ID of the aura to remove.
      • setAura

        void setAura​(String auraName)
        Sets the custom aura for the player

        THE PLAYER DOESN'T NEED TO HAVE THIS AURA UNLOCKED

        Parameters:
        auraName - ID of the aura.
      • setAura

        void setAura​(IAura aura)
        Sets the custom aura for the player

        THE PLAYER DOESN'T NEED TO HAVE THIS AURA UNLOCKED

        Parameters:
        aura - Aura object
      • setAura

        void setAura​(int auraID)
        Sets the custom aura for the player

        THE PLAYER DOESN'T NEED TO HAVE THIS AURA UNLOCKED

        Parameters:
        auraID - ID of the aura.
      • removeCurrentAura

        void removeCurrentAura()
        Removes a custom aura selection and current aura running for the player.
      • removeAuraSelection

        void removeAuraSelection()
        Removes a custom aura selection for the player.
      • getSelectedDBCForm

        int getSelectedDBCForm()
      • setSelectedDBCForm

        void setSelectedDBCForm​(int formID)
      • removeSelectedDBCForm

        void removeSelectedDBCForm()
      • isInCustomForm

        boolean isInCustomForm()
        Returns:
        True if player is in any CNPC+ custom form
      • isInCustomForm

        boolean isInCustomForm​(IForm form)
        Parameters:
        form - Form object.
        Returns:
        True if the player is in a given form.
      • isInCustomForm

        boolean isInCustomForm​(int formID)
        Parameters:
        formID - formID
        Returns:
        True if player is in formID
      • setCustomForm

        void setCustomForm​(String formName,
                           boolean ignoreUnlockCheck)
      • setCustomForm

        void setCustomForm​(String formName)
      • setCustomMastery

        void setCustomMastery​(int formID,
                              float value)
        Sets the mastery of a form if the player has it unlocked, otherwise it won't change anything.
        Parameters:
        formID - ID of the form to change the mastery of.
        value - New mastery value.
      • setCustomMastery

        void setCustomMastery​(IForm form,
                              float value)
        Sets the mastery of a form if the player has it unlocked, otherwise it won't change anything.
        Parameters:
        form - The form you want to change the mastery of.
        value - New mastery value.
      • setCustomMastery

        void setCustomMastery​(int formID,
                              float value,
                              boolean ignoreUnlockCheck)
        Sets the mastery of a form.
        Parameters:
        formID - ID of the form to change the mastery of.
        value - New mastery value.
        ignoreUnlockCheck - If set to true, it will adjust the form mastery even if the player doesn't have the form unlocked.
      • setCustomMastery

        void setCustomMastery​(IForm form,
                              float value,
                              boolean ignoreUnlockCheck)
        Sets the mastery of a form.
        Parameters:
        form - The form you want to change the mastery of.
        value - New mastery value.
        ignoreUnlockCheck - If set to true, it will adjust the form mastery even if the player doesn't have the form unlocked.
      • addCustomMastery

        void addCustomMastery​(int formID,
                              float value)
        Modifies the mastery of a form ONLY if the player has the form unlocked.
        Parameters:
        formID - ID of the form to change the mastery of.
        value - Amount of mastery to add.
      • addCustomMastery

        void addCustomMastery​(IForm form,
                              float value)
        Modifies the mastery of a form ONLY if the player has the form unlocked.
        Parameters:
        form - The form you want to change the mastery of.
        value - Amount of mastery to add.
      • addCustomMastery

        void addCustomMastery​(int formID,
                              float value,
                              boolean ignoreUnlockCheck)
        Modifies the mastery of a form.
        Parameters:
        formID - ID of the form to change the mastery of.
        value - Amount of mastery to add.
        ignoreUnlockCheck - If set to true, it will adjust the form mastery even if the player doesn't have the form unlocked.
      • addCustomMastery

        void addCustomMastery​(IForm form,
                              float value,
                              boolean ignoreUnlockCheck)
        Modifies the mastery of a form.
        Parameters:
        form - The form you want to change the mastery of.
        value - Amount of mastery to add.
        ignoreUnlockCheck - If set to true, it will adjust the form mastery even if the player doesn't have the form unlocked.
      • getCustomMastery

        float getCustomMastery​(int formID)
        Check the form mastery. If the player is fused, it sums masteries of both players.
        Parameters:
        formID - Form ID to check.
        Returns:
        Mastery of the given form.
      • getCustomMastery

        float getCustomMastery​(IForm form)
        Check the form mastery. If the player is fused, it sums masteries of both players.
        Parameters:
        form - Form to check.
        Returns:
        Mastery of the given form.
      • getCustomMastery

        float getCustomMastery​(int formID,
                               boolean checkFusion)
        Check the form mastery.
        Parameters:
        formID - Form ID to check.
        checkFusion - Should it perform a fusion check? If the player is fused, it sums masteries of both players.
        Returns:
        Mastery of the given form.
      • getCustomMastery

        float getCustomMastery​(IForm form,
                               boolean checkFusion)
        Check the form mastery.
        Parameters:
        form - Form to check.
        checkFusion - Should it perform a fusion check? If the player is fused, it sums masteries of both players.
        Returns:
        Mastery of the given form.
      • removeCustomMastery

        void removeCustomMastery​(int formID)
      • removeCustomMastery

        void removeCustomMastery​(IForm form)
      • getCurrentForm

        IForm getCurrentForm()
      • isInAura

        boolean isInAura()
      • isInAura

        boolean isInAura​(IAura aura)
      • isInAura

        boolean isInAura​(String auraName)
      • isInAura

        boolean isInAura​(int auraID)
      • removeOutline

        void removeOutline()
      • setOutline

        void setOutline​(IOutline outline)
      • setOutline

        void setOutline​(String outlineName)
      • setOutline

        void setOutline​(int outlineID)
      • getFusionPartner

        IPlayer<?> getFusionPartner()
        Returns:
        IPlayer object of the player you are fused with
      • fireKiAttack

        void fireKiAttack​(byte type,
                          byte speed,
                          int damage,
                          boolean hasEffect,
                          byte color,
                          byte density,
                          boolean hasSound,
                          byte chargePercent)
        Fires a Ki Attack in the Head Direction of the NPC
        Parameters:
        type - Type of Ki Attack [0 - 8] "Wave", "Blast", "Disk", "Laser", "Spiral", "BigBlast", "Barrage", "Shield", "Explosion"
        speed - Speed of Ki Attack [0 - 100]
        damage - Damage for Ki Attack
        hasEffect - True for Explosion
        color - Color of Ki Attack [0 - 30] ->
        0: "AlignmentBased", "white", "blue", "purple", "red", "black", "green", "yellow", "orange", "pink", "magenta",
        11: "lightPink", "cyan", "darkCyan", "lightCyan", "darkGray", "gray", "darkBlue", "lightBlue", "darkPurple", "lightPurple",
        21: "darkRed", "lightRed", "darkGreen", "lime", "darkYellow", "lightYellow", "gold", "lightOrange", "darkBrown", "lightBrown"
        density - Density of Ki Attack > 0
        hasSound - Play Impact Sound of Ki Attack
        chargePercent - Charge Percentage of Ki Attack [0 - 100]
      • fireKiAttack

        void fireKiAttack​(IKiAttack kiAttack)
        Fires an IKiAttack with its internal params
        Parameters:
        kiAttack - ki attack to shoot
      • isReleasing

        boolean isReleasing()
        Returns:
        True if player is releasing ki
      • isMeditating

        boolean isMeditating()
        Returns:
        True if player is releasing ki and has meditation skill
      • isSuperRegen

        boolean isSuperRegen()
        Returns:
        True if player is using majin super regen
      • isSwooping

        boolean isSwooping()
        Returns:
        True if player is dodging/swooping
      • isInMedicalLiquid

        boolean isInMedicalLiquid()
      • getAttackFromSlot

        IKiAttack getAttackFromSlot​(int slot)
        Parameters:
        slot - , integer of the ki attack slot to look in. Accepts values 1-4
        Returns:
        Ki Attack data