WoW:API GetTradeSkillInfo: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
mNo edit summary
Line 1: Line 1:
<center>'''GetTradeSkillInfo''' ''-Documentation edited by wowpendium.de-''</center>
<center>'''GetTradeSkillInfo''' - ''Documentation edited by wowpendium.de''</center>


Retrieves the name of the skill, the type of the skill and the amount the player can craft for a specific crafting skill.  
== Synopsis ==
Retrieves information about a specific trade skill.


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


----
== Arguments ==
;''Arguments''
:(skillIndex)
:(Number skillIndex)


:;skillIndex : The id of the skill you want to query.
:;skillIndex : Number - The id of the skill you want to query.


----
== Returns ==
;''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.
:;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" (?), "optimal", "difficult").
:;skillType : String - Either "header", if the skillIndex references to a heading, or a string indicating the difficulty to craft the item ("trivial", "easy" (?), "optimal", "difficult").
:;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


----
== Example ==
;''Example''
<!-- begin code -->
  local tradeSkillsNum;
  local tradeSkillsNum;
  local name, type;
  local name, type;
Line 29: Line 29:
     end
     end
  end
  end
<!-- end code -->
==== Result ====
:Displays all items the player is able to craft in the chat windows.


;''Result''
== Details ==
 
: Retrieves the name of the skill, the type of the skill and the amount the player can craft for a specific crafting skill.
Displays all items the player is able to craft in the chat windows.
 
----
;''Description''
 
: Retrieves information about a specific trade skill.


----
----
__NOTOC__
{{Template:WoW API}}
{{Template:WoW API}}
[[Category:API TradeSkill Functions|GetTradeSkillInfo]]

Revision as of 07:20, 29 March 2005

GetTradeSkillInfo - Documentation edited by wowpendium.de

Synopsis

Retrieves information about a specific trade skill.

skillName, skillType, numAvailable, isExpanded = 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" (?), "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

Example

local tradeSkillsNum;
local name, type;
for i=1,GetNumTradeSkills() do
   name, type, _, _ = GetTradeSkillInfo(i);
   if (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.

Template:WoW API