ABuff System

[Anitarf]

Update log: 12. 8. 2007: v1.2 20. 3. 2008: v1.3 24. 9. 2008: v1.4 19. 11. 2009: v1.5 26. 7. 2010: v1.6 21. 8. 2010: v1.7 18. 6. 2011: v1.8 15. 1. 2012: v1.9 17. 7. 2012: v1.9b

ABuff system The ABuff system was designed to provide a framework within which all kinds of triggered buffs can be created. Buffs can be made to respond to all sorts of events, including custom user-defined ones, thus allowing for interactions with map-specific gameplay mechanics. Custom user data can be attached to both buff types and specific buffs to make sure that the ABuff engine does not represent a limiting factor in buff design. The system was developed to support and promote the creation of interesting new buff spells, in hope that this will lead to new, more exciting gameplay in established map genres. Use your creativity. Version 1.8 was developed using the NewGen editor v5d with JassHelper 0.A.2.B.

Required libraries: Table or AutoIndex TimerUtils SpellEvent (optional) DamageEvent (optional)

| | | | | |

System components: ABuff ABuffDisplay ABuffDispel ABuffStruct ABuffHeroSkill ABuffSpell ABuffItem ABuffAura

| | | | | |

Acknowledgements: Thanks to Vexorian for creating vJass and to all the people who have contributed to the NewGen editor. Thanks to Vexorian and PipeDream for helpful suggestions provided during the system's design phase. Thanks to other users of wc3campaigns.net for their input.

Changelog Version 1.9b - Fixed a bug in ABuffDisplay that could result in the display ability not being preloaded correctly. Version 1.9 - Fixed a bug in ABuffDispel that would cause it not to work. - Fixed a bug where an aBuff could get destroyed twice when a unit died. - Fixed a bug where new buffs could be added on dying units and would then never get removed. - ABuff can now use .evaluate instead of .execute to run its event callbacks. - Made minor optimizations to the ABuffAura library. Version 1.8 - Fixed a bug in ABuffAura where updating the level of the aura did not update the aura buffs. - Fixed ABuffHeroSkill and ABuffItem to optionally use AutoEvents instead of the old StatusEvents. - The AutoIndex version of ABuff will no longer attempt to create buffs on units that are not indexed. Version 1.7 - Moved ABuff from Table to AutoIndex, the old Table version is still supported. - Fixed a bunch of bugs in ABuffStruct, code that uses it should actually compile now. - ABuffDisplay now properly preloads abilities when created in struct/module onInit methods. - ABuffItem now removes buffs before recreating them on unit reincarnation, avoiding bugs. - Added the ABuffDispel helper library. Version 1.6 - Added the ABuffSpell library that simplifies making abuffs applied by spells. - Added the ABuffStruct module that allows simple encapsulation of abuffs in structs. - Minor updates to ABuffHeroSkill and ABuffItem to help detect common user errors. - Updated some of the samples to make use of the new libraries. Version 1.5 - Added support for three different buff categories: STANDARD, STACKING, REFCOUNT. - Added the ABuffDisplay library that simplifies displaying buffs with tornado-based auras. - Added the ABuffHeroSkill library that simplifies making passive hero skills. - Added the ABuffItem library that simplifies making abuffs applied by items. - ABuff now uses DamageEvent instead of ADamage. It now also uses SpellEvent. - ABuff still works without these two libraries, it just does not use these events without them. - Completely recoded the ABuffAura library, it should be much more efficient now. - Renamed ABuffDestroy to ABuffRemove, the old function name is still supported. - Changed how custom events work, the new code is not backwards compatible. - Recoded the samples to utilize other useful libraries besides ABuff. Version 1.4b - Updated the test map to use 1.24-compatible Table and TimerUtils, ABuff remains unchanged. Version 1.4 - The system now uses standard libraries, Table for gamecache use and TimerUtils for timers. - Damage detection has been moved to an independant library, which also supports damage prevention. - The dummy units section has been replaced with the UnitRunsEvents function. - The aBuff core engine has been reworked and optimised. - The Aura subsystem has been reworked, removing dynamic trigger use and some bugs. - Fixed a bug in the SetABuffTimeRemaining function that prevented the duration from being decreased. Version 1.3 - Added effect delay safety checks to the stun system and to examples with dummy casters. - Added the functions GetABuffFromBuffedUnitByType and BuffedUnitHasABuff. - Did minor changes to the code to make use of new vJass syntax. Version 1.2 - Added an aura subsystem. - Fixed some non critical coding errors. - Made the system more robust by using .execute instead of .evaluate for user event response functions. - Added a safety check so buffs that are reapplied while being destroyed are not immediately cleaned up. - Added a safety check so buffs can no longer be applied to dying units on the unit dies event. Version 1.1 - Fixed an error which caused damage events not to be ingored even if the user specified that. - Added the RefreshNeverReduceDuration function.

