Spline

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

A Simple Spline Scene

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

Properties

URL

The URL of the SplineCode for the Scene.

See Finding the SplineCode for more details on where to find this.


Nodes: Broadcasters

Spline:onEvent

Fires when the Spline scene triggers an event.

Field
Type
Description

Spline Event Type

SplineEvent

The type of SplineEvent that was triggered. A list of event types can be found in the Spline Documentation.

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

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

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

Last updated

Was this helpful?