Expand item unique id control

[sader1992]

• Addressed Issue(s): #4175

• Server Mode: both

• Description of Pull Request:

there is already a command to get the equipment unique id

getequipuniqueid(<equipment slot>{,<char_id>})

with this PR
getinventorylist now assign a int variable the item unique id @inventorylist_unique_id$

OnSellItem now assign @sold_unique_id$ "idea from https://rathena.org/board/topic/119433-how-to-get-unique-id-from-onsellitem/#comment-362164"

countbound now returns @bound_unique_id$[] too for the item unique id

new commands

uniqueid_getiteminfo(<"string  unique id">{,<char_id>})

this command get the item information by it's unique id and assign it to the variables.
the variables are the same as the getinventorylist command , however it start with .@uid_ instead of @inventorylist_

uniqueid_find(<"item_unique_id">{,<char_id>})

check if the player have an item with the unique id provided.

uniqueid_delitem(<"string unique id">{,<char_id>})

this command delete an item from the inventory by it's unique id

test scripts

//@item hat 5
prontera,152,175,4	script	unique_id_control	444,{
	.@unique_id$ = getequipuniqueid(EQI_HEAD_TOP);
	mes .@unique_id$;
	next;
	uniqueid_delitem(.@unique_id$);
	end;
}

prontera,152,177,4	script	unique_id_control2	444,{
	.@unique_id$ = getequipuniqueid(EQI_HEAD_TOP);
	mes .@unique_id$;
	next;
	uniqueid_getiteminfo(.@unique_id$);
	
	mes "ID: " + .@uid_item_id;
	mes "Equip Place: " + .@uid_equip;
	mes "Refine: " + .@uid_refine;
	mes "Identify: " + .@uid_identify;
	mes "Attribute: " + .@uid_attribute;
	mes "Card 1: " + .@uid_card1;
	mes "Card 2: " + .@uid_card2;
	mes "Card 3: " + .@uid_card3;
	mes "Card 4: " + .@uid_card4;
	mes "Expire: " + .@uid_expire;
	mes "Bound: " + .@uid_bound;
	mes "Random Opions";
	mes "ID 1: " + .@uid_option_id1;
	mes "Value 1: " + .@uid_option_value1;
	mes "Param 1: " + .@uid_option_parameter1;
	mes "ID 2: " + .@uid_option_id2;
	mes "Value 2: " + .@uid_option_value2;
	mes "Param 2: " + .@uid_option_parameter2;
	mes "ID 3: " + .@uid_option_id3;
	mes "Value 3: " + .@uid_option_value3;
	mes "Param 3: " + .@uid_option_parameter3;
	mes "ID 4: " + .@uid_option_id4;
	mes "Value 4: " + .@uid_option_value4;
	mes "Param 4: " + .@uid_option_parameter4;
	mes "ID 5: " + .@uid_option_id5;
	mes "Value 5: " + .@uid_option_value5;
	mes "Param 5: " + .@uid_option_parameter5;
	mes "Tradable: " + .@uid_tradable;
end;
}

prontera,152,179,4	script	unique_id_control3	444,{
	getinventorylist;
	for(.@i = 0;.@i< @inventorylist_count;.@i++){
		mes @inventorylist_id[.@i] + " " + @inventorylist_unique_id$[.@i];
	}
end;
}

-	shop	dyn_shop1	-1,501:50.

prontera,152,181,4	script	unique_id_control4	444,{
	callshop "dyn_shop1",2;
	npcshopattach "dyn_shop1";
	end;

OnSellItem:
	mes @sold_unique_id$;
end;
}

Old Script/Idea

