WoW:API GetLootMethod: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
m (Fix documentation to reflect returned values)
m (Move page script moved page API GetLootMethod to WoW:API GetLootMethod without leaving a redirect)
 
(4 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{wowapi}}
{{wowapi}}
 
Retrieves the Loot Method and (if applicable) Master Looter identity.
Retrieves the Loot Method and (if applicable) Master Looter idenity.
 
  lootmethod, masterlooterPartyID, masterlooterRaidID = GetLootMethod()
  lootmethod, masterlooterPartyID, masterlooterRaidID = GetLootMethod()
=== Returns ===
:lootmethod, masterlooterID, masterlooterRaidID
:;lootmethod : String - One of 'freeforall', 'roundrobin', 'master', 'group', 'needbeforegreed'. Appears to be 'freeforall' if you are not grouped.
:;masterlooterPartyID : Number - (When In 'master', nil otherwise) returns 0 if player is masterLooter, 1-4 if party memeber is masterLooter (corresponding to party1-4) and nil if masterLooter is in another Party of the raid.
:;masterlooterRaidID : Number - (When In 'master', nil otherwise) returns number of raid members if player is masterLooter, 1-40 if raid member is masterLooter (corresponding to raid1-40) and nil if the player is not in a raid.


----
== Returns ==
__NOTOC__
;lootmethod : String ([[LootMethod]]) - One of 'freeforall', 'roundrobin', 'master', 'group', 'needbeforegreed'. Appears to be 'freeforall' if you are not grouped.: At least as of 7.3 the possible return values appear to be "freeforall", "master", "group" and "personalloot". "roundrobin" and "needbeforegreed" appear to be deprecated.
;masterlooterPartyID : Number - Returns 0 if player is the mater looter, 1-4 if party member is master looter (corresponding to party1-4) and nil if the master looter isn't in the player's party or master looting is not used.
;masterlooterRaidID : Number - Returns index of the master looter in the raid (corresponding to a raidX unit), or nil if the player is not in a raid or master looting is not used.

Latest revision as of 04:46, 15 August 2023

WoW API < GetLootMethod

Retrieves the Loot Method and (if applicable) Master Looter identity.

lootmethod, masterlooterPartyID, masterlooterRaidID = GetLootMethod()

Returns

lootmethod
String (LootMethod) - One of 'freeforall', 'roundrobin', 'master', 'group', 'needbeforegreed'. Appears to be 'freeforall' if you are not grouped.: At least as of 7.3 the possible return values appear to be "freeforall", "master", "group" and "personalloot". "roundrobin" and "needbeforegreed" appear to be deprecated.
masterlooterPartyID
Number - Returns 0 if player is the mater looter, 1-4 if party member is master looter (corresponding to party1-4) and nil if the master looter isn't in the player's party or master looting is not used.
masterlooterRaidID
Number - Returns index of the master looter in the raid (corresponding to a raidX unit), or nil if the player is not in a raid or master looting is not used.