Quickstart

For getting started with VaultLogic you'll need to familiarize yourself with 3 key components: the VaultComponent, VaultItems, the CollectableComponent.

Vault Component

The vault component is essentially your inventory. It holds VaultItems grouped into different Vaults depending on the VaultType of the items definition, to get started simply add the component to your player character or player state.

Vault Items

Vault items are UObjects that will represent items in your inventory. You can define an item by making a new subclass of UVaultItem in blueprints or c++. Making this new subclass will enable you to choose it as an item type in Collectable components (the most obvious workflow) or VaultComponents (if you want to make a vault start with certain items)

Collectable Component

The collectable component is expected to be placed in Actors that will represent items in the world. It provides the interface to "pickup" such items and add them to the player inventory, also provides a solution to facilitate the Actor reflecting the item data (e.g: Set actor material color based on item rarity).

Add this component to your pickup actors and in its settings you can select your new item you created in the previous step, you will see the properties of the item get populated into the details panel where you can change information about this item on a per-instance basis.