``` //@item hat 5 prontera,152,175,4 script unique_id_control 444,{ .@unique_id = getequipuniqueid(EQI_HEAD_TOP); mes .@unique_id; next; uniqueid_delitem .@unique_id; end; }

prontera,152,177,4 script unique_id_control2 444,{
.@unique_id = getequipuniqueid(EQI_HEAD_TOP);
mes .@unique_id;
next;
uniqueid_getiteminfo .@unique_id,.@item;
for(.@i=0;.@i<getarraysize(.s$);.@i++){
mes .s$[.@i] + " " + .@item[.@i];
}
for(.@i= getarraysize(.s$);.@i<getarraysize(.@item);.@i+=3){
mes "it->option[" + .@i + "].id" + .@item[.@i];
mes "it->option[" + .@i + "].value" + .@item[.@i];
mes "it->option[" + .@i + "].param" + .@item[.@i];
}
end;
OnInit:
setarray .s$,
"it->nameid"
,"it->refine"
,"it->identify"
,"it->attribute"
,"it->card[0]"
,"it->card[1]"
,"it->card[2]"
,"it->card[3]"
,"it->expire_time"
,"it->bound";
}

prontera,152,179,4 script unique_id_control3 444,{
getinventorylist;
for(.@i = 0;.@i< @inventorylist_count;.@i++){
mes @inventorylist_id[.@i] + " " + @inventorylist_unique_id[.@i];
}
end;
}

• shop dyn_shop1 -1,501:50.

prontera,152,181,4 script unique_id_control4 444,{
callshop "dyn_shop1",2;
npcshopattach "dyn_shop1";
end;

OnSellItem:
mes @sold_uniqueid;
end;
}

[anacondaq]

Also, recommend renaming uniqueid item commands to something like

uniqueid_COMMAND
or unique_id_COMMAND
to keep all unique_id with the same pre-fix or post-fix.

Also, you forgot to add documentation with examples to /doc/script_commands.txt

[sader1992]

tested it , work great
sorry @aleos89 look like i did a lot of things wrong xD
i will be more carefull next time

[cydh]

If you mind for these

[aleos89]

No worries, you did nothing wrong. I figured it'd be quicker for me to manually make the changes than list tons of edits.

[sader1992]

if someone want to test the PR (like for a real life usage)
this script is ready to use , that uses the new commands
[UnOfficial] Skyfortress Drop/reroll enchantment Functions 1.0.0

[sader1992]

update to work as int64 instead of unsigned long long
to follow e72c736

[Atemo]

My 2 cents!

[Atemo]

buildin_delitem_search doesn't check the unique id and it may delete the wrong item. Maybe pc_delitem would do the job

[sader1992]

@Atemo thanks for the feedback, will work on it

for the uniqueid_getiteminfo I think it's better idea to just remove it and relay on getinventorylist instead

getinventorylist;
if((.@ndx = inarray(@inventorylist_unique_id,<unique_id>)) !=-1){
	//@inventorylist_id[.@ndx]
	//@inventorylist_refine[.@ndx]
	//@inventorylist_card1[.@ndx]
	//etc
}else{
	//item not found
}

and it would be easier then just making the writer remember what index the cards are etc
so this pr would be just adding delete_item_unique_id/edit getinventorylist/also making getequipuniqueid return int instead of string

[Atemo]

Eventually the unique id could be also saved in

• @sold_unique_id for OnSellItem https://github.com/rathena/rathena/blob/master/doc/script_commands.txt#L7048
• and @bound_unique_id[] for countbound https://github.com/rathena/rathena/blob/master/doc/script_commands.txt#L5092

[lgtm-com]

This pull request introduces 1 alert when merging c1ae466 into 58f2d21 - view on LGTM.com

new alerts:

• 1 for Comparison result is always the same

[sader1992]

I think this is way better then just letting the scripter provide a .@array , the variables like this are the same as getinventorylist command but they start with ".@uid" instead of "@inventorylist_"
we can get the same result with something like this

getinventorylist;
if((.@ndx = inarray(@inventorylist_unique_id$,<"unique_id">)) !=-1){
	//@inventorylist_id[.@ndx]
	//@inventorylist_refine[.@ndx]
	//@inventorylist_card1[.@ndx]
	//etc
}else{
	//item not found
}

but i still think if we want the information of one item only , no need to use getinventory list command

[lgtm-com]

This pull request introduces 2 alerts when merging efebd7e into 58f2d21 - view on LGTM.com

new alerts:

• 2 for Comparison result is always the same

[Litro]

recommend to add "from the invoking character's inventory if found." for more detailed description

[sader1992]

I think after this update #6247
the inventory index update gives the intended functionality of this pull request in a different way.
so in think this pull request is not as important as before.
will close the pull request, if any dev wanted me to reopen it , I would.