So I figured why not make this API because a lot of people ask how to create a void item, and this keeps the process really simple for people.
You can also now modify existing transformations using this, so thats pretty cool.
You will need to add the DLL as a reference for your project, which you can acquire by downloading off the thunderstore or from the "Current DLL" folder in the github repo.
I made a wiki for how to create void items manually on r2wiki, in case you may not want to depend on this API.
Requirements:
Now that those are out of the way time for a mini-guide on how to use the API. It is pretty simple actually.
There are 4 different CreateTransformation methods you can choose from in the VoidTransformation class:
CreateTransformation(ItemDef VoidItem, ItemDef TransformedItem)
CreateTransformation(ItemDef VoidItem, ItemDef[] TransformedItems)
You can supply ItemDefs for these two to create your transformations, however remember that the ItemCatalog must be initialized before calling these.
CreateTransformation(ItemDef VoidItem, string TransformedItem)
CreateTransformation(ItemDef VoidItem, string[] TransformedItems)
You can use a string for these two if you want to call this before the catalog initializes. The string would simply be the name of the item you would use for the ItemDef.
For example: Red Whip = RoR2Content.Items.SprintOutOfCombat, which would mean the string would be "SprintOutOfCombat"
There are also 2 different methods for modifying existing transformations in the table.
The same rules apply to these methods about timing on using ItemDefs vs. Strings.
ModifyTransformation(ItemDef VoidItem, ItemDef CurrentTransformation, ItemDef NewTransformation, VoidItemModification.ModificationType type)
ModifyTransformation(string VoidItemName, string CurrentTransformationName, string NewTransformationName, VoidItemModification.ModificationType type)
With these two methods, you can modify or remove existing transformations by supplying the Defs or Names into these methods. If you are removing a transformation, just set the third parameter to null, and ensure that the fourth parameter is set to VoidItemModification.ModificationType.Remove, and the API will handle it for you.
Examples:
ModifyTransformation(DLC1Content.Items.CritGlassesVoid, RoR2Content.Items.CritGlasses, RoR2Content.Items.SprintOutOfCombat, VoidItemModification.ModificationType.Modify); //This changes the transformation for lost seer lenses from the crit glasses to red whip
ModifyTransformation("CritGlassesVoid", "CritGlasses", null, VoidItemModification.ModificationType.Remove); //This will remove the CritGlasses transformation on lost seer lenses
That's about it for the guide. You can declare the dependency at the top of your main class by typing:
[BepInDependency(VoidItemAPI.VoidItemAPI.MODGUID)]
If you need any help with anything just ping me or shoot me a dm on the modding discord: @joseph#6783
Thanks to bubbet for showing me his method of using strings to get the ItemDef.