Resource System

MyPad · Oct 21, 2018

~~I will test this later on, but~~ I suppose there must be something unique with this that warrants another attempt at a custom resource system.

~~Until then, I will ask: What does this resource offer compared to some Custom Resource bundles already posted here? I want to have some frame of reference for dealing with these.~~

Fingolfin · Oct 21, 2018

I actually wasn't aware of any other resource systems until i started searching, though it seems like this one is similar, and has some featuers which this one doesn't (more multiboard features, resources with no need for drop-off, harvested amount different from damaged amount, units or items as resources). However, i noticed some drawbacks it has over this one:

Mine supports animation tags for carrying resources, which his strangely doesn't seem to do.
His system works by hooking events to any kind of construction, training, selling, etc. and then cancel that event - while mine works by simply assigning a cost to an order (training and constructions are essentially orders in Wc3, with the unit's raw ID as order id) - and then canceling that order if the player can't "afford" it. This way, my system is a lot more compact than his and as a side effect allows for virtually any order to be assigned a cost.
My system uses dropoff abilities to define dropoff points, which in my opinion is more intuitive to configure and also slightly more efficient.
There is this weird bug thing in Warcraft where targeting destructibles inside the fog of war would not properly return the destructible as the order's target. My system compensates for this by searching for the destructable using a rect. I don't think his does this.
My system has no external dependencies (though a unit indexer is optional).
The visual appearance of my resource gathering is almost indistinghishable from that of vanilla Wc3 - namely, the harvest ability shows up as channeling while harvesting, "return resource" shows as channeling while returning it, and animation tags are properly assigned. This is not the case with his system.

This one is a resource system, but only supports a single custom resource on top of the existing ones. This one is an absolute mess and has many weird limitations which this system doesn't have. Overall, i think compactness and ease of use are the benefits of my system.

SNIper of DARKness · Oct 21, 2018

This system seems easier to introduce in to existing maps and configure it than the other ones available on Hive.

Though how would you go about adding a trading system so you can give other players resources.

MyPad · Oct 21, 2018

Thanks for that. I hope I can release my review for this soon.

It will be based on how the system is implemented overall.

Chaosy · Oct 21, 2018

I did not test it yet, but judging by the setup demo is there a requirement to setup lumber and gold resources to make the system work? or is that just for showcase?

Hazop · Oct 22, 2018

For units that use custom resources, how would you know how much of the custom resource they cost?

Lt_Hawkeye · Oct 22, 2018

You have to type the costs out in their tool tips.

Fingolfin · Oct 22, 2018

Chaosy said:
I did not test it yet, but judging by the setup demo is there a requirement to setup lumber and gold resources to make the system work? or is that just for showcase?

You can use any resource names you want - wood, gold, etc. are just examples. Actually, you don't really need anything from the "setup" part at all, you can register things yourself as you want. Basically, what you need is a globals block where you define your resource globals, and an initialization function of some sorts which creates the resources and assigns costs. The "ResourceSetup" part just shows how the different methods are used.

SNIper of DARKness said:
This system seems easier to introduce in to existing maps and configure it than the other ones available on Hive.

Though how would you go about adding a trading system so you can give other players resources.

Do you mean like a tribute system? Transferring resources is done like this:

JASS:

// Let's say that we have GUI integer globals ReceivingPlayerId and SendingPlayerId
// As well as a real global TributeAmount

set PlayerResource[udg_ReceivingPlayerId][Wood] = PlayerResource[udg_ReceivingPlayerId][Wood] + udg_TributeAmount
set PlayerResource[udg_SendingPlayerId][Wood] = PlayerResource[udg_SendingPlayerId][Wood] - udg_TributeAmount

Of course, on top if this you might need some sort of dialog system or hero menu.

Chaosy · Oct 22, 2018

Oh. I thought it overwrite the default system since you used gold and lumber.

My bad.

MyPad · Oct 23, 2018

System Review:

Notes:

This system is a self-contained library, with additional functionalities based on the whims of the user. With that said, usage of other libraries, as optional ones, would be beneficial for the user, since certain things handled by the system that it should not be involved with are taken care of, if these libraries exist. With that in mind, a possible collision might arise when the system overrides the inner mechanics of a UnitIndexer used by the end-user, or cause the total hashtable count to exceed 255, which isn't likely to happen, but must not be downplayed if such a case occurs.

Thus, I would recommend introducing these optional libraries (these are not the only ones you can add, though): [System] UnitDex - Unit Indexer, [Snippet] New Table.
In LIBRARY_ResourceLibrary, a certain function has the same name as the ai native GetUnitBuildTime. I would suggest adding Ex to it, just in case such a native is used by the end-user.
A certain minor lag-phase occurs if you issue multiple units to "harvest" a targeted destructable. This is due to repeated calls to EnumDestructablesInRect, which could be the probable cause. This only affects low-end computers, but optimization concerning this is recommended (I wonder what solution to this will the update offer).
On structs Resource and Harvester, the initialization process is of type struct-initialization. In Vexorian's vJASS compiler, this has a lower priority over module initializers. This could be potentially troublesome, as the events by which the system runs upon might be also found in other libraries, which, due to them having potentially been initialized first (module), might affect the way the system works. This is only reserved to listener functions.

Syntax of module initializers:
JASS:
```
module M
    private static method onInit takes nothing returns nothing
    endmethod
endmodule
struct S
    implement M
endstruct
```
In Resource::onInit and Harvester::onInit, some lines are unnecessarily verbose. These particular lines follow this paradigm:
JASS:
```
loop
    exitwhen i == bj_MAX_PLAYER_SLOTS
    call TriggerRegisterPlayerUnitEvent(t, Player(i), EVENT_PLAYER_UNIT_SPELL_EFFECT, null)
    set i = i+1
endloop
```
In that case above, you can just use the BJ-function equivalent of those lines, saving you some time, and grants a little bit more of readability. This is only reserved to such loops that invoke TriggerRegisterPlayerUnitEvent once and only once.

There are some more cases which might cause this system to bug, but I fear that I cannot disclose it in this review. So, I will just mention them on the messages hereafter.

Status:

Awaiting Update

Fingolfin · Oct 23, 2018

Uhm.... thank you for your review MyPad, though let me be straight... I've never encountered anything as infuriatingly dogmatic and arbitrary on this site as the spell reviewing process. So, brace for a huge rant.

First of all, this:

MyPad said:
Thus, I would recommend introducing these optional libraries (these are not the only ones you can add, though): [System] UnitDex - Unit Indexer, [Snippet] New Table.

The last system i uploaded was sent to "substandard" partly on the basis that it used UnitDex, which apparently was considered nonstandard and unreliable. Now, i'm getting pushback for NOT bundling UnitDex with it, despite a unit indexer being an optional feature to be enbled by the user if needed. Some trivia: I have also previously gotten crap over using a timer interval of 0.03 instead of 0.03125 (no, I'm not kidding).

