LibXPBonus
A library to help with XP bonus buffs.
It contains a list of the XP bonus buffs (abilityId) and some API functions to check if you got a specific buff, or any buff, of these active.
[Planned features]
None
Where is the data?
Your instance of LibXPBonus contains 1 "local" internal table "XPBonusData" with the abilityId of teh XP Bonus buff as key.
API functions of the library:
Lua Code:
--Global variable of the library to access it:
LibXPBonus
Last scanned character buffs:
LibXPBonus.currentPlayerBuffs
Contains a table with this info:
Code:
currentPlayerBuffs[abilityId] = {
["name"] = buffName,
["startTime"] = startTimeInMilliseconds,
["endTime"] = endTimeTimeInMilliseconds,
["timeLeft"] = timeLeftInMilliseconds,
["startTimeFormatted"] = formattedStartTimeWithFormatFrom os.time,
["endTimeFormatted"] = formattedEndTimeWithFormatFrom os.time,
["timeLeftFormatted"] = formattedTimeLeftWithFormatFrom os.time ,
["buffSlot"] = buffSlot,
["stackCount"] = stackCount,
["iconFile"] = iconFile,
["buffType"] = buffType,
["effectType"] = effectType,
["abilityType"] = abilityType,
["statusEffectType"] = statusEffectType,
["abilityId"] = abilityId,
["canClickOff"] = canClickOff,
}
--> These values are determiend via this API function (except teh formatted time entries!):
Code:
--** _Returns: _buffName_, _timeStarted_, _timeEnding_, _buffSlot_, _stackCount_, _iconFilename_, _buffType_, _effectType_, _abilityType_, _statusEffectType_, _abilityId_, _canClickOff_ = GetUnitBuffInfo("player", buffIndex)
The buffIndex starts at 1 and the maximum is given via API function:
Code:
GetNumBuffs("player")
API functions
Lua Code:
--Returns true if the player got an XP bonus currently ative
--> Returns: boolean isXPBonusActive
--> NILABLE number abilityIdFound (the abilityId of the XPBuff found)
function LibXPBonus.IsAnyXPBonusActive()
--Returns true if the player got the XP bonus currently ative, provided with parameter abilityId
--abilityId: AbilityId of an ability e.g. the XP buff
--> Returns: boolean isXPBonusActive
function LibXPBonus.IsXPBonusActive(abilityId)
--Returns a table containing the current player buffs, with the info determined via API function GetUnitBuffInfo()
--> NILABLE Boolean formattedTime: Should the output table contain the entries for the formatted time?
--> NILABLE String timeFormat: Will only be used if parameter formattedTime == true. If timeFormat is left empty "", the standard format will be used.
---> Else the function os.time will be used to use the given format string. Check the possible values for os.time in the lua docs please!
--> Returns: table currentPlayerBuffsInfo
--[[
currentPlayerBuffsInfo[abilityId] = {
["name"] = buffName,
["startTime"] = startTime,
["endTime"] = endTime,
["startTimeFormatted"] = startTimeFormattedWithParameter timeFormat (via os.time function)
["endTimeFormatted"] = endTimeFormattedWithParameter timeFormat (via os.time function)
["timeLeftFormatted"] = timeLeftFormattedWithParameter timeFormat (via os.time function)
["buffSlot"] = buffSlot,
["stackCount"] = stackCount,
["iconFile"] = iconFile,
["buffType"] = buffType,
["effectType"] = effectType,
["abilityType"] = abilityType,
["statusEffectType"] = statusEffectType,
["abilityId"] = abilityId,
["canClickOff"] = canClickOff,
}
]]
function LibXPBonus.GetCurrentPlayerBuffs(formattedTime, timeFormat)
--Returns a table of the active XP bonus buffs, with the info determined via API function GetUnitBuffInfo()
--> NILABLE Boolean formattedTime: Should the output table contain the entries for the formatted time?
--> NILABLE String timeFormat: Will only be used if parameter formattedTime == true. If timeFormat is left empty "", the standard format will be used.
---> Else the function os.time will be used to use the given format string. Check the possible values for os.time in the lua docs please!
--> Returns: table currentPlayerBuffsXPBonusInfo
--[[
currentPlayerBuffsXPBonusInfo[abilityId] = {
["name"] = buffName,
["startTime"] = startTime,
["endTime"] = endTime,
["startTimeFormatted"] = startTimeFormattedWithParameter timeFormat (via os.time function)
["endTimeFormatted"] = endTimeFormattedWithParameter timeFormat (via os.time function)
["timeLeftFormatted"] = timeLeftFormattedWithParameter timeFormat (via os.time function)
["buffSlot"] = buffSlot,
["stackCount"] = stackCount,
["iconFile"] = iconFile,
["buffType"] = buffType,
["effectType"] = effectType,
["abilityType"] = abilityType,
["statusEffectType"] = statusEffectType,
["abilityId"] = abilityId,
["canClickOff"] = canClickOff,
}
]]
function LibXPBonus.GetCurrentPlayerXPBonusBuffs(formattedTime, timeFormat)
GitHub - If you want to contribute
Currently not on GitHub
