Shield Engine 1.4.1

[Lesslife00]

Just as I was struggling to write my own!

 

[Marchombre]

Just as I was struggling to write my own!

Well, it means it was needed

If you see something missing, feel free to point it out.

 

[KitsuneTailsPrower]

Not to burst your bubble but you've got tough competition for a shield system (not mine) already GUI Friendly Shield System 1.00b

 

[Marchombre]

Not to burst your bubble but you've got tough competition for a shield system (not mine) already GUI Friendly Shield System 1.00b

Oh, why on earth did it not come up in my search result when I tried to look for something like this ?
All I could find was some really outdated systems. Guess I'm blind

Thanks for linking it, I'll look and see if it covers the same things (and how it's probably more optimized than mine).

 

[Lt_Hawkeye]

Personally I prefer this system over the one linked namely because its signficantly easier to import and the system code and api is all in one place for quick viewing.

 

[Marchombre]

Found a few things to fix.

---

Version 1.1.0

---

Added:

• API description
• ShieldEngine.IsUnitShielded : tells if unit has at least one shield attached to them
• ShieldEngine.UnitHasShield : tells if unit has a shield with given name
• ShieldEngine.CreateTimedShield : Simplified version for ShieldEngine.CreateShield with much less parameters.
• Triggers to use remove and destroy shield functions.

Bug fixes:

• Fixed a bug where shield effect and shield HP bar would not be destroyed for Attack & Spell shields when shield was stacked.
• Fixed a bug where shield HP bar would not correctly update when shield was stacked.
• Fixed an issue where some functions would check shieldType instead of shieldProcType or shieldHpType.

---

Version 1.1.1

---

Bug fixes:
- Units and their shields are now properly removed from the system if they're unindex by UnitEvent.

---

 

[Marchombre]

After playing with the system a bit, I added a few things that were needed.
Updated this thread to detail Jass API.

---

Version 1.2.0

---

Added:

• GUI variables:
  • ShieldAbsorbedDamageSource - unit - Who did the last damage absorbed by this shield
  • ShieldBaseMaxHP - real - Initial max HP when shield was casted, before any modification
  • ShieldPrvMaxHP - real - Max HP at the end of previous step
  • ShieldBaseDuration - real - Initial duration when shield was casted, before any modification
  • ShieldPrvDuration - real - Duration at the end of previous step
• Jass Functions:
  • ShieldEngine.UnitHasActiveShield - tells if a unit has at least one shield with current HP >= 1.0
  • ShieldEngine.UnitHasActiveShieldOfType - tells if a unit has at least one shield of given type with current HP >= 1.0
  • ShieldEngine.CreateInstanceShield - Simplified version for ShieldEngine.CreateShield with much less parameters for Instance shields.

 

[Antares]

This is very well-written and great for GUI users. The only gripe I have is that the API for non-GUI users could be better. Instead of a function with 15 input arguments, you could make an input data struct which you can create and then set the fields and overwrite the various default values.

If you're feeling really adventurous, you could make function interface fields for onAbsorb, onBreak etc. callbacks that replace the GUI event variables.

 

[Marchombre]

This is very well-written and great for GUI users.

Well, thanks a lot.

The only gripe I have is that the API for non-GUI users could be better. Instead of a function with 15 input arguments, you could make an input data struct which you can create and then set the fields and overwrite the various default values.

API for non-GUI users bothered me a bit too, which is why I started to create some simplified versions of ShieldEngine.CreateShield
I didn't think of using a struct for parameters, and probably would be better indeed.

Is something like the following what you would be looking for ?

struct ShieldParameters
        public unit source
        public unit target
        public string name
        public string sfxPath
        public string attachPoint
        public integer shieldProcType
        public integer shieldType
        public integer shieldHpType
        public boolean isStackable
        public boolean isTimed
        public real duration
        public real HP
        public boolean breakAtZero
        public boolean canRegen
        public real timeBeforeRegen
        public real regenTime
  
        public method CreateShield takes nothing returns boolean
            if this.target != null and this.name != null then
                call ShieldEngine.CreateShield(this.source, this.target, this.name, this.sfxPath, this.attachPoint, this.shieldProcType, this.shieldType, this.shieldHpType, this.isStackable, this.isTimed, this.duration, this.HP, this.breakAtZero, this.canRegen, this.timeBeforeRegen, this.regenTime)
              
                return true
            endif
            return false
        endmethod
          
          
        public static method create takes nothing returns ShieldParameters
            local ShieldParameters this = ShieldParameters.allocate()
            set this.source             = null
            set this.target             = null
            set this.name               = null
            set this.sfxPath            = SHIELD_DEFAULT_SFX_PATH
            set this.attachPoint        = SHIELD_DEFAULT_ATTACH_POINT
            set this.shieldProcType     = SHIELD_PROC_POSTREDUC
            set this.shieldType         = SHIELD_TYPE_HP_BASED
            set this.shieldHpType       = SHIELD_HP_TYPE_ALL
            set this.isStackable        = false
            set this.isTimed            = false
            set this.duration           = 0.00
            set this.HP                 = 0.00
            set this.breakAtZero        = true
            set this.canRegen           = false
            set this.timeBeforeRegen    = 0.00
            set this.regenTime          = 0.00
            return this
        endmethod
        public method destroy takes nothing returns nothing
            call this.deallocate()
        endmethod
    endstruct

If you're feeling really adventurous, you could make function interface fields for onAbsorb, onBreak etc. callbacks that replace the GUI event variables.

This does sound great, but also a lot more work to make it work, so not planned for now
Might look into it later on tho.

 

[Antares]

