WoW:API GetPVPSessionStats: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(Updated for 2.0.1)
(Updated to match the current API boilerplate.)
Line 1: Line 1:
{{wowapi}}
{{wowapi}} __NOTOC__
 
 
Gets the amount of honorable kills and honor points you have for the current session ( today ).
Gets the amount of honorable kills and honor points you have for the current session ( today ).
local hk, hp = GetPVPSessionStats();


local hk, hp = GetPVPSessionStats();


== Parameters ==
=== Arguments ===
=== Arguments ===
None


None


----
=== Returns ===  
=== Returns ===  
:;hk : Integer - Amount of honorable kills you have today, returns 0 if you havn't killed anybody today.
:;hk : Integer - Amount of honorable kills you have today, returns 0 if you havn't killed anybody today.
:;hp : Integer - Estimated honor points for today
:;hp : Integer - Estimated honor points for today
----
 


=== Details ===
=== Details ===
Line 20: Line 19:
Used for retrieving how many honorable kills and honor points you have for today, currently the honor points value is calculated using the ''estimated'' honor points from killing an enemy player, and does not take diminishing returns or bonus honor into effect.
Used for retrieving how many honorable kills and honor points you have for today, currently the honor points value is calculated using the ''estimated'' honor points from killing an enemy player, and does not take diminishing returns or bonus honor into effect.


----
 
=== Example ===
=== Example ===
Displays how many honorable kills and estimated honor points you have for today.
Displays how many honorable kills and estimated honor points you have for today.

Revision as of 17:29, 25 June 2007

WoW API < GetPVPSessionStats


Gets the amount of honorable kills and honor points you have for the current session ( today ).

local hk, hp = GetPVPSessionStats();


Arguments

None


Returns

hk
Integer - Amount of honorable kills you have today, returns 0 if you havn't killed anybody today.
hp
Integer - Estimated honor points for today


Details

Used for retrieving how many honorable kills and honor points you have for today, currently the honor points value is calculated using the estimated honor points from killing an enemy player, and does not take diminishing returns or bonus honor into effect.


Example

Displays how many honorable kills and estimated honor points you have for today.

local hk, hp = GetPVPSessionStats();
DEFAULT_CHAT_FRAME:AddMessage( "You currently have " .. hk .. " honorable kills today, and an estimated " .. hp .. " honor points." );