Configure the Inventory

1. Add the Equipment Manager Component to the Player Character.

2. Implement the Equipment Provider Interface to the Player Character and implement the GetEquipmentManager function.

   

3. In the Equipment Manager, create two virtual slots for the weapon actors, one for the sword, one for the shield.

   These Slots will be identified by the Gameplay Tags Equipment.Slot.Weapon.MainHand and Equipment.Slot.Weapon.OffHand. In this example they are mapped to sWeaponMainHand and sWeaponOffHand sockets.

   

   tip

   Slot/Socket Mapping

   Since our weapons are Actors, they are directly attached to the character. We need to map Slots to the Sockets previously created for the original Weapon Manager.

   For more information about the Slot/Socket Mapping, please check the Equipment page.

1. Replace your Weapon Manager Component with the Equipment Adapter Component.

2. Update the GetWeaponManager function, from the Combat System Interface, so it returns the new version of the Weapon Manager.

   

1. Re-parent your base Weapon Class or Blueprint to ANinjaCombatEquipmentWeaponActor.

2. Add the EquipmentActorInterface to the base class. You do not need to implement any methods from this interface.

3. Create a new Equipment Definition, from the Content Menu, for the Sword and Shield. Be sure to create this Data Asset in the folder configured in the Asset Manager.

4. Add a new State Configuration for the Equipment.State.Activated state. These instructions will be used when the Equipment is Active

5. Add an Actor entry setting the Sword Actor as the Actor Class, and the Equipment.Slot.Weapon.MainHand as the Slot Tag.

6. Add an Actor entry setting the Shield Actor as the Actor Class, and the Equipment.Slot.Weapon.OffHand as the Slot Tag.

tip

Scene Component Selector

For a regular character, you can use the Character Mesh selector, or even setting a Gameplay Tag to find another Scene Component.

For more complex characters, using something like realtime IK Retargeting or multiple possible meshes from a Leader Pose Component, you might want to use the Provider Interface selector.

More information about these selectors can be found in the Equipment page.

1. Create a new Item Definition, from the Content Menu, for the Sword and Shield.

2. Set a Gameplay Tag that identifies this item - Inventory.Item.Weapon.SwordAndShield.

3. Add the User Interface Fragment, set the Display Name (" Sword and Shield"), Display Type (Weapon) and an Icon.

4. Add the Stack Fragment, set the Stack Limit as 1 and Maximum Limit as 1.

5. Add the Container Fragment, set the Preferred Container Query to indicate the Weapon Container.

   

6. Add the Equipment Fragment, set the Equipment Definition defined in the previous step as the Equipment Data.

1. Create a new Container Definition, from the Content Menu, for the Backpack container.

2. Set the Display Name as Backpack, and add Inventory.Container.Backpack and Inventory.Container.Default Gameplay Tags.

   tip

   Default Container

   The Inventory.Container.Default is provided by the system and indicates a default container, used when no better option is available.

3. Set the Priority to 100, so this container will have low priority in comparison with other compatible containers.

4. Set the NinjaInventoryAttributeSet.BackpackSlots as the Slots Attribute.

   tip

   Backpack Attribute Value

   This attribute is part of the Ninja Inventory Attribute Set, and it was previously initialized in this guide.

1. Create a new Container Definition, from the Content Menu, for the Primary Weapon.

2. Set the Display Name as Primary Weapon, and add Inventory.Container.Equipment and Inventory.Container.Weapon.Primary Gameplay Tags.

   tip

   Equipment Container

   The Inventory.Container.Equipment is provided by the system and indicates an equipment slot, used to store equipment instances.

   Containers configured as Equipment Slots will default their size to 1.

3. Set Equipment.State.Activated as the Default State Tag, defining the initial state of equipment instances added to this slot.

4. Set the Item Compatibility Query so it filters items tagged as Weapons.

   

1. Create a new Container Definition, from the Content Menu, for the Secondary Weapon.

2. Repeat the steps above, defining the Secondary Weapon slot, setting Inventory.Container.Weapon.Secondary, as the identifying Gameplay Tag.

3. Set the Default State Tag to Equipment.State.Deactivated so items are deactivated by default.

4. Set the Priority to 2 to prioritize the Primary Weapon equipment slot.

1. Create a new Inventory Layout, from the Context Menu.

2. Add all Container Definitions created in the previous step to the list of Container Definitions.

1. Make sure that Ninja Inventory is added to your project and your Asset Manager was configured, as instructed by the Setup page.

2. Create a Player State using NinjaGASPlayerState as the base class (or a subclass of it). Set it to your Game Mode

   tip

   You probably have a Player State already configured, from the GAS setup guide.

3. Add the Inventory Manager Component to the Player State.

4. Add the Inventory Provider Interface to the Player State and implement the GetInventoryManager function.

   

1. In the Inventory Manager Component, set the Inventory Layout that was just created.

2. Add an entry for Default Items and add the Sword and Shield as the Item Data.

   tip

   Automatic Slot Placement

   The Weapon Slot and Weapon Item are configured so this item will be automatically placed in the correct equipment slot.

1. Press Play and check the sword and shield added to the correct slots and sockets.

2. Open your Gameplay Debugger, by pressing the pre-defined key. You can access the Gameplay Debugger Configuration in the Project Settings, Gameplay Debugger page.

3. Expand the Inventory Category and notice that both Containers were added and the Weapon Item is set to the correct slot.