The ScavengerHunt developer module gives players an inherently gamified way to explore your experience, organically introducing them to the entire place. Player progress is persistent, so scavenger hunts can continue across sessions.

Module Usage

Installation

To use the ScavengerHunt module in an experience:

1. Visit the ScavengerHunt marketplace page, click the green Get button, and confirm the transaction.
2. In Studio, open the toolbox (View → Toolbox).
3. Select your toolbox Inventory section.

4. Locate the module item and click it or drag-and-drop it into the 3D view.
5. In the Explorer window, move the entire ScavengerHunt folder into ServerScriptService. Upon running the experience, the module will distribute itself to various services and begin running.

Using Tokens

The scavenger hunt module uses tokens as the items which players search for and collect. The module comes with one token model that you can position in the 3D world.

1. Locate the Token1 mesh inside the Workspace folder of the module’s main folder.

2. Move Token1 into the top-level Workspace hierarchy and position it where desired.
3. Give the token a unique name; this name is how the module tracks which tokens each player has collected.
4. To add more tokens, duplicate an existing token and give it a unique name.

If you don’t want to use the bundled mesh tokens, any Model or BasePart will work, as long as it meets the following criteria:

• Assign the model or part a CollectionService tag of ScavengerHuntPart; the Tag Editor plugin is useful for doing so.
• Include a child StringValue instance set to the “flavor text” to display when the token is collected.

Using Regions

Regions differ slightly from tokens, as large areas that are marked as “collected” once the player enters them. Additionally, when a player leaves the region, the flavor text modal automatically dismisses and the region itself is removed from the workspace.

1. Create an anchored part around the region, such as a block or sphere. The module will automatically disable the BasePart|CanCollide|CanCollide property on runtime so players do not physically collide with the region.
2. Give it a unique name. This name is how the module tracks which regions each player has entered.
3. Assign the part a CollectionService tag of ScavengerHuntPart; the Tag Editor plugin is useful for doing so.
4. Include a child StringValue instance set to the “flavor text” to display when the region is entered.

Configuration

The module is preconfigured to work for most use cases, but it can be easily customized. For example, to change the token rotation speed and customize the modal info message:

1. In StarterPlayerScripts, create a new LocalScript and rename it to ConfigureScavengerHunt.
2. Paste the following code into the new script.

Collection Events

Every time a player collects a token or enters a region, the collected event fires. You can listen to this event from a server-side Script and respond accordingly. The connected function receives the Player that collided with the token or entered the region and that token or region’s name.

Similarly, when a player collects all tokens or enters all tagged regions, the allCollected event fires and the connected function receives the associated Player. This function is only fired once per player and it can be used to reward that player with a articles/Badges Special Game Awards|badge, access to a new area, in-experience currency, etc.

Custom GUI

This module exposes several options to customize its default GUI, but you can opt to display custom GUI elements instead.

When useCustomModals is set to true in the configureClient() function, the showInfoModal event fires every time the player activates the token tracker. Similarly, the showCompleteModal event fires when the player has collected everything in the scavenger hunt. Both of these events can be listened to in a LocalScript.

GUI Visibility

By default, the scavenger hunt hides all ScreenGui|ScreenGuis and CoreGui|CoreGuis (except for the player list) when the info modal or completion modal appears. If you want to override this auto-hiding behavior and programmatically decide which GUIs should remain visible, include the hideOtherGuis and showOtherGuis callbacks and respond with your own custom logic.

API Reference

Functions

configureClient()

Overrides default client-side configuration options. This function can only be called from a LocalScript.

configureServer()

Overrides default server-side configuration options. This function can only be called from a Script.

disable()

Hides all UI for the scavenger hunt, disconnects all input event listeners, and prevents players from collecting tokens or interacting with regions. This function can only be called from a Script.

enable()

Shows all UI for the scavenger hunt, connects all input event listeners, and allows players to collect tokens and interact with regions. This function can only be called from a Script.

Events

collected

Fires when a player collides with a token or enters a region. The connected function will receive the Player that collided with the token or entered the region and the name of the token that was collided into or the region that was entered. This event can only be connected in a Script.

allCollected

Fires when a player collects all tokens or enters all regions in the scavenger hunt. The connected function will receive the Player that collected all tokens, and it is only ever fired once per player. This event can only be connected in a Script.

showInfoModal

Fires when the player clicks on the token tracker when the useCustomModals configuration option is set to true. This event can only be connected in a LocalScript.

showCompleteModal

Fires when the player clicks on the token tracker when the useCustomModals configuration option is set to true and the player has collected all tokens in the scavenger hunt. This event can only be connected in a LocalScript.

Callbacks

hideOtherGuis

This callback runs immediately before a modal is displayed, letting you disable entire ScreenGui|ScreenGuis or elements within them before the modal is shown. See GUI Visibility for details and sample code.

showOtherGuis

This callback runs immediately after a modal has been dismissed, letting you re-enable entire ScreenGui|ScreenGuis or elements within. See GUI Visibility for details and sample code.