Class CarbonLogicVirtualInputData

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

Hierarchy (View Summary)

CarbonLogicData
- CarbonLogicVirtualInputData

Index

Constructors

Properties

deviceIndex executionState graph isDown isHeld virtualButton

Accessors

component scene sceneObject

Constructors

constructor

new CarbonLogicVirtualInputData(
    graph: CarbonLogicGraph,
    component: CarbonLogic,
    virtualButton: VirtualButton,
    deviceIndex: number,
    isDown: boolean,
    isHeld: boolean,
): 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