Get Started

Create AR effects for Instagram and Meta.
Get Started

Scripting API

SceneModule

Scene

Scene

Contents

Contents

The Scene class implements properties and methods to access the objects in a scene.

Example

Properties

Property	Description
`hidden`	(get) hidden: BoolSignal (set) hidden: BoolSignal Specifies whether the scene and its descendants are hidden.
`outputVisibility`	(get) outputVisibility: OutputVisibility (set) (Not Available) Represents the `OutputVisibility` that contains a set of flags that specify the overall scene visibility depending on the output.
`worldTransform`	(get) worldTransform: TransformSignal (set) (Not Available) Specifies a `TransformSignal` object describing the scene roots transformation relative to world coordinate system. This property is available only within the context of a block.

Methods

Method	Description
`addChild`	addChild(child: SceneObjectBase \| string): Promise<void> Add a child to the root of the scene. Please note the following specific behavior when using this API: - Adding an object as a child automatically removes it from any other parent. - Adding a child that was created in Studio is not allowed. Note: This API requires "Scripting Dynamic Instantiation" capability to be enabled.
`findAll`	findAll(name: string, config?: {recursive: boolean}): Promise<Array<SceneObjectBase>> Returns a promise that is resolved with the all of the scene objects with given name or empty array if none was found. `recursive` param of `config` controls whenever the find should be performed recursively (`true` by default). Empty array is returned in no objects are found. See Also: `SceneObjectBase.findFirst`, `SceneObjectBase.findByPath`, `SceneModule.root`.
`findByAllTags`	findByAllTags(tags: Array<string>, config?: {limit: number}): Promise<Array<SceneObjectBase>> Returns a promise that is resolved with all occurances of scene objects with given tags or empty array if none was found. `limit` parameter describes if `findByAllTags` should finish the search if it finds specified number of objects (default is no limit). Non-positive values for limit are treated as unlimited.
`findByAnyTags`	findByAnyTags(tags: Array<string>, config?: {limit: number}): Promise<Array<SceneObjectBase>> Returns a promise that is resolved with all occurances of scene objects that contains any of given tags or empty array if none was found. `limit` parameter describes if `findByAnyTags` should finish the search if it finds specified number of objects (default is no limit). Non-positive values for limit are treated as unlimited.
`findByPath`	findByPath(pathQuery: string, config?: {limit: number}): Promise<Array<SceneObjectBase>> Returns a promise that is resolved with the all occurrences of scene objects matching the path query or empty array if none was found. Path query format: `` matches any characters sequence. `` as standalone component matches one level of the scene tree (i.e. any child) `*` as standalone component matches any level of scene tree (will result in recursive find) `/` is a path component separator `\` can be used to include in component name any of the control characters (including '\' itself) Examples: `findByPath("")` will match all the direct children of the caller. `findByPath("/A")` will match all grandchildren of the caller named A. `findByPath("/A")` will match all descendants of the caller named A. `findByPath("A")` will match all children of the caller which name is prefixed with 'A', like 'ABC'. `findByPath("*/A")` will match all descendants of the caller which name contains 'A', like 'AX' and 'XA'. `findByPath("/A", {limit: 10})` will match at most first 10 descendants of the caller named A. `findByPath("\\")` will match all children of the caller named . `findByPath("\\\\")` will match all children of the caller named \. `limit` parameter describes if `findByPath` should finish the search if it finds specified number of results (default is no limit). Non-positive values for limit are treated as unlimited. Note: object D is considered to be a descendant of object P if either D is a child of P or if such an object C which is a child of P exists that D is a descendant of C. See Also*: `SceneObjectBase.findAll`, `SceneObjectBase.findFirst`, `SceneModule.root`.
`findByTag`	findByTag(tag: string, config?: {limit: number}): Promise<Array<SceneObjectBase>> Returns a promise that is resolved with all occurances of scene objects with given tag or empty array if none was found. `limit` parameter describes if `findByTag` should finish the search if it finds specified number of objects (default is no limit). Non-positive values for limit are treated as unlimited.
`findFirst`	findFirst(name: string, config?: {recursive: boolean}): Promise<SceneObjectBase \| null> Returns a promise that is resolved with the first occurrence of scene object with given name or null if none was found. `recursive` param of `config` controls whenever the find should be performed recursively (`true` by default). See Also: `SceneObjectBase.findAll`, `SceneObjectBase.findByPath`, `SceneModule.root`.
`removeChild`	removeChild(child: SceneObjectBase \| string): Promise<void> Remove a child from the root of the scene. When removing scene objects, keep the following in mind: - Removing a child that was created in Studio isn't allowed. - Removing a child that is not present under a given parent isn't allowed. - Removing a child doesn't unbind any of it's properties. Note: This API requires "Scripting Dynamic Instantiation" capability to be enabled.