WoW:API IsPassiveSpell: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
m (Forgot to change second argument)
m (Move page script moved page API IsPassiveSpell to API IsPassiveSpell without leaving a redirect)
 
(5 intermediate revisions by 5 users not shown)
Line 1: Line 1:
<center>'''IsSpellPassive''' ''-Documentation by [[user:Author|Myrrion aka Paul2200]]-''</center>
{{wowapi}}
 
<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->
 
if ( IsSpellPassive(spellID,bookType) )...
 
<!-- Describe the purpose of the function, though exhausting detail can be saved for a later section -->


Returns whether the icon in your spellbook is a Passive ability (not necessarily a spell). (And actually noted as so in spellbook)
Returns whether the icon in your spellbook is a Passive ability (not necessarily a spell). (And actually noted as so in spellbook)
isPassive = IsPassiveSpell(spellID, bookType);


----
==Arguments==
;''Arguments''
;spellID : Number: spellbook slot index, ascending from 1.
;bookType : Either '''BOOKTYPE_SPELL''' ("spell") or '''BOOKTYPE_PET''' ("pet"). "spell" is linked to your General Spellbook tab.


<!-- List each argument, together with its type -->
==Returns==
 
;isPassive : Flag : 1 if the spell is passive, nil otherwise.
:(spellID, bookType)
:;spellID : The slot number in your spellbook. Each page has 12 slots and the numbering continues throughout your entire spellbook, ignoring empty slots.
:;bookType : Either '''BOOKTYPE_SPELL''' ("spell") or '''BOOKTYPE_PET''' ("pet"). "spell" is linked to your General Spellbook tab.
 
----
;''Returns''
 
<!-- List each return value, together with its type -->
 
:1 or nil
 
:;1 : The "spell" is Passive
:;nil : The "spell" is not Passive
 
----
;''Example''
 
<!-- If it helps, include an example here, though it's not required if the usage is self-explanatory -->
 
message(IsSpellPassive(1,"spell"));
 
;''Result''
 
<!-- If it helps, include example results here, though they are not required-->
 
message box with a "1" or empty, depending on whether or not the very first icon in your spellbook is passive.
 
----
;''Details''
 
<!-- Details not appropriate for the main description can go here -->


==Details==
: With my Human Paladin, here are the "spells" I found to be Passive:
: With my Human Paladin, here are the "spells" I found to be Passive:
:: Block (Passive)
:: Block (Passive)
Line 54: Line 20:
:: Sword Specialization (Passive)
:: Sword Specialization (Passive)
:: The Human Spirit  (Racial Passive)
:: The Human Spirit  (Racial Passive)
----
{{Template:WoW API}}
<!-- Update the category to the appropriate subsection, and be sure to put the function name as the label for the category link. Multiple subcategories are okay if appropriate, please dont link functions to the API Functions category directly. -->
[[Category:API Functions|Empty Template]]

Latest revision as of 04:46, 15 August 2023

← WoW API < IsPassiveSpell

Returns whether the icon in your spellbook is a Passive ability (not necessarily a spell). (And actually noted as so in spellbook) 

isPassive = IsPassiveSpell(spellID, bookType);

Arguments[edit]

spellID
Number: spellbook slot index, ascending from 1.
bookType
Either BOOKTYPE_SPELL ("spell") or BOOKTYPE_PET ("pet"). "spell" is linked to your General Spellbook tab.

Returns[edit]

isPassive
Flag : 1 if the spell is passive, nil otherwise.

Details[edit]

With my Human Paladin, here are the "spells" I found to be Passive:
Block (Passive)
Diplomacy (Racial Passive)
Dodge (Passive)
Mace Specialization (Passive)
Parry (Passive)
Sword Specialization (Passive)
The Human Spirit (Racial Passive)
Retrieved from "https://addonstudio.org/mw/index.php?title=WoW:API_IsPassiveSpell&oldid=19477"