VikingXPBar.lua

-----------------------------------------------------------------------------------------------
-- Client Lua Script for VikingXPBar
-- Copyright (c) NCsoft. All rights reserved
-----------------------------------------------------------------------------------------------

require "Window"
require "Apollo"
require "GameLib"
require "GroupLib"
require "PlayerPathLib"

local VikingLib
local VikingXPBar = {
  _VERSION = 'VikingXPBar.lua 0.1.0',
  _URL     = 'https://github.com/vikinghug/VikingXPBar',
  _DESCRIPTION = '',
  _LICENSE = [[
    MIT LICENSE

    Copyright (c) 2014 Kevin Altman

    Permission is hereby granted, free of charge, to any person obtaining a
    copy of this software and associated documentation files (the
    "Software"), to deal in the Software without restriction, including
    without limitation the rights to use, copy, modify, merge, publish,
    distribute, sublicense, and/or sell copies of the Software, and to
    permit persons to whom the Software is furnished to do so, subject to
    the following conditions:

    The above copyright notice and this permission notice shall be included
    in all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
    OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
    IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
    CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
    TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
    SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  ]]
}

local knMaxLevel = 50 -- TODO: Replace with a variable from code
local knMaxPathLevel = 30 -- TODO: Replace this with a non hardcoded value

-- Enumeration that controls what is displayed in the path bar:
---- Automatic: Show Path XP unless both path and player level is at max
---- Path XP: Show Path XP
---- Periodic EP: Show percentage of periodic EP cap
local PathBarMode_Automatic = 0
local PathBarMode_PathXP = 1
local PathBarMode_PeriodicEP = 2

local ktPathIcon = {
  [PlayerPathLib.PlayerPathType_Soldier]    = "ClientSprites:Icon_Windows_UI_CRB_Soldier",
  [PlayerPathLib.PlayerPathType_Settler]    = "ClientSprites:Icon_Windows_UI_CRB_Colonist",
  [PlayerPathLib.PlayerPathType_Scientist]  = "ClientSprites:Icon_Windows_UI_CRB_Scientist",
  [PlayerPathLib.PlayerPathType_Explorer]   = "ClientSprites:Icon_Windows_UI_CRB_Explorer",
}

local c_arPathStrings = {
  [PlayerPathLib.PlayerPathType_Soldier]    = "CRB_Soldier",
  [PlayerPathLib.PlayerPathType_Settler]    = "CRB_Settler",
  [PlayerPathLib.PlayerPathType_Scientist]  = "CRB_Scientist",
  [PlayerPathLib.PlayerPathType_Explorer]   = "CRB_Explorer",
}

local kstrDefaultIcon = "CRB_DatachronSprites:sprDC_BluePlayRing"

local kstrRed = "ffff4040"
local kstrOrange = "ffffd100"
local kstrBlue = "ff32fcf6"
local kstrDarkBlue = "ff209d99"

function VikingXPBar:new(o)
    o = o or {}
    setmetatable(o, self)
    self.__index = self
    return o
end

-------- HELPER FUNCTIONS
local function Round(t)
  return (math.floor(10*t-0.5)+1) / 10.0
end
-------- END HELPER FUNCTIONS

function VikingXPBar:Init()
    Apollo.RegisterAddon(self, nil, nil, {"VikingLibrary"})
end

function VikingXPBar:OnLoad()
  self.xmlDoc = XmlDoc.CreateFromFile("VikingXPBar.xml")
  self.xmlDoc:RegisterCallback("OnDocumentReady", self)
end

