Class CarbonLogicVirtualInputData

Execution data that passes through control flow pins on nodes of a CarbonLogicOnVirtualInput event node.

Hierarchy (view full)

CarbonLogicData
- CarbonLogicVirtualInputData

Index

Constructors

constructor

new CarbonLogicVirtualInputData(graph, component, virtualButton, deviceIndex, isDown, isHeld): CarbonLogicVirtualInputData
Parameters
- graph: CarbonLogicGraph
- component: CarbonLogic
- virtualButton: VirtualButton
- deviceIndex: number
- isDown: boolean
- isHeld: boolean
Returns CarbonLogicVirtualInputData
Overrides CarbonLogicData.constructor

Properties

`Readonly`deviceIndex

deviceIndex: number

The device index.

`Readonly`executionState

executionState: CarbonGraphExecutionState

The execution state, used to set and retrieve values.

`Readonly`graph

graph: CarbonGraph

The CarbonGraph that is being executed.

`Readonly`isDown

isDown: boolean

Determines if the button is pressed.

`Readonly`isHeld

isHeld: boolean

Determines if the button is pressed and held.

`Readonly`virtualButton

virtualButton: VirtualButton

The VirtualButton.

Accessors

component

get component(): CarbonComponentBase
The CarbonComponentBase that is executing the CarbonLogicGraph event.

Returns CarbonComponentBase
Inherited from CarbonLogicData.component

scene

get scene(): SceneInstance
The SceneInstance which is executing the CarbonLogicGraph event.

Returns SceneInstance
Inherited from CarbonLogicData.scene

sceneObject

get sceneObject(): SceneObject
The SceneObject which is executing the CarbonLogicGraph event.

Returns SceneObject
Inherited from CarbonLogicData.sceneObject

Class CarbonLogicVirtualInputData

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Constructors

constructor

Parameters

Returns CarbonLogicVirtualInputData

Properties

`Readonly`deviceIndex

`Readonly`executionState

`Readonly`graph

`Readonly`isDown

`Readonly`isHeld

`Readonly`virtualButton

Accessors

component

Returns CarbonComponentBase

scene

Returns SceneInstance

sceneObject

Returns SceneObject

Settings

On This Page

Class CarbonLogicVirtualInputData

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Constructors

constructor

Parameters

Returns CarbonLogicVirtualInputData

Properties

ReadonlydeviceIndex

ReadonlyexecutionState

Readonlygraph

ReadonlyisDown

ReadonlyisHeld

ReadonlyvirtualButton

Accessors

component

Returns CarbonComponentBase

scene

Returns SceneInstance

sceneObject

Returns SceneObject

Settings

On This Page

`Readonly`deviceIndex

`Readonly`executionState

`Readonly`graph

`Readonly`isDown

`Readonly`isHeld

`Readonly`virtualButton