MyPad said:
With that said, usage of other libraries, as optional ones, would be beneficial for the user, since certain things handled by the system that it should not be involved with are taken care of, if these libraries exist. With that in mind, a possible collision might arise when the system overrides the inner mechanics of a UnitIndexer used by the end-user, or cause the total hashtable count to exceed 255, which isn't likely to happen, but must not be downplayed if such a case occurs.

This is such a massive non-issue. No, the system does not override the inner mechanics of any unit indexer (what is that even supposed to mean?), the whole point of an indexer is to generate an index-friendly ID for each unit for array storage (hence inherently no limitations or collisions with other systems). This system does not modify unit custom data in any way. As for Tables, this system uses both the parent and child keys to store certain data, Table is just for associating a single key with a value. I will not rewrite this whole system (which is already well utilizing a single hashtable) just in the remote and incredibly unlikely event that someone would have more than 256 hashtables in their map.

MyPad said:
In LIBRARY_ResourceLibrary, a certain function has the same name as the ai native GetUnitBuildTime. I would suggest adding Ex to it, just in case such a native is used by the end-user.

This is legit criticism, mainly because that function is not actually utilized at all in my system and is likely just legacy from an older version.

MyPad said:
A certain minor lag-phase occurs if you issue multiple units to "harvest" a targeted destructable. This is due to repeated calls to EnumDestructablesInRect, which could be the probable cause. This only affects low-end computers, but optimization concerning this is recommended (I wonder what solution to this will the update offer).

I guess it could be possible to cache the destructible search result per frame. I will see what i can do.

MyPad said:
On structs Resource and Harvester, the initialization process is of type struct-initialization. In Vexorian's vJASS compiler, this has a lower priority over module initializers. This could be potentially troublesome, as the events by which the system runs upon might be also found in other libraries, which, due to them having potentially been initialized first (module), might affect the way the system works. This is only reserved to listener functions.