Yes, that looks good. My vJASS knowledge is a bit rusty, but I think your destroy method is redundant because deallocate is the default destroy method already.

 

[Marchombre]

My vJASS knowledge is a bit rusty, but I think your destroy method is redundant because deallocate is the default destroy method already.

Indeed. I just took the habit to write create and destroy method on every struct so I do not forget. But I removed it there because it wasn't needed.

Version 1.3.0

---

Added a parameter structure with default values to make things easier for Jass User.
How to use:

set parameters = ShieldParameters.create()
set parameters.name = "YourName"
set parameters.target = yourTarget

call parameters.CreateShield()

You can also catch the result of parameters.CreateShield().
It'll return true if the shield creation has been called, or false if name or target has not been set.

 

[Antares]

Yep, that works perfectly.

Well-made system, well documented, easy to use.

High Quality

 

[Marchombre]

Yep, that works perfectly.

Well-made system, well documented, easy to use.

High Quality

Wow, high quality, I'm going to blush

Thanks for the approval !

 

[M1stery]

Hello! Is it possible to replace the CustomBar with a Shield Current HP / Shield Max HP number display?

 

[Wing-Span]

I did some tests and found bugs. In 95% of cases they are only visual, but a couple of times I encountered the fact that the shield was not applied at all.

(what is shown in the picture never disappears, I achieved this by spamming the spell for 3 minutes)

In general, if you don't abuse it, it works well. I just always want to see an ideal system))

By the way, if you make the shield stackable, then the bugs seem to disappear.

 

[Marchombre]

Hello! Is it possible to replace the CustomBar with a Shield Current HP / Shield Max HP number display?

Currently, no. But this might be a good idea indeed, so I'll probably add this in a future version.

I did some tests and found bugs. In 95% of cases they are only visual, but a couple of times I encountered the fact that the shield was not applied at all.

(what is shown in the picture never disappears, I achieved this by spamming the spell for 3 minutes)

In general, if you don't abuse it, it works well. I just always want to see an ideal system))

By the way, if you make the shield stackable, then the bugs seem to disappear.

Well, I guess I did not stress tested enough
The is weird indeed. I'll need to test this more to see how I can prevent stuff like that.

 

[Wing-Span]

Currently, no. But this might be a good idea indeed, so I'll probably add this in a future version.



Well, I guess I did not stress tested enough
The is weird indeed. I'll need to test this more to see how I can prevent stuff like that.

there is a simple stress test. Place 500 units on the map, and trigger it to put a shield on each unit selected in the zone of the game map. When I did this, something happened to something.

 

[P3in]

Dang, i ended up doing a little shield system, how i did not see this?

lol, it's amazing, congrats!

I am posting it in case someone would need it

The shield bar is dope, i think i will implement that aswell.

scope ShieldAdd initializer Init_ShieldAdd

globals
    hashtable ShieldTable = null
    constant string DEFAULT_SHIELD_SFX = ""
    constant string DEFAULT_SHIELD_ATTACH = "chest"
    constant real TEXTTAG_HEIGHT = 80.0
    constant real UPDATE_PERIOD = 0.06

    
    constant integer SHIELD_EXPLOSION_DMG = 10
    constant integer SHIELD_EXPLOSION_AOE = 11
    constant integer SHIELD_EXPLOSION_SFX = 12
    constant integer SHIELD_HAS_SHIELD = 20
endglobals

// ========== REMOVE SHIELD (cleanup all effects/tags/timers) ==========
function RemoveShield takes unit u returns nothing
    local integer id = GetHandleId(u)
    local texttag tag = LoadTextTagHandle(ShieldTable, id, 1)
    local timer t = LoadTimerHandle(ShieldTable, id, 2)
    local effect fx = LoadEffectHandle(ShieldTable, id, 3)
    call BJDebugMsg("RemoveShield: removing shield from " + GetUnitName(u) + " (id " + I2S(id) + ")")
    if tag != null then
        call DestroyTextTag(tag)
        call SaveTextTagHandle(ShieldTable, id, 1, null)
        call BJDebugMsg("RemoveShield: destroyed tag")
    endif
    if t != null then
        call PauseTimer(t)
        call DestroyTimer(t)
        call SaveTimerHandle(ShieldTable, id, 2, null)
        call BJDebugMsg("RemoveShield: destroyed timer")
    endif
    if fx != null then
        call DestroyEffect(fx)
        call SaveEffectHandle(ShieldTable, id, 3, null)
        call BJDebugMsg("RemoveShield: destroyed effect")
    endif
    call SaveBoolean(ShieldTable, id, SHIELD_HAS_SHIELD, false)
    call FlushChildHashtable(ShieldTable, id)
    call BJDebugMsg("RemoveShield: flushed hashtable for id " + I2S(id))
endfunction


