[Modding Support] Custom Item support for Cloak (and Shield) slots

[RedRoryOTheGlen]

ISSUE
In the current build of DFU, it is impossible to set a custom item to be equipped in the cloak slot.

If any item is equipped as a cloak in either slot, the PaperDollRenderer will try to render the cloak interior.

To get the cloak interior ImageData it will first check if the item is a cloak. If not, it will return a blank ImageData.

First problem is that it will only recognize the vanilla Casual and Formal Cloak items as Cloaks. So any other item (even if its a cloak, like a scarf or such) will not be able to have any kind of Cloak Interior.

Continuing on. With ImageData in hand, it will attempt to call DrawTexture with the blank ImageData and immediately throw an exception due to ImageData's contents being null. This results in the paperdoll being unable to refresh.

EXPECTED BEHAVIOR
First:
I am not quite sure how, but some way of being able to dictate whether an item has a Cloak Interior texture without having to replace the vanilla cloaks would be nice.

Second:
Adding a null check for the ImageData to either the DrawTexture or BlitCloakInterior methods completely avoids this issue.

No exception is thrown and the paperdoll updates as normal. Attached is my testing of equipping clothes to the cloak slot to enable layering chest clothing:

OTHERS
As an aside, there is a workaround for avoiding the exception. Because of how BlitCloakInterior is done, if there is a vanilla cloak equipped in Cloak2 slot, the player is able to equip custom items in Cloak1 slot without causing an error. This indicates to me that the exception for an item without a cloak interior image is more of an oversight than deliberate limitation.

Thank you for your time.

[KABoissonneault]

I remember covering some of this in my investigation for #2657
I think I had some suggestions for what we could do to fix these issues, more generally than just cloaks.

Hope this helps

[RedRoryOTheGlen]

I am able to change the draw order by using an ItemTemplates.json just fine. That's not an issue. It is the impossibility of assigning any sort of item to the Cloak slot because if it isn't exactly the vanilla cloaks, the game will throw an exception and prevent the Paperdoll from updating.

If the issue is addressed, this could be used to add clothing or accessories that shouldn't necessarily take up a chest or leg slot like hats, scarves or overcoats). It wouldn't make a lot of sense for an overcoat or scarf to prevent you from wearing a shirt, or a skirt preventing you from wearing pants.

[RedRoryOTheGlen]

As an update, Shields have a similar issue. DFU only checks for the item template indices of vanilla shields to determine if an object is a shield.

This prevents new custom items being recognized as shields.

Making the IsShield property virtual would be an expedient way of allowing this.