WoW:API GetInventoryAlertStatus: Difference between revisions

Revision as of 01:27, 25 February 2010

Reference e
AddOns WoW API Widget API XML UI Event API WoW Lua Macro API CVars Battle.net HOWTOs Snippets UI tech Categories

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");

index

String - one of the following:

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).

Used primarily for DurabilityFrame, ie the armor man placed under the Minimap when your equipment is damaged or broken.

@@ Line 1: / Line 1: @@
 {{wowapi}}
 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");
-== 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, 6 or more durability left
-*1 - Durability is low, 5 to 1 durability left
-*2 - Broken, 0 durability left
-==Details==
+== Returns ==
-: Used primarily for DurabilityFrame, ie the armor man placed 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.