R2API Items

R2API.Items - Item, ItemTags, Equipments, ItemDisplays and more

About

R2API.Items is a submodule assembly for R2API that allows mod creators to add new Items, Equipments, ItemTags, and manage the Items and Equipment's ItemDisplays.

Use Cases / Features

R2API.Items is mainly used for adding new ItemDefs and EquipmentDefs to the game, To facilitate the inclusion of Itemdisplays, R2API.Items provides wrapper classes for both Items and Equipments.

CustomItem: Represents a new ItemDef being added, includes a field for handling the Item's ItemDisplayRules

CustomEquipment: Represents a new EquipmentDef being added, includes a field for handling the Equipment's ItemDisplayRules.

The ItemDisplayRuleDictionary is a class included with the module, which provides utilities and systems for adding new ItemDisplays to your items, including default display rules if a character does not provide it's own item display for your item.

Finally, ItemAPI includes the ability to add new ItemTags to the game, which can be used for multiple things ingame.

Related Pages

A detailed tutorial on how to make custom items using ItemAPI can be found here

Changelog

'1.0.8'

• Fixes for Alloyed Collective DLC3.

'1.0.7'

• Ensure followerPrefabAddress is never null.

'1.0.6'

• Add support for followerPrefabAddress and pickupModelReference, also use GenerateRuntimeValuesAsync inside AddingItemDisplayRulesToCharacterModels

'1.0.5'

• Fix for 1.3.9 game patch.

'1.0.4'

• Make sure ItemDef never have a null tags array.

'1.0.3'

• Add missing BepInDependency to R2API.ContentManagement.

'1.0.2'

• Fix the NuGet package which had a dependency on a non-existent version of R2API.Core.

'1.0.1'

• Fix invalid IDRS checker telling IDRS are not correct when they actually are.

'1.0.0'

• Split from the main R2API.dll into its own submodule.