GetStatistic

Main Menu
WoW API Lua API FrameXML util Widget API Widget scripts XML schema Events CVars Macro commands Combat Log Escape sequences Hyperlinks API changes HOWTOs wowuidev

Returns a character statistic.

value, skip, id = GetStatistic(category [, index])

Arguments

category

number - AchievementID of a statistic or statistic category.

index

number - Entry within a statistic category, if applicable.

Returns

value

string - Value of the statistic as displayed in-game.

skip

boolean - Prevents a statistic from being shown in the default UI.

id

string - Unknown.

Details

• Using the achievementID's of actual Achievements, as opposed to statistics, generates strange results. More testing is needed.
• Wrapping the returned value with tonumber() is necessary to do comparisons using math operators.

Example

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

function GetStatisticId(StatisticTitle)
	for _, CategoryId in pairs(GetStatisticsCategoryList()) do	
		for i = 1, GetCategoryNumAchievements(CategoryId) do
			local IDNumber, Name = GetAchievementInfo(CategoryId, i)
			if Name == StatisticTitle then
				return IDNumber
			end
		end		
	end
	return -1
end

Patch changes

Patch 5.4.0 (2013-09-10): Added multiple return values and optional argument.
Patch 3.0.2 (2008-10-14): Added.