Verse API reference page for the inventory_component class | Fortnite Documentation

This page is not available in the language you have chosen. It will be displayed in English by default. If you would like to view it in a different language, you can try selecting another language.

Inventory components hold items. An entity with an inventory component can be considered to have an inventory. The inventory component controls which items can enter or exit. They also determine whether an item can be equipped.


Verse `using` statement	`using { /UnrealEngine.com/Itemization }`

Inheritance Hierarchy

This class is derived from component.

Name Description

Name	Description
`component`	Base class for authoring logic and data in the SceneGraph. Using components you can author re-usable building blocks of logic and data which can then be added to entities in the scene. Components are a very low level building block which can be used in many ways. For example: Exposing engine level concepts like mesh or sound Adding gameplay capabilities like damage or interaction Storing an inventory for a character in the game As components are generic there is no specific way that they must be used. It is up to the needs of your experience if you use one big game component or if you break up logic into many small components. Classes deriving from component must also specify `<final_super>` to be added to entities. This ensures the class will always derive directly from `component`. Further subclassing of the initial derived component is allowed and does not require specifying `<final_super>` on the derived classes. Only one instance of a component from each subclass group can be added to an entity at a time. For example, given this group of components, only one light_component can exist on a single entity. To create multiple lights you should use multiple entities. light_component := class(component){} capsule_light_component := class(light_component){} directional_light_component := class(light_component){} spot_light_component := class(light_component){} sphere_light_component := class(light_component){} rect_light_component := class(light_component){} ============================================================================== Component Lifetime Components move through a series of lifetime functions as they are added to entities, added to the scene, and begin running in the simulation. Components should override these methods to perform setup and run their simulation. As a component shuts down it will then move through shutdown version of these functions, giving users the opportunity to clean up any retained state on the component before it is disposed . Lifetime Methods: OnAddedToScene OnBeginSimulation -> OnSimulate OnEndSimulation OnRemovingFromScene ==============================================================================

component

Base class for authoring logic and data in the SceneGraph. Using components you can author re-usable building blocks of logic and data which can then be added to entities in the scene.

Components are a very low level building block which can be used in many ways. For example:

Exposing engine level concepts like mesh or sound
Adding gameplay capabilities like damage or interaction
Storing an inventory for a character in the game

As components are generic there is no specific way that they must be used. It is up to the needs of your experience if you use one big game component or if you break up logic into many small components.

Classes deriving from component must also specify <final_super> to be added to entities. This ensures the class will always derive directly from component. Further subclassing of the initial derived component is allowed and does not require specifying <final_super> on the derived classes.

Only one instance of a component from each subclass group can be added to an entity at a time. For example, given this group of components, only one light_component can exist on a single entity. To create multiple lights you should use multiple entities.

light_component := class(component){} capsule_light_component := class(light_component){} directional_light_component := class(light_component){} spot_light_component := class(light_component){} sphere_light_component := class(light_component){} rect_light_component := class(light_component){}

============================================================================== Component Lifetime

Components move through a series of lifetime functions as they are added to entities, added to the scene, and begin running in the simulation. Components should override these methods to perform setup and run their simulation.

As a component shuts down it will then move through shutdown version of these functions, giving users the opportunity to clean up any retained state on the component before it is disposed . Lifetime Methods: OnAddedToScene OnBeginSimulation -> OnSimulate OnEndSimulation OnRemovingFromScene ==============================================================================

Members

This class has both data members and functions.

Data

Data Member Name	Type	Description
`AddItemEvent`	`listenable(payload)`
`Entity`	`entity`	The parent entity of this component. Components must have a parent entity pointer provided when being constructed. Components cannot be moved between parents.
`EquipItemEvent`	`listenable(payload)`
`RemoveItemEvent`	`listenable(payload)`
`TickEvents`	`?tick_events`	Set callbacks to `TickEvents.PrePhysics` and `TickEvents.PostPhysics` to receive per-frame updates before and after physics is updated on your object.
`UnequipItemEvent`	`listenable(payload)`

Functions

Function Name	Description
`AddItem`	Adds the item to this inventory only, ignoring sub-inventories. Fails if no items could be added.
`AddItemDistribute`	Adds the item to this inventory, including sub-inventories. Fails if no items could be added.
`FindInventories`	Returns a list of all sub-inventories within this inventory and its descendant inventories.
`FindItems`	Returns a list of all items within this inventory and its descendant inventories.
`FindItems`	Returns a list of all items (of a specific type) within this inventory and its descendant inventories.
`GetEquippedItems`
`GetInventories`	Returns a list of sub-inventories of this inventory only.
`GetItems`	Returns a list of items within this inventory only.
`GetItems`	Returns a list of items (of a specific type) within this inventory only.
`IsInScene`	Succeeds if the component is currently in the scene. After `OnAddedToScene` is called this call succeeds. After `OnRemovingFromScene` is called this call fails.
`IsSimulating`	Succeeds if the component is currently simulating. After `OnBeginSimulation` is called this call succeeds. After `OnEndSimulation` is called this call fails.
`OnAddedToScene`	Called when the component is added to the scene by parenting it under the simulation entity or another entity already in the scene. Querying for components in the scene is valid after this phase completes.
`OnBeginSimulation`	Called when the component begins simulating within the scene. Use this to set up TickEvent callbacks or other setup that must be guaranteed to complete immediately. `OnAddedToScene` is guaranteed to run before `OnBeginSimulation`.
`OnEndSimulation`	Called when the component ends simulation within the scene. Simulation ends on a component when the experience resets, the parent entity is removed from the scene. Cached TickEvents cancelables should be canceled in `OnEndSimulation`. `OnSimulate` task will be canceled before `OnEndSimulation` is called. `OnEndSimulation` is only called on components that have already had `OnBeginSimulation` called.
`OnRemovingFromScene`	Called when the component is about to be removed from the scene. Components are removed from a scene when the parent entity is removed from the scene. `OnRemovingFromScene` is only called on components that have already had `OnAddedToScene` called.
`OnSimulate`	Called when the component begins simulating within the scene. Use this to add asynchronous/suspends update logic for a component. `OnBeginSimulation` is guaranteed to run before `OnSimulate`. `OnSimulate` will be cancelled before `OnEndSimulation`
`RemoveFromEntity`	Removes the component from the entity. Removed components are removed from the scene and can only be added back to the same entity. Flows through `OnEndSimulation`-> `OnRemovingFromScene`.
`RemoveItem`	Removes an item from this inventory or its descendent inventories. Fails if the item could not be removed.
`SendDown`	Send a scene event to this component. Return true to consume the event and halt propogation.