[JASS] Item Restriction System (IRS) v1.0f

[Moderator]

Item Restriction System v1.0a | Reviewed by Maker | 27th Feb 2013

APPROVED

A very useful system

[tr]

 

[Legendary]

Very useful

 

[Doomlord]

Whoops. This is actually my second submission, not first

This system is currently having a terrible bug but I cannot fix it right now. Please don't download it. - Updated

 

[Legendary]

I am supporting this i whish it would be Approve

 

[Almia]

        set k = LoadInteger(udg_IRS_Hashtable, i, 5)

        if GetHeroStr(u, true) < k then
            call IRS_SimError("The minimum Strength required to carry this item is " + I2S(k))
            call UnitRemoveItem(u, it)
            return false
        endif

        set k = LoadInteger(udg_IRS_Hashtable, i, 6)

        if GetHeroAgi(u, true) < k then
            call IRS_SimError("The minimum Agility required to carry this item is " + I2S(k))
            call UnitRemoveItem(u, it)
            return false
        endif

        set k = LoadInteger(udg_IRS_Hashtable, i, 7)

        if GetHeroAgi(u, true) < k then
            call IRS_SimError("The minimum Agility required to carry this item is " + I2S(k))
            call UnitRemoveItem(u, it)
            return false
        endif
    endif

->

    local integer i2 = 7
    loop
        exitwhen 4 == i2

        set k = LoadInteger(udg_IRS_Hashtable, i, i2)

        if GetHeroAgi(u, true) < k then
            call IRS_SimError("The minimum Agility required to carry this item is " + I2S(k))
            call UnitRemoveItem(u, it)
            return false
        endif
   
        set i2 = i2 - 1
    endloop

Change the following names of the function so that it won't be too vauge.
IRS_ItemRegistration -> RegisterRestrictedItem
IRS_ClassRegistration -> RegisterRestrictedItemClass

Also,i think that those messages should be configurable.

Btw, call SaveStr (udg_IRS_Hashtable, itemRawCode, 3, class)
I never knew that WE allows that kind of syntax(spaces before parentheses)

 

[Doomlord]

        set k = LoadInteger(udg_IRS_Hashtable, i, 5)

        if GetHeroStr(u, true) < k then
            call IRS_SimError("The minimum Strength required to carry this item is " + I2S(k))
            call UnitRemoveItem(u, it)
            return false
        endif

        set k = LoadInteger(udg_IRS_Hashtable, i, 6)

        if GetHeroAgi(u, true) < k then
            call IRS_SimError("The minimum Agility required to carry this item is " + I2S(k))
            call UnitRemoveItem(u, it)
            return false
        endif

        set k = LoadInteger(udg_IRS_Hashtable, i, 7)

        if GetHeroAgi(u, true) < k then
            call IRS_SimError("The minimum Agility required to carry this item is " + I2S(k))
            call UnitRemoveItem(u, it)
            return false
        endif
    endif

->

    local integer i2 = 7
    loop
        exitwhen 4 == i2

        set k = LoadInteger(udg_IRS_Hashtable, i, i2)

        if GetHeroAgi(u, true) < k then
            call IRS_SimError("The minimum Agility required to carry this item is " + I2S(k))
            call UnitRemoveItem(u, it)
            return false
        endif
   
        set i2 = i2 - 1
    endloop

Change the following names of the function so that it won't be too vauge.
IRS_ItemRegistration -> RegisterRestrictedItem
IRS_ClassRegistration -> RegisterRestrictedItemClass

Also,i think that those messages should be configurable.

Btw, call SaveStr (udg_IRS_Hashtable, itemRawCode, 3, class)
I never knew that WE allows that kind of syntax(spaces before parentheses)

Do you know what you are writing in the first code block? It seems you misunderstood the code. I will leave it to you to figure it out yourself later.

The function names are fine :v Why so picky and lengthy?

I consulted Mag twice before uploading this so don't worry, I am sure if he has nothing to say then it is alright.

edit

I wrote the wrong code. NOOO. Damn need to fix it now.

 

[Almia]

We need not vauge function names so it will be meaningful! Mag suggested it to me so many times because i write like that.

Also,the code block.
I mean it looks good than that.There's no problem in that code.It because you repeat the code block all over again with only changing the k value

 

[Doomlord]

Yeh yeh okay I will fix that together with the INT attribute check goof

 

[Almia]

Oh ok
I see what you did there that's why you are against my suggestion

 

[Felipe Gormadoc]

