WoW:API GetStatistic: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
mNo edit summary
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 ==
== Details ==
<!-- Details not appropriate for the main description can go here.
Using the achievementID's of actual Achievements, as opposed to statistics, generates strange results.  More testing is needed.
    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.


== Example ==
== Example ==

Revision as of 02:34, 17 May 2020

WoW API < GetStatistic

Return the value of the requested Statistic.

value = GetStatistic(achievementID)

Arguments

  • achievementID (number) - The ID of the Achievement

Returns

  • 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.

Example

Here is a function that will take any statistic category (like Battlegrounds) and any statistic title in that category (like Battlegrounds played) and will return the statistic ID for that statistic, so it can be used in other functions.

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