Item Rename Framework

[BrettMayson]

When merged this pull request will:

• Add a way to rename items during the mission
• Intended for unique items with IDs, but not required (Dogtags, TFAR, ACRE, etc)

Before

After

Known Issues:

Like the Item Context Menu, this does not work on corpses.

[commy2]

[SzwedzikPL]

@commy2 Done. I tried earlier my luck with changing the tooltip but so far i've been unable to find a way to do that. It looks like it comes directly from the engine.

I've been also thinking about supporting nil as a value in CBA_fnc_renameInventoryItem so "" can be used to remove item name or picture. What do you think?

[commy2]

Yeah, couldn't get the tooltips to work either. Probably some hard coded stuff managing the inventory ui tooltips that prevents scripted tooltips from working, sadly. Could always try to create custom tooltip controls though.

nil already converts to "" due to params command. Since empty stings make no sense (and for picture you could use the empty_ca.paa) it should treat "" as "revert to default".

[SzwedzikPL]

Ok, for now i think vanilla tooltips are fine, we can always add some workaround for tooltips later.

Any other suggestions?
Also, is there a chance for this to release in 3.15.2 ?

[commy2]

There're no plans for anything lol

outdated

[commy2]

Is this done?

[BrettMayson]

Afaik, yes.

The only outstanding issue is the bug with corpses, the same issue as the item context menu framework.

[commy2]

Errors when item in backpack on ground is renamed.

(The error means _classname is undefined.)

Script:

["FirstAidKit", "TEST", "\a3\3DEN\Data\Controls\ctrlDefault\arrowEmpty_ca.paa"] call cba_fnc_renameInventoryItem;

[mharis001]

What about allowing the text color to be changed as well.

[SzwedzikPL]

@commy2 do you have any idea how to properly support items inside backpacks/containers on the ground? InventoryOpened EH doesn't work in such case, nor ContainerOpened. I found some ugly way using loops and everyContainer but it won't work if there's more than one - don't know which one is opened.

[commy2]

Why does InventoryOpened not work?

[commy2]

The correct event name is "ContainerOpened". You can get which one is opened by tracking double click on the container list.

[johnb432]

@BrettMayson Can you resolve the merge conflicts?

• You can't rename backpacks atm. It might be possible to add it without game engine changes, but I'm not certain.
• Dogtags - Rename inventory items acemod/ACE3#10102 (comment)
  Which method is better - PFH, mouse EH or map EH? We should try to decide on a single method and stick with that imo, to make it more uniform.

[johnb432]

When I redid the inventory filtering in acemod/ACE3#9706, I found all item classnames are contained in lbData except for backpacks:
https://github.com/acemod/ACE3/blob/b714c8bce2628ff8d4795da8a7f2fc05bb82f474/addons/inventory/functions/fnc_forceItemListUpdate.sqf#L33

Workaround for backpacks is to get them using the display name and picture.

[johnb432]

Workaround for backpacks is to get them using the display name and picture.

That would likely cause ambiguities for backpacks with linked items, as I doubt they would change the picture and display name for each variant.

[johnb432]

It might be possible to add it without game engine changes, but I'm not certain.

Not possible atm, made a ticket: https://feedback.bistudio.com/T183096

[PabstMirror]

I'd like to merge now even if backpacks aren't working,
thoughts?

[johnb432]

It might be possible to just add backpackCargo to https://github.com/CBATeam/CBA_A3/pull/1329/files#diff-32e5060e1f3d15868d5a7eb7582a521ea990945ef5d516056f0c38bf16799fa5R49-R56 and have it work like that. If so, it would be a more robust solution than what ACE atm.
EDIT: It works, but I'm not sure how robust this solution is fundamentally. Can DLC or other atypical items pose issues?

[johnb432]

Can DLC or other atypical items pose issues?

Yes, atypical items can pose issues. Repro: I loaded ACE, CUP Weapons and RHS and put some mines from each mod into my backpack in the ACE arsenal (I had 13 items total in backpack, 1 base game training mine and 12 from CUP/RHS, I took 5 mines from 1 category, rest were 1 each). Restarted the game without CUP Weapons and RHS and went into the ACE arsenal. There, I still had 13 items, but 12 of them were "". In the backpack, 8 rows were filled with the "Premium item" thing that you get when you have non-existing item.
I added a backpack, renamed to "test" and added the backpack in my backpack. When I opened my backpack, the 3rd row was renamed from "" to "test".

_container = backpackContainer player;
weaponCargo _container + itemCargo _container + magazineCargo _container + backpackCargo _container;

returns ["TrainingMine_Mag","","","","","","","","","","","","","B_AssaultPack_rgr"], so it makes sense.

Any item renamed through the framework is affected by this: I tested it by trying to rename the training mine I had - this time it was the top most (again, makes sense).

There might be a way around this very specific issue though: getMagazineCargo is able to tell how many of each invalid classes there are. I'll experiment with the getXCargo commands to see if I can get it to work (would avoid us having to arrayIntersect the result).

[johnb432]

The getXCargo commands resolve the issue.

However, there are still 2 issues:

1. I renamed the training mag to "test 2". Because _control lbData _index returns "", it also renames the first invalid item to "test 2". It's not a big issue, but still.
2. More importantly: if you have 2 weapons of the same class, but they don't have the same attachments, then they won't stack in the inventory, but they are reported as the same class (getWeaponCargo returns 2, weaponCargo returns it twice). This creates a bad offset and renames the wrong backpack.

I don't think using inventory commands to determine the order of the UI is the way forward. Imo we should not support backpacks atm, remove the empty classname stuff and hope the BI ticket will be resolved.