Blueprint(UE5): Node Reference

Name

Inputs

Description

Input: Material

Returns an array of Substance Graph Instances used by a material. If you create a material that uses texture outputs from two different graph instance, this function will return those two graph instances.

Input: SubstanceGraphInstance

Returns an array of all enabled and currently computed textures from the Substance Graph Instance input parameter.

Input: SubstanceGraphInstance

Returns the graph name as set in Designer.

Input: SubstanceGraphInstance

Returns the name of the GraphInstanceFactory that was used to create the SubstanceGraphInstance that is passed into this node.

NONE

Returns a float between 0 and 1 with the percentage of how many substances have been fully loaded.

Input: SubstanceInstanceFactory - The factory which you want to create a graph instance from.Input: GraphIndex (int) - The index of the graph you want to create. Input: InstanceName (FString) - The name you want your new Instance to have.

Returns a new standalone graph instance that will persist until your application closes.

SubstanceGraphInstance - The graph instance you would like to create a copy of.

Returns a new standalone graph instance that will persist until your application closes.

Input: SubstanceGraphInstance - The graph instance containing the output to enable Input: OutputIndices (int32 Array) - The indices of the outputs you want to enable.

If previously disabled, creates the texture output(s) of passed in SubstanceGraphInstance. This has the same functionality as enabling output from the SubstanceGraphInstance Editor. NOTE: This will not update your material with the newly created texture. This needs to be handled by setting a sampler parameter at runtime using the new output.

Input: SubstanceGraphInstance - The graph instance containing the output to disable Input: OutputIndices (int32 Array) - The indices of the outputs you want to disable

If enabled, will disable and delete the texture output for the passed in the graph object

Input: SubstanceGraphInstance - The graph instance you want to apply values toInput: SubstanceGraphInstance - The graph instance you want to get the values from

Restores all of the changed input values of the Substance Graph Instance input parameter.

Input: SubstanceGraphInstance

Reset the input values of a Substance Graph Instance to their default values

Input: SubstanceGraphInstanceInput: Width - Texture Resolution of the X coordinateInput: Height - Texture Resolution of the Y coordinate

Sets texture resolution of all of the outputs generated from this graph instance with the sizes passed in from the parameters. Note - Max 2048 on CPU EngineNote - Max 4096 on GPU Engine

Recomputes output textures of the Substance Graph Instance input. (Non blocking)

Recomputes output textures of the Substance Graph Instance input. (Blocking)

Name

Input

Description

GetDynamicMaterialInstance

Input: Name (String)

Returns the runtime dynamic material instance of a substance or creates one if one does not exist. Dynamic material instances are rquired for most runtime value changes from substance value outputs.

NONE

Returns an array of Strings containing all of the input parameter names.

NONE

Returns the data type associated with this input.

Input: Identifier (String)Input: InputValues (int array)

Change the value of an input found by the Identifier. From within a game, must render substance using AyncRender or SyncRender for changes to be applied.

Input: Identifier (String)Input: InputValues (float array)

Change the value of an input found by the Identifier. From within a game, must render substance using AyncRender or SyncRender for changes to be applied.

Input: Identifier (String)

Returns an array of ints with the current values of an input parameter.

Identifier (String)

Returns an array of floats with the current values of an input parameter.

Input: Bool (Boolean)Input: Identifier (String)

Takes in a boolean value to assign a togglable input value type. Previously, this was only achievable by setting an int value of either a 1 or a 0 casted to a bool.

Input: Identifier (String)

Returns the current boolean value of an input.

Input: Color (LinearColor)Input: Identifier (FString)

Takes in a FLinearColor value to assign a color input value type to. Previously, this was only achievable by setting a float value and passing in an array of floats.

Input: Identifier (FString)

Returns the current color value in UE4 format.

Input: Output Factory (SubstanceInstanceFactory)*The factory creating the outputs that will be used as input to the Input factory.*Input: Output Factory Graph Index (Integer)Which graph within the substance you would like to use to combine. Input: Input Factory (SubstanceInputFactory)*The factory using the outputs as input images from the Output Factory.*Input: Connections (Array of SubstanceConnections)This can be created using the blueprint node Make Array. A substance connection is how you can the aggregate node which inputs to link to which outputs. **Return (SubstanceInstanceFactory)**Can be used to create a graph instance of the new combined instance.

The new aggregate substance node allows you to take two substance instance factories and create a new instance factory at runtime, which can be used to create a new graph instance. What makes this special is that you can connect output textures from one of the combined graph instances to input images of the other combined graph instance. To create a substance graph instance from this new factory, see our documentation on runtime graph instances.

Input: Output Identifier (FString)The identifier of the texture output to chain into an input. Input: Input Identifier (FString)

Used by Create Aggregate Substance Factory to specify how to chain each output texture with new input textures.