Item Pickup v.4.0.1 ( vJass) // v.1.0 ( JASS )

[Moderator]

23:38, 26th Nov 2013
Maker: This is a cool system and it is coded well

 

[Kazeon]

why JASS?

well, this could be useful for anyone who is too lazy just to do right clicks..

 

[BPower]

The API is designed very easy even for GUI only users, it just requires JNPG. Everything is explained inside the demo map. No need to cry

why JASS?

Because it is much faster, even if one is capable of doing miracles in GUI .

 

[Kazeon]

no cry, just sad

hey, why the autopick range is not configurable?

 

[BPower]

hey, why the autopick range is not configurable?

It is. Start the system for a unit with any radius.

    function StartAutoPickUp takes unit u, real radius returns nothing
        call AutoPickUp.start(u, radius)
    endfunction

or in GUI. Note 50 is the radius, therefore the pickup range will be 100.

• Custom script: call StartAutoPickUp(udg_TESTER, 50.)

 

[Kazeon]

so, you can set a different radius for each unit?

 

[BPower]

so, you can set a different radius for each unit?

Exactly.

 

[Kazeon]

convert it to GUI and I will approve this..
<<MODERATOR

 

[Zeatherann]

Interesting that is written in vJASS and not JASS. I might create my own JASS version then.

 

[Chaosy]

hm, either it just seems like a long code or you got more features than I can see.

basicly I would loop and then detect items within X range. The range would be stored in a real array variable. Use with with an indexer and its really simple.

3/5

I think this could be done very easy in vjass aswell.
this.radius = argument. done

 

[BPower]

hm, either it just seems like a long code or you got more features than I can see.

If you can make it shorter and provide the same speed, then I bow to you.
But you won't

 

[Maker]

Chaosy, to me the code looks quite short. A lot of it is the indexing/linked list.

He is looping through a list of units, and picking units within a square. Each unit has it's own search distance.

 

[Chaosy]

I dont know vjass very well. So I dont really read the code. I just imagined it to be shorter considering how I would have done it in GUI.

but recycle index is quite complex (atleast to me xD) so I guess the code isnt very long then.

 

[Zeatherann]

Hmm... I'm tempted to try to write a shorter same speed/or faster version in pain ol'e JASS.

 

[Chaosy]

I made a GUI version out of boredom.

It currently work ok but I know it have some flaws. Like if unit dies the hashtable still contains data which I could potentionaly reset but I am too lazy
here it is anyway.

triggers

• init
  • Events
    • Map initialization
  • Conditions
  • Actions
    • Hashtable - Create a hashtable
    • Set hash = (Last created hashtable)
    • Set u = Paladin 0001 <gen>
    • Set range = 100.00
    • Trigger - Run Set Range <gen> (ignoring conditions)

• Set Range
  • Events
  • Conditions
  • Actions
    • Unit Group - Add u to group
    • Custom script: call SaveReal( udg_hash, GetHandleId(udg_u), 1, udg_range )

• loop
  • Events
    • Time - Every 0.20 seconds of game time
  • Conditions
    • (Number of units in group) Greater than 0
  • Actions
    • Unit Group - Pick every unit in group and do (Actions)
      • Loop - Actions
        • Set u = (Picked unit)
        • Set u_loc = (Position of u)
        • Custom script: set udg_range = LoadReal( udg_hash, GetHandleId(udg_u), 1 )
        • Item - Pick every item in (Playable map area) and do (Actions)
          • Loop - Actions
            • Set item_loc = (Position of (Picked item))
            • If (All Conditions are True) then do (Then Actions) else do (Else Actions)
              • If - Conditions
                • (Distance between item_loc and u_loc) Less than or equal to range
                • Or - Any (Conditions) are true
                  • Conditions
                    • (Item-class of (Picked item)) Equal to Powerup
                    • (Item carried by u in slot 1) Equal to No item
                    • (Item carried by u in slot 2) Equal to No item
                    • (Item carried by u in slot 3) Equal to No item
                    • (Item carried by u in slot 4) Equal to No item
                    • (Item carried by u in slot 5) Equal to No item
                    • (Item carried by u in slot 6) Equal to No item
              • Then - Actions
                • Hero - Give (Picked item) to u
              • Else - Actions
            • Custom script: call RemoveLocation(udg_item_loc)
        • Custom script: call RemoveLocation(udg_u_loc)

please do not comment to much on those triggers it is not meant to be a perfect final released prodct. Then I would have submited it as a resource.
http://www.hiveworkshop.com/forums/pastebin.php?id=rrsam1

