Volume Devices

Have you ever wanted to trigger specific devices or events for a whole area of your island? The Volume device is designed to help you do that. As a customizable and nestable volume, you can size and place multiple volumes that can trigger events or functions when a player, vehicle, creature, wildlife animal, or guard enters or leaves that volume.

There are lots of ways to use this device, but they work particularly well with the Fixed Point Camera, Fixed Angle Camera, and Third Person Controls devices. See Designing with Cameras and Controls for more examples for how to use this device with camera and controls devices.

Looking for a spark of creative freedom? See Down But Not Out Device Design Example to liberate your imagination!

To find the Volume device, go to the Creative inventory and select the Devices tab. From there you can search or browse for the device. For more information on finding devices see Finding and Placing Devices.

Device Options

You can configure this device with the following options.

Default values are bold. Values that trigger contextual filtering are italic.

Direct Event Binding

Direct event binding allows devices to communicate directly, which makes your workflow more intuitive, and gives you more freedom to focus on your design ideas.

Below are the functions and events for this device.

Functions

This device has no functions.

Events

An event tells another device when to perform a function.

1. For any event, click the option, then Select Device to access and select from the Device dropdown menu.

2. Once you've selected a device, click Select Function to bind the device to a function for that device.

3. If more than one device is affected by the event, press the Add button to add a line and repeat these steps.

Using Volume Devices In Verse

You can use the code below to control a Volume device in Verse. This code shows how to use events and functions in the Volume device API. Modify it to fit the needs of your experience.

using { /Fortnite.com/Devices }
using { /UnrealEngine.com/Temporary/Diagnostics }
using { /Verse.org/Simulation }

# A Verse-authored creative device that can be placed in a level
volume_device_verse_example := class(creative_device):
    
    # Reference to the Volume device in the level.
    # In the Details panel for this Verse device,
    # set this property to your Volume device.
    @editable
    MyVolumeDevice:volume_device = volume_device{}

    # Runs when the device is started in a running game
    OnBegin<override>()<suspends>:void=
        # Example for subscribing to an event on the Creative device.
        # Signaled when an agent enters the Volume.
        MyVolumeDevice.AgentEntersEvent.Subscribe(OnAgentEntered)

        # Example for subscribing to an event on the Creative device.
        # Signaled when an agent exits the Volume.
        MyVolumeDevice.AgentExitsEvent.Subscribe(OnAgentExited)
  
    # This function runs when an agent enters the Volume because it's an event handler for AgentEntersEvent.
    OnAgentEntered(Agent:agent):void=
        Print("Agent entered the volume.")

    # This function runs when an agent exites the Volume because it's an event handler for AgentExitsEvent.
    OnAgentExited(Agent:agent):void=
        Print("Agent exited the volume.")
Copy full snippet

using { /Fortnite.com/Devices } using { /UnrealEngine.com/Temporary/Diagnostics } using { /Verse.org/Simulation } # A Verse-authored creative device that can be placed in a level volume_device_verse_example := class(creative_device): # Reference to the Volume device in the level. # In the Details panel for this Verse device, # set this property to your Volume device. @editable MyVolumeDevice:volume_device = volume_device{} # Runs when the device is started in a running game OnBegin<override>()<suspends>:void= # Example for subscribing to an event on the Creative device. # Signaled when an agent enters the Volume. MyVolumeDevice.AgentEntersEvent.Subscribe(OnAgentEntered) # Example for subscribing to an event on the Creative device. # Signaled when an agent exits the Volume. MyVolumeDevice.AgentExitsEvent.Subscribe(OnAgentExited) # This function runs when an agent enters the Volume because it's an event handler for AgentEntersEvent. OnAgentEntered(Agent:agent):void= Print("Agent entered the volume.") # This function runs when an agent exites the Volume because it's an event handler for AgentExitsEvent. OnAgentExited(Agent:agent):void= Print("Agent exited the volume.")

To use this code in your UEFN experience, follow these steps.

1. Drag a Volume device onto your island.
2. Create a new Verse device named volume_device_verse_example. See Create Your Own Device Using Verse for steps.
3. In Visual Studio Code, open volume_device_verse_example.verse in Visual Studio Code and paste the code above.
4. Compile your code and drag your Verse-authored device onto your island. See Adding Your Verse Device to Your Level for steps.
5. Add a reference for the Volume device on your island to your Verse device. See Adding a Verse Reference to a Creative Device in Your Level for steps.
6. Save your project and click Launch Session to playtest.

Volume Device Verse API

See the volume_device API Reference for more information on using the Volume device in Verse.