Considering that only the events are registered in onInit (resources are to be registered in library Init), i really don't see how this could cause issues with anything. If you can actually present me with a case where this could cause a failure, I'll change it.

MyPad said:
In Resource::onInit and Harvester::onInit, some lines are unnecessarily verbose. These particular lines follow this paradigm:

JASS:

loop exitwhen i == bj_MAX_PLAYER_SLOTS call TriggerRegisterPlayerUnitEvent(t, Player(i), EVENT_PLAYER_UNIT_SPELL_EFFECT, null) set i = i+1 endloop

Though i'm generally in favor of increased readability, i think this is a matter of personal preference more than anything else. In my case, i suppose i just don't like the red highlight which TESH gives BJ functions, since it kinda reminds me of error highlighting.

MyPad said:
There are some more cases which might cause this system to bug, but I fear that I cannot disclose it in this review. So, I will just mention them on the messages hereafter.

Please do.

MyPad · Oct 23, 2018

Ah, I see why you haven't incorporated some of these helper libraries (the optional ones).

Perhaps I haven't read the system extensively enough, so I'll agree with the custom user data not being an issue.

Fingolfin said:
Considering that only the events are registered in onInit (resources are to be registered in library Init), i really don't see how this could cause issues with anything.

This is a very rare case, but suppose some trigger, which was initialized first via module initializer, was registered to an onOrder event. Upon invocation of the event, it may do something with the unit that would deem it invalid.

Once the trigger in the system listens to that event, it would be working with a unit which may not be capable of doing these things. That is why I suggested a module initializer over a struct initializer.

Fingolfin said:
The last system i uploaded was sent to "substandard" partly on the basis that it used UnitDex, which apparently was considered nonstandard and unreliable. Now, i'm getting pushback for NOT bundling UnitDex with it, despite a unit indexer being an optional feature to be enbled by the user if needed.

You can indicate through documentation that the end-user can choose any unit indexer, and the system only works with the presence of such a system, should USE_INDEXER be true.

Mind if I'll ask for the link for that? I'd like to correct that (if in Spells)

Fingolfin said:
As for Tables, this system uses both the parent and child keys to store certain data, Table is just for associating a single key with a value.

Mmmh, you might have a point there. In the place of my previous suggestion on this, you can add a disclaimer about the hashtable count.

Fingolfin · Oct 25, 2018

All right, i will add some extra documentation then. Regarding the onInit part, i'm still not convinced that this is an issue. Unless you explicitly state library dependencies, libraries will also be initialized in an arbitrary order, so there is no guarantee that other systems won't fiddle with the unit state. If you wanted to make it watertight in that regard, you'd have to add sanity checks in each trigger event. I just think it looks neater to initialize triggers in the scope of the struct they belong to, rather than having it all in one big clusterfuck at the bottom. This is just my personal preference, though.

Here is the system in question:

Realistic Airplane System

To be fair, there were a couple of valid points besides using UnitDex, though those have been since long fixed. Would be great if you could take a look at it.

MyPad · Oct 29, 2018

Hmm... inspecting the code further (this resource), I found out the following:

Comments/Bug Reports:

<cond> == false, can be simplified into: not <cond>. There are a lot of these within the main library.
In Harvester::get, the case where no value supposedly exists in a specified index will not happen, in a way such that the returned value will be the same as that of the default 0 anyway.
In Resource::onBuildingConstructed, when the building gets removed, the building's user data should also be cleared (this is only the logical process of the removal of a unit, not a recommended course of action). The system assumes that this will never be the case, and will proceed, regardless of whether the building's user data exists or not. The same reasoning would apply with the handle id.
Mostly a tip, you can make functions that are used as triggerconditions return nothing. This is possible!
In the first globals block, there is a variable integer array PlayerResource[11][MAX_RESOURCES]. Any reason as to why the number 11 was chosen? (A magic number)
There is an odd bug, where a building that is still undergoing construction can be used as a return resource spot.
In Harvester, there is a static array member harvesters. This gets generated regardless of the USE_INDEXER flag being true or not.
In Harvester::remove(unit u), the logic of accessing the stored data is mixed. If USE_INDEXER is true, the method will instead invoke a hashtable call, and vice versa.

Fingolfin said:
Unless you explicitly state library dependencies, libraries will also be initialized in an arbitrary order, so there is no guarantee that other systems won't fiddle with the unit state.

That is correct, and something that would be enforced in a system, should it have to use external dependencies.

Fingolfin said:
If you wanted to make it watertight in that regard, you'd have to add sanity checks in each trigger event.

