WoW:API GetStatistic: Difference between revisions

m
Move page script moved page API GetStatistic to WoW:API GetStatistic without leaving a redirect
m (stub for testing results)
m (Move page script moved page API GetStatistic to WoW:API GetStatistic without leaving a redirect)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{stub/API}}
{{wowapi}} __NOTOC__
{{wowapi}} __NOTOC__


<!-- Describe the purpose of the function, exhausting detail can be saved for a later section -->
Return the value of the requested Statistic.
Return the value of the requested Statistic.
<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->
 
  value = GetStatistic(achievementID)
  value = GetStatistic(achievementID)


== Arguments ==
== Arguments ==
<!-- List each argument, together with its type -->
* achievementID (number) - The ID of the Achievement
:(achievementID)
 
:;achievementID : Integer - The ID of the Achievement
 


== Returns ==
== Returns ==
* value (string) - The value of the requested Statistic.


:;value : String - The value of the requested Statistic.
== Details ==
Using the achievementID's of actual Achievements, as opposed to statistics, generates strange results.  More testing is needed.


== Details ==
== Example ==
<!-- Details not appropriate for the main description can go here.  
Here is a function that will take any statistic category (like <code>Battlegrounds</code>) and any statistic title in that category (like <code>Battlegrounds played</code>) and will return the statistic ID for that statistic, so it can be used in other functions.
    REMOVE the section if you're just going to restate the intro line! -->


: Using the achievementID's of actual Achievements, as opposed to statistics, generates strange results.  More testing is needed.
<pre>
function GetStatisticId(CategoryTitle, StatisticTitle)
local str = ""
for _, CategoryId in pairs(GetStatisticsCategoryList()) do
local Title, ParentCategoryId, Something
Title, ParentCategoryId, Something = GetCategoryInfo(CategoryId)
if Title == CategoryTitle then
local i
local statisticCount = GetCategoryNumAchievements(CategoryId)
for i = 1, statisticCount do
local IDNumber, Name, Points, Completed, Month, Day, Year, Description, Flags, Image, RewardText
IDNumber, Name, Points, Completed, Month, Day, Year, Description, Flags, Image, RewardText = GetAchievementInfo(CategoryId, i)
if Name == StatisticTitle then
return IDNumber
end
end
end
end
return -1
end
</pre>
Anonymous user