Skip to main content

Interface: LoadScenePayload

Parameters for loading a saved modular scene configuration. Controls how a previously saved scene is restored and displayed to users, with options for customizing the loading behavior.

Extends​

Properties​

config?​

optional config: ModularSavedState

Optional detailed configuration state to apply

disableAutoZoom?​

optional disableAutoZoom: boolean

If true, prevents automatic focus/zoom when loading

id​

id: string

Unique identifier for this configuration

Inherited from​

ModularDefaultConfiguration.id

isAutosave?​

optional isAutosave: boolean

If true, this is an automatically saved version

isFav?​

optional isFav: boolean

If true, this scene is loaded from user favorites

name​

name: string

Display name shown to users

Inherited from​

ModularDefaultConfiguration.name

shortCode​

shortCode: string

Unique code that identifies this specific configuration

Inherited from​

ModularDefaultConfiguration.shortCode

src​

src: string

Path to the image representing this configuration

Inherited from​

ModularDefaultConfiguration.src

withoutResize?​

optional withoutResize: boolean

If true, prevents automatic resizing during load