WoW:API RollOnLoot: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
m (Remove singatures made using ~ in main namespace)
mNo edit summary
Line 1: Line 1:
{{wowapi}}
{{wowapi}}
<center>'''RollOnLoot'''</center>


  RollOnLoot(RollID{,roll});
  RollOnLoot(RollID{,roll});
Line 42: Line 41:


:Will display a message when you roll or pass on a roll. This could easily be changed to record how many times you roll on loot.
:Will display a message when you roll or pass on a roll. This could easily be changed to record how many times you roll on loot.
----
-Documentation by

Revision as of 16:33, 4 December 2007

WoW API < RollOnLoot

RollOnLoot(RollID{,roll});

Roll on the Loot roll identified with Rollid, roll is nil when passing, otherwise it uses 1 to roll on loot.


Arguments
(required)
Rollid
Number - The number increases with every roll you have in a party. Till how high it counts is currently unknown.


(Optional)
roll
Number/nil - Is the roll a pass on the item or a real roll? send nil to pass on the item, send 1 to roll.
Note: Blizzard uses 0 to pass, 1 to Need an item and 2 to Greed an item.

Returns
Nothing

Example
Hooks the function
Pre_WoW_Rollonloot = RollOnLoot;
RollOnLoot = YourAddon_RollOnLoot;
Run the new function
function YourAddon_RollOnLoot(Rollid, roll)
 if (roll ~= nil) then
   DEFAULT_CHAT_FRAME:AddMessage("You rolled on the item with id: " .. Rollid );
 else
   DEFAULT_CHAT_FRAME:AddMessage("You passed on the item with id: " .. Rollid );
 end
 Pre_WoW_Rollonloot(id, roll);
end
Result
Will display a message when you roll or pass on a roll. This could easily be changed to record how many times you roll on loot.