[rain9441]

Well I have to say that this is pretty sweet. I've spent some time looking into this system and am pretty pumped about it. The possibilities are pretty much astounding. I got a lot of ideas that were never before possible but are now... But I have a few questions (probably the same as others)

How practical is this on heavy action maps? Can it support 50 units with multiple buffs/debuffs, 100? 500?

Is it feasible to use this system with auras? Example: TriggerRegisterUnitInRange on a unit with an action of ABuffApply with duration 0, where the ABuff has a periodic event to check the range of the target with the caster.

Whats the bottleneck of the system? I can easily change the implementation of GetUnitABuffData to use Get/SetUnitUserData, would this increase performance (by drastically reducing gamecache usage)?

Any tips for implementing ABuff's with some sort of Orb Effect Detection engine?

And regarding your mini Stun System, does it interact well with other non-ABuff related stuns?

Whats the A stand for?

[Rising_Dusk]

Whats the A stand for?

Anitarf, I would guess.
Who cares about being modest when you made a system. :p

[Ammorth]

Nice system, although (correct me if I'm wrong) but it seems that the stunning unit shows it's health bar. Otherwise awesome job!

[Skater]

I just say: "Just another WarCraft III map".
Will look through it soon.

[Anitarf]

Originally Posted by rain9441

How practical is this on heavy action maps? Can it support 50 units with multiple buffs/debuffs, 100? 500?

I can't give you a direct answer to that. It always depends on what you do with the system and what else is going on in the map. When it comes to more trigger/sfx heavy spells, the system is not the critical component anyway; when the game starts lagging, it's because of the spells, not the system. If you have simpler spells, but a lot more of them, then the system plays a bigger role, but still, to geta lot of buffs you need a lot of units so the graphics and pathing are contributing to lag as much as the system.

You can always turn off some events to increase performance. Turning them all off would limit what you can do with buffs considerably, but turning one or two off would still leave you with enough creative space to make enough buff spells for one map. For example, the map I designed this system for will most likely not use the "other buff" and damage events. (speaking of which, I just noticed that I forgot to add an if statement in there somewhere, so turning off damage detection doesn't stop on damage triggers from being created... it's not critical, I'll fix it later :) )

Consider it like this: most events require two gamecache lookups and then a bit of array access, how much depends on the number of buffs the units involved in the event have but it's not an issue either way, it's just looking up global variables and comparing stuff. Now, if the system finds a buff that has a response function to the event, it takes one more .evaluate to run it and of course whatever the user wrote in that function. Except on common events like attack and damage with a lot of units with fast attack speeds (and probably not even then unless we're talking excessive amount of attacks), the system alone handling a bunch of blank buffs shouldn't be a problem.

Is it feasible to use this system with auras? Example: TriggerRegisterUnitInRange on a unit with an action of ABuffApply with duration 0, where the ABuff has a periodic event to check the range of the target with the caster.

I didn't make an aura template because I thought it was impractical but the way you described it's implementation it sounds rather feasible. You could even have a seperate custom periodic event (by enumerating buffs by type) that only runs only once or twice per second to lower the load (or lower the frequency of the default periodic event if no other buff requires it to be smoother), but it might not be neccessary at all, IsUnitInRange() is a native, and getting the two units is trivial. I think I will write that aura template for the next version. :)

Whats the bottleneck of the system? I can easily change the implementation of GetUnitABuffData to use Get/SetUnitUserData, would this increase performance (by drastically reducing gamecache usage)?

Gamecache calls seem like a bottleneck considering how slow they are together with H2I but they are only used twice for each event to get the unit's data and then it's looping through linked lists of buffs. Now, if you have many events occuring, but only few units involved in them have buffs or most buffs don't respond to frequent events, then GC calls may have a considerable contribution compared to the rest of the code, but that's because there is almost no "rest of the code". Otherwise, not really.

That's why I decided to go with game cache, I don't need to use much of it so it's not that heavy, but the system is a lot more import friendly as it doesn't conflict with any other system that would use unit custom values. If you change the implementation, however, note that you need to alter GetUnitABuffData(), IsUnitAllocated() and the create and destroy methods of the aBuffUnit struct. I think that's it.

Any tips for implementing ABuff's with some sort of Orb Effect Detection engine?

Nope. What specificaly did you have in mind?

And regarding your mini Stun System, does it interact well with other non-ABuff related stuns?

If you use the stun system, you should do all your stunning through it. It might not conflict if you use different buffs though.

Whats the A stand for?

Rising_Dusk is correct, I afforded myself a moment of vanity when trying to think of a name. I was really out of ideas so it was either ABuff or no buff (I couldn't really start coding if I didn't know how to name the most basic structs :) ).

Originally Posted by Ammorth

Nice system, although (correct me if I'm wrong) but it seems that the stunning unit shows it's health bar. Otherwise awesome job!

Not sure what you mean, but dummy stunners have the locust ability so I choose to blame Blizzard (either that, or your sight :P ).

As for the "Just another WarCraft III map", it shows how eager I was to get this out after a month of coding followed by a month of no computer (when I was finishing it up today I realised I should really comment my code more :) ). It's not that important, all the documentation is in the map anyway. I'll fix it with the next version.

[Fulla]

Well this is interesting, I was just planning on building a buff system, will have to take a look at this, should come in very handy.

[PipeDream]

Best JASS ever. Amazing job, Anitarf.
Comments:

• How about GC for IsUnit(Ignored)Dummy
• It would be nice if we could find a way to let you work around inlining basic list utilities like search
• Automatic inlining would actually help this code
• Indentation is funny in GroupEnumUnitsInArea
• Switch these two lines (87/88) in the AoE buff template?
  JASS:

              call GroupRemoveUnit(g, u)
              exitwhen u== null

I'm afraid I can't give you any real feedback. Maybe someone in the content business can find something to criticize. E.g., I have no idea if this is even useful ;)

