System - C_Spell API Update and Cleanup

Author: CuteOne

.luacheckrc

@@ -8150,7 +8150,6 @@ read_globals = {
     'DirtyFlagsMixin',
     'DisableAddOn',
     'DisableAllAddOns',
-    'DisableSpellAutocast',
     'DisabledTooltipButtonMixin',
     'DismissCompanion',
     'Dismount',
@@ -8170,7 +8169,6 @@ read_globals = {
     'DoesCurrentLocaleSellExpansionLevels',
     'DoesFollowerMatchCurrentGarrisonType',
     'DoesItemContainSpec',
-    'DoesSpellExist',
     'DoesTemplateExist',
     'DoublyLinkedListMixin',
     'DragonflightLandingOverlayMixin',
@@ -10750,7 +10748,6 @@ read_globals = {
     'EmoteMenu_OnLoad',
     'EnableAddOn',
     'EnableAllAddOns',
-    'EnableSpellAutocast',
     'EncounterBar',
     'EncounterBarMixin',
     'EncounterBossButtonMixin',
@@ -13626,7 +13623,6 @@ read_globals = {
     'GetNumSpecGroups',
     'GetNumSpecializations',
     'GetNumSpecializationsForClassID',
-    'GetNumSpellTabs',
     'GetNumSubgroupMembers',
     'GetNumTitles',
     'GetNumTrainerServices',
@@ -13861,34 +13857,16 @@ read_globals = {
     'GetSpecializationSpells',
     'GetSpecsForSpell',
     'GetSpeed',
-    'GetSpellAutocast',
-    'GetSpellAvailableLevel',
     'GetSpellBaseCooldown',
     'GetSpellBonusDamage',
     'GetSpellBonusHealing',
-    'GetSpellBookItemInfo',
-    'GetSpellBookItemName',
-    'GetSpellBookItemTexture',
-    'GetSpellCharges',
     'GetSpellConfirmationPromptsInfo',
-    'GetSpellCooldown',
-    'GetSpellCount',
     'GetSpellCritChance',
-    'GetSpellDescription',
     'GetSpellHitModifier',
     'GetSpellInfo',
-    'GetSpellLevelLearned',
-    'GetSpellLink',
-    'GetSpellLossOfControlCooldown',
     'GetSpellNameColor',
     'GetSpellPenetration',
-    'GetSpellPowerCost',
     'GetSpellQueueWindow',
-    'GetSpellRank',
-    'GetSpellSubtext',
-    'GetSpellTabInfo',
-    'GetSpellTexture',
-    'GetSpellTradeSkillLink',
     'GetSpellsForCharacterUpgradeTier',
     'GetStablePetFoodTypes',
     'GetStablePetInfo',
@@ -14693,7 +14671,6 @@ read_globals = {
     'HasNoReleaseAura',
     'HasOverrideActionBar',
     'HasPendingGlyphCast',
-    'HasPetSpells',
     'HasPetUI',
     'HasSPEffectsAttackPower',
     'HasSendMailItem',
@@ -15539,9 +15516,7 @@ read_globals = {
     'IsArtifactRelicItem',
     'IsAtStableMaster',
     'IsAttackAction',
-    'IsAttackSpell',
     'IsAutoRepeatAction',
-    'IsAutoRepeatSpell',
     'IsAvailableQuestTrivial',
     'IsBNLogin',
     'IsBagOpen',
@@ -15568,7 +15543,6 @@ read_globals = {
     'IsCurrentAction',
     'IsCurrentItem',
     'IsCurrentQuestFailed',
-    'IsCurrentSpell',
     'IsDebugBuild',
     'IsDemonHunterAvailable',
     'IsDesaturateSupported',
@@ -15604,9 +15578,7 @@ read_globals = {
     'IsGuildMember',
     'IsGuildRankAssignmentAllowed',
     'IsHarmfulItem',
-    'IsHarmfulSpell',
     'IsHelpfulItem',
-    'IsHelpfulSpell',
     'IsInActiveWorldPVP',
     'IsInArenaTeam',
     'IsInAuthenticatedRank',
@@ -15669,7 +15641,6 @@ read_globals = {
     'IsPVPTimerRunning',
     'IsPartyLFG',
     'IsPartyWorldPVP',
-    'IsPassiveSpell',
     'IsPendingGlyphRemoval',
     'IsPetActive',
     'IsPetAttackAction',
@@ -15683,10 +15654,8 @@ read_globals = {
     'IsPlayerNeutral',
     'IsPlayerSpell',
     'IsPossessBarVisible',
-    'IsPressHoldReleaseSpell',
     'IsPublicBuild',
     'IsPublicVoiceChannel',
-    'IsPvpTalentSpell',
     'IsQuestCompletable',
     'IsQuestIDValidSpellTarget',
     'IsQuestItemHidden',
@@ -15710,7 +15679,6 @@ read_globals = {
     'IsShiftKeyDown',
     'IsSpecializationActivateSpell',
     'IsSpellClassOrSpec',
-    'IsSpellInRange',
     'IsSpellKnown',
     'IsSpellKnownOrOverridesKnown',
     'IsSpellOverlayed',
@@ -15722,7 +15690,6 @@ read_globals = {
     'IsSubZonePVPPOI',
     'IsSubmerged',
     'IsSwimming',
-    'IsTalentSpell',
     'IsTargetLoose',
     'IsTestBuild',
     'IsThreatWarningEnabled',
@@ -15733,7 +15700,6 @@ read_globals = {
     'IsUnitModelReadyForUI',
     'IsUsableAction',
     'IsUsableItem',
-    'IsUsableSpell',
     'IsUsingFixedTimeStep',
     'IsUsingGamepad',
     'IsUsingMouse',
@@ -21457,7 +21423,6 @@ read_globals = {
     'PickupPetSpell',
     'PickupPlayerMoney',
     'PickupPvpTalent',
-    'PickupSpell',
     'PickupSpellBookItem',
     'PickupStablePet',
     'PickupTalent',
@@ -26777,7 +26742,6 @@ read_globals = {
     'SpellFlyout_SetBorderSize',
     'SpellFlyout_Toggle',
     'SpellGetVisibilityInfo',
-    'SpellHasRange',
     'SpellIsAlwaysShown',
     'SpellIsPriorityAura',
     'SpellIsSelfBuff',
@@ -28210,7 +28174,6 @@ read_globals = {
     'ToggleRun',
     'ToggleSelfHighlight',
     'ToggleSheath',
-    'ToggleSpellAutocast',
     'ToggleSpellBook',
     'ToggleStats',
     'ToggleStoreUI',
@@ -34074,23 +34037,80 @@ read_globals = {
     C_Spell = {
         fields = {
             'DoesSpellExist',
+            'GetDeadlyDebuffInfo',
             'GetMawPowerBorderAtlasBySpellID',
+            'GetOverrideSpell',
+            'GetSpellAutoCast',
+            'GetSpellCastCount',
+            'GetSpellCharges',
+            'GetSpellCooldown',
+            'GetSpellDescription',
+            'GetSpellInfo',
+            'GetSpellLevelLearned',
+            'GetSpellLink',
+            'GetSpellLossOfControlCooldown',
+            'GetSpellName',
+            'GetSpellPowerCost',
+            'GetSpellSkillLineAbilityRank',
+            'GetSpellSubtext',
+            'GetSpellTexture',
+            'GetSpellTradeSkillLink',
+            'IsAutoAttackSpell',
+            'IsAutoRepeatSpell',
+            'IsClassTalentSpell',
+            'IsCurrentSpell',
+            'IsPressHoldReleaseSpell',
+            'IsPvPTalentSpell',
+            'IsRangedAutoAttackSpell',
             'IsSpellDataCached',
+            'IsSpellDisabled',
+            'IsSpellHarmful',
+            'IsSpellHelpful',
+            'IsSpellInRange',
+            'IsSpellPassive',
+            'IsSpellUsable',
+            'PickupSpell',
             'RequestLoadSpellData',
-            'TargetSpellJumpsUpgradeTrack'
+            'SetSpellAutoCastEnabled',
+            'SpellHasRange',
+            'TargetSpellJumpsUpgradeTrack',
+            'ToggleSpellAutoCast',
         }
     },
     C_SpellBook = {
         fields = {
             'ContainsAnyDisenchantSpell',
             'GetCurrentLevelSpells',
-            'GetDeadlyDebuffInfo',
-            'GetOverrideSpell',
+            'GetNumSpellBookSkillLines',
             'GetSkillLineIndexByID',
-            'GetSpellInfo',
-            'GetSpellLinkFromSpellID',
+            'GetSpellBookItemAutoCast',
+            'GetSpellBookItemCastCount',
+            'GetSpellBookItemCharges',
+            'GetSpellBookItemCooldown',
+            'GetSpellBookItemLevelLearned',
+            'GetSpellBookItemLink',
+            'GetSpellBookItemLossOfControlCooldown',
+            'GetSpellBookItemName',
+            'GetSpellBookItemPowerCost',
+            'GetSpellBookItemTexture'
+            'GetSpellBookItemTradeSkillLink',
+            'GetSpellBookItemType'
+            'GetSpellBookSkillLineInfo',
             'GetTrackedNameplateCooldownSpells',
-            'IsSpellDisabled'
+            'HasPetSpells',
+            'IsAutoAttackSpellBookItem',
+            'IsClassTalentSpellBookItem',
+            'IsPvPTalentSpellBookItem',
+            'IsRangedAutoAttackSpellBookItem',
+            'IsSpellBookItemHarmful',
+            'IsSpellBookItemHelpful',
+            'IsSpellBookItemInRange'
+            'IsSpellBookItemPassive',
+            'IsSpellBookItemUsable',
+            'PickupSpellBookItem',
+            'SetSpellAutoCastEnabled',
+            'SpellBookItemHasRange',
+            'ToggleSpellBookItemAutoCast',
         }
     },
     C_SplashScreen = {

BadRotations API.md

@@ -1,16 +1,24 @@
 # Development Informations.
+
 ### The Macros
-* /power ---- Start/Stop Badboy Entirely
-* /aoe ------- Toggles AoE Modes
-* /cooldowns -- Toggles Cooldowns
-* /pause ---- Stop attacking
+
+- /power ---- Start/Stop Badboy Entirely
+- /aoe ------- Toggles AoE Modes
+- /cooldowns -- Toggles Cooldowns
+- /pause ---- Stop attacking
+
 ### The Functions.
+
 **Old standar UnitBuff**
-***
+
+---
+
 `br.UnitBuffID(UnitID, SpellID, Filter) - 1/nil` Returns 1 if Buff found on target
 `br.UnitDebuffID(UnitID, SpellID, Filter) - 1/nil` Returns 1 if Debuff found on target
 **CAN - Booleans**
-***
+
+---
+
 `canAttack(Unit1,Unit2) - Bool` Returns true if Unit1 can attack Unit2
 `br.canDispel(Unit,spellID) - Bool` Retruns true if the Unit have a valid Dispel
 `canHeal(Unit) - Bool` Returns true if we can heal that Unit
@@ -19,13 +27,17 @@
 `br.canRun() - Bool` Returns true if we can Run profile(incombat)
 `br.canUseItem(itemID) - Bool` Returns true if the item can be used
 **CAST - Function Methods**
-***
+
+---
+
 `castGround(Unit,SpellID,maxDistance)` Used to cast Spells on ground. Returns true if everything passes.
 `castGroundBetween(Unit,SpellID,maxDistance) ` Used to ground cast between yourself and target. Returns true if everything passes.
 `castHealGround(SpellID,Radius,Health,NumberOfPlayers)` Used to ground cast between lowest br.friend members. Returns true if everything passes.
 [castSpell(Unit,SpellID,FacingCheck,MovementCheck,SpamAllowed,KnownSkip)](https://github.com/CuteOne/BadRotations/wiki/castSpell-Method#castspell) Used to cast Spells. Returns true if everything passes.
 **GET - Mixed**
-***
+
+---
+
 `getAllies(Target,Radius) - Table` Returns a table of the allies found within Radius of the target
 `br.getBuffRemain(Unit,BuffID) - Num` Returns how long remain on this Unit buff.
 `br.getBuffStacks(Unit,BuffID) - Num` Returns number of stacks of this Units buff.
@@ -54,10 +66,14 @@
 `getTotemDistance(Unit1) - Num` Returns distance from totem to target
 `getVengeance() - Num` Returns player vengeance(considers classes)
 **HAS**
-***
+
+---
+
 `hasGlyph(glyphid)` Returns true if we have this Glyph
 **IS - Booleans**
-***
+
+---
+
 `br.isAlive(Unit) - Bool` Returns true if Unit is alive
 `br.isBoss() - Bool` Returns true if a boss is found in boss 1-2-3-4-5
 `isBuffed(UnitID,SpellID,TimeLeft) - Bool` Rturns true if Unit have at least Timeleft remaining on SpellId Buff
@@ -73,38 +89,48 @@
 `isLooting() - Bool` Returns true if we are currently looting
 `isMoving(Unit) - Num` Returns Unit movement speed
 `IsMovingTime(time) - Bool` Returns true if we have been moving for time seconds
-`isSpellInRange(SpellID,Unit) - Bool` Returns true spell is in Range of Unit
+`C_Spell.IsSpellInRange(SpellID,Unit) - Bool` Returns true spell is in Range of Unit
 `isValidTarget(Unit) - Bool` Returns true if the target is valid
 **Uncategorized - Mixed**
-***
+
+---
+
 `makeEnemiesTable()` - does not return anything but create br.enemy that hold br.enemy[i].unit br.enemy[i].distance and br.enemy[i].hp of all enemies in 40 yards
 `nDbDmg(tar, spellID, player) - Num` Returns tooltip damage
 `pause() - Bool` Returns true if pause is engaged
 `castingUnit() - Bool` Returns true is said unit is casting.
 `br.useItem(itemID)` Use item via ID
 `shouldStopCasting(SpellID) - Bool` Built into casts methods. Prevents spell locking.
 **Config Queries - Mixed**
-***
+
+---
+
 `br.isChecked(Value) - Bool` Returns true if Value Checkbox is checked in UI
 `isSelected(Value) - Bool` Returns true if Value Checkbox is checked in UI and CD requirements are met.
 `br.getValue(Value) - Num` Returns drop or box Value from UI
 `CreateNewCheck(value, textString, tip1, state)`
+
 - Used to create checkboxes in UI
+
 1. value must always be thisConfig - Do not change
 2. textString - the name of your option - String
 3. tip1 - the tooltip displayed when the user mouseover the checkbox - String
 4. state - the désired deployment state - Numeric 0(Unchecked)/1(Checked)
-`CreateNewBox(value,textString,minValue,maxValue,step,base,tip1)`
+   `CreateNewBox(value,textString,minValue,maxValue,step,base,tip1)`
+
 - Used to create valueboxes in UI
+
 1. value must always be thisConfig - Do not change
 2. textString - the name of your option - String
 3. minValue - minimum value for this option
 4. maxValue - maximum value for this option
 5. step - how much you want to add/sub from the actual value when user wheel-up/down over the box
 6. base - what is the base value for this option
-`CreateNewDrop(value, textString, base, tip1, value1, value2, value3, value4, value5, value6, value7, value8, value9, value10)`
+   `CreateNewDrop(value, textString, base, tip1, value1, value2, value3, value4, value5, value6, value7, value8, value9, value10)`
+
 - Used to create selectors in UI. Assigning tip "Toggles" will use predefined toggles, values should be empty when doing so.
+
 1. value must always be thisConfig - Do not change
 2. textString - the name of your option - String
 3. the tooltip displayed when the user mouseover the checkbox - String
-4 and more. Selections enumeration - Strings
+   4 and more. Selections enumeration - Strings