WoW:API GetCritChance - Revision history

Move page script: Move page script moved page API GetCritChance to WoW:API GetCritChance without leaving a redirect

2023-08-15T04:45:52Z

Move page script moved page API GetCritChance to API GetCritChance without leaving a redirect

← Older revision

Revision as of 04:45, 15 August 2023

WoWWiki>Ravas: Updated to match the current API boilerplate.

2007-06-25T17:16:32Z

Updated to match the current API boilerplate.

← Older revision		Revision as of 17:16, 25 June 2007
Line 1:		Line 1:
	{{wowapi}}		{{wowapi}} __NOTOC__
	~~{{Stub/API}}~~

			Gets the player's critical hit chance percentage.
			critChance = GetCritChance()


			== Arguments ==
			:none


	=== Returns ===		=== Returns ===
	:The player's melee critical hit chance in an unformatted, floating-point figure.		:; critChance : Number - The player's melee critical hit chance in an unformatted, floating-point figure.

WoWWiki>Pcj at 16:55, 25 June 2007

2007-06-25T16:55:08Z

← Older revision		Revision as of 16:55, 25 June 2007
Line 1:		Line 1:
	{{wowapi}}		{{wowapi}}
			{{Stub/API}}
	=== Returns ===		=== Returns ===
	:The player's melee critical hit chance in an unformatted, floating-point figure.		:The player's melee critical hit chance in an unformatted, floating-point figure.

WoWWiki>Hobinbot: upgraded deprecated template

2007-01-06T17:32:33Z

upgraded deprecated template

← Older revision		Revision as of 17:32, 6 January 2007
Line 1:		Line 1:
			{{wowapi}}
	=== Returns ===		=== Returns ===
	:The player's melee critical hit chance in an unformatted, floating-point figure.		:The player's melee critical hit chance in an unformatted, floating-point figure.

	~~----~~
	~~{{WoW API}}~~

WoWWiki>Patchtimer at 14:02, 19 December 2006

2006-12-19T14:02:24Z

@@ Line 1: / Line 1: @@
 === Returns ===
-:Player's critical hit chance, in percentage (''without the % symbol'').
+:The player's melee critical hit chance in an unformatted, floating-point figure.
 ----
 {{WoW API}}

WoWWiki>CaptainQ at 20:36, 23 August 2006

2006-08-23T20:36:04Z

