SceneModule Overview
SceneModule Overview
BlockInstanceInputs

BlockInstanceInputs

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

Properties

This module exposes no properties.

Methods

MethodDescription
setBoolean
setBoolean(name: String, signal: 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, signal: 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 a ColorSignal.
setPoint
setPoint(name: String, signal: 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, signal: Point2DSignal): Promise<void>


Sends a Point2DSignal 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 Point2DSignal.
setPulse
setPulse(name: String, signal: EventSource): 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, signal: 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, signal: 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, signal: 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.
setVector
setVector(name: String, signal: 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.