NOTE: that this is only for GUIers who want to learn how it works or needs to modify the system but doesnt know vJASS. Else I strongly suggest you use the original system.

 

[BPower]

First of all, nice to see this system caught your interest

please do not comment to much on those triggers

The code has some serious issues, but I'll respect your please.

What can't stay uncommented are two things:

1. If the group is empty the timer isn't stopped.
2. Power Up items can be picked up with full inventory.

Just for the GUI community I didn't use List or SharedList or Alloc as requirement. And UnitIndexer is a must have in my eyes.
Also the API is easy to understand.

The reason such resources should be vJass and use a linked list is, because they are "passive" resources. They don't add any eyecandy to the game.
Therefore they must run as silent and undetectable as possible.
GUI just cannot provide the speed that vJass or JASS have, not only because it generates redundant lines of code.

 

[Chaosy]

1. oh yeah, I can fix that.
2. not a big deal will fix that too.

I highly dislike arrays since they make code fugly. Else I would have gone with an unit indexer instead of an hashtable.

And I don't question the functions and advantages of vjass. If I made it in C# I would have used an list but GUI doesnt have it so yeah.

edit: done

 

[BPower]

Better but the trigger has to be turned off when the group is empty and turned on when the first unit is added to the group.
Also you picked every item in playable map area every 0.2 seconds for each unit in the group. That's not effective, especially in really big maps.

Your skript won't work the way it is, because items are not removed on death.
Example: You kill a claw of attack +15 item. Then you walk over it with your skript on. You will find that item in your inventory. If you use a tome of strength + 2. It will die, but not beeing removed. Aslong as you stay on that position every 0.2 seconds a tome of strenght +2 will be added to your hero.

Another thing

• Item - Pick every item in (Playable map area) and do (Actions)
  • Loop - Actions

Mistakenly you think this is a short and clean piece of code. Actually it is:

function PickItemInPlayable takes nothing returns nothing
    call EnumItemsInRectBJ( GetPlayableMapRect(), function action)
endfunction
function EnumItemsInRectBJ takes rect r, code actionFunc returns nothing
    call EnumItemsInRect(r, null, actionFunc)
endfunction
function GetPlayableMapRect takes nothing returns rect
    return bj_mapInitialPlayableArea
endfunction

In my code it is only:

call SetRect(TEMP, x - .rad, y - .rad, x + .rad, y + .rad)
call EnumItemsInRect(TEMP, null, function thistype.pick)//thistype. is used when dealing with methods instead of functions

And I use a very small rect --> the actually pickup rect.

 

[Nestharus]

Why are these in your settings area if you don't want users to touch them? lol..

        private rect TEMP               = Rect(0,0,0,0)//Don't touch this
        private timer TMR               = CreateTimer()//Don't touch this. Used timer.

Just figured that I'd point that out. Maybe you want to move that down into your actual code .

 

[BPower]

Just figured that I'd point that out. Maybe you want to move that down into your actual code .

I agree. I'll update it later.

updated: Also changed the demo unit back to a Paladin instead of a footman. Updated documentation aswell.

udpated again: Added TimerUtils as optional requirement. (10.12.2013)

udpated again: Can now use any UnitIndexer for instance Bribes GUI version by replacing GetUnitId with GetUnitUserData. (26.12.2013)

udpated (14.03.2014)
Changelog:

• Split the code into a light and normal version. MoveRectTo(..) seems to be ~50% faster than SetRect(..). In conclusion the light version is ~50% slower than the normal version, but uses only 1 rect.
• Replaced static unit u with static thistype index.
• The code looks much cleaner now.

 

[shadowvzs]

only to me have problem? when i tested in normal we and press is esc then paladin dont pick up anything, when try press esc again then say its running but acctually hero just stand, then i typed stop and pressed esc still nothing happened

 

[IcemanBo]

Doesn't work in vanilla editor. Requires JNGP to compile the vjass.

 

[BPower]

Very minor change. I just swapped the position of method clear to avoid needless code generation.

 

[BPower]

What is new:

• Improved the debug only code of all versions.
• Added a Table version supporting Bribes & Vexorians Table (No UnitIndexer needed)
• Added a version, which does not use any requirements.
• Added a GUI version. (Easy to setup and use)
• Mentioned GUI version is mainly written with custom script and performs only slightly worse than the vJass versions.
• Removed the code from the description and added a manual instead.
• Reading the manual will help you to find the perfect of all uploaded versions for your map.

 

[Wietlol]