function VikingXPBar:OnDocumentReady()
  Apollo.RegisterEventHandler("ChangeWorld",          "OnClearCombatFlag", self)
  Apollo.RegisterEventHandler("ShowResurrectDialog",      "OnClearCombatFlag", self)
  Apollo.RegisterEventHandler("UnitEnteredCombat",      "OnEnteredCombat", self)

  Apollo.RegisterEventHandler("Group_MentorRelationship",   "RedrawAll", self)
  Apollo.RegisterEventHandler("CharacterCreated",       "RedrawAll", self)
  Apollo.RegisterEventHandler("UnitPvpFlagsChanged",      "RedrawAll", self)
  Apollo.RegisterEventHandler("UnitNameChanged",        "RedrawAll", self)
  Apollo.RegisterEventHandler("PersonaUpdateCharacterStats",  "RedrawAll", self)
  Apollo.RegisterEventHandler("PlayerLevelChange",      "RedrawAll", self)
  Apollo.RegisterEventHandler("UI_XPChanged",         "OnXpChanged", self)
  Apollo.RegisterEventHandler("ElderPointsGained",      "OnXpChanged", self)
  Apollo.RegisterEventHandler("OptionsUpdated_HUDPreferences","RedrawAll", self)

  Apollo.RegisterEventHandler("PlayerCurrencyChanged",    "OnUpdateInventory", self)
  Apollo.RegisterEventHandler("UpdateInventory",        "OnUpdateInventory", self)
  Apollo.RegisterEventHandler("PersonaUpdateCharacterStats",  "OnUpdateInventory", self)

  self.wndArt = Apollo.LoadForm(self.xmlDoc, "BaseBarCornerArt", "FixedHudStratum", self)
  self.wndMain = Apollo.LoadForm(self.xmlDoc, "BaseBarCornerForm", "FixedHudStratum", self)
  self.wndXPLevel = self.wndMain:FindChild("XPButton")
  self.wndPathLevel = self.wndMain:FindChild("PathButton")

  self.wndInvokeForm = Apollo.LoadForm(self.xmlDoc, "InventoryInvokeForm", "FixedHudStratum", self)
  self.wndQuestItemNotice = self.wndInvokeForm:FindChild("QuestItemNotice")
  self.wndInvokeButton = self.wndInvokeForm:FindChild("InvokeBtn")

  self.bInCombat = false
  self.bOnRedrawCooldown = false

  Apollo.RegisterTimerHandler("BaseBarCorner_RedrawCooldown", "RedrawCooldown", self)
  Apollo.CreateTimer("BaseBarCorner_RedrawCooldown", 1, false)
  Apollo.StopTimer("BaseBarCorner_RedrawCooldown")

  if VikingLib == nil then
    VikingLib = Apollo.GetAddon("VikingLibrary")
  end

  if VikingLib ~= nil then
    self.db = VikingLib.Settings.RegisterSettings(self, "VikingXPBar", self:GetDefaults(), "XP Bar")
    self.generalDb = self.db.parent
  end

  self.tPathBarMode = self.db.char.mode

  if GameLib.GetPlayerUnit() ~= nil then
    self:RedrawAll()
  end

end

function VikingXPBar:GetDefaults()

  local tColors = VikingLib.Settings.GetColors()

  return {
    char = {
      mode = PathBarMode_Automatic,
      colors = {
        Normal = { col = "ff" .. tColors.green },
        Rested = { col = "ff" .. tColors.blue },
      },
      textStyle = {
        OutLineFont = false  
      }
    }
  }

end

function VikingXPBar:RedrawCooldown()
  Apollo.StopTimer("BaseBarCorner_RedrawCooldown")
  self.bOnRedrawCooldown = false
  self:RedrawAllPastCooldown()
end

function VikingXPBar:RedrawAll()
  if not self.bOnRedrawCooldown then
    self.bOnRedrawCooldown = true
    self:RedrawAllPastCooldown()
  end

  Apollo.StartTimer("BaseBarCorner_RedrawCooldown")
end

