GUI Unit Indexer 1.4.0.0

[Moderator]

16:29, 28th Jun 2011
Maker: Approved. Can be of great use in creating MUI spells and systems.

 

[nafre]

Does this mean that this trigger can count units for you and give the unit a special code?

 

[Bribe]

If you mean counting how many units are in the map at once, no this is not what it's used for.

The custom value of the unit is a mere integer used in array lookups to make indexing more automated (user-friendly).

• Set MyData[(Custom value of (Triggering unit))] = 1000

^The above example effectively allows you assign "1000" to the unit as a pseudo-attribute. Normally in this case, data attachment would involve hashtables.

 

[Magtheridon96]

This really deserves a DC
A UnitIndexer is ok, but a UnitIndexer for GUIers?? That is above and beyond
The only problem is that some GUIers use custom values for other stuff
If they do, it's their loss xD
Good Job dude sir Bribe 5/5 ^^

 

[baassee]

LOL what is this?! You know that GUIers doesn't use unit indexers for some what unknown reason.

The filter should filter out units with locust btw.

 

[Bribe]

It intentionally enumerates units with locust, because dummy units like projectiles can benefit from indexes.

However, I should make it clearer what users can add to make it filter out unwanted units.

Jesus4Lyf used a very similar approach in his "GUI AIDS" so I cannot take credit for the idea. This is simply a different implementation and has some pros and cons against his:

Jesus4Lyf - Uses a timer throughout the game to check if units should be removed - As a consequence, only removes up to 32 dead instances per second, making it (in a stretch of the imagination) possible that the digit 8190 can be exceeded (more a logical problem than a practical one) - Ends up being more efficient when units are created - Pretty easy to implement (3 sets of cnp)	Bribe - Checks for removed units only when a new unit is added to the map - Does a quick iteration over all indexed units each time a unit is added - Ends up being more efficient over the course of the game, using fewer handles - Easier to implement (two cnp instead of 3)

 

[baassee]

But the timer option in AIDS is optional from my experience. Else it uses the classic "undefend" ability to detect leave/removed instances.

Yeah you're probably right about the dummies now when I think about it, GUIers will gain alot by this.

Does the userdata always return 0 when a unit is removed/decayed? Cool.

 

[Bribe]

His GUI version of AIDS only uses a timer, it doesn't have an option for the undefend bug.

GetUnitUserData returns 0 for null/removed/decayed units. The wc3 system does some internal deallocation when units pass from scope - an event Blizzard forgot couldn't be bothered with to give us access to.

 

[Jazztastic]

I'm really, really confused by this. But from what I gather, this replaces hashtables right? So you could put the custom value of whatever unit in a spell, and it will make it MUI, so long as you don't have 8190 units on the field, right? If that's what it does only problem I see with it is that is uses custom values. A lot of system use custom values

 

[Nestharus]

A lot of system use custom values

Those other systems shouldn't be using SetUnitUserData, but should rather just be assuming that a unit indexer is in the map and make use of GetUnitUserData

= )

 

[Bribe]

Update to 1.0.0.1 - added an optional filter and an optional initializer.

Before, it was unclear how to filter units.
Now, you can filter units from the UnitIndexFilter function in the custom script.

Before, if you needed to get the custom value of a unit during map initialization, it may have returned zero.
Now, you can run any of those triggers from the designated spot in the Unit Indexer trigger (where it says "run initialization triggers after this line").

With these changes, this system is now perfect unless the user calls SetUnitUserData (sets the custom value of the unit) themselves. However, users should not be doing that if they want to use this system (only calling GetUnitUserData).

Finally, no map that exceeds 8190 units can be taken seriously. The array limit in that case is out of the question.

 

[nafre]

i still do not understand what does a indexer do? Could someone explain this a little more if you have the time?

 

[Nestharus]

It gives each unit a unique id that can be used as an array index.


So rather than (hashtable)

SaveInteger(table,GetHandleId(unit),0,value)

you can do (array)

set a[GetUnitUserData(unit)]=value

 

[Bribe]

Updated description with a short text on why unit indexing is important.

 

[tenchisouzou]

hi i'm new to mapping and am having trouble on how to use this system in my map.

i followed the steps and added the system to my map.

i didn't edit anything, i.e, Unit Indexer trig and the jass script located on map name.