// ========== EXPLOSION ON EXPIRE/BREAK ==========
function ShieldAdd_Explosion takes unit u returns nothing
    local integer id = GetHandleId(u)
    local real aoe = LoadReal(ShieldTable, id, SHIELD_EXPLOSION_AOE)
    local real dmg = LoadReal(ShieldTable, id, SHIELD_EXPLOSION_DMG)
    local string sfx = LoadStr(ShieldTable, id, SHIELD_EXPLOSION_SFX)
    local group g
    local unit v
    if dmg > 0 and aoe > 0 then
        set g = CreateGroup()
       // call BJDebugMsg("ShieldAdd_Explosion: Exploding shield on unit id " + I2S(id) + ", aoe=" + R2S(aoe) + ", dmg=" + R2S(dmg))
        call GroupEnumUnitsInRange(g, GetUnitX(u), GetUnitY(u), aoe, null)
        loop
            set v = FirstOfGroup(g)
            exitwhen v == null
            call GroupRemoveUnit(g, v)
            if IsUnitEnemy(v, GetOwningPlayer(u)) and UnitAlive(v) then
              //  call BJDebugMsg("ShieldAdd_Explosion: Damaging " + GetUnitName(v) + " for " + R2S(dmg))
                call UnitDamageTarget(u, v, dmg, true, false, ATTACK_TYPE_NORMAL, DAMAGE_TYPE_MAGIC, null)
                if sfx != "" then
                    call DestroyEffect(AddSpecialEffectTarget(sfx, v, "chest"))
                endif
            endif
        endloop
        call DestroyGroup(g)
    elseif sfx != "" then
        call DestroyEffect(AddSpecialEffect(sfx, GetUnitX(u), GetUnitY(u)))
       // call BJDebugMsg("ShieldAdd_Explosion: Only played SFX (no aoe/dmg)")
    else
     //   call BJDebugMsg("ShieldAdd_Explosion: No explosion (dmg/aoe not set)")
    endif
endfunction

// ========== UPDATE SHIELD TEXT (arcing tag, updates every tick) ==========
function ShieldAdd_Shield_Update takes nothing returns nothing
    local timer t = GetExpiredTimer()
    local unit u = LoadUnitHandle(ShieldTable, GetHandleId(t), 0)
    local integer id
    local real shield
    local real remaining
    local string text
    // call BJDebugMsg("UPDATE SHIELD PERIODIC RUN")
    if u == null then
        // call BJDebugMsg("UPDATE: unit is null, destroying timer")
        call DestroyTimer(t)
        return
    endif
    set id = GetHandleId(u)
    set shield = LoadReal(ShieldTable, id, 0)
    set remaining = LoadReal(ShieldTable, id, 4)
    set remaining = remaining - UPDATE_PERIOD // decrement duration
    call SaveReal(ShieldTable, id, 4, remaining)
    // call BJDebugMsg("UPDATE: shield=" + R2S(shield) + ", remaining=" + R2S(remaining))
    set text = "|c00A0FFFFShield: " + I2S(R2I(shield)) + "|r"
    if remaining > 0.0 then
        set text = text + " (" + I2S(R2I(remaining + 0.999)) + "s)"
    endif
    //call ArcingTextTag.createEx(text, u, 0.9, 1.0, GetOwningPlayer(u))
    if shield > 0.0 and remaining > 0.0 then
        call TimerStart(t, UPDATE_PERIOD, false, function ShieldAdd_Shield_Update)
    else
      //  call BJDebugMsg("ShieldAdd: shield expired or depleted on " + GetUnitName(u))
        call ArcingTextTag.createEx("|cffbbbbff[Shield expired]|r", u, 1.1, 1.2, GetOwningPlayer(u))
        call ShieldAdd_Explosion(u)
        call RemoveShield(u)
    endif
endfunction

// ========== EXPIRE SHIELD (by timer, force remove) ==========
function ShieldAdd_Shield_Expire takes nothing returns nothing
    local timer t = GetExpiredTimer()
    local unit u = LoadUnitHandle(ShieldTable, GetHandleId(t), 0)
    // call BJDebugMsg("Expire function called, removing shield")
    call ShieldAdd_Explosion(u)
    call RemoveShield(u)
endfunction

// ========== GIVE SHIELD, with sfx and attach, and explosion support ==========
function GiveShieldSFXEx takes unit u, real amount, real duration, string sfx, string attach, real explosionDmg, real explosionAoe, string explosionSfx, boolean forceOverwrite returns nothing
    local integer id = GetHandleId(u)
    local timer t
    local effect fx = null

    if not forceOverwrite and LoadBoolean(ShieldTable, id, SHIELD_HAS_SHIELD) then
        //call BJDebugMsg("GiveShieldSFXEx: unit " + GetUnitName(u) + " (id " + I2S(id) + ") already has a shield, new shield not applied.")
        return
    endif

    call RemoveShield(u) // Always remove before applying
   // call BJDebugMsg("GiveShieldSFXEx: applying shield to " + GetUnitName(u) + " (id " + I2S(id) + ") (forceOverwrite=" + I2S(B2I(forceOverwrite)) + ")")
    call SaveBoolean(ShieldTable, id, SHIELD_HAS_SHIELD, true)
    call SaveReal(ShieldTable, id, 0, amount)
    call SaveUnitHandle(ShieldTable, id, 0, u)
    if sfx != "" then
        set fx = AddSpecialEffectTarget(sfx, u, attach)
        call SaveEffectHandle(ShieldTable, id, 3, fx)
    endif
    call SaveReal(ShieldTable, id, 4, duration)
    call SaveReal(ShieldTable, id, SHIELD_EXPLOSION_DMG, explosionDmg)
    call SaveReal(ShieldTable, id, SHIELD_EXPLOSION_AOE, explosionAoe)
    call SaveStr(ShieldTable, id, SHIELD_EXPLOSION_SFX, explosionSfx)
    set t = CreateTimer()
    call SaveTimerHandle(ShieldTable, id, 2, t)
    call SaveUnitHandle(ShieldTable, GetHandleId(t), 0, u)
    call TimerStart(t, UPDATE_PERIOD, false, function ShieldAdd_Shield_Update)
endfunction



// Old interface for backward compatibility (no explosion)
function GiveShieldSFX takes unit u, real amount, real duration, string sfx, string attach returns nothing
    call GiveShieldSFXEx(u, amount, duration, sfx, attach, 0.0, 0.0, "", false)
endfunction

