Add F_MesItemInfo function to show item name with description link #2068

AnnieRuru · 2018-06-06T18:08:59Z

Pull Request Prelude

I have followed proper Hercules code styling.
I have read and understood the contribution guidelines before making this PR.
I am aware that this PR will be closed if the above-mentioned criteria are not fulfilled.

Issues addressed

too many members doesn't even know this exist
simply because it is not documented

Changes Proposed

Add F_MesItemInfo function to show item name with description link

Affected Branches

Master

Tested with

prontera,155,180,0	script	Test Instance	1_F_MARIA,{
	mes("You can <URL>Google<INFO>http://www.google.com/</INFO></URL> anything");
	.@id = Apple;
	mes(F_MesColor(C_BLUE) +"This message is now in BLUE");
	mes F_MesColor(C_BLACK);
    mesf("%sThis message is now in BLUE.", F_MesColor(C_BLUE));
	mes F_MesColor(C_BLACK);
	mes F_MesItemInfo(.@id);
	mesf "Testing %s", F_MesItemInfo(.@id);
	mes("Bring me an <ITEM>Apple<INFO>512</INFO></ITEM>.");
	mes("Bring me an "+ F_MesItemInfo(Apple) +".");
    mesf("Bring me an %s.", F_MesItemInfo(Apple));
	select getitemname(.@id), F_MesItemInfo(.@id);
	close;
}

Known Issues and TODO List

although unrelated, but my hexed client doesn't show the www.google.com properly

HerculesWSAPI · 2018-06-06T18:09:08Z

This change is

npc/other/Global_Functions.txt

AnnieRuru · 2019-01-21T10:21:30Z

bump

@Emistry , why you add item slot to the function ?
I test in-game,
example, Item ID 1201,1202,1203 are all Knife with different amount of slots
when you have these items in your inventory, it display the slot just below the item description
but when you display it inside mes, right click on it, it doesn't show the slot

Emistry · 2019-01-22T01:40:23Z

@Emistry , why you add item slot to the function ?

hmm, I didnt modify anything to this PR?

anyways, if you're asking for opinion, I find that showing the item slot of the item make more sense and accurate to display the item. RO has too many redundant item due to the different amount of item slots.
Display the item slots of the said item help to reduce confusion among the player when interact with NPC.

it display the slot just below the item description

Previously, similar case only happen when the message in the mes() are long and resulting the alignment messed up.

but when you display it inside mes, right click on it, it doesn't show the slot

no idea, i never really paid any attention to this. If you asked me, all I need are just the item description to be displayed there in the popup.

dastgirp · 2019-01-22T14:21:54Z

Also, can someone check with different clients?
I believe tags were changed 3 times.
ITEM, ITEML and ITEMLINK

Emistry · 2019-01-22T18:20:50Z

use PACKETVER for checking and change the tag accordingly.

AnnieRuru · 2019-01-22T18:47:05Z

you are right
https://github.com/HerculesWS/Hercules/blob/master/npc/re/instances/OldGlastHeim.txt#L2747

test in-game

prontera,155,185,5	script	asdasdad	1_F_MARIA,{
	mes("<ITEM>Apple<INFO>512</INFO></ITEM>.");
	mes("<ITEMLINK>Apple<INFO>512</INFO></ITEMLINK>.");
	close;
}

20180620Re

not sure when this happens

http://herc.ws/board/topic/15440-solved-itemlink-help-on-2015-09-16aragexeexe-client/?do=findComment&comment=85465

4144 · 2019-01-22T19:13:21Z

I not sure is client using ITEMLINK or not, but search in clients show what this string present only in clients: from 2013-01-30 to 2015-07-22

4144 · 2019-01-22T19:28:54Z

and ITEM present in clients from 2015-07-29 to latest

AnnieRuru · 2019-01-22T20:06:20Z

script_commands.txt says the Navigation system was implemented on 20111010 ...
I thought its same date getting the <ITEMLINK>

tested with

prontera,155,185,5	script	asdasdad	1_F_MARIA,{
	mes(F_MesItemInfo(123));
	mes(F_MesItemInfo(512));
//	mes("<ITEMLINK>Apple<INFO>512</INFO></ITEMLINK>.");
	mes PACKETVER +"";
	mes(F_MesItemInfo(White_Knightage_Card));
	mes(F_MesItemInfo(Khali_Knightage_Card));
	close;
}

