WoW:API GetMasterLootCandidate: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
m (Reformat.)
Line 1: Line 1:
<center>'''GetMasterLootCandidate''' ''-Documentation by [[User:Haarm|Haarm]]-''</center>
{{wowapi}} __NOTOC__
 
Returns the name of the player at the specified index, who would receive an item assigned by [[API GiveMasterLoot|GiveMasterLoot(slot, index)]] using the same index.
Returns the name of the player at the specified index, who would receive an item assigned by [[API GiveMasterLoot|GiveMasterLoot(slot, index)]] using the same index.


candidate = GetMasterLootCandidate(index);
candidate = GetMasterLootCandidate(index);


----
== Parameters ==
;''Arguments''
=== Arguments ===


:;index : The number of the player whose name you wish to return. Typically between 1 and [[API GetNumRaidMembers|GetNumRaidMembers()]]
:;index : The number of the player whose name you wish to return. Typically between 1 and [[API GetNumRaidMembers|GetNumRaidMembers()]]
----
 
;''Returns''
=== Returns ===


:;candidate : The name of the player at '''index'''.
:;candidate : The name of the player at '''index'''.
----
 
;''Example''
== Example ==
  for i = 1, GetNumRaidMembers() do
  for i = 1, GetNumRaidMembers() do
   DEFAULT_CHAT_FRAME:AddMessage(i.." -> "..GetMasterLootCandidate(i))
   DEFAULT_CHAT_FRAME:AddMessage(i.." -> "..GetMasterLootCandidate(i))
  end
  end


;''Result''
Lists master loot candidates by index.  - These are the people capable of receiving loot from the Master Looter.  This function is only useable by the master looter.


Lists master loot candidates by index.  - These are the people capable of receiving loot from the Master Looter.  This function is only useable by the master looter.
== See Also ==
----
;''See Also''


:* [[API GetNumRaidMembers|GetNumRaidMembers()]]
:* [[API GetNumRaidMembers|GetNumRaidMembers()]]
:* [[API GiveMasterLoot|GiveMasterLoot(slot, index)]]
:* [[API GiveMasterLoot|GiveMasterLoot(slot, index)]]
----
 
;''Features / Bugs''
== Notes ==
This appears not to work unless you are the master looter, and not until the list of candidates has been built by the system, which looks like after you first try and assign an item.
This appears not to work unless you are the master looter, and not until the list of candidates has been built by the system, which looks like after you first try and assign an item.


Also if you were master looter of a group, and then join another group later and are not the master looter, it will return the names of candidates from your previous group.
Also if you were master looter of a group, and then join another group later and are not the master looter, it will return the names of candidates from your previous group.
-- [[User:Haarm|Haarm]]
-- [[User:Haarm|Haarm]]
{{Template:WoW API}}

Revision as of 02:23, 21 June 2006

WoW API < GetMasterLootCandidate

Returns the name of the player at the specified index, who would receive an item assigned by GiveMasterLoot(slot, index) using the same index.

candidate = GetMasterLootCandidate(index);

Parameters

Arguments

index
The number of the player whose name you wish to return. Typically between 1 and GetNumRaidMembers()

Returns

candidate
The name of the player at index.

Example

for i = 1, GetNumRaidMembers() do
 DEFAULT_CHAT_FRAME:AddMessage(i.." -> "..GetMasterLootCandidate(i))
end

Lists master loot candidates by index. - These are the people capable of receiving loot from the Master Looter. This function is only useable by the master looter.

See Also

Notes

This appears not to work unless you are the master looter, and not until the list of candidates has been built by the system, which looks like after you first try and assign an item.

Also if you were master looter of a group, and then join another group later and are not the master looter, it will return the names of candidates from your previous group. -- Haarm