WoW:API GetTrainerServiceInfo: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m (Move page script moved page API GetTrainerServiceInfo to API GetTrainerServiceInfo without leaving a redirect) |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{ | {{wowapi}} | ||
Returns information about a trainer service. | |||
name, rank, category, expanded = GetTrainerServiceInfo(id); | |||
---- | |||
;''Arguments'' | |||
:; id : Index of the trainer service to retrieve information about. Note that indices are affected by the trainer filter. (See [[API_GetTrainerServiceTypeFilter|GetTrainerServiceTypeFilter]] and [[API_SetTrainerServiceTypeFilter|SetTrainerServiceTypeFilter]].) | |||
---- | |||
;''Returns'' | |||
:; name : (String) Name of the spell or the header (i.e. "Arcane Explosion" or "Fire"). | |||
:; rank : (String) Rank of the spell, if applicable. Headers return empty strings. | |||
:; category : (String) "used" (already have the spell), "unavailable" (can not train this skill), "available" (can train this skill) and "header". | |||
:; expanded : (Number) nil if this is a collapsed header (category == "header"), 1 otherwise. (See [[API_CollapseTrainerSkillLine|CollapseTrainerSkillLine]] and [[API_ExpandTrainerSkillLine|ExpandTrainerSkillLine]].) | |||
---- | |||
;''Example'' | |||
Prints the list of trainable spells when interacting with a trainer. | |||
local i, name, rank, category; | |||
for i=1,GetNumTrainerServices() do | |||
name, rank, category = GetTrainerServiceInfo(i); | |||
if (name == nil) then | |||
break; -- GetNumTrainerServices() does not check if you're talking to a trainer or not. | |||
end | |||
if (category == "available") then | |||
DEFAULT_CHAT_FRAME:AddMessage(name .. " (" .. rank .. ")"); | |||
end | |||
end | |||
== Patch changes == | |||
{{Patch 4.0.1|note=New return values: name (String), subType (String), category (String), texture (String), requiredLevel (Number), topServiceLine (Number).}} | |||
Latest revision as of 04:46, 15 August 2023
← WoW API < GetTrainerServiceInfo
Returns information about a trainer service.
name, rank, category, expanded = GetTrainerServiceInfo(id);
- Arguments
- id
- Index of the trainer service to retrieve information about. Note that indices are affected by the trainer filter. (See GetTrainerServiceTypeFilter and SetTrainerServiceTypeFilter.)
- Returns
- name
- (String) Name of the spell or the header (i.e. "Arcane Explosion" or "Fire").
- rank
- (String) Rank of the spell, if applicable. Headers return empty strings.
- category
- (String) "used" (already have the spell), "unavailable" (can not train this skill), "available" (can train this skill) and "header".
- expanded
- (Number) nil if this is a collapsed header (category == "header"), 1 otherwise. (See CollapseTrainerSkillLine and ExpandTrainerSkillLine.)
- Example
Prints the list of trainable spells when interacting with a trainer.
local i, name, rank, category;
for i=1,GetNumTrainerServices() do
name, rank, category = GetTrainerServiceInfo(i);
if (name == nil) then
break; -- GetNumTrainerServices() does not check if you're talking to a trainer or not.
end
if (category == "available") then
DEFAULT_CHAT_FRAME:AddMessage(name .. " (" .. rank .. ")");
end
end
Patch changes[edit]
Template:Wotlk-inline/Template:Cata-inline <span style="" title="Patch 4.0.1">Patch 4.0.1</span> (patch date::12-Oct-2010): New return values: name (String), subType (String), category (String), texture (String), requiredLevel (Number), topServiceLine (Number).