// ========== GIVE SHIELD (direct), duration and optional SFX ==========
function GiveShield takes unit u, real amount, real duration returns nothing
    call GiveShieldSFX(u, amount, duration, DEFAULT_SHIELD_SFX, DEFAULT_SHIELD_ATTACH)
endfunction

// ========== GIVE SHIELD ONLY IF BUFF PRESENT ==========
function GiveShieldWithBuff takes unit u, real amount, real duration, integer buffid returns nothing
    if GetUnitAbilityLevel(u, buffid) > 0 then
        call GiveShield(u, amount, duration)
    endif
endfunction

// ========== DAMAGE ENGINE: SHIELD ABSORB (to be registered on udg_DamageModifierEvent) ==========
function ShieldAdd_OnShieldDamage takes nothing returns nothing
    local unit u = udg_DamageEventTarget
    local integer id = GetHandleId(u)
    local real shield = LoadReal(ShieldTable, id, 0)
    local real dmg = udg_DamageEventAmount
    // call BJDebugMsg("OnShieldDamage: shield=" + R2S(shield) + ", dmg=" + R2S(dmg))
    if shield > 0.0 then
        if dmg >= shield then
            set udg_DamageEventAmount = dmg - shield // pass overkill
            // call BJDebugMsg("OnShieldDamage: shield broken!")
            call ShieldAdd_Explosion(u)
            call RemoveShield(u)
            call ArcingTextTag.createEx("|c00FF4040[Shield Broken]|r", u, 1.0, 1.0, GetOwningPlayer(u))
        else
            set udg_DamageEventAmount = 0.0
            set shield = shield - dmg
            call SaveReal(ShieldTable, id, 0, shield)
            // call BJDebugMsg("OnShieldDamage: shield reduced, new value=" + R2S(shield))
            call ArcingTextTag.createEx("|c00A0FFFFShield: " + I2S(R2I(shield)) + "|r", u, 0.9, 1.0, GetOwningPlayer(u))
        endif
    endif
endfunction

// ========== GIVE SHIELD USING AbiDamage (all params, supports explosion/overwrite) ==========

function DOSHIELD takes unit source, unit target, real flat, real lvlScale, real statScale, real adScale, real armorScale, real hpScale, real curhpScale, real manaScale, real curmanaScale, real msScale, real asScale, real perStack, boolean showDebug, integer abilityId, real duration, string sfx, string attach, real explosionDmg, real explosionAoe, string explosionSfx, boolean forceOverwrite returns nothing
    local real shieldAmount = AbiDamage(source, target, flat, lvlScale, statScale, adScale, armorScale, hpScale, curhpScale, manaScale, curmanaScale, msScale, asScale, perStack, showDebug, abilityId)
    call GiveShieldSFXEx(target, shieldAmount, duration, sfx, attach, explosionDmg, explosionAoe, explosionSfx, forceOverwrite)
endfunction

function DOAOESHIELD takes unit source, real x, real y, real radius, real flat, real lvlScale, real statScale, real adScale, real armorScale, real hpScale, real curhpScale, real manaScale, real curmanaScale, real msScale, real asScale, real perStack, boolean showDebug, integer abilityId, real duration, string sfx, string attach returns nothing
    local group g = CreateGroup()
    local unit v
    local real amt
    call GroupEnumUnitsInRange(g, x, y, radius, null)
    loop
        set v = FirstOfGroup(g)
        exitwhen v == null
        call GroupRemoveUnit(g, v)
        if IsUnitAlly(v, GetOwningPlayer(source)) and UnitAlive(v) then
            set amt = AbiDamage(source, v, flat, lvlScale, statScale, adScale, armorScale, hpScale, curhpScale, manaScale, curmanaScale, msScale, asScale, perStack, showDebug, abilityId)
            call GiveShieldSFX(v, amt, duration, sfx, attach)
        endif
    endloop
    call DestroyGroup(g)
endfunction

// ========== INITIALIZER ==========
private function Init_ShieldAdd takes nothing returns nothing
    local trigger t = CreateTrigger()
    set ShieldTable = InitHashtable()
    call TriggerRegisterVariableEvent(t, "udg_DamageModifierEvent", EQUAL, 1)
    call TriggerAddAction(t, function ShieldAdd_OnShieldDamage)
    // call BJDebugMsg("Init_ShieldAdd called")
endfunction

private function Init takes nothing returns nothing
    call Init_ShieldAdd()
    // call BJDebugMsg("ShieldAdd: system fully initialized.")
endfunction
endscope

 

[Wing-Span]

Even in a normal game, when the shield is applied to 4-5 units once per minute, sometimes a visual bug appears with a shield strip hanging in the air. Is there any way to select all previously created effects and remove them?

 

[Wing-Span]

Okay, I fixed all the visual bugs by making some adjustments to the code.

I replaced:

        public static method RemoveUnitFromSystem takes nothing returns nothing

            local integer uId = udg_UDex

            local ShieldWielder wielder



            if isInSystem[uId] then

                set wielder = unitToWielder[uId]



                call ShieldEngine.RemoveAllShields(wielder.wielder)

            endif

        endmethod

With this for confidence.

public static method RemoveUnitFromSystem takes nothing returns nothing

       local integer uId = udg_UDex

       local ShieldWielder wielder

       local Shield shield



       if isInSystem[uId] then

           set wielder = unitToWielder[uId]

       

 

           set shield = wielder.firstPreReduc

           loop

               exitwhen shield == 0

               if shield.visualEffect != null then

                   call DestroyEffect(shield.visualEffect)

                   set shield.visualEffect = null

               endif

               set shield = shield.next

           endloop

       

    

           call ShieldEngine.RemoveAllShields(wielder.wielder)

       endif

   endmethod

