Class SceneSettings

The Scene Settings API provides access to the settings of the currently loaded scene.

Hierarchy

Events
- SceneSettings

Index

Constructors

Accessors

Methods

get has json set

Constructors

constructor

new SceneSettings(): SceneSettings
Creates new instance of the API

Returns SceneSettings
Overrides Events.constructor
- Defined in submodules/editor-api/src/settings/scene.ts:22

Accessors

history

get history(): ObserverHistory
Gets the history object for this entity

Returns ObserverHistory
- Defined in submodules/editor-api/src/settings/scene.ts:130

Methods

get

get(path: string): any
Gets value at path. See the SceneSettings overview for a full list of properties.
Parameters
- path: string
  The path
Returns any
The value
Example
```
console.log(editor.settings.scene.get('render.fog'));
```
- Defined in submodules/editor-api/src/settings/scene.ts:91

has

has(path: string): boolean
Checks if path exists. See the SceneSettings overview for a full list of properties.
Parameters
- path: string
  The path
Returns boolean
True if path exists
Example
```
console.log(editor.settings.scene.has('render.fog'));
```
- Defined in submodules/editor-api/src/settings/scene.ts:77

json

json(): Record<string, any>
Returns JSON representation of scene settings data

Returns Record<string, any>
- The data
Example
```
console.log(editor.settings.scene.json());
```
- Defined in submodules/editor-api/src/settings/scene.ts:119

set

set(path: string, value: any): boolean
Sets value at path. See the SceneSettings overview for a full list of properties.
Parameters
- path: string
  The path
- value: any
  The value
Returns boolean
Whether the value was set
Example
```
editor.settings.scene.set('render.fog', 'none');
```
- Defined in submodules/editor-api/src/settings/scene.ts:106