Create and Use Consumable Items

1. In your Content Browser, create a new Curve Table and set the Interpolation Type to Linear. For this example, we'll name it "TB_Scale_Consumables".

2. Open your new Curve Table and click the Add button to create a new curve. In this example, we'll name it Potion.Health.

3. This curve contains Level over Magnitude, add as many values as you find necessary, by clicking the Append Column button.

4. Once you are done, you should have a similar Curve Table. Feel free to add others, if you like!

   

1. In your Content Browser, create a new Gameplay Effect Blueprint, using GameplayEffect as the base class. For this example, we'll name it "GE_HealthPotion".

2. Open your new Gameplay Effect Blueprint and make sure it's Duration Policy is set to Instant. Then, add a new Modifier entry.

3. Select the Attribute that you want to modify. For this example, we'll use the Health Attribute, from Ninja Combat.

4. Set the Modifier Operation to Add.

5. Set the Magnitude Calculation Type to Scalable Float.

6. Set the Magnitude to 1.0, the Curve Table to TB_Scale_Consumables and the Curve to Potion.Health.

7. Once you are done, your Gameplay Effect should look like this.

   

1. Create or select the Item Definition that will be used for your potion. In this example, we'll use the Consumable_Potion_Health item.

2. Add the Consumable fragment to the Fragments list.

3. In the Consumable Fragment, set the Charges to Stack Fragment and the Effect Class to GE_HealthPotion.

4. Disable the option Use Item Level as Effect Level.

5. Once you are done, your Health Potion Definition should look like this.

   

tip

Setting the Charges strategy

note

You can choose other types of Charges if that makes more sense to you. A Flask, for example, could use a Gameplay Attribute instead.

1. Select the Animation Sequence representing the Activate action. Create an Animation Montage from it and name it M_ConsumePotion.

2. Open your Animation Montage and add the Consumable Animation Notify State to the frames where the consumable should be displayed.

3. Set the appropriate Mesh Type for your scenario, the Mesh Asset, the Slot Tag in your character and the Attachment Socket

4. Add any other Slots to Hide as well, in this case, we'll hide the Main Weapon, represented by the tag Equipment.Slot.MainHand

5. Once you are done, your Animation Notify State should be similar to this.

   

   tip

   This Animation Notify is a work-in-progress and in the future it will allow dynamic meshes.

1. Open the TB_Inventory_Animations table, containing your Inventory Animations.

2. Add another row and set the Montage To Play to M_ConsumePotion.

3. Set the Montage Query to be compatible any items marked as Potions.

   

1. In your Content Browser, navigate to your ability folder and create a new Gameplay Ability using UInventoryAbility_ConsumeItem as the parent. Name it GA_Common_Consume.

2. Open your new ability and configure the Consumable Query to find any Consumable Items in a Consumable Slot.

   

3. Set TB_Inventory_Animations as the Montage Table.

4. Add Ability.Consume.

5. When you are done, your Ability should look like this:

   

1. Open your Character Blueprint or any other location where you are handling Player inputs.

2. Create a new Consume Operation, using the Inventory Function Library to create the Payload.

3. Retrieve the Inventory Manager from the character, using the Inventory Function Library

4. Using the Inventory Manager, obtain the consumable item using an item query.

5. Request the execution of the Consume Fragment Operation to the Inventory Manager.

6. Compile and save your Blueprint.

note

Multiplayer Events

The Consume Operation is a Gameplay Event and as such, in multiplayer games, it must be triggered on the Server and Local Client.

Make sure to account for that in your input handling. The Ninja Input plugin can help you with that!