function VikingXPBar:RedrawAllPastCooldown()
  local unitPlayer = GameLib.GetPlayerUnit()
  if not unitPlayer then
    return
  end

  local strName = unitPlayer:GetName()
  local tStats = unitPlayer:GetBasicStats()
  local tMyGroupData = GroupLib.GetGroupMember(1)

  -- XP/EP Progress Bar and Tooltip
  local strXPorEP = ""
  local strTooltip = ""
  local strPathXP = ""
  local strPathTooltip = ""

  if tStats.nLevel == knMaxLevel then -- TODO: Hardcoded max level
    -- EP
    strXPorEP = String_GetWeaselString(Apollo.GetString("BaseBar_EPBracket"), self:RedrawEP())
    strTooltip = self:ConfigureEPTooltip(unitPlayer)

    if (self.tPathBarMode == PathBarMode_PeriodicEP or (self.tPathBarMode == PathBarMode_Automatic and PlayerPathLib.GetPathLevel() == knMaxPathLevel)) then
      -- Periodic EP
      self.tActualPathBarMode = PathBarMode_PeriodicEP
      strPathXP = String_GetWeaselString(Apollo.GetString("BaseBar_EPBracket"), self:RedrawPeriodicEP())
      strPathTooltip = self:ConfigurePeriodicEPTooltip(unitPlayer)
    else
      -- Path XP
      self.tActualPathBarMode = PathBarMode_PathXP
      strPathXP = String_GetWeaselString(Apollo.GetString("BaseBar_PathBracket"), self:RedrawPathXP())
      strPathTooltip = self:ConfigurePathXPTooltip(unitPlayer)
    end 
  else
    -- XP
    strXPorEP = String_GetWeaselString(Apollo.GetString("BaseBar_XPBracket"), self:RedrawXP())
    strTooltip = self:ConfigureXPTooltip(unitPlayer)

    -- Path XP
    self.tActualPathBarMode = PathBarMode_PathXP
    strPathXP = String_GetWeaselString(Apollo.GetString("BaseBar_PathBracket"), self:RedrawPathXP())
    strPathTooltip = self:ConfigurePathXPTooltip(unitPlayer)
  end

  -- If grouped, Mentored by
  if tMyGroupData and #tMyGroupData.tMentoredBy ~= 0 then
    strName = String_GetWeaselString(Apollo.GetString("BaseBar_MenteeAppend"), strName)
    for idx, nMentorGroupIdx in pairs(tMyGroupData.tMentoredBy) do
      local tTargetGroupData = GroupLib.GetGroupMember(nMentorGroupIdx)
      if tTargetGroupData then
        strTooltip = "<P Font=\"CRB_InterfaceSmall_O\">"..String_GetWeaselString(Apollo.GetString("BaseBar_MenteeTooltip"), tTargetGroupData.strCharacterName).."</P>"..strTooltip
      end
    end
  end

  -- If grouped, Mentoring
  if tMyGroupData and tMyGroupData.bIsMentoring then -- unitPlayer:IsMentoring() -- tStats.effectiveLevel ~= 0 and tStats.effectiveLevel ~= tStats.level
    strName = String_GetWeaselString(Apollo.GetString("BaseBar_MentorAppend"), strName, tStats.nEffectiveLevel)
    local tTargetGroupData = GroupLib.GetGroupMember(tMyGroupData.nMenteeIdx)
    if tTargetGroupData then
      strTooltip = "<P Font=\"CRB_InterfaceSmall_O\">"..String_GetWeaselString(Apollo.GetString("BaseBar_MentorTooltip"), tTargetGroupData.strCharacterName).."</P>"..strTooltip
    end
  end

  -- If in an instance (or etc.) and Rallied
  if unitPlayer:IsRallied() and tStats.nEffectiveLevel ~= tStats.nLevel then
    strName = String_GetWeaselString(Apollo.GetString("BaseBar_RallyAppend"), strName, tStats.nEffectiveLevel)
    strTooltip = "<P Font=\"CRB_InterfaceSmall_O\">"..Apollo.GetString("BaseBar_YouAreRallyingTooltip").."</P>"..strTooltip
  end

  -- PvP
  local tPvPFlagInfo = GameLib.GetPvpFlagInfo()
  if tPvPFlagInfo and tPvPFlagInfo.bIsFlagged then
    strName = String_GetWeaselString(Apollo.GetString("BaseBar_PvPAppend"), strName)
  end

  -- self.wndXPLevel:SetText(String_GetWeaselString(strXPorEP))
  -- self.wndPathLevel:SetText(strPathXP)

   self.wndMain:FindChild("XPBarContainer"):SetTooltip(strTooltip)
  self.wndXPLevel:SetTooltip(strTooltip)

  self.wndMain:FindChild("PathBarContainer"):SetTooltip(strPathTooltip)
  self.wndPathLevel:SetTooltip(strPathTooltip)
  
  local wndPathIcon = self.wndMain:FindChild("PathIcon")

  if self.tPathBarMode == PathBarMode_Automatic then
    if self.tActualPathBarMode == PathBarMode_PathXP then
      wndPathIcon:SetTooltip("Secondary Bar: Automatic (Path XP)") -- TODO: Localization
    else
      wndPathIcon:SetTooltip("Secondary Bar: Automatic (EP Weekly Progress)") -- TODO: Localization
    end
  else
    if self.tPathBarMode == PathBarMode_PathXP then
       wndPathIcon:SetTooltip("Secondary Bar: Path XP") -- TODO: Localization
    else
       wndPathIcon:SetTooltip("Secondary Bar: EP Weekly Progress") -- TODO: Localization
    end
  end


  --Toggle Visibility based on ui preference
  local nVisibility = Apollo.GetConsoleVariable("hud.xpBarDisplay")

  if nVisibility == 1 then -- always on
    self.wndMain:Show(true)
  elseif nVisibility == 2 then --always off
    self.wndMain:Show(false)
  elseif nVisibility == 3 then --on in combat
    self.wndMain:Show(unitPlayer:IsInCombat())
  elseif nVisibility == 4 then --on out of combat
    self.wndMain:Show(not unitPlayer:IsInCombat())
  else
    --If the player has any XP draw the bars and set the preference to 1 automatically.
    --else hide the bar until the player earns some XP, then trigger a tutorial prompt
    self.wndMain:Show(false)
  end

  self.wndArt:Show(true)
  self:OnUpdateInventory()
