Lumberyard
Legacy Reference

ProceduralMaterial Nodes

Flow Graph is deprecated and will be removed in a future version of Lumberyard. Learn about Script Canvas, Lumberyard's new visual scripting environment.

This topic references tools and features that are legacy. If you want to use legacy tools in Lumberyard Editor, disable the CryEntity Removal gem using the Project Configurator or the command line. To learn about the latest features, see the Amazon Lumberyard User Guide.

You can use the following flow graph nodes to configure procedural material settings.

GetGraphInstanceID node

Used to get the graph instance ID.

Inputs

Port Type Description
ProceduralMaterial String Name of the procedural material
GraphicIndex Integer Graph index
Get Any Get the graph index

Outputs

Port Type Description
Result Integer Outputs the graph index

GetInputFloat node

Used to get the Substance input floating point value.

Inputs

Port Type Description
GraphInstanceID Integer Graph instance ID
ParameterName String Parameter name
Get Any Get parameter value

Outputs

Port Type Description
Value1 Float Outputs parameter value
Done Any Triggered when input completes

GetInputFloat2 node

Used to get the Substance input floating point values.

Inputs

Port Type Description
GraphInstanceID Integer Graph instance ID
ParameterName String Parameter name
Get Any Get parameter value

Outputs

Port Type Description
Value1 Integer Outputs parameter value 1
Value2 Integer Outputs parameter value 2
Done Any Triggered when input completes

GetInputFloat3 node

Used to get the Substance input floating point values.

Inputs

Port Type Description
GraphInstanceID Integer Graph instance ID
ParameterName String Parameter name
Get Any Get parameter value

Outputs

Port Type Description
Value1 Float Outputs parameter value 1
Value2 Float Outputs parameter value 2
Value3 Float Outputs parameter value 3
Done Any Triggered when input completes

GetInputFloat4 node

Used to get the Substance input floating point values.

Inputs

Port Type Description
GraphInstanceID Integer Graph instance ID
ParameterName String Parameter name
Get Any Get parameter value

Outputs

Port Type Description
Value1 Float Outputs parameter value 1
Value2 Float Outputs parameter value 2
Value3 Float Outputs parameter value 3
Value4 Float Outputs parameter value 4
Done Any Triggered when input completes

GetInput node

Used to get the Substance input value.

Inputs

Port Type Description
GraphInstanceID Integer Graph instance ID
ParameterName String Parameter name
Get Any Get parameter value

Outputs

Port Type Description
Value1 Float Outputs parameter value
Done Any Triggered when input completes

GetInput2 node

Used to get the Substance input value.

Inputs

Port Type Description
GraphInstanceID Integer Graph instance ID
ParameterName String Parameter name
Get Any Get parameter value

Outputs

Port Type Description
Value1 Float Outputs parameter value 1
Value2 Float Outputs parameter value 2
Done Any Triggered when input completes

GetInput3 node

Used to get the Substance input value.

Inputs

Port Type Description
GraphInstanceID Integer Graph instance ID
ParameterName String Parameter name
Get Any Get parameter value

Outputs

Port Type Description
Value1 Float Outputs parameter value 1
Value2 Float Outputs parameter value 2
Value3 Float Outputs parameter value 3
Done Any Triggered when input completes

GetInput4 node

Used to get the Substance input value.

Inputs

Port Type Description
GraphInstanceID Integer Graph instance ID
ParameterName String Parameter name
Get Any Get parameter value

Outputs

Port Type Description
Value1 Float Outputs parameter value 1
Value2 Float Outputs parameter value 2
Value3 Float Outputs parameter value 3
Value4 Float Outputs parameter value 4
Done Any Triggered when input completes

QueueGraphInstance node

Used to queue to graph instance.

Inputs

Port Type Description
GraphInstanceID Integer Graph instance ID
Add Any Add graph instance ID to the queue

Outputs

Port Type Description
Done Any Triggered when input completes

RenderASync node

Used to render queued graphs asynchronously.

Inputs

Port Type Description
Render Any Begin rendering graph instance asyncronously

Outputs

Port Type Description
RenderBegin Any Triggered when rendering has started
RenderComplete Any Triggered when rendering has completed

RenderSync node

Used to render queued graphs synchronously.

Inputs

Port Type Description
Render Any Begin rendering graph instance syncronously

Outputs

Port Type Description
RenderComplete Any Triggered when rendering has completed

SetInputFloat node

Used to set the Substance input floating point value.

Inputs

Port Type Description
GraphInstanceID Integer Graph instance ID
ParameterName String Parameter name
Value1 Float Floating point parameter value to set
Apply Any Set parameter value

Outputs

Port Type Description
Done Any Triggered when input completes

SetInputFloat2 node

Used to set the Substance input floating point values.

Inputs

Port Type Description
GraphInstanceID Integer Graph instance ID
ParameterName String Parameter name
Value1 Float Floating point parameter value 1 to set
Value2 Float Floating point parameter value 2 to set
Apply Any Set parameter value

Outputs

Port Type Description
Done Any Triggered when input completes

SetInputFloat3 node

Used to set the Substance input floating point values.

Inputs

Port Type Description
GraphInstanceID Integer Graph instance ID
ParameterName String Parameter name
Value1 Float Floating point parameter value 1 to set
Value2 Float Floating point parameter value 2 to set
Value3 Float Floating point parameter value 3 to set
Apply Any Set parameter value

Outputs

Port Type Description
Done Any Triggered when input completes

SetInputFloat4 node

Used to set the Substance input floating point values.

Inputs

Port Type Description
GraphInstanceID Integer Graph instance ID
ParameterName String Parameter name
Value1 Float Floating point parameter value 1 to set
Value2 Float Floating point parameter value 2 to set
Value3 Float Floating point parameter value 3 to set
Value4 Float Floating point parameter value 4 to set
Apply Any Set parameter value

Outputs

Port Type Description
Done Any Triggered when input completes

SetInputImage node

Used to set the Substance input image.

Inputs

Port Type Description
GraphInstanceID Integer Graph instance ID
ParameterName String Parameter name
Texture String Image to be set
Apply Any Set input image

Outputs

Port Type Description
Done Any Triggered when input completes

SetInputInt node

Used to set the Substance input value.

Inputs

Port Type Description
GraphInstanceID Integer Graph instance ID
ParameterName String Parameter name
Value1 Float Parameter value to set
Apply Any Set parameter value

Outputs

Port Type Description
Done Any Triggered when input completes

SetInputInt2 node

Used to set the Substance input values.

Inputs

Port Type Description
GraphInstanceID Integer Graph instance ID
ParameterName String Parameter name
Value1 Float Parameter value 1 to set
Value2 Float Parameter value 2 to set
Apply Any Set parameter value

Outputs

Port Type Description
Done Any Triggered when input completes

SetInputInt3 node

Used to set the Substance input values.

Inputs

Port Type Description
GraphInstanceID Integer Graph instance ID
ParameterName String Parameter name
Value1 Float Parameter value 1 to set
Value2 Float Parameter value 2 to set
Value3 Float Parameter value 3 to set
Apply Any Set parameter value

Outputs

Port Type Description
Done Any Triggered when input completes

SetInputInt4 node

Used to set the Substance input values.

Inputs

Port Type Description
GraphInstanceID Integer Graph instance ID
ParameterName String Parameter name
Value1 Float Parameter value 1 to set
Value2 Float Parameter value 2 to set
Value3 Float Parameter value 3 to set
Value4 Float Parameter value 4 to set
Apply Any Set parameter value

Outputs

Port Type Description
Done Any Triggered when input completes