[Mod] Always Visible Health Mana XP Text

By pacov on June 7, 2011 7:14:29 PM from

Demigod Forums

pacov

Join Date 02/2008

+182

Background

We’ve been using the original Always visible health and mana text mod by gunblob (https://forums.demigodthegame.com/369556) for quite some time as part of the advanced ui mod. I recently noticed that the original version has a minor bug that causes some issues with the visual display during replays. Thanks to the assistance of miriyaka, a fix has been found for this issue. I also came up with a new enhancement today that enables you to see your current experience without mousing over the xp bar. You only need to download the version I’m linking to here in this thread if you do not use the advanced ui mod. I will be updating the advanced ui mod and the combined mod installer to include this updated code. This page is only for reference. Do not use this mod AND the enhanced UI mod.

What’s it look like?

What’s the point of the mod?

The purpose of this mod is to alter the UI so that you will always see a text value indicating the exact value of HP and mana of the Demigod you control. Without the mod, you can still view the text values, but you have to move your mouse over the hp and mana bars to view this. With this mod, it is always on.

Why make a mod?

It’s a logical addition that improves the Demigod UI.

How do I use the mod?

Download the mod and run the installer. Then, use the Demigod Mod manager to enable the mod. As this is a UI mod, all players DO NOT need to have this mod installed for you to use it.

Where can I download the mod?

http://www.box.net/shared/rnr99evq1huc5ut86at6

Revision history

v1.1
- Current level and xp required for next level automatically viewable as text
v1.01
- Fixed an issue with the visual display when viewing replays as an observer
v1.0
- HP and mana automatically viewable as text

Successfully updated karma reason!

So, I've been working on an update to this that follows similar logic. It's coded and tested and works great, but I'd like a code review from one of you folks so that I can remove additional lines of code that are unnecessary.

Here's what the addition to the mod will do: it will now show your current level and experience to next level (0/200 for instance). This functionality existed previously but was only visible if you moused over it. After the change, you automatically always see your current level and experience to next level.

I also noticed that there is quite a bit of real estate on this bar that additional data could be added to.

To make the mod, I simply copied the entirety of HUD_xp.lua and edited from there. I commented out the mouse over functionality, changed the positioning of the EXP to next level, and changed the functionality so that all would appear. That said, I'm pretty sure I don't need all of the code and would like some help to know what I can remove without doing trial and error. Thanks!

Code: c++
#*****************************************************************************
#* File: lua/ui/game/HUD_xp.lua
#*
#* Hero XP bar
#*
#* Copyright © 2008 Gas Powered Games, Inc.  All rights reserved.
#*****************************************************************************
local UIUtil = import('/lua/ui/uiutil.lua')
local LayoutHelpers = import('/lua/maui/layouthelpers.lua')
local Group = import('/lua/maui/group.lua').Group
local Bitmap = import('/lua/maui/bitmap.lua').Bitmap
local StatusBar = import('/lua/maui/statusbar.lua').StatusBar
local Tooltip = import('/lua/ui/game/tooltip.lua')
local InGameUI = import('/lua/ui/game/InGameUI.lua')
local Common = import('/lua/common/CommonUtils.lua')
local GameMain = import('/lua/ui/game/gamemain.lua')
local EffectHelpers = import('/lua/maui/effecthelpers.lua')
local hero = nil
local tempPrevXP = nil
local currentHeroLevel = 1
local currentExperience = 0
local currentScores = false
local maxLevelHit = false
local bar = false
function OnHeroChange(unit)
    hero = unit
    tempPrevXP = nil
    currentHeroLevel = 0
    currentExperience = 0
    currentScores = false
    maxLevelHit = false
    
    bar:Show()
    xptolevelTxt:Show()
    xpTxt:Show()
end
function Create(parent)
    InGameUI.OnFocusArmyHeroChange:Add( OnHeroChange )
    local xpBarImg = Bitmap(parent, '/textures/ui/hud/bars/xp.dds')
    xpBarImg.Width:Set(770)
    xpBarImg.Height:Set(25)
    xpBarImg.glow = Bitmap(xpBarImg, '/textures/ui/hud/bars/xp_glow.dds')
    LayoutHelpers.FillParent(xpBarImg.glow, xpBarImg)
    xpBarImg.glow.Depth:Set( function() return xpBarImg.Depth() + 2 end)
    xpBarImg.glow:SetAlpha(0)
    bar = xpBarImg.xpBarGroup
    bar = Group(parent)
    bar.Width:Set(736)
    bar.Height:Set(24)
    LayoutHelpers.AtCenterIn(bar, xpBarImg, 1, 0)
    bar.Depth:Set(function() return xpBarImg.glow.Depth() + 2 end)
    # So we can mouseover for level/experience text
    bar.dummy = Bitmap(bar)
    LayoutHelpers.FillParent(bar.dummy, bar)
    LayoutHelpers.DepthOverParent(bar.dummy, bar, 10000)
    bar.level = StatusBar(bar, 0, 100, false, true, false, '/textures/ui/hud/bars/xp_black_mid.dds', "LevelBar")
    LayoutHelpers.FillParent(bar.level, bar)
    LayoutHelpers.ResetWidth(bar.level)
    LayoutHelpers.ResetHeight(bar.level)
    bar.level:SetValue(0)
    bar.left = Bitmap(bar, '/textures/ui/hud/bars/xp_black_endcap_left.dds')
    bar.left.Width:Set(19)
    bar.left.Height:Set(26)
    LayoutHelpers.AnchorToLeft(bar.left, bar.level._bar, -3)
    bar.left.Bottom:Set(function() return bar.level._bar:Bottom() + 1 end)
    bar.right = Bitmap(bar, '/textures/ui/hud/bars/xp_black_endcap_right.dds')
    bar.right.Width:Set(19)
    bar.right.Height:Set(26)
    LayoutHelpers.CenteredRightOf(bar.right, bar.level, -1)
    bar.levelText = UIUtil.CreateText(bar.level, '', 14, UIUtil.bodyFont )
    bar.levelText:SetColor('ffefda9c')
    LayoutHelpers.AtHorizontalCenterIn(bar.levelText, bar.level, - 80)
    LayoutHelpers.AtVerticalCenterIn(bar.levelText, bar.level)
    bar.levelText:SetDropShadow(true)
    bar.levelText:Hide()
    # XP text
    xpTxt = UIUtil.CreateText(bar, '<LOC XPHUD_0000>Level 1', 16, UIUtil.bodyFont)
    #LayoutHelpers.AtCenterIn(xpTxt, bar, 2, 0)
    LayoutHelpers.AtLeftIn(xpTxt, bar, 5)
    LayoutHelpers.AtVerticalCenterIn(xpTxt, bar)
    xpTxt:SetDropShadow(true)
    xpTxt:SetColor('ffefda9c')
    LayoutHelpers.DepthOverParent(xpTxt, bar, 300)
    xptolevelTxt = UIUtil.CreateText(bar, '<LOC XPHUD_0001>Experience to Level 2: 0/200', 14, UIUtil.bodyFont)
    #LayoutHelpers.AtCenterIn(xptolevelTxt, bar, 70, 0)
    LayoutHelpers.AtLeftIn(xptolevelTxt, bar, 76)
    LayoutHelpers.AtVerticalCenterIn(xptolevelTxt, bar)
    xptolevelTxt:SetDropShadow(true)
    xptolevelTxt:SetColor('ffefda9c')
    LayoutHelpers.DepthOverParent(xptolevelTxt, bar, 300)
    xptolevelTxt:Hide()
    # Gold display
    local gold = import('/lua/ui/game/HUD_gold.lua').Create(bar)
    LayoutHelpers.AtRightIn(gold, bar)
    LayoutHelpers.AtVerticalCenterIn(gold, bar, 1)
    LayoutHelpers.DepthOverParent(gold, bar, 300)
    gold.dummy = Bitmap(gold)
    LayoutHelpers.FillParent(gold.dummy, gold)
    LayoutHelpers.DepthOverParent(gold.dummy, gold, 10000)
    local xpbar_gold_title = '<LOC XPBAR_0000>Gold'
    local xpbar_gold_text = '<LOC XPBAR_0001>Control Gold Mines and kill enemies to earn Gold. Spend Gold on items and Citadel Upgrades.'
    function gold.dummy.HandleEvent(self, event)
       if event.Type == 'MouseEnter' then
            gold.dummy.tooltip = Tooltip.CreateExtendedTooltip(self, xpbar_gold_title, xpbar_gold_text, true)
       elseif event.Type == 'MouseExit' then
            if gold.dummy.tooltip then
                gold.dummy.tooltip:Destroy()
                gold.dummy.tooltip = nil
            end
       end
    end
    --[[
    # REmoving war score per SD - dstaltman
    # War Points display
    warPts = UIUtil.CreateText(bar, '', 14, UIUtil.bodyFont)
    LayoutHelpers.AtCenterIn(warPts, bar, 2, 0)
    LayoutHelpers.DepthOverParent(warPts, bar, 300)
    warPts:SetColor('ffefda9c')
    warPts:SetDropShadow(true)
    warPts.dummy = Bitmap(warPts)
    LayoutHelpers.FillParent(warPts.dummy, warPts)
    LayoutHelpers.DepthOverParent(warPts.dummy, warPts, 10000)
    local xpbar_warscore_title = '<LOC XPBAR_0002>War Score (War Rank)'
    local xpbar_warscore_text = '<LOC XPBAR_0003>Control flags to earn War Score. War Score determines your team\'s War Rank and available Ciadel Upgrades.'
    function warPts.dummy.HandleEvent(self, event)
       if event.Type == 'MouseEnter' then
            warPts.dummy.tooltip = Tooltip.CreateExtendedTooltip(self, xpbar_warscore_title, xpbar_warscore_text, true)
       elseif event.Type == 'MouseExit' then
            if warPts.dummy.tooltip then
                warPts.dummy.tooltip:Destroy()
                warPts.dummy.tooltip = nil
            end
       end
    end
    ]]--
    
    #local warPtsIcon = Bitmap(bar, UIUtil.UIFile('/icons/warpoints.dds'))
    #warPtsIcon.Height:Set(20)
    #warPtsIcon.Width:Set(20)
    #LayoutHelpers.AnchorToLeft(warPtsIcon, warPts, 2)
    #LayoutHelpers.AtVerticalCenterIn(warPtsIcon, bar)
    #LayoutHelpers.DepthOverParent(warPtsIcon, bar, 300)
--[[
    function bar.dummy.HandleEvent(self, event)
       if event.Type == 'MouseEnter' then
            if not maxLevelHit then
                xpTxt:Show()
                xptolevelTxt:Hide()
            end
       elseif event.Type == 'MouseExit' then
            if not maxLevelHit then
                xpTxt:Hide()
                xptolevelTxt:Show()
            end
       end
    end
]]--
    function bar.Update()
        if GetFocusArmy() != -1 then
            if hero and not hero:IsDead() and not IsDestroyed(bar) then
                local bp = hero:GetBlueprint()
                local data = EntityData[hero:GetEntityId()]
                if not data then
                    local id = BlipMap[hero:GetBlipId()]
                    if id then
                        data = EntityData[id]
                    end
                end
                if currentHeroLevel != data.HeroLevel then
                    xpTxt:SetText(LOCF('<LOC XPHUD_0002>Level %d', data.HeroLevel))
                    currentHeroLevel = data.HeroLevel
                end
                if currentExperience != data.XP then
                    if data.HeroLevel != 20 then
                        xptolevelTxt:SetText(LOCF('<LOC XPHUD_0003>Experience to Level %d: %d/%d', data.HeroLevel+1, data.XP, data.NextLevelXP))
                    else
                        xptolevelTxt:SetText('')
                    end
                    currentExperience = data.XP
                end
                local levelPct
                if data.XP > 0 then
                    levelPct = math.min(1.0,(data.XP - data.ThisLevelXP) / (data.NextLevelXP - data.ThisLevelXP))
                else
                    levelPct = 0
                end
                #xpBar.level:SetValue(levelPct * 100)
                bar.level:SetValue(100 - (levelPct * 100))
                if levelPct > 0 then
                    bar.left:SetTexture('/textures/ui/hud/bars/xp_black_endcap_left2.dds')
                else
                    bar.left:SetTexture('/textures/ui/hud/bars/xp_black_endcap_left.dds')
                end
                if levelPct >= 0.999 then
                    bar.right:Hide()
                    bar.left:Hide()
                else
                    bar.right:Show()
                    bar.left:Show()
                end
                #if levelPct <= 0.55 then
                    #xpTxt:SetColor('ffefda9c')
                    #xpTxt:SetDropShadow(true)
                #else
                    #xpTxt:SetColor('ff183349')
                    #xpTxt:SetDropShadow(false)
                #end
                #if levelPct <= 0.65 then
                    #xptolevelTxt:SetColor('ffefda9c')
                    #xptolevelTxt:SetDropShadow(true)
                #else
                    #xptolevelTxt:SetColor('ff183349')
                    #xptolevelTxt:SetDropShadow(false)
               # end
                if tempPrevXP != data.XP and data.HeroLevel != 20 then
                    EffectHelpers.FadeOut(xpBarImg.glow, 1.0, 1.0, 0)
                end
                tempPrevXP = data.XP
                if data.HeroLevel == 20 then
                    xptolevelTxt:SetText(LOC('<LOC xp_0000>Experience: 32400 / 32400'))
                    maxLevelHit = true
                end
            end
        else
            bar:Hide()
        end
        --[[
        # removing war score from the XP bar per SD - dstaltman
        if Sync.Score then
            if not currentScores then
                currentScores = Sync.Score
            else
                currentScores = table.merged(currentScores, Sync.Score)
            end
        end
        local armiesInfo = GetArmiesTable()
        local focusArmy = armiesInfo.focusArmy
        local team = armiesInfo.armiesTable[focusArmy].team
        for index, army in armiesInfo.armiesTable do
            if army.name == team then
                local warScore = currentScores[index].WarScore or 0
                local warRank = currentScores[index].WarRank or 0
                if focusArmy and not IsDestroyed(warPts) then
                    warPts:SetText(math.floor(warScore) .. ' (' .. warRank .. ')')
                end
            end
        end
        ]]--
        # Update War Score
        ### This is weird, why is this different than what's in Sync.Score?
        --[[
        local focusArmy = GetFocusArmy()
        local warScore = ArmyWarScore[focusArmy] or 0
        local warRank = currentScores[focusArmy].WarRank or 0
        if focusArmy and not IsDestroyed(warPts) then
            warPts:SetText(warScore .. ' (' .. warRank .. ')')
        end
        #for k, v in ArmyWarScore do
            #LOG("*UITest: index: ", k, "  warscore: ", v)
        #end
        ]]--
    end
    GameMain.BeatCallback:Add(bar.Update)
    return xpBarImg
end

Successfully updated karma reason!

Oh - and on another note, I think I've magically figured out enough about the ui to be able to make a ui mod that would show all of the new stats enabled via uberfix. Not that I'm exactly in a rush, but I did some toying around today with some of the other built in ui menus and I think I could pull this off.

Successfully updated karma reason!

If you want help learning to write hooked / non-destructive code, or help hooking any individual files or functions, I'll be glad to assist with that - but I don't have any interest in digging through entire files to find changes. At the very least, always leave tagged comments next to all of your changes, so that it's easy to find them (e.g. --pacov: etc etc).

Since I know what to look for in this particular instance, I'll write a hook for it for demonstration purposes, but in the future I'd highly recommend starting with a blank file and learning to do proper hooks - it's actually pretty simple, and it makes troubleshooting and debugging a lot easier (especially for people trying to help you):

Code: c++
--save a local copy of the original OnHeroChange
local prevOnHeroChange = OnHeroChange
--re-define the function
function OnHeroChange(unit)
    --call the saved instance
    prevOnHeroChange(unit)
    --make sure the saved instance set the 'hero' variable
    --that is declared at the top of the original file
    --if it's nil, that means we're in observer mode
    --we could also check 'unit', as that's what the original
    --sets 'hero' to, I'm just mimicking the check that
    --the original does in case I missed something
    if hero then
        --these will have all been hidden by the original
        --instance of the function that we just ran, but
        --we can just Show() them afterward without any
        --visual disruption
        xpTxt:Show()
        xptolevelTxt:Show()
    else
        --if no hero, then insure that the bar is hidden
        bar:Hide()
    end
end
local prevCreate = Create
function Create(parent)
    --call saved, storing what it returns in a local
    local xpBarImg = prevCreate(parent) 
    --change the position of the controls the original function created
    --in this particular case, their reference variables are defined
    --at the top of the file, so we don't need to reference them
    --within the table/control that the saved function returns
    LayoutHelpers.AtLeftIn(xptolevelTxt, bar, 76)
    
    --un-do the Hide() that the bar's HandleEvent does on mouseover
    --first we need to save a copy of the original HandleEvent so that
    --other mods' hooks of this function are preserved
    --we could just nil this function out - the whole dummy object,
    --in fact - but then if another mod attempted to hook it, it would
    --generate an error and/or not work at all, so we need to play nice
    local prevHandleEvent = bar.dummy.HandleEvent
    --redefine it
    bar.dummy.HandleEvent = function(self, event)
        --call the saved copy
        prevHandleEvent(self, event)
        --counteract the appropriate Hide() on mouse enter/exit
        if event == 'MouseEnter' then
            xpTxt:Show()
        elseif event == 'MouseExit' then
            xptolevelTxt:Show()
        end
    end
    
    --return stored local, i.e. what the original function returned
    --this must be done, because the UI function that calls Create
    --uses the control object it returns
    return xpBarImg
end

Hopefully you can figure out what is being done and why from the comments. I'd highly recommend downloading an editor like Notepad++ that does lua syntax highlighting, if you don't already have one. It makes the comments more obvious and readable, if nothing else.

Take a stab at doing your next hook from a blank file, and post if you need help with anything. Most of the UI isn't too difficult to hook, and changing the layout is usually just a matter of hooking a file's Create and adjusting positions etc after running the original function.

Successfully updated karma reason!

Good tips - I'll be sure to leave comments going forward. I'll dig into this sometime tomorrow. Thanks for taking the time, miri!

oh - and I only use notepad ++, so I've got that covered at least.

Successfully updated karma reason!

I'll try to sort through what you coded there. I just ran it on the quick and it works great until you mouse over it. Then it reverts to the original behavior.

Successfully updated karma reason!

ah - got it sorted now. I changed...

Code: c++
if event == 'MouseEnter' then
                xpTxt:Show()
            elseif event == 'MouseExit' then
                xptolevelTxt:Show()

Code: c++
if event.Type == 'MouseEnter' then
                xpTxt:Show()
            elseif event.Type == 'MouseExit' then
                xptolevelTxt:Show()

Successfully updated karma reason!

Compiled and uploaded new version.

Successfully updated karma reason!

Whoops, I missed that. Obviously I typed it out by hand and didn't test it. Sometimes it pays to copy bits and pieces of the original, and reduce it down to what you need, as it eliminates these kinds of errors.

Successfully updated karma reason!

Quoting miriyaka,

reply 9

yah - i know. I'm just glad I was able to figure out what it was Thanks again for all the comments in the code, though. Very helpful.

Successfully updated karma reason!

Miri - if you magically find yourself having some free time (and are feeling super helpful), I thought of one more bit of info I'd like to see added after the XP info. I would love to see the total amount of warscore required for the next level. It could be setup exactly like xp (100/1000 to level 2). At least when I think of it, I would probably like it best if it was changed to just show something like this: 1000 WS to level 10 (and just have 1000 drop). That might even be a better way to display the XP info.

I'm finding that I glance down from time to time to check out that XP info, but perhaps if we just showed a decreasing counter, that might be even better. Anyway, if you have chance to check out the WS display, I'd appreciate it. Thanks!

Successfully updated karma reason!

Adding that to the actual scoreboard would probably be easier. Take a look at HUD_scoreboard (and the in-game scoreboard itself), and see if you can find a way to fit in another 5 digits plus parentheses or brackets next to the war score.

Successfully updated karma reason!

The Forums Are Now Closed!

The content will remain as a historical reference, thank you.

[Mod] Always Visible Health Mana XP Text

pacov