end

-----------------------------------------------------------------------------------------------
-- Path XP
-----------------------------------------------------------------------------------------------

function VikingXPBar:RedrawPathXP()
  if not PlayerPathLib then
    return 0
  end

  local nCurrentLevel = PlayerPathLib.GetPathLevel()
  local nNextLevel = math.min(knMaxPathLevel, nCurrentLevel + 1)

  local nLastLevelXP = PlayerPathLib.GetPathXPAtLevel(nCurrentLevel)
  local nCurrentXP =  PlayerPathLib.GetPathXP() - nLastLevelXP
  local nNeededXP = PlayerPathLib.GetPathXPAtLevel(nNextLevel) - nLastLevelXP

  local wndPathBarFill = self.wndMain:FindChild("PathBarContainer:PathBarFill")
  wndPathBarFill:SetMax(nNeededXP)
  wndPathBarFill:SetProgress(nCurrentXP)
  wndPathBarFill:SetBarColor(ApolloColor.new(self.db.char.colors["Normal"].col))

  local ePathId = PlayerPathLib.GetPlayerPathType()
  local wndPathIcon = self.wndMain:FindChild("PathIcon")
  wndPathIcon:SetSprite(ktPathIcon[ePathId])
  
  if self.db.char.textStyle["OutlineFont"] then
    wndPathBarFill:SetFont("CRB_InterfaceSmall_O")
  else
    wndPathBarFill:SetFont("Default")
  end

  if nNeededXP == 0 then
    wndPathBarFill:SetMax(100)
    wndPathBarFill:SetProgress(100)
    return 100
  end

  return math.min(99.9, nCurrentXP / nNeededXP * 100)
end

function VikingXPBar:ConfigurePathXPTooltip(unitPlayer)
  if not PlayerPathLib then
    return ""
  end

  local unitPlayer = GameLib.GetPlayerUnit()
  if not unitPlayer then
    return
  end

  local strPathType = c_arPathStrings[unitPlayer:GetPlayerPathType()] or ""

  local nCurrentLevel = PlayerPathLib.GetPathLevel()
  local nNextLevel = math.min(knMaxPathLevel, nCurrentLevel + 1)

  local nLastLevelXP = PlayerPathLib.GetPathXPAtLevel(nCurrentLevel)
  local nCurrentXP =  PlayerPathLib.GetPathXP() - nLastLevelXP
  local nNeededXP = PlayerPathLib.GetPathXPAtLevel(nNextLevel) - nLastLevelXP

  local strTooltip = nNeededXP > 0 and string.format("<P Font=\"CRB_InterfaceSmall_O\">%s</P>", String_GetWeaselString(Apollo.GetString("Base_XPValue"), nCurrentXP, nNeededXP, nCurrentXP / nNeededXP * 100)) or ""
  strTooltip = string.format("<P Font=\"CRB_InterfaceSmall_O\">%s %s%s</P>%s", Apollo.GetString(strPathType), Apollo.GetString("CRB_Level_"), nCurrentLevel, strTooltip)

  return strTooltip
end

-----------------------------------------------------------------------------------------------
-- Elder Points (When at max level)
-----------------------------------------------------------------------------------------------