And this:

public method RemoveShield takes Shield shield returns nothing

            if shield == this.firstPreReduc then

                set this.firstPreReduc = shield.next

            elseif shield == this.firstPostReduc then

                set this.firstPostReduc = shield.next

            elseif shield == this.firstPreReducAttack then

                set this.firstPreReducAttack = shield.next

            elseif shield == this.firstPostReducAttack then

                set this.firstPostReducAttack = shield.next

            elseif shield == this.firstPreReducSpell then

                set this.firstPreReducSpell = shield.next

            elseif shield == this.firstPostReducSpell then

                set this.firstPostReducSpell = shield.next

            endif



            if shield == this.lastPreReduc then

                set this.lastPreReduc = shield.prev

            elseif shield == this.lastPostReduc then

                set this.lastPostReduc = shield.prev

            elseif shield == this.lastPreReducAttack then

                set this.lastPreReducAttack = shield.prev

            elseif shield == this.lastPostReducAttack then

                set this.lastPostReducAttack = shield.prev

            elseif shield == this.lastPreReducSpell then

                set this.lastPreReducSpell = shield.prev

            elseif shield == this.lastPostReducSpell then

                set this.lastPostReduc = shield.prev

            endif



            if shield.prev != 0 then

                set shield.prev.next = shield.next

            endif

            if shield.next != 0 then

                set shield.next.prev = shield.prev

            endif

        

            call this.AdjustShieldBars("remove", shield)

            call ShieldEngine.CheckRemoveWielder(this)

        endmethod

On this one:

        public method RemoveShield takes Shield shield returns nothing



    if shield.visualEffect != null then

        call DestroyEffect(shield.visualEffect)

        set shield.visualEffect = null

    endif



    if shield == this.firstPreReduc then

        set this.firstPreReduc = shield.next

    elseif shield == this.firstPostReduc then

        set this.firstPostReduc = shield.next

    elseif shield == this.firstPreReducAttack then

        set this.firstPreReducAttack = shield.next

    elseif shield == this.firstPostReducAttack then

        set this.firstPostReducAttack = shield.next

    elseif shield == this.firstPreReducSpell then

        set this.firstPreReducSpell = shield.next

    elseif shield == this.firstPostReducSpell then

        set this.firstPostReducSpell = shield.next

    endif



    if shield == this.lastPreReduc then

        set this.lastPreReduc = shield.prev

    elseif shield == this.lastPostReduc then

        set this.lastPostReduc = shield.prev

    elseif shield == this.lastPreReducAttack then

        set this.lastPreReducAttack = shield.prev

    elseif shield == this.lastPostReducAttack then

        set this.lastPostReducAttack = shield.prev

    elseif shield == this.lastPreReducSpell then

        set this.lastPreReducSpell = shield.prev

    elseif shield == this.lastPostReducSpell then

        set this.lastPostReduc = shield.prev

    endif



    if shield.prev != 0 then

        set shield.prev.next = shield.next

    endif

    if shield.next != 0 then

        set shield.next.prev = shield.prev

    endif

 

    call this.AdjustShieldBars("remove", shield)



    call ShieldEngine.CheckRemoveWielder(this)

endmethod

There are still some visual bugs, but at least they disappear after the shield wears off, which is good news.
And now I can cast a shield on 100 units at once.

 

[Marchombre]

Well spotted, I indeed forgot to destroy shields when the shield is remove silently (without event)
Which, in turn, doesn't destroy the attached effect.
This will probably cause some memory leak too, as the shield structure is not in the system anymore and yet not destroyed.

You should only need to change the ShieldWielder.RemoveShieldsByType function tho.
Adding call shield.destroy() after removing the shield.
This should destroy the struct and the associated effect.

Spoiler: New RemoveShieldsByType

public method RemoveShieldsByType takes integer hpType returns nothing
        local Shield shield

        if hpType == SHIELD_HP_TYPE_ALL then
            set shield = this.firstPreReduc
        elseif hpType == SHIELD_HP_TYPE_ATTACK then
            set shield = this.firstPreReducAttack
        elseif hpType == SHIELD_HP_TYPE_SPELL then
            set shield = this.firstPreReducSpell
        endif

        loop
            exitwhen shield == 0

            call this.RemoveShield(shield)
            call shield.destroy()

            set shield = shield.next
        endloop

        if hpType == SHIELD_HP_TYPE_ALL then
            set shield = this.firstPostReduc
        elseif hpType == SHIELD_HP_TYPE_ATTACK then
            set shield = this.firstPostReducAttack
        elseif hpType == SHIELD_HP_TYPE_SPELL then
            set shield = this.firstPostReducSpell
        endif

        loop
            exitwhen shield == 0

            call this.RemoveShield(shield)
            call shield.destroy()

            set shield = shield.next
        endloop
endmethod

I'll post a new version when I'll have more time to test a bit more (after the techtree contest most likely).
In the meantime, feel free to point out other cases of failure / bugs

 

[Wing-Span]

Well spotted, I indeed forgot to destroy shields when the shield is remove silently (without event)
Which, in turn, doesn't destroy the attached effect.
This will probably cause some memory leak too, as the shield structure is not in the system anymore and yet not destroyed.

You should only need to change the ShieldWielder.RemoveShieldsByType function tho.
Adding call shield.destroy() after removing the shield.
This should destroy the struct and the associated effect.

Spoiler: New RemoveShieldsByType