4144 · 2019-01-22T20:51:39Z

Yes NAVI was added in 2011-10-10 clients

npc/other/Global_Functions.txt

Emistry · 2019-01-27T05:51:17Z

btw, how about adding the slot display too?

I find that showing the item slot of the item make more sense and accurate to display the item. RO has too many redundant item due to the different amount of item slots.
Display the item slots of the said item help to reduce confusion among the player when interact with NPC.

AnnieRuru · 2019-01-27T09:17:00Z

some time ago I was digging my old harddisk,
I found myself made this function long long time ago, (probably 4 years ago, on the PACKEVER)

function	script	F_GetItem2	{
	.@itemid = getarg(0);
	.@name$ = getitemname( .@itemid );
	if( .@name$ == "null" )
		return "^FF0000[Unknown-"+.@itemid+"]^000000";
	.@type = getiteminfo( .@itemid,2 );
	if( .@type == IT_ARMOR || .@type == IT_WEAPON ){
		.@name$ = .@name$ +" ["+getitemslots( .@itemid )+"]";
	}
	return "<ITEMLINK>"+.@name$+"<INFO>"+.@itemid+"</INFO></ITEMLINK>";
}

I couldn't test this very old hexed client right now, this old client now throw me char info size mismatch
but if I did like this way back then, this must mean long time ago, it actually does display item slot
and I test it again right now on newer client 20180620Re doesn't display item slot

maybe just do it, for the sake of 'old me'

EDIT: interesting note,
right now it display "Unknown Item",
but this function says ... "Unknown- 512"

also fix OldGlastHeim ITEMLINK display incorrectly

AnnieRuru · 2019-01-27T13:25:32Z

finally able to connect to this old client 2013-08-07aRagexe_patched.exe
and I got this .... disappointing

Emistry · 2019-01-27T13:55:33Z

doc/script_commands.txt

+If you're using client from 2013-01-30 onwards, you can also use <ITEMLINK> to show
+the item's description. Gravity changed this into <ITEM> since 2015-07-29 onwards.
+
+    mes("Bring me an <ITEM>Apple<INFO>512</INFO></ITEM>.");


I think this line shall be removed, since not every client version support the <ITEM> tag. It could be confusing.

hard to define this, many members said its harder and harder to use older hex client
because client translation project always keep itself up to date with no backward compatibility

I have some older hexed client just simply because when I inactive, and active back
I always install newer stuffs, and the old stuffs just kept inside external harddisk

we should always encourage members to use latest client revision ... isn't it ?

and removing that line ... is just like hide this method from public

No, I mean we should encourage them to use the F_ItemMesInfo and not <ITEM> or <ITEMLINK>.

my opinion is show them both methods ...

ok 1 vote for showing 1 method (Emistry)
1 vote for showing both methods (AnnieRuru)

any one else vote for showing 1 method or showing both ?

Emistry · 2019-01-27T13:57:50Z

npc/other/Global_Functions.txt

