Flux Product Docs
  • What is Flux?
  • Guides
    • Creating a Premium Video
    • Creating Your First Site
    • Creating a Countdown
    • Creating a Navigation Bar
    • Creating a Group
    • Custom 404 Page
    • Adding a Favicon to Your Site
    • Adding Videos to Your Site
    • Managing Your Guest List
    • Asset Management
    • Creating Sites from Site Templates
    • Publishing Site Versions
    • Advanced Debugging
  • Fundamentals
    • Key Concepts
    • Sites
    • Guests
    • Environments
      • Show Variables
    • Flows
      • Anatomy of a Node
      • Connecting Nodes and Building Flows
      • Passing Data
      • Scope
      • Interpolation
    • Keyboard Shortcuts
      • Keyboard Shortcuts - Page Editor
    • Animation States
    • Local Variables
    • Groups
  • Use Cases
    • For Designers
    • For Engineers
      • Custom CSS
      • Custom Modules
    • For Event Manager
      • Intercom Integration
  • Documentation
    • FAQ
    • Glossary
    • 🚀Show Controller
      • Modes
    • Domains and Subdomains
      • Hover
      • AWS Route 53
    • Premium Live Channels
    • Basic Video
    • Premium Video
      • AI Generated Subtitles
      • Supported Input Codecs and Containers
      • Supported Language Labels
      • Serverside Forensic Watermarking
    • Flow Nodes
      • Middleware
  • Modules
    • Access Code
    • Audio
    • Button
    • Carousel
    • Chat
    • Checkbox
    • Container
    • Countdown
    • Date
    • Embed
    • Image
    • Intercom
    • Link
    • Lottie
    • Page
    • Meter
    • Modal
    • Photobooth Gallery
    • Open Login
    • QR Code
    • Radio
    • Rich Text
    • Stack
    • Style
    • Spline
    • Switch
    • Text Input
    • Video
  • Template Guides
    • NatGeo FYC
      • Adding a Panel
    • Meow Wolf All Shrimps
  • 🚀Change Logs
    • July 12, 2024
    • June 08, 2024
    • April 26, 2024
    • April 12, 2024
    • March 29, 2024
    • March 15, 2024
    • March 1, 2024
    • September 2022
    • August 2022
    • July 2022
    • June 2022
Powered by GitBook
On this page
  • Properties
  • URL
  • Nodes: Broadcasters
  • Spline:onEvent
  • Nodes: Listeners
  • Spline:setUrl
  • Spline:setVariable
  • Spline:triggerEvent
  • Guides
  • Finding the SplineCode for a Scene
  • Updating a Spline Scene

Was this helpful?

  1. Modules

Spline

Allows a Spline 3D scene to be integrated into a Flux site.

Last updated 1 year ago

Was this helpful?

The Spline module allows Flux sites to natively embed and interact with .

Properties

URL

The URL of the SplineCode for the Scene.


Nodes: Broadcasters

Spline:onEvent

Fires when the Spline scene triggers an event.

Field
Type
Description

Spline Event Type

SplineEvent

Object

String

The name of the Spline Object where the event occurred.

Nodes: Listeners

Spline:setUrl

When triggered, changes the currently loaded Spline scene.

Field
Type
Description

URL

String

The SplineCode for the new Spline scene to load.

Spline:setVariable

When triggered, sets a Spline variables to the specified Value.

Field
Type
Description

Spline Variable Name

String

The name of the Spline Variable to set

Value

String | Number | Boolean

The value to set the Spline Variable to.

Spline:triggerEvent

When triggered, triggers a Spline Event in the target Spline Scene.

Field
Type
Description

Event Type

SplineEvent

Object

String

The name of the Spline Object to trigger the Event on.

Guides

Finding the SplineCode for a Scene

  1. Open a Spline Scene

  2. Click "Export" in the top toolbar.

  3. Select "Viewer"

  4. Copy the scene link at the top. It should look like:

prod.spline.design/kdQpJNHWdLyIY6fZ/scene.splinecode

Updating a Spline Scene

When making changes to your Spline Scene, you must update the export before changes will appear in the Flux module.

  1. Update your Spline Scene (e.g. change the color of an object)

  2. Click "Export" in the top toolbar.

  3. Select "Viewer"

  4. Click "Update Viewer" and wait until the loading spinner disappears

See for more details on where to find this.

The type of SplineEvent that was triggered. A list of event types

The type of Spline Event to trigger in the target Scene. A list of accepted values can be found

Finding the SplineCode
can be found in the Spline Documentation.
in the Spline Documentation.
Spline scenes
A Simple Spline Scene