function VikingXPBar:RedrawEP()
  local nCurrentEP = GetElderPoints()
  local nEPToAGem = GameLib.ElderPointsPerGem
  local nEPDailyMax = GameLib.ElderPointsDailyMax
  local nRestedEP = GetRestXp()               -- amount of rested xp
  local nRestedEPPool = GetRestXpKillCreaturePool()     -- amount of rested xp remaining from creature kills
  
  local wndXPBarFill = self.wndMain:FindChild("XPBarContainer:XPBarFill")
  local wndRestXPBarFill = self.wndMain:FindChild("XPBarContainer:RestXPBarFill")
  local wndRestXPBarGoal = self.wndMain:FindChild("XPBarContainer:RestXPBarGoal")
  local wndMaxEPBar = self.wndMain:FindChild("XPBarContainer:DailyMaxEPBar")
  
  if self.db.char.textStyle["OutlineFont"] then
    wndXPBarFill:SetFont("CRB_InterfaceSmall_O")
    wndRestXPBarFill:SetFont("CRB_InterfaceSmall_O")
  else
    wndXPBarFill:SetFont("Default")
    wndRestXPBarFill:SetFont("Default")
  end

  if not nCurrentEP or not nEPToAGem or not nEPDailyMax or not nRestedEP then
    return
  end

  wndXPBarFill:SetMax(nEPToAGem)
  wndXPBarFill:SetProgress(nCurrentEP)
  wndXPBarFill:SetBarColor(ApolloColor.new(self.db.char.colors["Normal"].col))

  -- Rest Bar and Goal (where it ends)
  wndRestXPBarFill:SetMax(nEPToAGem)
  wndRestXPBarFill:Show(nRestedEP and nRestedEP > 0)
  if nRestedEP and nRestedEP > 0 then
    wndRestXPBarFill:SetProgress(math.min(nEPToAGem, nCurrentEP + nRestedEP))
    wndRestXPBarFill:SetBarColor(ApolloColor.new(self.db.char.colors["Rested"].col))
  end

  local bShowRestEPGoal = nRestedEP and nRestedEPPool and nRestedEP > 0 and nRestedEPPool > 0
  wndRestXPBarGoal:SetMax(nEPToAGem)
  wndRestXPBarGoal:Show(bShowRestEPGoal)
  if bShowRestEPGoal then
    wndRestXPBarGoal:SetProgress(math.min(nEPToAGem, nCurrentEP + nRestedEPPool))
    wndRestXPBarGoal:SetBarColor(ApolloColor.new(self.db.char.colors["Rested"].col))
  end

  -- This is special to Rested EP, as there is a daily max
  wndMaxEPBar:SetMax(nEPToAGem)
  wndMaxEPBar:Show(nEPDailyMax ~= nEPToAGem)
  if nEPDailyMax < nEPToAGem then
    wndMaxEPBar:SetProgress(nEPDailyMax)
  elseif nEPDailyMax > nEPToAGem then
    wndMaxEPBar:SetProgress(nEPToAGem)
  end

  return math.min(99.9, nCurrentEP / nEPToAGem * 100)
end

function VikingXPBar:RedrawPeriodicEP()
  local nCurrentEP = GetElderPoints()
  local nCurrentToDailyMax = GetPeriodicElderPoints()
  local nEPDailyMax = GameLib.ElderPointsDailyMax

  local wndPathBarFill = self.wndMain:FindChild("PathBarContainer:PathBarFill")
  wndPathBarFill:SetMax(nEPDailyMax)
  wndPathBarFill:SetProgress(nCurrentToDailyMax)
  wndPathBarFill:SetBarColor(ApolloColor.new(self.db.char.colors["Normal"].col))

  local wndPathIcon = self.wndMain:FindChild("PathIcon")
  wndPathIcon:SetSprite(kstrDefaultIcon)
  
  if self.db.char.textStyle["OutlineFont"] then
    wndPathBarFill:SetFont("CRB_InterfaceSmall_O")
  else
    wndPathBarFill:SetFont("Default")
  end

  if nEPDailyMax - nCurrentToDailyMax == 0 then
    wndPathBarFill:SetMax(100)
    wndPathBarFill:SetProgress(100)
    return 100
  end

  return math.min(99.9, nCurrentToDailyMax / nEPDailyMax * 100)
end

function VikingXPBar:ConfigureEPTooltip(unitPlayer)
  local nCurrentEP = GetElderPoints()
  local nCurrentToDailyMax = GetPeriodicElderPoints()
  local nEPToAGem = GameLib.ElderPointsPerGem
  local nEPDailyMax = GameLib.ElderPointsDailyMax

  local nRestedEP = GetRestXp()               -- amount of rested xp
  local nRestedEPPool = GetRestXpKillCreaturePool()     -- amount of rested xp remaining from creature kills

  if not nCurrentEP or not nEPToAGem or not nEPDailyMax then
    return
  end

  -- Top String
  local strTooltip = String_GetWeaselString(Apollo.GetString("BaseBar_ElderPointsPercent"), nCurrentEP, nEPToAGem, math.min(99.9, nCurrentEP / nEPToAGem * 100))
  if nCurrentEP == nEPDailyMax then
    strTooltip = "<P Font=\"CRB_InterfaceSmall_O\">" .. strTooltip .. "</P><P Font=\"CRB_InterfaceSmall_O\">" .. Apollo.GetString("BaseBar_ElderPointsAtMax") .. "</P>"
  else
    local strDailyMax = String_GetWeaselString(Apollo.GetString("BaseBar_ElderPointsWeeklyMax"), nCurrentToDailyMax, nEPDailyMax, math.min(99.9, nCurrentToDailyMax / nEPDailyMax * 100))
    strTooltip = "<P Font=\"CRB_InterfaceSmall_O\">" .. strTooltip .. "</P><P Font=\"CRB_InterfaceSmall_O\">" .. strDailyMax .. "</P>"
  end

  -- Rested
  if nRestedEP > 0 then
    local strRestLineOne = String_GetWeaselString(Apollo.GetString("Base_EPRested"), nRestedEP, nRestedEP / nEPToAGem * 100)
    strTooltip = string.format("%s<P Font=\"CRB_InterfaceSmall_O\" TextColor=\"ffda69ff\">%s</P>", strTooltip, strRestLineOne)

    if nCurrentEP + nRestedEPPool > nEPToAGem then
      strTooltip = string.format("%s<P Font=\"CRB_InterfaceSmall_O\" TextColor=\"ffda69ff\">%s</P>", strTooltip, Apollo.GetString("Base_EPRestedEndsAfterLevelTooltip"))
    else
      local strRestLineTwo = String_GetWeaselString(Apollo.GetString("Base_EPRestedPoolTooltip"), nRestedEPPool, ((nRestedEPPool + nCurrentEP)  / nEPToAGem) * 100)
      strTooltip = string.format("%s<P Font=\"CRB_InterfaceSmall_O\" TextColor=\"ffda69ff\">%s</P>", strTooltip, strRestLineTwo)
    end
  end

  strTooltip = string.format("<P Font=\"CRB_InterfaceSmall_O\">%s%s</P>%s", Apollo.GetString("CRB_Level_"), unitPlayer:GetLevel(), strTooltip)

  return strTooltip