i tried setting custom integer variable to triggering units custom variable to my spell

and when i try to multi cast the spell with 2 different units with 2 different custom values, it doesn't work. The last casted spell overwrites the first one.

could someone help me fix this?

i have attached the map to this post.

thanks =)

 

[Jazztastic]

Make sure you properly affix the map . . . Because it isn't showing up. Once you attach the file you have to also click the little attachment button to put in the attachment in the post somewhere.

 

[tenchisouzou]

yeh just fixed it, i attached the wrong map b4 so i edited it lol

 

[Jazztastic]

You have waits in your spell. Even with a unit indexer, waits will overwrite the data previously stored. To avoid this, DON'T USE WAITS. Look up some tutorials on making spells MUI. Just in case you don't, heres a simple breakdown. Don't ever use waits in spells unless you use local variables. Any spell that isn't instant needs a unit indexer (this very thing , hashtables, or recycling. Next time you post something about triggers it should probably be under the "triggers and scripts" part of the help section.

 

[Bribe]

Updated to 1.0.1.0, this version now recycles every 15 new units as an optimization. The demo map has been updated to be more dynamic - you can type commands to create new units, display their indices and click on them to remove them from the game. This is to better show off the index recycling as the old demo I had won't work with the new "recycle every 15 new units" setup.

 

[mckill2009]

I thought you said that custom values of a unit can conflict with other systems? or am I missing something?...

You're using custom value of unit, which can conflict with other systems. This part should use hashtable instead.

 

[Bribe]

The point of a unit indexer is to use the same custom value of a unit for all systems, instead of relying on hashtables. "Custom value" is fine as long as it keeps in mind that other systems might also want to use it, which is exactly what this does.

Edit: Fixed a potential indexing problem and made the test map *way* better. You can play around with this thing a lot more than before.

 

[Ironside]

So if I understand correctly you can make any amount of MUI spells with this system without the indexing and hastables by just using the custom value of a unit as the index?

 

[Nestharus]

So if I understand correctly you can make any amount of MUI spells with this system without the indexing and hastables by just using the custom value of a unit as the index?

that'd be correct

 

[baassee]

And as long as the user don't touch the UnitUserData aka Custom Value when using this.

 

[Ironside]

that'd be correct

Then this is exactly what I've been looking for.

And as long as the user don't touch the UnitUserData aka Custom Value when using this.

Nothing uses custom values in the map currently.

 

[baassee]

Nothing uses custom values in the map currently.

Then you're good to go sir!

 

[Bannar]

Exellent tool for any GUI user. I'm pretty sure it will soon be used commonly.
Deserves DC. Since I can not give more oyu Bride at least you get: 5/5

Trust me. Eventually, the entire GUI community on this site will begin to use it

It is true, and whoever doubts it, will burn.

 

[Ironside]

The only problem is that this will only be used in maps, as using it in spells uploaded here will break the rules since spells must not use unit custom values.

 

[baassee]

The only problem is that this will only be used in maps, as using it in spells uploaded here will break the rules since spells must not use unit custom values.

I'm sure that we can add a rule to prevent this when using this.

 

[Bribe]

The only problem is that this will only be used in maps, as using it in spells uploaded here will break the rules since spells must not use unit custom values.

There is no spell rule that says you can't use
custom value. In fact, I should add a rule that
says "custom value" is encouraged, as long as
the only thing that sets it is a unit indexer of
some kind.

The thing about a unit indexer is it sets the
custom value for a unit only once, to give it a
unique ID, which can be shared by all systems.
The value is 1-8190 so it will be perfect for
array indices. Instead of setting the custom
value, now you just have to set an array by
array index of the custom value.

If a system sets the custom value and doesn't
consider that other resources might depend on
it, then I'll definitely reject it, because that's
breaking compatibility.

 

[Ironside]

There is no spell rule that says you can't use
custom value. In fact, I should add a rule that
says "custom value" is encouraged, as long as
the only thing that sets it is a unit indexer of
some kind.

The thing about a unit indexer is it sets the
custom value for a unit only once, to give it a
unique ID, which can be shared by all systems.
The value is 1-8190 so it will be perfect for
array indices. Instead of setting the custom
value, now you just have to set an array by
array index of the custom value.

If a system sets the custom value and doesn't
consider that other resources might depend on
it, then I'll definitely reject it, because that's
breaking compatibility.

Well in that case this is great, might actually make some spells of my own sometime.

 

[Jazztastic]

Bribe, you should link IsUnitMoving to this also, seeing as that's an add-on. If I were you I'd also release them together in the packs section.

 

[Bribe]

IsUnitMoving and UnitIndexer are pretty different resources. There
is unlimited potential for UnitIndexer while IsUnitMoving serves a
pretty specific purpose. At most I'd like to "examples" of "what you
can do", but I wouldn't consider IsUnitMoving an add-on.

However, as inspired by Maker, I will be making some changes to
both IsUnitMoving as well as UnitIndexer

 

[Jazztastic]

My mistake, sorry. But I think any other resources that utilize the UnitIndexer as a base should be mentioned somewhere, which you said yourself

At most I'd like to "examples" of "what you
can do", but I wouldn't consider IsUnitMoving an add-on.

IsUnitMoving is a great example of what you can do with the UnitIndexer. You are definitely right in that it serves a specific purpose, and I guess add-on was the wrong term for it, but it shows what the UnitIndexer can do Also, EvilCrispy has a spell that runs on UnitIndexer I believe.

 

[Bribe]

Updated to version 1.1.0.0 - this now has three custom events that GUI
users can take advantage of:

• Unit Indexer Events
  • Events
    • -------- When a unit is indexed: --------
    • Game - UnitIndexEvent becomes Equal to 1.00
    • -------- When a unit is deindexed: --------
    • Game - UnitIndexEvent becomes Equal to 2.00
    • -------- When Unit Indexer has been initialized: --------
    • Game - UnitIndexEvent becomes Equal to 3.00
  • Conditions
  • Actions
    • -------- UDexUnits[UDex] refers to the indexed/deindexed unit --------

 

[Jazztastic]

You attached the wrong map

EDIT: I have a question. Do things such as summonable units and illusions get indexed when created?

 

[Bannar]

I'm pretty sure they are, although you can disable indexing new unit using:

• Set UnitIndexerEnabled = False
• Unit - <Create unit>
• Set UnitIndexerEnabled = True

About summonable and illusions - they are still just normal Created units - with some modification ofcourse (like instantly added expiration timer).

 

[Bribe]

Update to 1.2.0.0 - now can be installed with just one copy and paste (I have removed the dependency on the map header script).

Edit: Added a "how to" for the index events, and fixed a possible recursion bug that was in all Event-based versions.

Edit 2: Fixed all possible recursion bugs.

 

[Bribe]

Updated the description. Anyone who had trouble figuring out how to use this in their
maps is welcome to try out the template I developed for that purpose:

http://www.hiveworkshop.com/forums/spells-569/unit-indexer-spell-template-202003/

 

[maddeem]

The only problem with this is that I can see myself making 100 variables for each spell lol

 

[Bribe]

The beauty is that if you have a bunch of spells that all have similar type things
(duration, caster, damage, area of effect) you can use hte same variables for all
spells.

 

[EloTheMan]

Item Indexer next?

 

[Bribe]

Item indexing isn't nearly as important, nor as easy to
do

I recommend hashtables for items.

 

[baassee]

I never got the point with an item indexer... and there are plenty in vJASS and still don't get the point.

 

[Nestharus]

Actually if cJASS is fixed, Item Indexing will be fairly easy to do = ).

 

[baassee]

Actually if cJASS is fixed, Item Indexing will be fairly easy to do = ).

How come? (Never learned cJASS as it has been buggy)

 

[maddeem]

Used this in mah casting bar =D

 

[nGy]

So is this really "better" (using less ressources) than hashtables or is it just not as confusing?

 

[Bribe]

It's both.

Using arrays with Custom value of (unit) as the index is using fewer hashtables (you can only have a max of 256 in the map), is more logical (because each array has a name of its own) and is more practical because it's way faster than using hashtables.

For spells I typically recommend Hanky's Dynamic Indexing or I'll recommend this or hashtables if the user is more comfortable with that approach.

http://www.hiveworkshop.com/forums/spells-569/gui-dynamic-indexing-template-144325/
http://www.hiveworkshop.com/forums/...9/complete-beginners-guide-hashtables-197381/