WoW:API GetTradeSkillInfo: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
mNo edit summary
(Added missing return information on altVerb)
Line 4: Line 4:
Retrieves information about a specific trade skill.
Retrieves information about a specific trade skill.


  skillName, skillType, numAvailable, isExpanded = GetTradeSkillInfo(skillIndex)
  skillName, skillType, numAvailable, isExpanded, altVerb = GetTradeSkillInfo(skillIndex)


== Arguments ==
== Arguments ==
Line 18: Line 18:
:;numAvailable : Number - The number of items the player can craft with his available trade goods.
:;numAvailable : Number - The number of items the player can craft with his available trade goods.
:;isExpanded : Boolean - Returns if the header of the skillIndex is expanded in the crafting window or not
:;isExpanded : Boolean - Returns if the header of the skillIndex is expanded in the crafting window or not
:;altVerb: String - If not nil, a verb other than "Create" which describes the trade skill action (i.e., for Enchanting, this returns "Enchant"). If nil the expected verb is "Create."


== Example ==
== Example ==
Line 24: Line 25:
  local name, type;
  local name, type;
  for i=1,GetNumTradeSkills() do
  for i=1,GetNumTradeSkills() do
     name, type, _, _ = GetTradeSkillInfo(i);
     name, type, _, _, _ = GetTradeSkillInfo(i);
     if (name and type ~= "header") then
     if (name and type ~= "header") then
       DEFAULT_CHAT_FRAME:AddMessage("Found: "..name);
       DEFAULT_CHAT_FRAME:AddMessage("Found: "..name);

Revision as of 13:19, 26 January 2009

WoW API < GetTradeSkillInfo

Synopsis

Retrieves information about a specific trade skill.

skillName, skillType, numAvailable, isExpanded, altVerb = GetTradeSkillInfo(skillIndex)

Arguments

(skillIndex)
skillIndex
Number - The id of the skill you want to query.

Returns

skillName, skillType, numAvailable, isExpanded
skillName
String - The name of the skill, e.g. "Copper Breastplate" or "Daggers", if the skillIndex references to a heading.
skillType
String - Either "header", if the skillIndex references to a heading, or a string indicating the difficulty to craft the item ("trivial", "easy", "medium", "optimal", "difficult").
numAvailable
Number - The number of items the player can craft with his available trade goods.
isExpanded
Boolean - Returns if the header of the skillIndex is expanded in the crafting window or not
altVerb
String - If not nil, a verb other than "Create" which describes the trade skill action (i.e., for Enchanting, this returns "Enchant"). If nil the expected verb is "Create."

Example

local tradeSkillsNum;
local name, type;
for i=1,GetNumTradeSkills() do
   name, type, _, _, _ = GetTradeSkillInfo(i);
   if (name and type ~= "header") then
      DEFAULT_CHAT_FRAME:AddMessage("Found: "..name);
   end
end

Result

Displays all items the player is able to craft in the chat windows.

Details

Retrieves the name of the skill, the type of the skill and the amount the player can craft for a specific crafting skill.