four months ago That would be my salvation

 

[Maker]

I don't think you need boolean for the class and level.

For class, check that stored class != null, maybe not HaveSavedStr(...) will work also.
For level, you can store 0 if it doesn't need to be checked.

 

[TKF]

Well, I never thought of using items with hashtables in that fashion as a item indexer system. Smart way to save items info.

Like SetUnitUserData, you can use SetItemUserData/GetItemUserData for items as well, it can set a custom integer value to an item.

 

[Elprede]

I suggest adding support for item levels because # of levels > # of item classes.

 

[Almia]

@TKF
It will collide with some Item Indexers.(there are few)

 

[Doomlord]

I suggest adding support for item levels because # of levels > # of item classes.

My system supports an unlimited number of item classes. Or am I misunderstanding sth?

@Maker: Thanks. I will include that in the update.

 

[Legendary]

My system supports an unlimited number of item classes. Or am I misunderstanding sth?

@Maker: Thanks. I will include that in the update.

If your done with the update send me fast so i can start im using my laptop right now and my pc still dosn't have any net just send me a message

 

[Doomlord]

Updated.

 

[Legendary]

Yes It has been Approved

 

[meowie]

Very useful system.

 

[MasterTrainer]

I could really use this for my srpg. Thanks!

 

[Vinz]

5/5 Attack!

 

[Maker]

It would be nice to be able to limit an item type to be used by multiple unit types.

 

[Doomlord]

It would be nice to be able to limit an item type to be used by multiple unit types.

What do you mean Maker? I am sorry but I don't understand.

 

[Maker]

"This item can only be used by Paladin, Mountain King and Blood Mage."

 

[Doomlord]

Uhm well you can actually register multiple unit types as a single type of 'class' and the system would still work. Does thaj suffice?

 

[Maker]

It does

 

[Doomlord]

It does

Ha ha okay

 

[Girl-Stalk3r]

How can i use the item registration if i am using custom items with the same raw code? Example: 'frgd'

l00A:frgd
l00B:frgd
l009:frgd

 

[Maker]

The first part is the raw code, I00A, I00B, I009.

 

[Doomlord]

Thank you Maker for answering his question for me

 

[Girl-Stalk3r]

oh, thank you very much!

 

[MajorKaza]

Hi there,

What is the difference between:
String Setting
and
Examplary Declaration
??

Could you give an example how to make restriction for any class? Leave it as null string or space? Or wildcard maybe? "*"

 

[Doomlord]

Hi there,

What is the difference between:
String Setting
and
Examplary Declaration
??

Could you give an example how to make restriction for any class? Leave it as null string or space? Or wildcard maybe? "*"

"String Setting" is where you change your error messages as you wish. "Examplary Declaration" is, well, a simple how-to. And it is also the example you are looking for. Consult the documentation for the APIs if you need to.

 

[Faith]

hey guise, whats a vJASS?
cool beans broski, im gonna use this <3

 

[Deleted member 219079]

when hero dies, the text goes to top of the screen when the system has shown a text message some time before. that's a shame, this is otherwise a perfect system.

JPG (811x864)

Edit: Restriction by wearer's range would be awesome

 

[Doomlord]

when hero dies, the text goes to top of the screen when the system has shown a text message some time before. that's a shame, this is otherwise a perfect system.

JPG (811x864)

Edit: Restriction by wearer's range would be awesome

Hello. Thank you very much for using the system (and your compliment too). About the bug, I am afraid it is a permanent glitch with the SimError library I am using for the error messages. I don't think there is any way to get around that, I may be wrong though

Wielder's range? Could you elaborate a bit? But I am kinda busy atm so when I have some free time I will look into it. Do your map really need that feature?

 

[Deleted member 219079]

Attack range that is. My map doesn't need that feature, but it's just not realistic to have claws of attack boost Archmage's attack, since he uses fire to attack and attacks with distance.

I can stack hero types who I allow to use the item (right?), so I won't need range filter on top of that. I just thought it would be more practical to have range filter...

Also, I just implemented this to my map, works like a charm, 5/5 from me

 

[Doomlord]

Attack range that is. My map doesn't need that feature, but it's just not realistic to have claws of attack boost Archmage's attack, since he uses fire to attack and attacks with distance.

I can stack hero types who I allow to use the item (right?), so I won't need range filter on top of that. I just thought it would be more practical to have range filter...

Also, I just implemented this to my map, works like a charm, 5/5 from me

Thank you.

