WoW:API SetLootThreshold: Difference between revisions

Latest revision as of 04:47, 15 August 2023

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

Sets the loot quality threshold as a number for the party or raid.

SetLootThreshold(threshold)

threshold: Number - The loot quality to start using the current loot method with.

0 - Poor 1 - Common 2 - Uncommon 3 - Rare 4 - Epic 5 - Legendary 6 - Artifact

/script SetLootThreshold(2)

Result

If you are the party or raid leader, the script will set the loot threshold to Uncommon(green) items or better and report its new status.

Setting loot threshold below Uncommon(green) will result in an error.
Calling this while the loot method is changing will revert to the original loot method. To account for this I simply set the loot threshold 1 second after calling API_SetLootMethod

@@ Line 1: / Line 1: @@
-{{wowapi}}
+{{wowapi}} __NOTOC__
-Sets the loot quality threshold as a number for the party/raid loot method.<br>
-<br>
-;;arg1
+Sets the loot quality threshold as a number for the party or raid.
-: Integer - a value from 0 to 6 indicating loot threshold<br>
+ SetLootThreshold(threshold)
-- Poor<br>
-- Common<br>
+== Arguments ==
-- Uncommon<br>
+:; threshold : Number - The loot quality to start using the current loot method with.
-- Rare<br>
+:;:* 0 - Poor
-- Epic<br>
+:;:* 1 - Common
-- Legendary<br>
+:;:* 2 - Uncommon
-- Artifact<br>
+:;:* 3 - Rare
-<br>
+:;:* 4 - Epic
+:;:* 5 - Legendary
+:;:* 6 - Artifact
+== Example ==
   /script SetLootThreshold(2)
-If you're the party/raid leader, the example above will set the loot threshold to Uncommon(green) items or better and report its new status.<br>
+<big>'''Result'''</big>
+If you are the party or raid leader, the script will set the loot threshold to Uncommon(green) items or better and report its new status.
+== Notes ==
+* Setting loot threshold below Uncommon(green) will result in an error.
+* Calling this while the loot method is changing will revert to the original loot method.  To account for this I simply set the loot threshold 1 second after calling [[API_SetLootMethod]]