[Toadcop]

well looks interesting!
...
well looks awesome ^^

so 1 year ago i have understand what to stick together a map out of custom (different) systems is a full crap. =\ cause they are not beloning together thats the problem ! what i mean ? 100% it's a best system for YOU. and it's right so. but it's not the point the feature is what someone can learn from your sys and made own one. for example i got also a buff sys it's very similar to this one ^^ (but not the code it self) and i made it more than a 6 months ago.
something about system.

i don't like the peredical event =\ it's awesome lame. in 2 ways.
1) you could symple use a new separate timer.
2) ok you are optimization junkie ^^ you use a single timer. BUT the events are launching every event tick =\ whats suxx. you could simple add counter to the buff.

the rest is ok but with some "BUT"s

Best JASS ever.

not really see the generated jass code <_<
it maybe the best vJass code =)

Custom systems rocks ! may Tiesto be with you ! xD

~approved =)

[Fulla]

The more I look at this, the more possibilities open up in my mind for some awesome spells.

EDiT: Can the system handle/have the capability:

-Storing a buffs, strength/level? For:
Magic Resistance Every 1-10 seconds destroys a negative buff on the hero, strongest ones first.

[Toadcop]

Fulla currently not. but it's no problem to do what.

Magic Resistance Every 1-10 seconds destroys a negative buff on the hero, strongest ones first.

what is strongest ? i mean how do you want to know it ? if you have a way to find it out then ofc using a loop through all buffs but it's not a problem.

The more I look at this, the more possibilities open up in my mind for some awesome spells.

omg guess why Anitarf made it O_o ?! he is of the one who can see potential awesome things (it's like me ^^)

[Silvenon]

Really nice system, now I don't have to bother with missing Add Buff action :)

[Toadcop]

hmmm =\ ... xD queation what will happen if your unit (with a buff) dies but it has reincarnation ? let me guess... the custom effect will be there but buff icon no ^^ + it was a big mistake to combine jass with spell buffs. for example i use tornado slow aura as "buff". and i don't get any trouble with it.

[Fulla]

I basically meant simply something like:
Hero Ultimate Buffs - Rank 3
Hero Buffs - Rank 2
Unit Buffs - Rank 1

But ofcourse Id have a 1-10 rank, and simply set a spell on how strong/important it is.
Isnt there someting like this already in the game, buff priority or something?