public method RemoveShieldsByType takes integer hpType returns nothing
        local Shield shield

        if hpType == SHIELD_HP_TYPE_ALL then
            set shield = this.firstPreReduc
        elseif hpType == SHIELD_HP_TYPE_ATTACK then
            set shield = this.firstPreReducAttack
        elseif hpType == SHIELD_HP_TYPE_SPELL then
            set shield = this.firstPreReducSpell
        endif

        loop
            exitwhen shield == 0

            call this.RemoveShield(shield)
            call shield.destroy()

            set shield = shield.next
        endloop

        if hpType == SHIELD_HP_TYPE_ALL then
            set shield = this.firstPostReduc
        elseif hpType == SHIELD_HP_TYPE_ATTACK then
            set shield = this.firstPostReducAttack
        elseif hpType == SHIELD_HP_TYPE_SPELL then
            set shield = this.firstPostReducSpell
        endif

        loop
            exitwhen shield == 0

            call this.RemoveShield(shield)
            call shield.destroy()

            set shield = shield.next
        endloop
endmethod

I'll post a new version when I'll have more time to test a bit more (after the techtree contest most likely).
In the meantime, feel free to point out other cases of failure / bugs

My correction = it's a crutch. So I'm waiting for a new quality version!

btw
Besides the visuals, what confuses me is that when I cast a mass shield on my army fighting another army, for some reason my hero's shield gradually gets removed, as if he is being attacked, even though he is not in combat.

Moreover, it is removed very slowly, since my army has 1000 armor. Apparently, my hero is indexed as one of the warriors in the army for some reason.

 

[Wing-Span]

I noticed something else: the mana shield does not work with the physical shield. In short, manashit is taken into account first.
Because Damagearmor doesn't stack with Manashield. I changed it to Predamage and everything became normal, but now you also need to take armor into account, in short, yeah...

 

[Marchombre]

Yeah, manashield is known to be pre-reduction.
Best probably is to trigger mana shield with ShieldEngine.

Give a shield with an amount equal to current mana that proc after armor, and substract mana on ShieldAbsorbEvent.

 

[Wing-Span]

Sometimes, once every 100 uses spell "mass-shield", I get the bar to get stuck on one spot instead of sticking to the unit. I dug into the code a bit and found something. call this.shieldBar.Show and call this.shieldBar.showCB() should be on cb.Show and cb.showCB() to properly initialize and start updating the bar. I could be wrong.

 

[Marchombre]

Sometimes, once every 100 uses spell "mass-shield", I get the bar to get stuck on one spot instead of sticking to the unit. I dug into the code a bit and found something. call this.shieldBar.Show and call this.shieldBar.showCB() should be on cb.Show and cb.showCB() to properly initialize and start updating the bar. I could be wrong.

Nice catch !
Something I forgot to change when I added support for multiple shield type


I'll add that to next version

 

[Wing-Span]

By the way, I previously found another bug with the shield bar: when activating any spells, even enemy ones, the bar can suddenly appear and get stuck in the air forever (this happens very rarely). I made a few more changes for stability, after which this bug probably disappeared. Perhaps you will take note of something from this.

public method destroy takes nothing returns nothing
    if this.shieldBar != 0 then
        call this.shieldBar.destroy()
        set this.shieldBar = 0
    endif
    if this.spellShieldBar != 0 then
        call this.spellShieldBar.destroy()
        set this.spellShieldBar = 0
    endif
    if this.attackShieldBar != 0 then
        call this.attackShieldBar.destroy()
        set this.attackShieldBar = 0
    endif
    call this.deallocate()
endmethod

The point is that this will add a "call to remove the bar" (destroy bar) exactly where the system finally clears the unit of shields. After that, the bar should not "resurrect" when casting spells, since the CustomBar resources will be completely freed.

 

[Marchombre]

By the way, I previously found another bug with the shield bar: when activating any spells, even enemy ones, the bar can suddenly appear and get stuck in the air forever (this happens very rarely). I made a few more changes for stability, after which this bug probably disappeared. Perhaps you will take note of something from this.

public method destroy takes nothing returns nothing
    if this.shieldBar != 0 then
        call this.shieldBar.destroy()
        set this.shieldBar = 0
    endif
    if this.spellShieldBar != 0 then
        call this.spellShieldBar.destroy()
        set this.spellShieldBar = 0
    endif
    if this.attackShieldBar != 0 then
        call this.attackShieldBar.destroy()
        set this.attackShieldBar = 0
    endif
    call this.deallocate()
endmethod

The point is that this will add a "call to remove the bar" (destroy bar) exactly where the system finally clears the unit of shields. After that, the bar should not "resurrect" when casting spells, since the CustomBar resources will be completely freed.

Damn, you have been hunting bugs like crazy
I guess that destroy method is for ShieldWielder structure ?

Hmm. There shouldn't be a need to do clear that, as a ShieldWielder instance should be destroyed if and only if all of its shields are removed
Guess I'll add that to the list of things to check

 

[Wing-Span]

Damn, you have been hunting bugs like crazy
I guess that destroy method is for ShieldWielder structure ?

Hmm. There shouldn't be a need to do clear that, as a ShieldWielder instance should be destroyed if and only if all of its shields are removed
Guess I'll add that to the list of things to check

Yes, this change did not fix the problem. The bars still occasionally randomly appear on units, even when the shield spell is not activated. Then, when new zits are applied to these units, the bars are forever stuck in the air. If only there was a trigger that, when a new bar is applied, checks if the old one is there and removes it... Yes, it's a crutch, but it will remove visual bugs from the game.

 

[Regno]

Mandatory - Bribe's GUI Unit Event, Bribe's Damage Engine 5.A.0, Anachron's CustomBar

Do we need GUI Unit Event if we only import and use the vJass? I got the damage angine and CustomBar implemented

 

