Pickup System

The Roblox Battle Royale pickup system lets players pick up different kinds of objects, although it's currently only used for weapon pickups. In game, weapons are spawned around the game map and — when players get close enough — an on-screen key/action/button prompt appears along with the weapon name and description.

Battle Royale Weapon Example

Structure

There are several important folders related to the pickup system. Make sure that these folders are set up correctly in your project:

  • Workspace/PickupSpawners — Contains pickup spawner Parts which tell the system where to place visual pickup Models (see the next point). Note that these spawners are not required to be in this folder since the system looks for parts tagged with the PickupSpawner tag instead of the folder path.

    Pickup Spawners
  • ReplicatedStorage/Assets/Weapons — Contains the weapons (functional Tools) that the pickup system grants when a weapon pickup is activated.

    Battle Royale Items
  • ReplicatedStorage/Assets/Pickups — Contains the pickup Models that the system will place at pickup spawners in the game world. These should be visual models only, not functional weapon Tools.

    Battle Royale Pickups

Adding New Pickups

As noted above, pickups require both a functional Tool and a visual Model that will be spawned in the game world.

Tool

  1. Create a Tool and give it a unique name. You can create new weapons based upon those in the Weapons Kit or take tools from the Toolbox.

  2. Place the Tool in ReplicatedStorage/Assets/Weapons.

    Battle Royale New Weapon

Model

  1. Create a Model for the visual pickup and give it the same name as you gave the Tool.

  2. Using the Tag Editor, accessible from the View tab, apply the following tags to the model:

    • Action
    • Pickup
    • WeaponPickup
    • WeaponSystemIgnore
    • One of the rarity tags as outlined in Rarity.
  3. Place the model in ReplicatedStorage/Assets/Pickups.

    Battle Royale New Pickup

Rarity

Pickup rarity is not defined by any mathematical formula, but you can associate an on-screen GUI like those pictured below to suggest an item's rarity.

  1. Open the ReplicatedFirst/Configurations/RarityConfiguration script. This script contains tables for each rarity category, each of which includes a color value (Color) for the pickup's particle effect and an asset ID (Image) for the on-screen GUI background. For each GUI:

    • The item name will appear as the model/weapon name.
    • The description will appear as the rarity name (such as Epic) plus Item.

    The default rarities are as follows, but feel free to define your own.

    RarityGUI
    Common
    Uncommon
    Rare
    Epic
    Legendary
    Special
  2. For the pickup Model you created previously (located in ReplicatedStorage/Assets/Pickups), assign one of the tags you've defined in the RarityConfiguration script.