Get Started

Create AR effects for Instagram and Meta.
Get Started

Scripting API

SceneModule

BlockSceneRootInputs

BlockSceneRootInputs

Contents

Contents

The BlockSceneRootInputs class encapsulates methods for setting inputs to the block instance.

Properties

This module exposes no properties.

Methods

Method	Description
`findFirst`	findFirst(name: string, config?: {type?: string}): Promise<BlockInstanceInput \| null>
`findUsingPattern`	findUsingPattern(namePattern: string, config?: {limit?: number, type?: string}): Promise<Array<BlockInstanceInput>>
`getAll`	getAll(config?: {type?: string}): Promise<Array<BlockInstanceInput>>
`setBoolean`	setBoolean(name: string, v: BoolSignal): Promise<void> Sends a `BoolSignal` to the Block's input with the given `name`. Returns a promise that is fulfilled if the operation succeeds and is rejected if the operation fails, such as if no input exists with the given name, or if the input's type is not a `BoolSignal`.
`setColor`	setColor(name: string, v: ColorSignal): Promise<void> Sends a `ColorSignal` to the Block's input with the given `name`. Returns a promise that is fulfilled if the operation succeeds and is rejected if the operation fails, such as if no input exists with the given name, or if the input's type is not of Color or Vec4.
`setPoint`	setPoint(name: string, v: PointSignal): Promise<void> Sends a `PointSignal` to the Block's input with the given `name`. Returns a promise that is fulfilled if the operation succeeds and is rejected if the operation fails, such as if no input exists with the given name, or if the input's type is not a `PointSignal`.
`setPoint2D`	setPoint2D(name: string, v: Vec2Signal): Promise<void> Sends a `Vec2Signal` to the Block's input with the given `name`. Returns a promise that is fulfilled if the operation succeeds and is rejected if the operation fails, such as if no input exists with the given name, or if the input's type is not a `Vec2Signal`.
`setPulse`	setPulse(name: string, v: EventSource<any>): Promise<void> Sends a `EventSource` to the Block's input with the given `name`. Returns a promise that is fulfilled if the operation succeeds and is rejected if the operation fails, such as if no input exists with the given name, or if the input's type is not a `EventSource`.
`setScalar`	setScalar(name: string, v: ScalarSignal): Promise<void> Sends a `ScalarSignal` to the Block's input with the given `name`. Returns a promise that is fulfilled if the operation succeeds and is rejected if the operation fails, such as if no input exists with the given name, or if the input's type is not a `ScalarSignal`.
`setShader`	setShader(name: string, v: ShaderSignal): Promise<void> Sends a `ShaderSignal` to the Block's input with the given `name`. Returns a promise that is fulfilled if the operation succeeds and is rejected if the operation fails, such as if no input exists with the given name, or if the input's type is not a `ShaderSignal`.
`setString`	setString(name: string, v: StringSignal): Promise<void> Sends a `StringSignal` to the Block's input with the given `name`. Returns a promise that is fulfilled if the operation succeeds and is rejected if the operation fails, such as if no input exists with the given name, or if the input's type is not a `StringSignal`.
`setVec4`	setVec4(name: string, v: Vec4Signal): Promise<void> Sends a `Vec4Signal` to the Block's input with the given `name`. Returns a promise that is fulfilled if the operation succeeds and is rejected if the operation fails, such as if no input exists with the given name, or if the input's type is not of Color or Vec4.
`setVector`	setVector(name: string, v: VectorSignal): Promise<void> Sends a `VectorSignal` to the Block's input with the given `name`. Returns a promise that is fulfilled if the operation succeeds and is rejected if the operation fails, such as if no input exists with the given name, or if the input's type is not a `VectorSignal`.