← Older revision		Revision as of 20:36, 23 August 2006
Line 33:		Line 33:
	:'''Note''': Sometimes, the percentage returned would include a '''lot''' of decimals, hence the usage of [http://www.lua.org/manual/5.0/manual.html#5.5 math.ceil()]] here to round up the number to the nearest decimal.		:'''Note''': Sometimes, the percentage returned would include a '''lot''' of decimals, hence the usage of [http://www.lua.org/manual/5.0/manual.html#5.5 math.ceil()]] here to round up the number to the nearest decimal.

	== ~~Exemples~~ ==		== Examples ==
	Simply call the function and display it, like this:		Simply call the function and display it, like this:
	<!-- begin code -->		<!-- begin code -->

WoWWiki>C0ldfusi0n: Added 1.10 fix to GameTooltip -- :SetOwner

2006-04-06T16:53:22Z

Added 1.10 fix to GameTooltip -- :SetOwner

← Older revision		Revision as of 16:53, 6 April 2006
Line 18:		Line 18:
	end		end
	end		end
			[[Widget API#GameTooltip\|GameTooltip:SetOwner]](WorldFrame,"ANCHOR_NONE");
	[[Widget API#GameTooltip\|GameTooltip:SetSpell]](id, [[WoW Constants#Miscellaneous\|BOOKTYPE_SPELL]]);		[[Widget API#GameTooltip\|GameTooltip:SetSpell]](id, [[WoW Constants#Miscellaneous\|BOOKTYPE_SPELL]]);
	local spellName = [[Widget API#GameTooltip\|GameTooltipTextLeft2:GetText()]];		local spellName = [[Widget API#GameTooltip\|GameTooltipTextLeft2:GetText()]];

WoWWiki>Muert at 04:50, 4 January 2006

2006-01-04T04:50:28Z

← Older revision		Revision as of 04:50, 4 January 2006
Line 56:		Line 56:
	Much of this [[GetCritChance\|GetCritChance()]] function was taken and (slightly) modified from [http://ui.worldofwar.net/ui.php?id=722 mercdev's Combat Info] ([http://www.curse-gaming.com/mod.php?addid=1208 alt]) for [[Titan_Panel\|Titan Panel]]. Thanks to him.		Much of this [[GetCritChance\|GetCritChance()]] function was taken and (slightly) modified from [http://ui.worldofwar.net/ui.php?id=722 mercdev's Combat Info] ([http://www.curse-gaming.com/mod.php?addid=1208 alt]) for [[Titan_Panel\|Titan Panel]]. Thanks to him.

	~~[[Category:HOWTOs]]~~		----
	~~[[Category:~~API ~~Functions]]~~		{{WoW API}}
	~~[[Category:API Character Functions]]~~

WoWWiki>C0ldfusi0n: Function to return critical hit chance

2005-10-30T11:44:38Z

Function to return critical hit chance

New page

Since there are functions incorporated in the [[World of Warcraft API|WoW API]] to return [[API GetParryChance|parry]], [[API GetDodgeChance|dodge]] and [[API GetBlockChance|block]] chances but none to return critical hit chance, here is a [[GetCritChance|GetCritChance()]] function that will do so.

== GetCritChance() ==
=== Function code ===

function GetCritChance()
local critChance, iCritInfo, critNum;
local id = 1;
''-- This may vary depending on WoW localizations.''
local atkName = "Attack";
local attackSpell = [[API GetSpellName|GetSpellName]](id,[[WoW Constants#Miscellaneous|BOOKTYPE_SPELL]]);
if (attackSpell ~= atkName) then
name, texture, offset, numSpells = [[API GetSpellTabInfo|GetSpellTabInfo]](1);
for i=1, numSpells do
if ([[API GetSpellName|GetSpellName]](i,[[WoW Constants#Miscellaneous|BOOKTYPE_SPELL]]) == atkName) then
id = i;
end
end
end
[[Widget API#GameTooltip|GameTooltip:SetSpell]](id, [[WoW Constants#Miscellaneous|BOOKTYPE_SPELL]]);
local spellName = [[Widget API#GameTooltip|GameTooltipTextLeft2:GetText()]];
[[Widget API#GameTooltip|GameTooltip:Hide()]];
iCritInfo = string.find(spellName, "%s");
critNum = string.sub(spellName,0,(iCritInfo -2));
critChance = math.ceil(critNum);
return critChance;
end


=== Returns ===
:Player's critical hit chance, in percentage (''without the % symbol'').
:'''Note''': Sometimes, the percentage returned would include a '''lot''' of decimals, hence the usage of [http://www.lua.org/manual/5.0/manual.html#5.5 math.ceil()]] here to round up the number to the nearest decimal.

== Exemples ==
Simply call the function and display it, like this:

-- Will display your critical hit chance in your default chat frame.
DEFAULT_CHAT_FRAME:AddMessage("Your crit chance is: "..[[GetCritChance|GetCritChance()]].."%");


You can also use this code for a more thorough display:

-- Will send a "SAY" message (/s) with your [[GetCritChance|crit]], [[API GetDodgeChance|dodge]], [[API GetParryChance|parry]] and [[API GetBlockChance|block]] chances in percentage.
[[API SendChatMessage|SendChatMessage]]("My crit chance is: "..[[GetCritChance|GetCritChance()]].."%","SAY");
[[API SendChatMessage|SendChatMessage]]([[API UnitName|UnitName('player')]].."'s chances to...","SAY");
[[API SendChatMessage|SendChatMessage]]("Crit: "..[[GetCritChance|GetCritChance()]].."%","SAY");
[[API SendChatMessage|SendChatMessage]]("Dodge: "..[[API GetDodgeChance|GetDodgeChance()]].."%","SAY");
[[API SendChatMessage|SendChatMessage]]("Parry: "..[[API GetParryChance|GetParryChance()]].."%","SAY");
[[API SendChatMessage|SendChatMessage]]("Block: "..[[API GetBlockChance|GetBlockChance()]].."%","SAY");


== How it works ==
This function simply loops through your spellbook ([[WoW Constants#Miscellaneous|BOOKTYPE_SPELL]]) for your regular melee attack skill and then grabs the text from the skill's tooltip using [[Widget API#GameTooltip|GameTooltip]] functions (the tooltip of the regular melee attack is the only place where the crit chance is displayed).

== Credits ==
Much of this [[GetCritChance|GetCritChance()]] function was taken and (slightly) modified from [http://ui.worldofwar.net/ui.php?id=722 mercdev's Combat Info] ([http://www.curse-gaming.com/mod.php?addid=1208 alt]) for [[Titan_Panel|Titan Panel]]. Thanks to him.

[[Category:HOWTOs]]
[[Category:API Functions]]
[[Category:API Character Functions]]