end

function VikingXPBar:ConfigurePeriodicEPTooltip(unitPlayer)
  local nCurrentToDailyMax = GetPeriodicElderPoints()
  local nEPToAGem = GameLib.ElderPointsPerGem
  local nEPDailyMax = GameLib.ElderPointsDailyMax

  local nRestedEP = GetRestXp()                             -- amount of rested xp
  local nRestedEPPool = GetRestXpKillCreaturePool()         -- amount of rested xp remaining from creature kills

  if not nCurrentToDailyMax or not nEPToAGem or not nEPDailyMax then
    return
  end

  -- Top String
  -- TODO: Localization
  local strTooltip = string.format("<P Font=\"CRB_InterfaceSmall_O\">Total Elder Gems: %s</P><P Font=\"CRB_InterfaceSmall_O\">Approx. Weekly Elder Gems: %s/%s (%s%s)</P>", GameLib.GetPlayerCurrency(Money.CodeEnumCurrencyType.ElderGems):GetAmount(), math.floor(nCurrentToDailyMax / nEPToAGem), math.floor(nEPDailyMax / nEPToAGem), Round(math.min(100, nCurrentToDailyMax / nEPDailyMax * 100)), "%")

  return strTooltip
end

-----------------------------------------------------------------------------------------------
-- XP (When less than level 50)
-----------------------------------------------------------------------------------------------

function VikingXPBar:RedrawXP()
  local nCurrentXP = GetXp() - GetXpToCurrentLevel()    -- current amount of xp into the current level
  local nNeededXP = GetXpToNextLevel()          -- total amount needed to move through current level
  local nRestedXP = GetRestXp()               -- amount of rested xp
  local nRestedXPPool = GetRestXpKillCreaturePool()     -- amount of rested xp remaining from creature kills
  
  local wndXPBarFill = self.wndMain:FindChild("XPBarContainer:XPBarFill")
  local wndRestXPBarFill = self.wndMain:FindChild("XPBarContainer:RestXPBarFill")
  local wndRestXPBarGoal = self.wndMain:FindChild("XPBarContainer:RestXPBarGoal")
  local wndMaxEPBar = self.wndMain:FindChild("XPBarContainer:DailyMaxEPBar")
  
  if self.db.char.textStyle["OutlineFont"] then
    wndXPBarFill:SetFont("CRB_InterfaceSmall_O")
    wndRestXPBarFill:SetFont("CRB_InterfaceSmall_O")
  else
    wndXPBarFill:SetFont("Default")
    wndRestXPBarFill:SetFont("Default")
  end

  if not nCurrentXP or not nNeededXP or not nNeededXP or not nRestedXP then
    return
  end 

  wndXPBarFill:SetMax(nNeededXP)
  wndXPBarFill:SetProgress(nCurrentXP)
  wndXPBarFill:SetBarColor(ApolloColor.new(self.db.char.colors["Normal"].col))

  -- Rest Bar and Goal (where it ends)
  wndRestXPBarFill:SetMax(nNeededXP)
  wndRestXPBarFill:Show(nRestedXP and nRestedXP > 0)

  if nRestedXP and nRestedXP > 0 then
    wndRestXPBarFill:SetProgress(math.min(nNeededXP, nCurrentXP + nRestedXP))
    wndRestXPBarFill:SetBarColor(ApolloColor.new(self.db.char.colors["Rested"].col))
  end

  local bShowRestXPGoal = nRestedXP and nRestedXPPool and nRestedXP > 0 and nRestedXPPool > 0
  wndRestXPBarGoal:SetMax(nNeededXP)
  wndRestXPBarGoal:Show(bShowRestXPGoal)
  if bShowRestXPGoal then
    wndRestXPBarGoal:SetProgress(math.min(nNeededXP, nCurrentXP + nRestedXPPool))
    wndRestXPBarGoal:SetBarColor(ApolloColor.new(self.db.char.colors["Rested"].col))
  end

  -- This is only for EP at max level
  wndMaxEPBar:SetProgress(0)
  wndMaxEPBar:Show(false)

  return math.min(99.9, nCurrentXP / nNeededXP * 100)
