Equipment Slots
Equipment Slots is a feature that displays Inventory Items on the bottom of the screen and allows them to be ‘used’ by touching them (on mobile) or with hotkeys. Think of them as a shortcut for users to use an Inventory Item without having to go to their Backpack. Creators can enable/disable them via circuits or allow users to assign Inventory Items to the Equipment Slots of their choice.
^MyLittleMonsters
Context
Why did we make Equipment Slots? Well, we heard a lot of feedback regarding the difficulty of using Room Consumables—you had to open your watch, click on the Backpack, find the Room Consumable you wanted to use, then press the ‘Use’ button. There were a lot of steps that left Creators worried that their consumables weren’t as valuable because people didn’t know how to use them; And if people didn’t use them, why would they purchase any more?
^IgnitedBonnie
Use Cases
Equipment Slots are designed to be a shortcut for using Inventory Items, but they can also serve other functions. Some examples include:
-
Equipment Manager: Use an item as a shortcut to equip an item or weapon in a user’s hand.
-
Ability Hotkeys: Items can function like unlockable abilities, like flight, fireballs, or regeneration.
-
Custom UI Shortcuts: Does your game need a menu Rec Room doesn’t have? You can tie an Item to opening a UI panel in Rec Room Studio.
-
Special Interactions: We’ve seen players turn slots into a tool for entering secret codes, a currency display, health meter, and more.
Because Creators can control what items are equipped to Slots, and what happens when those Items activate, almost anything is possible. And as an added bonus, if a gameplay element works through Slots, it’ll work the same for players on any platform, no extra work required.
^FleetheRisingLava
How it Works
Requirements
A few things to keep in mind when using Equipment Slots:
- Inventory Items must have ‘Enable Action Button’ enabled to equip to an Equipment Slot
- Users must have at least one Inventory Item in order to equip to an Equipment Slot
- Equipment Slots must be enabled via circuits (even if you allow users to assign items themselves)
- Make sure that you follow-up with the ‘Event Receiver: Inventory Item Used’ chip so that something happens when the user interacts with the Equipment Slot
Setting up Equipment Slots via circuits
Here’s what you need:
- Inventory Item with the ‘Action Button’ enabled (in the Inventory Item Settings)
- ‘Inventory Item Constant’ chip
- ‘Equipment Slot’ chip
- ‘Player Set Equipment Slot Is Enabled’ chip
- ‘Player Equip Inventory Item’ chip
- Some event to enable the equipment slot (In this case, we’ll use ‘Event Receiver: Player Joined’)
First, make the following configurations:
- ‘Event Receiver’ configured to ‘Player Joined’
- ‘Inventory Item Constant’ configured to your Inventory Item
- ‘Equipment Slot’ chip configured to the appropriate slot
- ‘Player Set Equipment Slot Is Enabled’ = True
Next, make the following connections:
- ‘Equipment Slot’ (Equipment Slot) → ‘Player Set Equipment Slot Is Enabled’ (Equipment Slot)
- ‘Equipment Slot’ (Equipment Slot) → ‘Player Equip Inventory Item’ (Equipment Slot)
- ‘Inventory Item Constant’ (Inventory Item) → ‘Player Equip Inventory Item’ (Inventory Item)
- ‘Event Receiver: Player Joined’ (‘Run’ exec) → ‘Player Set Equipment Slot Is Enabled’ (‘Run’ exec)
- ‘Player Set Equipment Slot Is Enabled’ (‘Run’ exec) → ‘Player Equip Inventory Item’ (‘Run’ exec)
- ‘Event Receiver: Player Joined’ (Player) → ‘Player Set Equipment Slot Is Enabled’ (Player)
- ‘Player Set Equipment Slot Is Enabled’ (Player) → ‘Player Equip Inventory Item’ (Player)
Allowing users to set up their own Equipment Slots
^Extreme-Dropper
- Go to the ‘This Room’ page
- Go to the ‘Inventory Items’ tab
- Click on the ⛭ (Gear) icon for the Inventory Item you want to set
- Set ‘Enable “Equip” Button’ to True
This allows users to equip that Inventory Item to an Equipment Slot. However, you still need to enable the Equipment Slot(s) via circuits. Here’s what you need:
- ‘Equipment Slot’ chip
- ‘Player Set Equipment Slot Is Enabled’ chip
- Some event to enable the equipment slot (In this case, we’ll use ‘Event Receiver: Player Joined’)
First, make the following configurations:
- ‘Equipment Slot’ chip configured to the appropriate slot
- ‘Player Set Equipment Slot Is Enabled’ = True
- ‘Equipment Slot’ (Equipment Slot) → ‘Player Set Equipment Slot Is Enabled’ (Equipment Slot)
Next, make the following connections:
- ‘Event Receiver: Player Joined’ (‘Run’ exec) → ‘Player Set Equipment Slot Is Enabled’ (‘Run’ exec)
- ‘Event Receiver: Player Joined’ (Player) → ‘Player Set Equipment Slot Is Enabled’ (Player)
- ‘Equipment Slot’ (Equipment Slot) → ‘Player Set Equipment Slot Is Enabled’ (Equipment Slot)
If you want to enable more than one Equipment Slot, you will need:
- ‘List Create’ chip
- ‘For Each’ chip
- ‘Equipment Slot’ chip (up to four)
- ‘Player Set Equipment Slot Is Enabled’ chip
- Some event to enable the equipment slot (In this case, we’ll use ‘Event Receiver: Player Joined’)
First, make the following configurations:
- ‘Equipment Slot’ chip configured to the appropriate slot (repeat for each one)
- ‘Player Set Equipment Slot Is Enabled’ = True
- ‘Event Receiver’ chip configured to ‘Player Joined’
Next, make the following connections:
- ‘Equipment Slot’ chip (Equipment Slot) → ‘List Create’ (Item) (Repeat for each ‘Equipment Slot’ chip)
- ‘List Create’ (List) → ‘For Each’ (Items)
- ‘For Each’ (Item) → ‘Player Set Equipment Slot Is Enabled’ (Equipment Slot)
- ‘Event Receiver: Player Joined’ (Player) → ‘Player Set Equipment Slot Is Enabled’ (Player)
- ‘Event Receiver: Player Joined’ (‘Run’ exec) → ‘For Each’ (exec)
- ‘For Each’ (‘Loop’ exec) → ‘Player Set Equipment Slot Is Enabled’ (‘Run’ exec)
Important Notes:
- Users must have at least one Inventory Item in order to equip to an Equipment Slot
- Inventory Items must have ‘Enable Action Button’ enabled to equip to an Equipment Slot
Components
Inventory Item Settings
- ‘Enable Action Button’ - Allows Inventory Items to be ‘used’; Required for Equipment Slots
- ‘Enable “Equip” Button’ - Allows users to assign Inventory Items to an Equipment Slot
- ‘Shows Count in Equipment Slots’ - Allows the number of owned Inventory Items to be displayed on the Equipment Slot
Circuits
- ‘Equipment Slot’ (When configured, this reads as ‘Inventory Equipment Slot x’ where x is the Slot number—e.g., 1, 2, 3, or 4)
- ‘Player Equip Inventory Item’
- ‘Player Unequip Inventory Item’
- ‘Player Get Equipment Slot Is Enabled’
- ‘Player Set Equipment Slot Is Enabled’
- ‘Player Unequip From Slot’
