WoW:API GetXPExhaustion: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
m (Formatted properly)
Line 1: Line 1:
{{wowapi}} __NOTOC__
<!-- Describe the purpose of the function, exhausting detail can be saved for a later section -->
Returns the number of XP gained from killing mobs until "player" goes from rest state to normal state.
Returns the number of XP gained from killing mobs until "player" goes from rest state to normal state.


This is the total and not the amount added. For example, if this says 5000 then the next 5000 XP gained from mobs will occur at double rate. The game actually gives double XP for mobs while rested as an add on. An example, a mob worth 98 XP is killed, XP gained is 98 +98 rested XP bonus which reduces your 5000 by 196. If you take 1/2 the number then this is the XP bonus you are eligible for. ie. you will get +2500 rested bonus for earning 2500 XP from mobs for a total XP gain of 5000 during that time. When you hit 0 the bonus is small, for example say you have 20 left and you kill a mob worth 98 then you get 98 +10 rested bonus and go to the 'normal' non rested state. So if you rest in an inn and get this up to 2 then you will recieve +1 bonus XP from your next mob and not double XP from the mob.
<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->
retVal = GetXPExhaustion()
 
 
== Parameters ==
 
 
=== Returns ===
<!-- List each return value, together with its type -->
 
 
 
:;retVal : Number (if player is "rested")
:: nil (if player is "normal")
 
 
 


==Details==
<!-- Details not appropriate for the main description can go here.
    REMOVE the section if you're just going to restate the intro line! -->


----
: This is the total and not the amount added. For example, if this says 5000 then the next 5000 XP gained from mobs will occur at double rate. The game actually gives double XP for mobs while rested as an add on. An example, a mob worth 98 XP is killed, XP gained is 98 +98 rested XP bonus which reduces your 5000 by 196. If you take 1/2 the number then this is the XP bonus you are eligible for. ie. you will get +2500 rested bonus for earning 2500 XP from mobs for a total XP gain of 5000 during that time. When you hit 0 the bonus is small, for example say you have 20 left and you kill a mob worth 98 then you get 98 +10 rested bonus and go to the 'normal' non rested state. So if you rest in an inn and get this up to 2 then you will recieve +1 bonus XP from your next mob and not double XP from the mob.
{{WoW API}}

Revision as of 16:50, 18 July 2006

← WoW API < GetXPExhaustion


Returns the number of XP gained from killing mobs until "player" goes from rest state to normal state. 

retVal = GetXPExhaustion()


Parameters

Returns

retVal
Number (if player is "rested")
nil (if player is "normal")



Details

This is the total and not the amount added. For example, if this says 5000 then the next 5000 XP gained from mobs will occur at double rate. The game actually gives double XP for mobs while rested as an add on. An example, a mob worth 98 XP is killed, XP gained is 98 +98 rested XP bonus which reduces your 5000 by 196. If you take 1/2 the number then this is the XP bonus you are eligible for. ie. you will get +2500 rested bonus for earning 2500 XP from mobs for a total XP gain of 5000 during that time. When you hit 0 the bonus is small, for example say you have 20 left and you kill a mob worth 98 then you get 98 +10 rested bonus and go to the 'normal' non rested state. So if you rest in an inn and get this up to 2 then you will recieve +1 bonus XP from your next mob and not double XP from the mob.
Retrieved from "https://addonstudio.org/mw/index.php?title=WoW:API_GetXPExhaustion&oldid=8971"