Anyhow, I added the range filter function since it seems legitimate enough

edit

@Others: yeah I am still alive. And 4 months of non-coding really takes its toll :S

 

[Deleted member 219079]

Nice range feature

It seems like the effect of item is still applied to wielder, even when it's removed the second it's acquired. This is probably caused because the event is EVENT_PLAYER_UNIT_PICKUP_ITEM, it first goes through wc3's code, which applies any buffs item gives, then reads custom triggers. The buff stays for couple of seconds, along with stats buff. Maybe just adding possible buff id item gives to hero onto hashtable, and removing it if there's anything ?

PNG (1088x681)

Edit:
I added this:

call UnitRemoveAbility(u,'BEar')

to beginning of the code after declaring locals to test it out, the effect of the flute didn't appear anymore.

 

[BPower]

Not worth it. It would require a lot of extra space to store all these information.
Also this effect might influence units in an aoe and not only the carrier.

In order to safely remove all buffs from all affected units the code would be incredible long with alot of condition checks.

 

[Deleted member 219079]

Also this effect might influence units in an aoe and not only the carrier.

It doesn't do that at the same moment the item is acquired, at least on flute.

Edit:

GIF (692x539, 4,85MB)

 

[Doomlord]

^What BPower said. I am bothered about that too but those extra miles are not worth going in the slightest. Coding is more or less about coping with not knowing what the users are going to throw at your system, that is why some mapmakers prefer to create simple systems running on a logic limited to a particular map of theirs where they can control everything.

It doesn't do that at the same moment the item is acquired, at least on flute.

The buff is removed immediately so I guess it cannot affect nearby units.

 

[Deleted member 219079]

It hurts me as a perfectionist (sry, nothing I can do about it :/ ), but I guess as long as players playing my map I have this on won't complain about it, I won't get bothered too much about it.

Again the range feature was really nice add-on, I will update the version I used on my map to this one now

 

[Doomlord]

It hurts me as a perfectionist (sry, nothing I can do about it :/ ), but I guess as long as players playing my map I have this on won't complain about it, I won't get bothered too much about it.

Again the range feature was really nice add-on, I will update the version I used on my map to this one now

Thank you! Hope you enjoy it

 

[marvey323]

Uh

This system is not MUI ?

Because I placed it in my map, properly configured.. and as soon as another player picks up an item that is restricted for that player, I also get the error messages on my screen

 

[Doomlord]

This system is not MUI ?

Because I placed it in my map, properly configured.. and as soon as another player picks up an item that is restricted for that player, I also get the error messages on my screen

That is indeed an important bug. I probably overlooked that when I first made the system (then there was still no way to test multiplayer without someone to help). Anyway, thank you for reporting. Oh and it is called MPI, not MUI.

The issue has been addressed in the new version. Please update the system ASAP.

 

[marvey323]

Update:

So I have updated to version 1.0.f however upon importing, I get the errors :

"Undeclared function IRS_RegisterRestrictedItem" as well as "Undeclared function IRS_ClassRegistration"

even though I imported the map-specific custom code at the start as well as replacing the old IRS trigger with the new one. Am I missing something?


Update 2:

Solved the problem of importing the update: It was totally weird but I had to basically cut and paste my item configuration trigger from 1.0e to 1.0f .. and then the map saved without giving errors. Isn't that weird?

 

[Doomlord]

Update:

So I have updated to version 1.0.f however upon importing, I get the errors :

"Undeclared function IRS_RegisterRestrictedItem" as well as "Undeclared function IRS_ClassRegistration"

even though I imported the map-specific custom code at the start as well as replacing the old IRS trigger with the new one. Am I missing something?


Update 2:

Solved the problem of importing the update: It was totally weird but I had to basically cut and paste my item configuration trigger from 1.0e to 1.0f .. and then the map saved without giving errors. Isn't that weird?

Well that is really weird indeed. So, does everything work fine now? Is there still any issue?

 

[zv27]

Range filter values are as follow:

"0" means the item can be used by both melee and ranged units.
"1" means the item is for ranged units only.
"2" means the item is for melee units only.

small suggestions[I think it would be easier to navigate]

set IRS_MeleeRanged = 0 -> means the item can be used by both melee and ranged units.
set IRS_Ranged = 1 -> means the item is for ranged units only.
set IRS_Melee = 2 -> means the item is for melee units only.

call IRS_ItemRegistration ('afac', "Weapon", "Mountain King", 10, 20, 10, 10, IRS_Melee)