WoW:API GetInventoryAlertStatus: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
mNo edit summary
m (Move page script moved page API GetInventoryAlertStatus to API GetInventoryAlertStatus without leaving a redirect)
 
(6 intermediate revisions by 6 users not shown)
Line 1: Line 1:
<center>'''GetInventoryAlertStatus''' ''-Documentation by [[user:Moof|Moof]]-''</center>
{{wowapi}}
 
Returns one of several codes describing the "status" of an equipped item. The main use for this function is generalized durability checks.
Returns one of several codes describing the "status" of an equipped item. The main use for this function is generalized durability checks.
  alertStatus = GetInventoryAlertStatus("index");
  alertStatus = GetInventoryAlertStatus("index");


== Parameters ==
== Arguments ==
=== Arguments ===
; index : String - one of the following:
:index is one of the following:
:* Head
# Head
:* Shoulders
# Shoulders
:* Chest
# Chest
:* Waist
# Waist
:* Legs
# Legs
:* Feet
# Feet
:* Wrists
# Wrists
:* Hands
# Hands
:* Weapon
# Weapon
:* Shield
# Shield
:* Ranged
# Ranged
 
=== Returns ===
:alertStatus: One of the following:
*0 - Normal, ie not under any of the other conditions.
*1 - Temporarily enchanted. Poisons, weapon sharpeners, etc.
*2 - Unknown.
*3 - Durability is low. (Don't know exact % --Moof)
*4 - Broken.


==Details==
== Returns ==
: Used primarily for DurabilityFrame, the little thingy that comes up on the right under the minimap when your equipment is damaged or broken.
;alertStatus : Number - 0 for normal (6 or more durability points left), 1 for yellow (5 to 1 durability points left), 2 for broken (0 durability points left).


----
==Notes==
__NOTOC__
* Used primarily for DurabilityFrame, ie the armor man placed under the Minimap when your equipment is damaged or broken.
{{Template:WoW API}}
[[Category:API Functions|GetInventoryAlertStatus]]
[[Category:API Inventory Functions|GetInventoryAlertStatus]]

Latest revision as of 04:46, 15 August 2023

← WoW API < GetInventoryAlertStatus

Returns one of several codes describing the "status" of an equipped item. The main use for this function is generalized durability checks. 

alertStatus = GetInventoryAlertStatus("index");

Arguments[edit]

index
String - one of the following:
  • Head
  • Shoulders
  • Chest
  • Waist
  • Legs
  • Feet
  • Wrists
  • Hands
  • Weapon
  • Shield
  • Ranged

Returns[edit]

alertStatus
Number - 0 for normal (6 or more durability points left), 1 for yellow (5 to 1 durability points left), 2 for broken (0 durability points left).

Notes[edit]

  • Used primarily for DurabilityFrame, ie the armor man placed under the Minimap when your equipment is damaged or broken.
Retrieved from "https://addonstudio.org/mw/index.php?title=WoW:API_GetInventoryAlertStatus&oldid=19075"