Documentation / scene / GraphNodeInput

Type Alias: GraphNodeInput

GraphNodeInput = object

Defined in: libs/scene/src/utility/blueprint/node.ts:131

Input slot definition for a graph node

Remarks

Describes an input connection point on a node, including its type constraints, connected source node, default value, and validation requirements.

Example

const input: GraphNodeInput = {
  id: 0,
  name: 'value',
  type: ['float', 'vec2', 'vec3'],  // Accepts multiple types
  required: true,
  defaultValue: 0.0
};

Properties

id

id: number

Defined in: libs/scene/src/utility/blueprint/node.ts:133

Unique identifier for this input slot

---

name

name: string

Defined in: libs/scene/src/utility/blueprint/node.ts:135

Display name of the input

---

type

type: string[]

Defined in: libs/scene/src/utility/blueprint/node.ts:140

Array of accepted type names

Remarks

Multiple types indicate the input can accept any of these types

---

inputNode?

optional inputNode?: Nullable<IGraphNode>

Defined in: libs/scene/src/utility/blueprint/node.ts:145

The source node connected to this input

Remarks

Undefined if no connection exists

---

inputId?

optional inputId?: Nullable<number>

Defined in: libs/scene/src/utility/blueprint/node.ts:150

The output slot ID of the connected source node

Remarks

Only valid when inputNode is defined

---

defaultValue?

optional defaultValue?: number[]

Defined in: libs/scene/src/utility/blueprint/node.ts:155

Default value when no connection exists

Remarks

Can be a single number or an array of numbers for vector types

---

required?

optional required?: boolean

Defined in: libs/scene/src/utility/blueprint/node.ts:161

Whether this input must be connected

Remarks

If true, validation will fail if no connection exists

Default Value

false

---

originType?

optional originType?: string

Defined in: libs/scene/src/utility/blueprint/node.ts:166

Original type name before any type casting

Remarks

Used for tracking type conversions and compatibility checking