end

function VikingXPBar:ConfigureXPTooltip(unitPlayer)
  local nCurrentXP = GetXp() - GetXpToCurrentLevel()    -- current amount of xp into the current level
  local nNeededXP = GetXpToNextLevel()          -- total amount needed to move through current level
  local nRestedXP = GetRestXp()               -- amount of rested xp
  local nRestedXPPool = GetRestXpKillCreaturePool()     -- amount of rested xp remaining from creature kills

  if not nCurrentXP or not nNeededXP or not nNeededXP or not nRestedXP then
    return
  end

  local strTooltip = string.format("<P Font=\"CRB_InterfaceSmall_O\">%s</P>", String_GetWeaselString(Apollo.GetString("Base_XPValue"), nCurrentXP, nNeededXP, nCurrentXP / nNeededXP * 100))
  if nRestedXP > 0 then
    local strRestLineOne = String_GetWeaselString(Apollo.GetString("Base_XPRested"), nRestedXP, nRestedXP / nNeededXP * 100)
    strTooltip = string.format("%s<P Font=\"CRB_InterfaceSmall_O\" TextColor=\"ffda69ff\">%s</P>", strTooltip, strRestLineOne)

    if nCurrentXP + nRestedXPPool > nNeededXP then
      strTooltip = string.format("%s<P Font=\"CRB_InterfaceSmall_O\" TextColor=\"ffda69ff\">%s</P>", strTooltip, Apollo.GetString("Base_XPRestedEndsAfterLevelTooltip"))
    else
      local strRestLineTwo = String_GetWeaselString(Apollo.GetString("Base_XPRestedPoolTooltip"), nRestedXPPool, ((nRestedXPPool + nCurrentXP)  / nNeededXP) * 100)
      strTooltip = string.format("%s<P Font=\"CRB_InterfaceSmall_O\" TextColor=\"ffda69ff\">%s</P>", strTooltip, strRestLineTwo)
    end
  end

  strTooltip = string.format("<P Font=\"CRB_InterfaceSmall_O\">%s%s</P>%s", Apollo.GetString("CRB_Level_"), unitPlayer:GetLevel(), strTooltip)

  return strTooltip
end

-----------------------------------------------------------------------------------------------
-- Events to Redraw All
-----------------------------------------------------------------------------------------------

function VikingXPBar:OnEnteredCombat(unitArg, bInCombat)
  if unitArg == GameLib.GetPlayerUnit() then
    self.bInCombat = bInCombat
    self:RedrawAll()
  end
end

function VikingXPBar:OnClearCombatFlag()
  self.bInCombat = false
  self:RedrawAll()
end

function VikingXPBar:OnXpChanged()
  if GetXp() == 0 then
    return
  end

  local nVisibility = Apollo.GetConsoleVariable("hud.xpBarDisplay")

  --NEW Player Experience: Set the xp bars to Always Show once you've started earning experience.
  if nVisibility == nil or nVisibility < 1 then
    --Trigger a HUD Tutorial
    Event_FireGenericEvent("OptionsUpdated_HUDTriggerTutorial", "xpBarDisplay")
  end

  self:RedrawAll()
end

function VikingXPBar:OnPathClicked()
  if self.tActualPathBarMode == PathBarMode_PathXP then
    Event_FireGenericEvent("PlayerPathShow")
  else
    Event_FireGenericEvent("ToggleQuestLog")
  end
end