[Marchombre]

Mandatory - Bribe's GUI Unit Event, Bribe's Damage Engine 5.A.0, Anachron's CustomBar

Do we need GUI Unit Event if we only import and use the vJass? I got the damage angine and CustomBar implemented

It is currently needed.
Used to remove units from shield engine on death/removal.

 

[ElevatorEleven]

Bug report. Visual. Dunno if this got fixed already by any of the stuff people said above, but I didn't see anyone mention this in particular.

Looks like the bar doesn't refill properly for HP Based shields that regenerate. At first I thought that HP shields just couldn't regenerate at all, but it seems they do, just without showing it. I redownloaded the demo map and changed literally nothing except making Magic Shield be HP Based instead of Instanced, and changed its HP to be 101 instead of 3, then I cast it on a guy and hit that guy with one frost bolt, then another. The shield bar went down to almost nothing on the first hit and stayed there, then went down to literally empty on the second hit, but the shield wasn't destroyed.

 

[HeavenlyHero]

Hey bro, I'm liking your shield system. I've tried it out, and I like that it's easy to use, but I have a question... Can I add new types of shields, bro?

 

[Marchombre]

Bug report. Visual. Dunno if this got fixed already by any of the stuff people said above, but I didn't see anyone mention this in particular.

Looks like the bar doesn't refill properly for HP Based shields that regenerate. At first I thought that HP shields just couldn't regenerate at all, but it seems they do, just without showing it. I redownloaded the demo map and changed literally nothing except making Magic Shield be HP Based instead of Instanced, and changed its HP to be 101 instead of 3, then I cast it on a guy and hit that guy with one frost bolt, then another. The shield bar went down to almost nothing on the first hit and stayed there, then went down to literally empty on the second hit, but the shield wasn't destroyed.
View attachment 582999
View attachment 583000

Will check that as soon I have time to work on this again.

Hey bro, I'm liking your shield system. I've tried it out, and I like that it's easy to use, but I have a question... Can I add new types of shields, bro?

There isn't at the moment a way to configure an other type of shield atm, but the system cover many types of shields and usages.
What kind of shield are you thinking about that can't be done with it ?

 

[HeavenlyHero]

Will check that as soon I have time to work on this again.


There isn't at the moment a way to configure an other type of shield atm, but the system cover many types of shields and usages.
¿En qué tipo de escudo estás pensando que no se puede hacer con él?

I'm honestly switching everything to VAJSS. I already have the damage engine and the unitevent; I just need your shield system, but that's no problem.

But I'm delving into modifying its system, and I'm studying it to create new shields that protect against a certain type of damage, or that prevent others from reducing a certain type of damage.



Bro, I just don't like the GUI because of the GUI variables, so I'll switch your system to vJass; it's more convenient, cleaner, and more organized.

 

[Marchombre]

I'm honestly switching everything to VAJSS. I already have the damage engine and the unitevent; I just need your shield system, but that's no problem.

But I'm delving into modifying its system, and I'm studying it to create new shields that protect against a certain type of damage, or that prevent others from reducing a certain type of damage.

Hmm, I probably could add a field containing a list of damage type absorbed by the shield and functions to add/remove a damage type to a shield without making the system a complete mess. I'll look into this.

Bro, I just don't like the GUI because of the GUI variables, so I'll switch your system to vJass; it's more convenient, cleaner, and more organized.

I don't know how much you've done in you project already, but it feels like you should jump to lua. From what I have seen, it will be much cleaner for you

Anyway, I will try to make a pure vJass version where you don't need any GUI variable.

 

[HeavenlyHero]

Hmm, I probably could add a field containing a list of damage type absorbed by the shield and functions to add/remove a damage type to a shield without making the system a complete mess. I'll look into this.


I don't know how much you've done in you project already, but it feels like you should jump to lua. From what I have seen, it will be much cleaner for you

Anyway, I will try to make a pure vJass version where you don't need any GUI variable.

Bro, there's a big problem. It doesn't reduce external damage from detonators. In this case, damage that isn't magical. I don't know if that's because your system is designed that way.


It only seems to reduce damage coming from the damage engine. The strange thing is, damage engine events should reduce all filtered damage... Yours only reduces damage from the damage engine... That's where the shield system is poorly implemented, bro. You need to allow all damage to interact with your shield system.

 

[Marchombre]

Bro, there's a big problem. It doesn't reduce external damage from detonators. In this case, damage that isn't magical. I don't know if that's because your system is designed that way.


It only seems to reduce damage coming from the damage engine. The strange thing is, damage engine events should reduce all filtered damage... Yours only reduces damage from the damage engine... That's where the shield system is poorly implemented, bro. You need to allow all damage to interact with your shield system.

View attachment 592257

From what I see from your screen, you're calling the damage function:

• Unit - Cause (triggering unit) to damage (Target unit of ability being cast), dealing 500.0 damage of attack type Hero and damage type Normal

BEFORE calling the shield creation

• Trigger - Run CreateShield Complete <gen> (ignoring condition)

So I guess it is normal that it isn't absorbed ?

 

[HeavenlyHero]

It still doesn't reduce external damage... Bro, the whole point of a shield system is to protect against damage. And Damage Engine filters out all types of damage, but with its system, it ignores external damage... where it shouldn't. It should absorb all damage...

It will be up to you if you want to improve that aspect of blocking types of external damage.

Unfortunately, I can't use your system in my MOBA because, by not ignoring external damage, it harms me, causing imbalance.

 

[Marchombre]

