Documentation
  • Welcome to Odyssey
  • Upload a project
    • Getting Started
    • Set up your project
    • Package for Linux (it's easy)
    • Upload your project
    • Create and publish your space
  • Instant Multiplayer
    • Quickstart
    • Spatial voice & video
      • Add spatial comms to player
      • Huddle
      • Share your screen
    • Avatars
      • Using Avatars
      • Avatar Blueprints
  • Realtime Configurator
    • Quickstart
    • Sketchfab importer
    • Actor importer
    • Level & object configurator
      • Level configurator
      • Object configurator
      • Configurator blueprint API
    • Media importer
      • Vimeo & web panels
      • Dolby.io in-world streams
  • Embed in a website
    • Enable embedding
    • Pass messages to and from Unreal
      • Sending messages to Unreal
      • Receiving messages from Unreal
    • Manage your stream
      • Stream loading states
      • Session states
      • Stream quality settings
      • Dynamic styling
  • Admin
    • Sharing and permissions
    • Subscriptions
    • Purchase stream hours
  • FAQ
    • Our GPUs (Coreweave)
    • Concurrent user limits
    • Vulkan renderer
    • In-world video support on Linux
  • Guides
    • Add the Odyssey plugin
    • Validate your project settings
    • Troubleshoot "Project zip is invalid"
Powered by GitBook
On this page
  • Overview
  • Switch on configurator key
  • Acting on configuration event data
  • Strings and numbers
  • Enums and booleans
  • Images
  • Triggers
  1. Realtime Configurator
  2. Level & object configurator

Configurator blueprint API

Last updated 1 year ago

Overview

This example walks through the steps of binding runtime gameplay logic to Level or Object Configurator events.

Make sure you have set up your blueprint to start receiving events, from within your or your .

Switch on configurator key

In most cases you'll want to set up a Switch on Configurator Key node to separate logic based on the specific property you are targeting.

  1. Right click on the event node and select Split Struct Pin:

  1. Drag out of Event Data Key and select Switch on Configurator Event Key:

  1. Select the new node and in it's options assign the correct Configurator Dataset asset to it:

  1. Your Switch on Key node should now be populated with the correct properties.

Acting on configuration event data

Depending on your property type you have different options for acting on the configuration event data (flowing from the Event Data pin).

Strings and numbers

In the case of strings and numbers, the Event Data Value can be passed directly to the consuming node:

Enums and booleans

Enum and booleans Configurator values are easy to work with thanks to the Switch on Configurator enum value node. Once added, specify the correct Key in its node settings:

Images

  1. Reacting to an Image event type is easy. The Event Data Value can be linked to a Get Image From URL node.

  2. The bound delegate will fire once the file is downloaded and turned into a runtime texture:

Triggers

Trigger events do not carry any value, and can be used to fire non-parametrized events. Simply drag off the Switch on Key node to listen for Trigger events.

level configurat
or
object configurator