pls upload code...
real programmers are too lazy to download

 

[BPower]

pls upload code...
real programmers are too lazy to download

Later maybe, as I mentioned the map includes 5 different versions of AutoPickUp.

 

[Wietlol]

Then place 5 different Hidden tags named "version 1", "version 2", "version 3", etc?

Uploading code is like... 8 minutes time.

 

[BPower]

Couldn't upload a new description ... maybe because it uses too many characters.
I will put it in the second comments, which is luckily my own.

EDIT: I managed to upload it in the description. You are welcome.

 

[Wietlol]

private static method pk takes nothing returns nothing
            local item i = GetFilterItem()
            if (FilterItem(i)) and (GetWidgetLife(i) > .405) then
                call UnitAddItem(index.u, i)
            endif
            set i = null
        endmethod

Warcraft3 doesn't remove dead items from the game automatically.

Why not separate the checks and remove the item yourself?

private static method pk takes nothing returns nothing
            local item i = GetFilterItem()
            if GetWidgetLife(i) > .405 then
                if FilterItem(i) then
                    call UnitAddItem(index.u, i)
                endif
            else
                call RemoveItem(i)
            endif
            set i = null
        endmethod

 

[BPower]

Good question .

First of all it should look like this:

if FilterItem(i) and IsItemPowerup(i) then
    call SetWidgetLife(i, 1.00)
    call RemoveItem(i)
endif

I used this on previous versions of AutoPickUp.
However items objects also have death animations, by removing them you will not play
an items death animation (eventually).
That's why I removed that part from the code.

There are snippets, which remove dead items periodically after playing the death animation.
They estimate a death animation time and remove the item after it. For example after 1.5 seconds.

 

[Lign]

I got a problem, when I enable the Auto Pickup No Requirements trigger, it's say "The trigger "Auto Pickup No Requirements" must have an initialization function called "InitTrig_Auto_Pickup_No_Requirements".
How can I fix that. And I don't know how to filter which item-type to be picked up. Can you give me an example how to filter more than 2 item-types. 'Cause I don't know much about Jass.

btw, this system's very useful for me. Thank you.

 

[BPower]

Update:

The previous version ( v.3.3 ) worked flawless. No need to update to v.4.0 in you map.
It's more a cosmetic update than bug fixing.

Changelog:

1. Replaced the linked list structure with a stack ( less memory allocated, more speed )
2. No longer in a struct ( there was no reason for . syntax )
3. Lookup complexity on start and stop is now O(n), before it was O(1) using a Table.

Reason: Normally start and stop are not called frequently ( stop maybe never ).
In case your map demands a better performance ( many units use this system ),
you can replace the loop with a Table to load/save the stack index per unit.

I got a problem, when I enable the Auto Pickup No Requirements trigger, it's say "The trigger "Auto Pickup No Requirements" must have an initialization function called "InitTrig_Auto_Pickup_No_Requirements".

You can ignore that message. Everything is fine

And I don't know how to filter which item-type to be picked up. Can you give me an example how to filter more than 2 item-types. 'Cause I don't know much about Jass.

You're still struggling with this issue? You don't need JASS knowledge for that.

 

[Bribe]

I am just now seeing this resource for the first time. Here's my feedback:

Use one rect and use SetRect to the radius for each unit each loop instead of MoveRectTo. It won't slow things down enough to have 2 extra parameters and 4 arithmatic operations per unit to justify the huge difference in generated handles.

Can I make a GUI version of this? I need something to do

 

[BPower]

Use one rect and use SetRect to the radius for each unit each loop instead of MoveRectTo. It won't slow things down enough to have 2 extra parameters and 4 arithmatic operations per unit to justify the huge difference in generated handles.

The previous version ( 3.3 ) there was two types on this library in the demo map.
One with SetRect and one with 1 rect per units.

Back then I've run benchmark tests on SetRect vs MoveRect and MoveRect ( thead page 2 ) using Sharpcraft and the StopWatch native.
Turned out MoveRect is faster than SetRect. As it is a periodically running system, I've chosen the memory unfriendly but faster way.

udpated (14.03.2014)
Changelog:
Split the code into a light and normal version. MoveRectTo(..) seems to be ~50% faster than SetRect(..). In conclusion the light version is ~50% slower than the normal version, but uses only 1 rect.

I can add the 1 rect version to the demo map.

Can I make a GUI version of this? I need something to do