View attachment 592266
It still doesn't reduce external damage... Bro, the whole point of a shield system is to protect against damage. And Damage Engine filters out all types of damage, but with its system, it ignores external damage... where it shouldn't. It should absorb all damage...

It will be up to you if you want to improve that aspect of blocking types of external damage.

Unfortunately, I can't use your system in my MOBA because, by not ignoring external damage, it harms me, causing imbalance.

No need to be this aggressive, bro.

---

Anyway, I think I found the root cause of this behavior.
One variable not initiated, that would not be assigned a value when DamageEvent didn't flag the damage as spell nor attack.

Will do more testing this week-end before publishing a correction.

 

[HeavenlyHero]

No need to be this aggressive, bro.

---

Anyway, I think I found the root cause of this behavior.
One variable not initiated, that would not be assigned a value when DamageEvent didn't flag the damage as spell nor attack.

Will do more testing this week-end before publishing a correction.

Friend, I haven't disrespected you at any point. I haven't been rude, much less aggressive. I'm just writing to you from a logical perspective regarding a shield system.

I mentioned that the point of a shield system is that it reduces damage. Especially if it's an "all" type shield.

Look, in my MOBA, I use different types of damage, but there's a particular type called "DEGENERATIVE," which causes damage to penetrate shields.

 

[IronBladeClan]

Will do more testing this week-end before publishing a correction

Should I wait for the fix before I use this?

 

[Marchombre]

Should I wait for the fix before I use this?

If you use trigger damage without setting udg_NextDamageIsAttack to true (for attacks) or you're not using the "default" pair of attack type and damage type for spells (detected by Damage Engine to set DamageIsSpell to true), it would be better to wait for the fix indeed.

I'll have much more time to work and fix this now that the tech tree contest is over

 

[Marchombre]

New version is out !
I think I included everything you guys have reported. If I forgot something, feel free to remind me

---

Version 1.4.0

---

Bug fixes:

• Fixed an issue of some damage instance not being absorbed by shields when the corresponding DamageEvent didn't have IsdamageAttack = true or IsDamageSpell = true.
• The shield visual bar will now update when the shield regenerate its HPs.
• Added a fail safe to make sure every shield bar is destroyed properly when a wielder is destroy.

New features:

• Added support for pure vJass use of this system. You can now add callbacks functions to events using the following functions:
  • ShieldEvent.AddOnPreCreation
  • ShieldEvent.AddOnCreation
  • ShieldEvent.AddOnAbsorb
  • ShieldEvent.AddOnExpired
  • ShieldEvent.AddOnBreak
  • ShieldEvent.AddOnRefresh
  • ShieldEvent.AddOnStack
• Added parameter USE_GUI (boolean), default is false. Set to true to enabled usage of GUI variables in event firing. If kept to false, feel free to delete the whole folder GUI Management folder.
• Shield can now filter absorbed damage using attack types and damage types.
  • ShieldEvent.AddAttackType will add given attack type to the list of absorbed attack types. If never called, the shield will absorb all attack types.
  • ShieldEvent.ExcludeAttackType will make the shield unabled to absorb the given attack type.
  • ShieldEvent.AddDamageType will add given attack type to the list of absorbed damage types. If never called, the shield will absorb all damage types.
  • ShieldEvent.ExcludeDamageType will make the shield unabled to absorb the given damage type.
• Added parameters NUMBER_OF_ATTACK_TYPE and NUMBER_OF_DAMAGE_TYPE. These are used to define the max size of arrays for attack and damage inclusion/exclusion. Default are the number of types in the DamageEngine.

 

[HeavenlyHero]

New version is out !
I think I included everything you guys have reported. If I forgot something, feel free to remind me

---

Version 1.4.0

---

Bug fixes:

• Fixed an issue of some damage instance not being absorbed by shields when the corresponding DamageEvent didn't have IsdamageAttack = true or IsDamageSpell = true.
• The shield visual bar will now update when the shield regenerate its HPs.
• Added a fail safe to make sure every shield bar is destroyed properly when a wielder is destroy.

New features:

• Added support for pure vJass use of this system. You can now add callbacks functions to events using the following functions:
  • ShieldEvent.AddOnPreCreation
  • ShieldEvent.AddOnCreation
  • ShieldEvent.AddOnAbsorb
  • ShieldEvent.AddOnExpired
  • ShieldEvent.AddOnBreak
  • ShieldEvent.AddOnRefresh
  • ShieldEvent.AddOnStack
• Added parameter USE_GUI (boolean), default is false. Set to true to enabled usage of GUI variables in event firing. If kept to false, feel free to delete the whole folder GUI Management folder.
• Shield can now filter absorbed damage using attack types and damage types.
  • ShieldEvent.AddAttackType will add given attack type to the list of absorbed attack types. If never called, the shield will absorb all attack types.
  • ShieldEvent.ExcludeAttackType will make the shield unabled to absorb the given attack type.
  • ShieldEvent.AddDamageType will add given attack type to the list of absorbed damage types. If never called, the shield will absorb all damage types.
  • ShieldEvent.ExcludeDamageType will make the shield unabled to absorb the given damage type.
• Added parameters NUMBER_OF_ATTACK_TYPE and NUMBER_OF_DAMAGE_TYPE. These are used to define the max size of arrays for attack and damage inclusion/exclusion. Default are the number of types in the DamageEngine.

Dude, the shield disappears, but the effect continues. Take a look to see what's going on. I'm still having trouble understanding the system, but I see you've improved a lot. :,3

 

[Marchombre]

Oh damn, stupid me, the destroying part was inside the block removed if USE_GUI was set to false.

Version 1.4.1

---

Bug fixes:

• Fix an issue where shield effect would not disappear when USE_GUI was set to false.