+	if (.@itemname$ != "null") {
+		.@itemslot = getitemslots(.@item);
+		if (.@itemslot)
+			.@itemname$ = sprintf("%s [%d]", .@itemname$, .@itemslot);


the equipment slot should check for item type is EQI_ARMOR / EQI_WEAPON or not.
If its not armor/weapon then it shall not show any postfix of equipment slot in the item name.
If the item were armor/weapon then it shall show the equipment slot even if its [0] slot.

I knew you going to say this, I have tested this in my getitemname2 function
all items are default to 0 slots

Def: Defense (int, defaults to 0) Range: Attack Range (int, defaults to 0) Slots: Slots (int, defaults to 0) Job: { (defaults to all job) All: true/false (boolean, defaults to false) Novice: true/false (boolean, defaults to false) Swordsman: true/false (boolean, defaults to false) Magician: true/false (boolean, defaults to false)

and no, items with [0] slot doesn't show in-game
please test it,

and WHY the fuck I have to upload a screenshot every time ????
sigh...
OK I upload screenshots because you think it work your way but it doesn't work like that

prontera,155,185,5 script asdasdad 1_F_MARIA,{ getitem 1201, 1; getitem 1203, 1; mes(F_MesItemInfo(1201)); mes(F_MesItemInfo(1203)); close; }

bWolfie reviewed Jun 7, 2018

View reviewed changes

npc/other/Global_Functions.txt Outdated Show resolved Hide resolved

bWolfie reviewed Jun 7, 2018

View reviewed changes

npc/other/Global_Functions.txt Outdated Show resolved Hide resolved

AnnieRuru added type:enhancement Issue describes an enhancement or feature that should be implemented component:scripts Affecting the scripts and NPCs status:code-review Awaiting code review labels Jun 7, 2018

skyleo requested changes Jun 20, 2018

View reviewed changes

npc/other/Global_Functions.txt Outdated Show resolved Hide resolved

AnnieRuru force-pushed the 37-F_MesItemInfo branch from fb11920 to 29766ef Compare January 21, 2019 10:15

AnnieRuru requested review from Emistry and skyleo January 21, 2019 10:19

AnnieRuru force-pushed the 37-F_MesItemInfo branch from 29766ef to bc9bbe1 Compare January 22, 2019 20:03

AnnieRuru force-pushed the 37-F_MesItemInfo branch from bc9bbe1 to 4ff2b67 Compare January 22, 2019 20:09

AnnieRuru requested a review from 4144 January 22, 2019 21:41

4144 requested changes Jan 22, 2019

View reviewed changes

npc/other/Global_Functions.txt Show resolved Hide resolved

AnnieRuru force-pushed the 37-F_MesItemInfo branch from 4ff2b67 to 0272f97 Compare January 23, 2019 11:10

AnnieRuru requested a review from 4144 January 23, 2019 11:12

4144 approved these changes Jan 23, 2019

View reviewed changes

Emistry approved these changes Jan 27, 2019

View reviewed changes

Add F_MesItemInfo function to show item name with description link

7b48fee

also fix OldGlastHeim ITEMLINK display incorrectly

AnnieRuru force-pushed the 37-F_MesItemInfo branch from 0272f97 to 7b48fee Compare January 27, 2019 13:21

AnnieRuru requested a review from Emistry January 27, 2019 13:25

Emistry reviewed Jan 27, 2019

View reviewed changes

dastgirp approved these changes Jan 27, 2019

View reviewed changes

AnnieRuru added this to the Release v2019.05.05 milestone Apr 10, 2019

MishimaHaruna approved these changes May 5, 2019

View reviewed changes

MishimaHaruna merged commit 892ed5f into HerculesWS:master May 5, 2019

Add F_MesItemInfo function to show item name with description link #2068

Add F_MesItemInfo function to show item name with description link #2068

Uh oh!

Conversation

AnnieRuru commented Jun 6, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Prelude

Issues addressed

Changes Proposed

Affected Branches

Tested with

Known Issues and TODO List

Uh oh!

HerculesWSAPI commented Jun 6, 2018

Uh oh!

Uh oh!

Uh oh!

Uh oh!

AnnieRuru commented Jan 21, 2019

Uh oh!

Emistry commented Jan 22, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dastgirp commented Jan 22, 2019

Uh oh!

Emistry commented Jan 22, 2019

Uh oh!

AnnieRuru commented Jan 22, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

4144 commented Jan 22, 2019

Uh oh!

4144 commented Jan 22, 2019

Uh oh!

AnnieRuru commented Jan 22, 2019

Uh oh!

4144 commented Jan 22, 2019

Uh oh!

Uh oh!

Emistry commented Jan 27, 2019

Uh oh!

AnnieRuru commented Jan 27, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

AnnieRuru commented Jan 27, 2019

Uh oh!

Emistry Jan 27, 2019

Choose a reason for hiding this comment

Uh oh!

AnnieRuru Jan 27, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Emistry Jan 27, 2019

Choose a reason for hiding this comment

Uh oh!

AnnieRuru Jan 27, 2019

Choose a reason for hiding this comment

Uh oh!

Emistry Jan 27, 2019

Choose a reason for hiding this comment

Uh oh!

AnnieRuru Jan 27, 2019

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

AnnieRuru commented Jun 6, 2018 •

edited

Loading

Emistry commented Jan 22, 2019 •

edited

Loading

AnnieRuru commented Jan 22, 2019 •

edited

Loading

AnnieRuru commented Jan 27, 2019 •

edited

Loading

AnnieRuru Jan 27, 2019 •

edited

Loading