That is what I desire when looking at systems in the spell section, making sure that no edge-cases can possibly jeopardize the system, or if it cannot be helped, minimize its' impacts.

I think I might have not covered some more edge-cases, and I haven't figured out how to optimize the system in the case of multiple units being ordered to target a "resource" at the same time.

Realistic Airplane System

I'll check out the link and see what I could find.

Leubast · Sep 1, 2019

So, how would I access a player's custom resource via scripting? Like adding an ability to a Marketplace to sell the custom Stone resource for Gold?

Fingolfin · Sep 1, 2019

Something like this, in Jass:

JASS:

local integer playerId = GetPlayerId(GetTriggerPlayer())

if PlayerResource[playerId][Stone] >= 100 then
    set PlayerResource[playerId][Stone] = PlayerResource[playerId][Stone] - 100
    set PlayerResource[playerId][Gold] = PlayerResource[playerId][Gold] + 100
else
    // Do something to prompt the player that he doesn't have enough stone
endif

Though i suppose the easiest way is to register a cost to the ability ID of your trade ability. There is a function called RegisterCost, and although it was primarily meant to assign cost to units, it automatically works for spells since both spells and construction/training are just orders.

Put this in some initialization function, you can for instance set it somewhere in the Resource Setup trigger with all the other initialization stuff:

JASS:

call RegisterCost('a001', Gold, 100)

The benefit of this is that the player gets a message automatically when they can't afford the transaction. However, knowing when to give the gold is harder... you'd have an event when the spell is cast, but to know whether it passes or not, you'd probably still need to make the same check as above.

Leubast · Sep 2, 2019

Ok, so like this?:

Events
Unit - A unit starts casting an ability
Conditions
(Ability-type of (casting ability)) Equal to Sell Stone
Actions
Custom Script - local integer playerId = GetPlayerId(GetTriggerPlayer())
Custom Script - if PlayerResource[playerId][Stone] >= 50 then
Custom Script - set PlayerResource[playerId][Stone] = PlayerResource[playerId][Stone] - 50
Player - add 35 to (Owner of (casting unit)) Current gold
Custom Script - else
Sound - play error
Game - Display to (Owner of (casting unit)) the text: Not enough stone!

Fingolfin · Sep 2, 2019

Yes, but you'll need to add this to the end:

custom script: endif

Other than that, it looks fine.

SNIper of DARKness · Sep 6, 2019

Fingolfin said:
Yes, but you'll need to add this to the end:

custom script: endif

Other than that, it looks fine.

Did you fix the lag Fingolfin?

Fingolfin · Sep 6, 2019

I haven't had time to take a look at that yet, though i suppose it might be related to EnumDestructablesInRect calls. I will see what i can do.

DarkImagine · Nov 13, 2019

I had a problem with buying items ... The fact is that the system does not use a custom resource when buying items. Can this be solved somehow?

Pyrogasm · Nov 14, 2019

Not in the regular ‘hover over object to buy’ interface. They can’t be made to show up there. You can detect item/unit buy events and try to subtract the appropriate resource (or refund purchase if insufficient) by reading from some precached array/hashtable database.

Grothfabris · Nov 23, 2019

Guys, sorry, but there is some erros happening with my map when I try using this wonderful script, I will post them here! Sorry for been soo dumb, I think it is some very simple.

Fingolfin · Nov 23, 2019

You need to have a version of the editor which support the vJass compiler! The latest version should, but you might need to enable it. If it is enabled, you can ignore that error.

Drake53 · Jan 22, 2020

Any plans on updating this system? I've noticed some issues trying the test map, the most critical being that when I spam the train button fast enough, peasants will be added to the training queue even when I don't have enough resources (and I get free resources when I cancel them again).

Hazop · Sep 13, 2020

Cant seem to get this to function properly, I imported the triggers, abilities, destructibles and then set the unit ideas to them (with DropoffAll being A03Z for ex)

But I still cant seem to get it to work, I right click stone, the peasant starts attacking it instead of harvesting, attacking/killing a sheep to get food results in the sheep dying and a corpse spawning, but the corpse is playing the stand anim's and I cant harvest it.
Here's an screenshot, I wanted to try to use the resources already provided in the system to get a hang of it.

Map Designer · Jan 30, 2021

MORE MORE PEASANTS.
Gather ore/stones and meat for the men.

we age of empires now?

I might use this system sometime in the future.

Resource System

Resource System (Map)

System Review:

Notes:

Status:

Attachments

Similar threads