function VikingXPBar:OnIconClicked()
  if GetXp() == 0 then
    return
  end

  if self.tPathBarMode == PathBarMode_Automatic then
    self.db.char.mode = PathBarMode_PathXP
    self.tPathBarMode = self.db.char.mode
    self:RedrawAllPastCooldown()
    return
  end
  if self.tPathBarMode == PathBarMode_PathXP then
    self.db.char.mode = PathBarMode_PeriodicEP
    self.tPathBarMode = self.db.char.mode
    self:RedrawAllPastCooldown()
    return
  end
  if self.tPathBarMode == PathBarMode_PeriodicEP then
    self.db.char.mode = PathBarMode_Automatic
    self.tPathBarMode = self.db.char.mode
    self:RedrawAllPastCooldown()
    return
  end
end

function VikingXPBar:OnXpClicked()
  Event_FireGenericEvent("ToggleCharacterWindow")
end

function VikingXPBar:OnUpdateInventory()
  local unitPlayer = GameLib.GetPlayerUnit()
  if not unitPlayer then
    return
  end

  self.wndInvokeForm:FindChild("MainCashWindow"):SetAmount(GameLib.GetPlayerCurrency(), false)

  local nOccupiedInventory = #unitPlayer:GetInventoryItems() or 0
  local nTotalInventory = GameLib.GetTotalInventorySlots() or 0
  local nAvailableInventory = nTotalInventory - nOccupiedInventory

  local strOpenColor = ""
  if nOccupiedInventory == nTotalInventory then
    strOpenColor = kstrRed
    self.wndInvokeButton:ChangeArt("DatachronSprites:btnBag")
  elseif nOccupiedInventory >= nTotalInventory - 3 then
    strOpenColor = kstrOrange
    self.wndInvokeButton:ChangeArt("DatachronSprites:btnBag")
  else
    strOpenColor = kstrBlue
    self.wndInvokeButton:ChangeArt("DatachronSprites:btnBag")
  end

  local strPrefix = ""

  if nOccupiedInventory < 10 then strPrefix = "<T TextColor=\"00000000\">.</T>" end
  local strAMLCode = string.format("%s<T Font=\"CRB_Pixel\" Align=\"Right\" TextColor=\"%s\">%s<T TextColor=\"%s\">/%s</T></T>", strPrefix, strOpenColor, nOccupiedInventory, kstrDarkBlue, nTotalInventory)
  self.wndInvokeForm:FindChild("InvokeBtn"):SetText(tostring(nAvailableInventory))
  self.wndInvokeForm:FindChild("InvokeBtn"):SetTooltip(strAMLCode)

  self.wndQuestItemNotice:Show(GameLib.DoAnyItemsBeginQuest())
end

function VikingXPBar:OnToggleFromDatachronIcon()
  Event_FireGenericEvent("InterfaceMenu_ToggleInventory")
end

---------------------------------------------------------------------------------------------------
-- Tutorial anchor request
---------------------------------------------------------------------------------------------------
function VikingXPBar:OnTutorial_RequestUIAnchor(eAnchor, idTutorial, strPopupText)
  if eAnchor ~= GameLib.CodeEnumTutorialAnchor.Inventory then return end

  local tRect = {}
  tRect.l, tRect.t, tRect.r, tRect.b = self.wndInvokeForm:GetRect()

  Event_FireGenericEvent("Tutorial_RequestUIAnchorResponse", eAnchor, idTutorial, strPopupText, tRect)
end

---------------------------------------------------------------------------------------------------
-- VikingSettings Functions
---------------------------------------------------------------------------------------------------

function VikingXPBar:UpdateSettingsForm(wndContainer)
  -- Colors
  for sBarName, tBarColorData in pairs(self.db.char.colors) do
    local wndColorContainer = wndContainer:FindChild("Colors:Content:" .. sBarName)

    if wndColorContainer then
      for sColorState, sColor in pairs(tBarColorData) do
        local wndColor = wndColorContainer:FindChild(sColorState)

        if wndColor then wndColor:SetBGColor(sColor) end
      end
    end
  end
  
  -- Text Style
  wndContainer:FindChild("TextStyle:Content:OutlineFont"):SetCheck(self.db.char.textStyle["OutlineFont"])
  
  self:RedrawAllPastCooldown()
end

function VikingXPBar:OnSettingsBarColor( wndHandler, wndControl, eMouseButton )
  VikingLib.Settings.ShowColorPickerForSetting(self.db.char.colors[wndControl:GetParent():GetName()], wndControl:GetName(), function() self:RedrawAllPastCooldown() end, wndControl)
end

function VikingXPBar:OnSettingsTextStyle(wndHandler, wndControl, eMouseButton)
  self.db.char.textStyle[wndControl:GetName()] = wndControl:IsChecked()
  self:RedrawAllPastCooldown()
end

local BaseBarCornerInst = VikingXPBar:new()
BaseBarCornerInst:Init()