There is also GUI version in the demo map. ( Actually it's mainly JASS / custom script )
You can see the code in tab 2 - 4 in the map description on the first page of the thread.
Btw, that one uses SetRect.

 

[Bribe]

Oh man, those tabs can be confusing. I didn't even see that there were other triggers there.

Why in the vJass version do you filter out level 2 items? Is it just an example? I think the system should not auto-pick up tomes by default in case the wrong unit accidentally picked up the tome, though that's easy enough to set for the user on a per-map basis.

Why not use GUI Unit Indexer so that you can make removal O(1)? You can also then auto-add units to the system who have the hero inventory ability on behalf of the user.

 

[BPower]

Why in the vJass version do you filter out level 2 items? Is it just an example?

Yes it just serves as an example.

I think the system should not auto-pick up tomes by default in case the wrong unit accidentally picked up the tome, though that's easy enough to set for the user on a per-map basis

I guess the map maker can add that condition to the FilterItem function.
By default the system just filters out dead item.

Why not use GUI Unit Indexer so that you can make removal O(1)? You can also then auto-add units to the system who have the hero inventory ability on behalf of the user.

I had a UnitIndexer version uploaded before ( something v 3.1 ). I removed it in this version.
It's nearly the same like using a Table and saving the stack index on GetUnitHandlId.
Personally I'm a fan of UnitIndexers, but only for systems which significantly improve when
using such an indexer.

I agree, that if you frequently register/unregister units to ItemPickup, you'll need an indexer + array or a Table instance.

I like ItemPickup as simple as it is now. UnitIndexer or Table, both can be implemented with just a little change in the code.

So far I saw this system in pratical usage twice:
1. In the map I'm working on, which is close to the RPG genre.
2. In Glideon from Quilnez, which can be compared to Super Mario Kart.

Both examples do not need fast performing start & stop functions.

 

[BPower]

I replaced the in custom script written GUI version with a clean JASS script.
Yet it's still very easy to use and import for GUI coders.

There are two function for user settings at the head of the ItemPick JASS library.
Don't forget to edit them to your needs.

A proper GUI demo has been added to the attached map.

 

[KILLCIDE]

Sorry for the update. Just updating the tags.

 

[Bribe]

Here is a Lua version of this resource:

OnGlobalInit(function() AutoPickup = {}
--Item Pickup by BPower, converted to Lua by Bribe and renamed to AutoPickup.
--Version 1.0
 
--Requires:
--Global Initialization: https://www.hiveworkshop.com/threads/global-initialization.317099/
--Timed Call and Echo:   https://www.hiveworkshop.com/threads/timed-call-and-echo.339222/
--Linked List:           https://www.hiveworkshop.com/threads/definitive-doubly-linked-list.339392/
 
-- User settings:
-- ==============
    
    local _TIMEOUT  = 0.1   -- How frequently (in seconds) to check for nearby items.
    local _RADIUS   = 128   -- How wide a net to cast around the unit looking for items.
    local rect      = Rect(-_RADIUS,-_RADIUS,_RADIUS,_RADIUS)
    local getX      = GetUnitX
    local getY      = GetUnitY
    local alive     = UnitAlive
    local getId     = GetUnitTypeId
    local moveRect  = MoveRectTo
    local getItems  = EnumItemsInRect
    local getItem   = GetEnumItem
    local getLife   = GetWidgetLife
    local addItem   = UnitAddItem
 
    ---@param u unit
    ---@return boolean added
    function AutoPickup.start(u)
        if not AutoPickup[u] then
            AutoPickup[u] = Timed.echo(function()
                if alive(u) then
                    moveRect(rect, getX(u), getY(u))
                    getItems(rect, nil, function()
                        local i = getItem() ---@type item
                        if getLife(i) > 0.405 then
                            --one can add further comparisons above to rule out specific items.
                            addItem(u, i)
                        end
                    end)
                elseif getId(u) == 0 then
                    AutoPickup[u] = nil
                    return true
                end
            end, _TIMEOUT)
            return true
        end
    end
 
    ---@param u unit
    ---@return boolean removed
    function AutoPickup.stop(u)
        if AutoPickup[u] then
            AutoPickup[u]:remove()
            AutoPickup[u] = nil
            return true
        end
    end
end)
[/code

 

[The_Silent]

I can't get the Vjass Version to work. I think something with the increment and decrement of size and index is wrong. It seems to think that the source unit array is empty and pause the timer, even if I add multiple units to it. Size never gets bigger than 1. No matter how many units I add.

I just ran it using

call StartItemPickup(some_unit, 64.0)

The normal jass version works for me, so will use that for now.