WoW:API GetTradeSkillReagentInfo: Difference between revisions

WoW:API GetTradeSkillReagentInfo (source)

Revision as of 23:15, 23 December 2006

389 bytes removed , 23 December 2006

{{wowapi}}, format, steal example from GetTradeSkillNumReagents.

Anonymous user

WoWWiki>Starlightblunder

@@ Line 1: / Line 1: @@
- <center>'''GetTradeSkillReagentInfo''' ''-Documentation by [[User:Goldark|Goldark]]-''</center>
+{{wowapi}} __NOTOC__
 Returns information on reagents for the specified trade skill.
+ reagentName, reagentTexture, reagentCount, playerReagentCount = GetTradeSkillReagentInfo(tradeSkillRecipeId, reagentId);
- local reagentName, reagentTexture, reagentCount, playerReagentCount =
+==Parameters==
-    GetTradeSkillReagentInfo(tradeSkillRecipeId, reagentId);
+===Arguments===
-----
-;''Arguments''
-:(Number tradeSkillRecipeId, Number reagentId)
 :;tradeSkillRecipeId : The Id of the tradeskill recipe
 :;reagentId : The Id of the reagent (from 1 to x, where x is the result of calling [[API GetTradeSkillNumReagents|GetTradeSkillNumReagents]])
+===Returns===
+:; reagentName : String - The name of the reagent.
+:; reagentTexture : String - The texture for the reagent's icon.
+:; reagentCount : Integer - The quantity of this reagent required to make one of these items.
+:; playerReagentCount : Integer - The quantity of this reagent in the player's inventory.
-----
+==Example==
-;''Returns''
-: String reagentName, String reagentTexture, Integer reagentCount, Integer playerReagentCount
-:; reagentName : The name of the reagent.
-:; reagentTexture : The texture for the reagent's icon.
-:; reagentCount : The quantity of this reagent required to make one of these items.
-:; playerReagentCount : The quantity of this reagent in the player's inventory.
-----
-;''Example''
   local numReagents = GetTradeSkillNumReagents(id);
+ local totalReagents = 0;
   for i=1, numReagents, 1 do
     local reagentName, reagentTexture, reagentCount, playerReagentCount = GetTradeSkillReagentInfo(id, i);
-    SetItemButtonTexture(reagent, reagentTexture);
+    totalReagents = totalReagents + reagentCount;
-   name:SetText(reagentName);
-   -- Grayout items
-   if ( playerReagentCount < reagentCount ) then
-     SetItemButtonTextureVertexColor(reagent, 0.5, 0.5, 0.5);
-     name:SetTextColor(GRAY_FONT_COLOR.r, GRAY_FONT_COLOR.g, GRAY_FONT_COLOR.b);
-     creatable = nil;
-   end;
   end;
+===Result===
+Calculates the total number of items required by the recipe.
-----
-{{WoW API}}