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
  • Create a configurator dataset
  • Create a configuration property
  • Add configuration logic
  1. Realtime Configurator
  2. Level & object configurator

Object configurator

Last updated 1 year ago

Object Configurations are a way for you to add configuration data per Imported Actor. The defined configuration UI will show up in your actor menu after being placed.

Make sure you have set up your Object Library and at least one Imported Actor by following the instructions in Actor importer.

Create a configurator dataset

  1. In your project's content browser, right click and go to Odyssey -> Odyssey Configurator Dataset. Name it after your Imported Actor.

  1. Open your Odyssey Configurator Objects Library asset (created in Actor importer).

  2. In the row that holds your object, under Configurator Dataset -> Add your newly created configurator dataset.

You will need to follow these steps for every Imported Actor you want to attach configuration properties to.

Create a configuration property

  1. Open your Configurator Dataset asset.

  2. Add a Configurator key to the Dataset using the Add button:

  3. Fill your configuration data in your newly created row. Each configuration needs a Display Name, Type, and a Default Value.

Add configuration logic

  1. Open your Imported Actor blueprint (type OdysseyConfigurable).

  2. Override the Handle Configuration State Change function

  1. Connect your custom configuration logic to the exec pin of the newly created event.

  1. From this point you can follow the guide Configurator blueprint API to learn how to set up events and hooks from your configurator properties.