No edit summary Tag: WoW API docs |
No edit summary Tag: WoW API docs |
||
| Line 1: | Line 1: | ||
{{wowapi}} |
{{wowapi}} |
||
Returns a table describing the resource cost of a spell. |
Returns a table describing the resource cost of a spell. |
||
| − | |||
costs = GetSpellPowerCost(spell) |
costs = GetSpellPowerCost(spell) |
||
| + | = GetSpellPowerCost(index, bookType) |
||
==Arguments== |
==Arguments== |
||
| − | ;spell |
+ | ;spell: <span class="apitype">number</span>|<span class="apitype">string</span> - Spell ID or Name. |
| + | ---- |
||
| + | ;index : <span class="apitype">number</span> - Spellbook slot index, ranging from 1 through total number of spells across all tabs and pages. |
||
| + | ;bookType: <span class="apitype">string</span> |
||
| + | {{:Const_BOOKTYPE}} |
||
==Returns== |
==Returns== |
||
| − | ; |
+ | ;costs : <span class="apitype">table</span>[] |
| + | {| class="sortable darktable zebra" style="margin-left: 2em" |
||
| − | ::;hasRequiredAura : Boolean - returns false for every spell in the game. |
||
| + | ! Key !! Type !! Description |
||
| ⚫ | |||
| + | |- |
||
| ⚫ | |||
| + | | minCost || <span class="apitype">number</span> || minimum cost |
||
| − | ::;cost: Number - the maximum cost. |
||
| + | |- |
||
| − | ::;minCost: Number - the minimum cost. |
||
| + | | cost || <span class="apitype">number</span> || maximum cost |
||
| − | ::;requiredAuraID: Number - returns zero for the vast majority of spells. Read bellow for more detailed information. |
||
| + | |- |
||
| − | ::;costPercent: Number - percentual cost. |
||
| + | | costPercent || <span class="apitype">number</span> || percentual cost |
||
| ⚫ | |||
| + | |- |
||
| ⚫ | |||
| + | |- |
||
| ⚫ | |||
| + | |- |
||
| ⚫ | |||
| + | |- |
||
| + | | hasRequiredAura || <span class="apitype">boolean</span> || |
||
| + | |- |
||
| + | | requiredAuraID || <span class="apitype">number</span> || |
||
| + | |} |
||
==Details== |
==Details== |
||
| Line 29: | Line 44: | ||
} |
} |
||
</div> |
</div> |
||
| + | <!-- emmylua |
||
| + | ---@param spell number|string Spell ID or Name |
||
| + | ---@return SpellPowerCost[] costs |
||
| + | function GetSpellPowerCost(spell) end |
||
| + | |||
| + | ---@param index number |
||
| + | ---@param bookType string |
||
| + | ---@return SpellPowerCost[] costs |
||
| + | function GetSpellPowerCost(index, bookType) end |
||
| + | |||
| + | ---@type SpellPowerCost |
||
| + | ---@field minCost number |
||
| + | ---@field cost number |
||
| + | ---@field costPercent number |
||
| + | ---@field costPerSec number |
||
| + | ---@field type PowerType |
||
| + | ---@field name string |
||
| + | ---@field hasRequiredAura boolean |
||
| + | ---@field requiredAuraID number |
||
| + | --> |
||
Revision as of 04:51, 20 May 2022
 |
Automated updating of API pages at this location, to reflect patch changes, has ceased from 10.1.7 onwards. |
Returns a table describing the resource cost of a spell.
costs = GetSpellPowerCost(spell)
= GetSpellPowerCost(index, bookType)
Arguments
- spell
- number|string - Spell ID or Name.
- index
- number - Spellbook slot index, ranging from 1 through total number of spells across all tabs and pages.
- bookType
- string
| Constant | Value | Description |
|---|---|---|
| BOOKTYPE_SPELL | "spell" | The General, Class, Specs and Professions tabs[1] |
| BOOKTYPE_PET | "pet" | The Pet tab |
Returns
- costs
- table[]
| Key | Type | Description |
|---|---|---|
| minCost | number | minimum cost |
| cost | number | maximum cost |
| costPercent | number | percentual cost |
| costPerSec | number | The cost per second for channeled spells. |
| type | Enum.PowerType | powerType of the cost |
| name | string | powerToken: "MANA", "RAGE", "FOCUS", "ENERGY", "HAPPINESS", "RUNES", "RUNIC_POWER", "SOUL_SHARDS", "HOLY_POWER", "STAGGER", "CHI", "FURY", "PAIN", "LUNAR_POWER", "INSANITY" |
| hasRequiredAura | boolean | |
| requiredAuraID | number |
Details
- Returns an empty table if the spell has no resource cost.
- Reflects resource discounts provided by auras.
- requiredAuraID has a return value different than zero for 36 spells. Most are spellIDs associated with a hidden healing/damage modifier spec aura, one refers to
[Bear Form], two seem to be connected to Helya; some are honor talents, and some don't refer to a valid aura spellID. This return value mostly exists for spells that change their cost depending on which spec the player is in. - Some spells may have costs composed of multiple resource types. In this case, the
costsarray contains multiple tables. For example,GetSpellPowerCost("Rip")returns
{
{type=3, name="ENERGY", cost=30, minCost=30, costPercent=0, costPerSec=0, hasRequiredAura=false, requiredAuraID=0},
{type=4, name="COMBO_POINTS", cost=5, minCost=1, costPercent=0, costPerSec=0, hasRequiredAura=false, requiredAuraID=0}
}