This feature is in an experimental state so you can try it out, provide feedback, and see what we are planning. You cannot publish a project that uses Custom Items and Inventories at this time.
Please keep in mind that we do not guarantee backward compatibility for assets created at the experimental stage, the APIs for these features are subject to change, and we may remove entire experimental features or specific functionality at our discretion. Check out the list of known issues before you start working with the feature.
The item_details_component is a Scene Graph component. It contains text data about the item, such as its name and description. For how to add a component to your entity, see Working with Entities and Components.
Entities are only considered items if they have an item_component. Without one, entities will not be added to inventories properly and lots of Custom Item and Inventories functionality may be broken.
References to an “item” are referring to an entity with an
item_component.References to “inventories” are referring to an entity with an
inventory_component.
Class Description
The item_details_component is a component that contains text data that can be used by other systems. The item_details_component provides a way to add input for the item's:
Name: The name of the item.
Description: A long description of the item.
Short Description: A brief description of the item.
These properties are <protected> and can therefore only be modified at instantiation or by subclassing the component and defining them inside the subclass.
See Components for a complete list of item and inventory components.
When the Custom Items and Inventories system is enabled the item_details_component is shown in the component dropdown list. For more information, check out the item_details_component API Reference from the Verse API.
Example
Properties from the item_details_component’s can be used to display item details in the HUD. Through Verse the item_details_component properties can be dynamically modified and new ones added.
You can use the examples below to set up the item_details_component in your project using Verse.
using { /Fortnite.com/Devices }
using { /Fortnite.com/Itemization }
using { /Verse.org/SceneGraph }
using { /UnrealEngine.com/Itemization }
# This device will create an entity with an item_details_component.
# Once this entity has been instantiated, print all the item details set.
add_details_item_device := class(creative_device) :
In order to modify the properties of an item_details_component at runtime, you can create a subclass and write new functions to update the values:
# This is a subclass of the item_details_component with property setters.
custom_item_details_component := class(item_details_component) :
SetName(NewName:message):void=
set Name = NewName
SetDescription(NewDescription:message):void=
set Description = NewDescription