Kit material

252 ferramentas. Gerado a partir do código-fonte do plugin; não edite manualmente.

As descrições das ferramentas e dos argumentos são exibidas em inglês porque espelham o schema das ferramentas (o mesmo texto que o agente recebe em tools/list).

Guia

Everything needed to author materials from an agent: create the asset, build the expression graph, expose parameters, derive instances, package logic into material functions, stack material layers (UE 5) and generate complete materials from a single call with the recipes.

Class map

Class	What it covers
UUeaKit_Material	the Material asset: creation, domain/blend/shading settings, usage flags, compile + statistics, textures, hierarchy, validation, expression-class discovery, graph JSON export
UUeaKit_MaterialGraph	the expression graph: list/find/move/delete nodes, connections, comments, every typed material.add_* factory, material.build_graph, parameter declarations
UUeaKit_MaterialInstance	Material Instance Constants: parameter overrides, base-property overrides, hierarchy, batch edits
UUeaKit_MaterialFunction	Material Functions: inputs/outputs, the exposed library, function instances, extraction and inlining
UUeaKit_MaterialLayers	material layers and layer blends (UE 5.0+, hidden on 4.27)
UUeaKit_MaterialRecipes	one-call builders: PBR, emissive, masked, glass, decal, UI, post-process, water, landscape, checker, ...

All six share the kit name material, so edit.enable_kits {"kits":["material"]} exposes the lot.

Start here

1. material.list_recipes — see what can be built in one call.
2. material.recipe_pbr {"folder":"/Game/Materials","name":"M_Rock","baseColor":"/Game/Tex/T_Rock_BC","normal":"/Game/Tex/T_Rock_N","roughness":"/Game/Tex/T_Rock_R","parameterize":true} creates a compiled, parameterised material and returns the node map.
3. material.create_instance {"parent":"/Game/Materials/M_Rock","folder":"/Game/Materials","name":"MI_RockMossy","scalars":[{"name":"Roughness","value":0.8}]}.
4. Need something custom? material.get_graph to see the current state, then material.build_graph to author nodes and links declaratively, then material.compile.

Recipe workflow (fastest path)

Every recipe accepts either folder + name (creates the asset) or material (fills an existing one, clearing its graph first). parameterize: true (default) turns the inputs into material parameters in the group given by group, so one base material plus instances covers all variants.

material.recipe_checker    {"folder":"/Game/Dev","name":"M_Checker","scale":16}
material.recipe_emissive   {"folder":"/Game/FX","name":"M_Glow","color":{"r":0,"g":0.7,"b":1},"intensity":8,"pulse":2}
material.recipe_masked     {"folder":"/Game/Foliage","name":"M_Leaf","texture":"/Game/Tex/T_Leaf","foliage":true}
material.recipe_from_texture_folder {"textureFolder":"/Game/Tex/Rock","folder":"/Game/Materials","name":"M_Rock","dryRun":true}

The reply's nodes maps a role (baseColor, normal, roughness, emissive, ...) to the expression object name, so follow-up edits can address the nodes directly.

Graph workflow

• Identify a node by its object name (MaterialExpressionMultiply_3), its description (set it with desc when creating, or material.set_node_desc), a #index, or a parameter name. Descriptions are the most readable and survive renames.
• material.build_graph is the batch form: nodes[] with a local id and a kind (Multiply, TextureSample, ScalarParameter, ... — the class name without the MaterialExpression prefix), links[] with from/output/to/input. to may be a node id or a material property name (BaseColor, Roughness, EmissiveColor, OpacityMask, Normal, WorldPositionOffset, AmbientOcclusion, Refraction, PixelDepthOffset, CustomizedUV0..7, SubsurfaceColor, ...).
• material.connect {"target":..., "node":"Mul", "to":"BaseColor"} for a property, "to":"OtherNode.A" for an expression input. material.connect_many batches them.
• material.add_node is the escape hatch for any class the typed factories do not cover; use material.list_expression_classes / material.get_expression_class_info to discover names, pins and editable properties first.
• material.arrange_nodes tidies the layout, material.add_comment_around documents a cluster.

Compiling

Node tools do not recompile (compile defaults to false): shader compilation is the slow part. Batch the edits and call material.compile once. material.get_stats reads the current statistics without recompiling; material.get_compile_errors reports the per-expression errors of the last compile. On UE 4.27 RecompileMaterial returns nothing, so errors comes back empty there even when the material fails — check material.validate as well.

Instances

• material.get_instance returns every parameter with its value, the parent value and an overridden flag: the one call an agent needs before changing anything.
• material.set_scalar / set_vector / set_texture / set_static_switch fail with E_NOT_FOUND when the name is not a parameter of the parent, which is the usual typo signal.
• material.set_instance_overrides handles blend mode, shading model, two-sided, dithered LOD, opacity mask clip value and shadow flags. Pass "inherit" to drop an override.
• Bulk work: material.create_instance_variants, material.batch_set_scalar, material.batch_set_texture, material.batch_reparent, material.copy_parameters.

Functions and the library

material.create_function declares inputs and outputs in one call; the function's graph is then edited with the same node tools by passing the function asset as target. material.add_function_input and material.add_function_output add more declarations. material.list_function_library and material.list_engine_functions are the palette an agent can call from material.add_function_call. material.function_from_nodes extracts a selection of a material's expressions into a new function (and replaces them with a call); material.inline_function_call does the reverse.

Layers (UE 5.0+)

material.create_layer / material.create_layer_blend make the assets, material.add_material_attribute_layers_node puts the stack host into a material, then material.set_layers / add_layer / remove_layer / reorder_layer / set_layer_visible edit the stack. Layer index 0 is the background layer and has no blend. On UE 4.27 these tools are not advertised at all.

Gotchas

• Compile cost. Keep compile: false on node tools; one material.compile at the end.
• Sampler types. material.add_texture_sample with samplerType: "auto" derives the type from the texture. A normal map sampled as color compiles but looks wrong — material.get_texture_samplers lists the mismatches.
• Parameter names are unique per material. Two declarations with the same name are a compile error; material.validate reports them as duplicate_parameter.
• 4.27 vs 5.1+ input storage is transparent. The kit hides UMaterialEditorOnlyData, so "to":"BaseColor" works identically on both engines. Property names that only exist on one engine (RefractionMethod, outputTranslucentVelocity, Substrate) return E_NOT_SUPPORTED.
• Named reroutes need UE 5.0. On 4.27 use material.add_reroute.
• Math ops differ per engine. material.add_math accepts length, exp, log, modulo only from UE 5.x; on 4.27 the call returns E_NOT_SUPPORTED with the list of known operations.
• material.clear_graph and material.delete_nodes are destructive and break every link that touched the removed expressions. Export first with material.export_graph if in doubt.
• Names with spaces work for expression inputs ("to":"Blend.Layer Grass"); quote them in JSON as usual.

Ferramentas

Legenda. risco 0 = somente leitura, 1 = operação inofensiva do editor, 2 = altera asset, 3 = apaga/substitui asset, 4 = projeto/config/build, 5 = potencialmente destrutivo (chamadas acima de MaxAutoRisk exigem "_confirm": true). altera = roda numa transação (edit.undo reverte). requer PIE / requer mundo = recusado sem sessão PIE / sem nível aberto. requer plugin = indisponível quando o plugin está desativado. dryRun = aceita o argumento dryRun. smoke = coberto por edit.self_test.

material.add_actor_position (risco 2, altera, smoke)

Adds an Actor Position (world space) node.

Argumento	Tipo	Descrição
target	string	obrigatório. Material or Material Function asset to add the expression to.
x	integer	Padrão 0.
y	integer	Padrão 0.
desc	string	Optional description; it becomes a stable selector for later calls.
compile	boolean	Recompile the material afterwards (default false; compile once at the end). Padrão false.

Retorna: node, target, errors.

material.add_blackbody (risco 2, altera, smoke)

Adds a Blackbody node (colour of a temperature in kelvin).

Argumento	Tipo	Descrição
target	string	obrigatório. Material or Material Function asset to add the expression to.
x	integer	Padrão 0.
y	integer	Padrão 0.
desc	string	Optional description; it becomes a stable selector for later calls.
compile	boolean	Recompile the material afterwards (default false; compile once at the end). Padrão false.

Retorna: node, target, errors.

material.add_bump_offset (risco 2, altera, smoke)

Adds a Bump Offset (parallax) node.

Argumento	Tipo	Descrição
heightRatio	number	Padrão 0.05.
referencePlane	number	Padrão 0.5.

Retorna: node, target, errors.

material.add_camera_position (risco 2, altera, smoke)

Adds a Camera Position (world space) node.

Argumento	Tipo	Descrição
target	string	obrigatório. Material or Material Function asset to add the expression to.
x	integer	Padrão 0.
y	integer	Padrão 0.
desc	string	Optional description; it becomes a stable selector for later calls.
compile	boolean	Recompile the material afterwards (default false; compile once at the end). Padrão false.

Retorna: node, target, errors.

material.add_camera_vector (risco 2, altera, smoke)

Adds a Camera Vector node.

Argumento	Tipo	Descrição
target	string	obrigatório. Material or Material Function asset to add the expression to.
x	integer	Padrão 0.
y	integer	Padrão 0.
desc	string	Optional description; it becomes a stable selector for later calls.
compile	boolean	Recompile the material afterwards (default false; compile once at the end). Padrão false.

Retorna: node, target, errors.

material.add_collection_parameter (risco 2, altera)

Adds a Material Parameter Collection parameter node. SmokeSkip: it needs a Material Parameter Collection asset, which the sandbox does not provide.

Argumento	Tipo	Descrição
collection	string	obrigatório. Material Parameter Collection asset.
name	string	obrigatório. Parameter name inside the collection.

Retorna: node, target, errors.

material.add_comment (risco 2, altera, smoke)

Adds a comment box to a graph.

Argumento	Tipo	Descrição
target	string	obrigatório.
text	string	obrigatório.
x	integer	Padrão 0.
y	integer	Padrão 0.
width	integer	Padrão 400.
height	integer	Padrão 200.
color	UeaMatColor

Retorna: comment.

material.add_comment_around (risco 2, altera, smoke)

Adds a comment box sized to enclose the given expressions.

Argumento	Tipo	Descrição
target	string	obrigatório.
text	string	obrigatório.
nodes	array of string	obrigatório. Expressions to enclose.
padding	integer	Extra margin in graph units (default 40). Padrão 40.
color	UeaMatColor

Retorna: comment.

material.add_component_mask (risco 2, altera, smoke)

Adds a Component Mask node.

Argumento	Tipo	Descrição
r	boolean	Padrão true.
g	boolean	Padrão false.
b	boolean	Padrão false.
a	boolean	Padrão false.

Retorna: node, target, errors.

material.add_constant (risco 2, altera, smoke)

Adds a scalar constant.

Argumento	Tipo	Descrição
value	number	Padrão 0.0.

Retorna: node, target, errors.

material.add_constant2 (risco 2, altera, smoke)

Adds a two-component constant.

Argumento	Tipo	Descrição
r	number	Padrão 0.0.
g	number	Padrão 0.0.

Retorna: node, target, errors.

material.add_constant3 (risco 2, altera, smoke)

Adds a three-component (colour) constant.

Argumento	Tipo	Descrição
color	UeaMatColor

Retorna: node, target, errors.

material.add_constant4 (risco 2, altera, smoke)

Adds a four-component constant.

Argumento	Tipo	Descrição
color	UeaMatColor

Retorna: node, target, errors.

material.add_curve_atlas_row_parameter (risco 2, altera, smoke)

Adds a Curve Atlas Row Parameter node (the atlas and curve assets are optional).

Argumento	Tipo	Descrição
name	string	obrigatório.
atlas	string	Curve Atlas asset.
curve	string	Curve Linear Color asset inside the atlas.
group	string

Retorna: node, target, errors.

material.add_custom (risco 2, altera, smoke)

Adds a Custom HLSL node with named inputs and an output type.

Argumento	Tipo	Descrição
code	string	obrigatório. HLSL body; it must return a value of the declared output type.
outputType	string	float (default) / float2 / float3 / float4 / material_attributes.
inputs	array of string	Input names.
description	string	Caption of the node.
additionalOutputs	array of UeaMatCustomOutput	Extra named outputs.
includes	array of string	.ush files to include (5.x).
defines	array of UeaKeyValue	Preprocessor defines as name=value pairs (5.x).

Retorna: node, target, errors.

material.add_ddx (risco 2, altera, smoke)

Adds a DDX node (screen-space horizontal derivative).

Argumento	Tipo	Descrição
target	string	obrigatório. Material or Material Function asset to add the expression to.
x	integer	Padrão 0.
y	integer	Padrão 0.
desc	string	Optional description; it becomes a stable selector for later calls.
compile	boolean	Recompile the material afterwards (default false; compile once at the end). Padrão false.

Retorna: node, target, errors.

material.add_ddy (risco 2, altera, smoke)

Adds a DDY node (screen-space vertical derivative).

Argumento	Tipo	Descrição
target	string	obrigatório. Material or Material Function asset to add the expression to.
x	integer	Padrão 0.
y	integer	Padrão 0.
desc	string	Optional description; it becomes a stable selector for later calls.
compile	boolean	Recompile the material afterwards (default false; compile once at the end). Padrão false.

Retorna: node, target, errors.

material.add_depth_fade (risco 2, altera, smoke)

Adds a Depth Fade node.

Argumento	Tipo	Descrição
fadeDistance	number	Padrão 100.0.
opacity	number	Padrão 1.0.

Retorna: node, target, errors.

material.add_depth_of_field_function (risco 2, altera, smoke)

Adds a Depth Of Field Function node.

Argumento	Tipo	Descrição
target	string	obrigatório. Material or Material Function asset to add the expression to.
x	integer	Padrão 0.
y	integer	Padrão 0.
desc	string	Optional description; it becomes a stable selector for later calls.
compile	boolean	Recompile the material afterwards (default false; compile once at the end). Padrão false.

Retorna: node, target, errors.

material.add_desaturation (risco 2, altera, smoke)

Adds a Desaturation node with luminance weights.

Argumento	Tipo	Descrição
luminanceFactors	UeaMatColor	Luminance weights (default 0.3/0.59/0.11).

Retorna: node, target, errors.

material.add_distance_to_nearest_surface (risco 2, altera, smoke)

Adds a Distance To Nearest Surface node (needs distance fields).

Argumento	Tipo	Descrição
target	string	obrigatório. Material or Material Function asset to add the expression to.
x	integer	Padrão 0.
y	integer	Padrão 0.
desc	string	Optional description; it becomes a stable selector for later calls.
compile	boolean	Recompile the material afterwards (default false; compile once at the end). Padrão false.

Retorna: node, target, errors.

material.add_dynamic_parameter (risco 2, altera, smoke)

Adds a Dynamic Parameter node (four named channels driven by the particle system).

Argumento	Tipo	Descrição
names	array of string	Names of the four parameter channels.
index	integer	Padrão 0.

Retorna: node, target, errors.

material.add_eye_adaptation (risco 2, altera, smoke)

Adds an Eye Adaptation node.

Argumento	Tipo	Descrição
target	string	obrigatório. Material or Material Function asset to add the expression to.
x	integer	Padrão 0.
y	integer	Padrão 0.
desc	string	Optional description; it becomes a stable selector for later calls.
compile	boolean	Recompile the material afterwards (default false; compile once at the end). Padrão false.

Retorna: node, target, errors.

material.add_feature_level_switch (risco 2, altera, smoke)

Adds a Feature Level Switch node.

Argumento	Tipo	Descrição
target	string	obrigatório. Material or Material Function asset to add the expression to.
x	integer	Padrão 0.
y	integer	Padrão 0.
desc	string	Optional description; it becomes a stable selector for later calls.
compile	boolean	Recompile the material afterwards (default false; compile once at the end). Padrão false.

Retorna: node, target, errors.

material.add_fresnel (risco 2, altera, smoke)

Adds a Fresnel node.

Argumento	Tipo	Descrição
exponent	number	Padrão 5.0.
baseReflectFraction	number	Padrão 0.04.

Retorna: node, target, errors.

material.add_function_call (risco 2, altera, smoke)

Adds a Material Function Call node bound to a function asset.

Argumento	Tipo	Descrição
function	string	obrigatório. Material Function asset, e.g. "/Engine/Functions/Engine_MaterialFunctions02/Utility/BlendAngleCorrectedNormals".

Retorna: node, target, errors.

material.add_function_input (risco 2, altera, smoke)

Adds a Function Input node (material functions only).

Argumento	Tipo	Descrição
name	string	obrigatório.
type	string	scalar / vector2 / vector3 / vector4 / texture2d / texture_cube / texture2d_array / volume_texture / static_bool / material_attributes / bool.
previewValue	UeaMatColor	Preview value used while editing the function.
sortPriority	integer	Padrão 32.
usePreviewValueAsDefault	boolean	Make the preview value the default when the input is left unconnected. Padrão false.
description	string

Retorna: node, target, errors.

material.add_function_output (risco 2, altera, smoke)

Adds a Function Output node (material functions only).

Argumento	Tipo	Descrição
name	string	obrigatório.
sortPriority	integer	Padrão 32.
description	string

Retorna: node, target, errors.

material.add_function_to_library (risco 2, altera, smoke)

Exposes a function in the material palette under the given categories (shortcut for set_function_settings).

Argumento	Tipo	Descrição
function	string	obrigatório.
description	string
exposeToLibrary	string	"true" / "false"; empty keeps the current state.
categories	array of string

Retorna: asset, description, exposeToLibrary, libraryCategories, inputs, outputs, nodeCount, users.

material.add_if (risco 2, altera, smoke)

Adds an If node (branch on a comparison).

Argumento	Tipo	Descrição
target	string	obrigatório. Material or Material Function asset to add the expression to.
x	integer	Padrão 0.
y	integer	Padrão 0.
desc	string	Optional description; it becomes a stable selector for later calls.
compile	boolean	Recompile the material afterwards (default false; compile once at the end). Padrão false.

Retorna: node, target, errors.

material.add_landscape_coords (risco 2, altera, smoke)

Adds a Landscape Layer Coords node (world-aligned landscape UVs).

Argumento	Tipo	Descrição
mappingScale	number	Padrão 1.0.
mappingType	string	auto / xy / xz / yz.

Retorna: node, target, errors.

material.add_landscape_layer_blend (risco 2, altera, smoke)

Adds a Landscape Layer Blend node with its layer list.

Argumento	Tipo	Descrição
layers	array of UeaMatLandscapeLayer	obrigatório.

Retorna: node, target, errors.

material.add_landscape_layer_sample (risco 2, altera, smoke)

Adds a Landscape Layer Sample node.

Argumento	Tipo	Descrição
layerName	string	obrigatório.
previewWeight	number	Padrão 1.0.
previewUsed	boolean	Preview the "used" branch of a layer switch (default true). Padrão true.

Retorna: node, target, errors.

material.add_landscape_layer_switch (risco 2, altera, smoke)

Adds a Landscape Layer Switch node.

Argumento	Tipo	Descrição
layerName	string	obrigatório.
previewWeight	number	Padrão 1.0.
previewUsed	boolean	Preview the "used" branch of a layer switch (default true). Padrão true.

Retorna: node, target, errors.

material.add_landscape_layer_weight (risco 2, altera, smoke)

Adds a Landscape Layer Weight node.

Argumento	Tipo	Descrição
layerName	string	obrigatório.
previewWeight	number	Padrão 1.0.
previewUsed	boolean	Preview the "used" branch of a layer switch (default true). Padrão true.

Retorna: node, target, errors.

material.add_layer (risco 2, altera, UE 5.0+, smoke)

Appends one layer (and its blend) to the stack of a material.

Argumento	Tipo	Descrição
target	string	obrigatório.
layer	string	Material layer function asset.
blend	string	Blend function asset.
name	string	Display name.

Retorna: layers, total, node.

material.add_material_attribute_layers_node (risco 2, altera, UE 5.0+, smoke)

Adds a Material Attribute Layers expression to a material (the node that hosts the layer stack).

Argumento	Tipo	Descrição
target	string	obrigatório. Material or Material Function asset to add the expression to.
x	integer	Padrão 0.
y	integer	Padrão 0.
desc	string	Optional description; it becomes a stable selector for later calls.
compile	boolean	Recompile the material afterwards (default false; compile once at the end). Padrão false.

Retorna: node, target, errors.

material.add_material_attributes_node (risco 2, altera, smoke)

Adds a Make / Break / Set / Get Material Attributes node.

Argumento	Tipo	Descrição
kind	string	obrigatório. make / break / set / get.
attributes	array of string	Attribute names for the set/get variants ("BaseColor", "Roughness", ...).

Retorna: node, target, errors.

material.add_math (risco 2, altera, smoke)

Adds a math expression by operation name (multiply, lerp, clamp, dot, append, ...).

Argumento	Tipo	Descrição
op	string	obrigatório. add, subtract, multiply, divide, lerp, power, clamp, one_minus, saturate, abs, sine, cosine, frac, floor, ceil, round, truncate, step, smoothstep, min, max, dot, cross, normalize, append, sqrt, distance, fmod, sign, arctangent, arctangent2, desaturation, if (5.x also exposes length, exp, log, log2, log10).
constA	number	Constant fallback of the A input, when the expression has one. Padrão 0.0.
constB	number	Constant fallback of the B input, when the expression has one. Padrão 1.0.

Retorna: node, target, errors.

material.add_named_reroute (risco 2, altera, UE 5.0+, smoke)

Adds a named reroute declaration; usages reference it by name.

Argumento	Tipo	Descrição
name	string	obrigatório. Name of the reroute variable.

Retorna: node, target, errors.

material.add_named_reroute_usage (risco 2, altera, UE 5.0+, smoke)

Adds a usage of an existing named reroute declaration.

Argumento	Tipo	Descrição
name	string	obrigatório. Name of the reroute variable.

Retorna: node, target, errors.

material.add_node (risco 2, altera, smoke)

Adds any material expression class by name, optionally setting properties on it. The escape hatch for anything the typed factories do not cover.

Argumento	Tipo	Descrição
class	string	obrigatório. Expression class or short alias ("Multiply", "TextureSample", "MaterialExpressionFresnel").
properties	array of UeaKeyValue	Properties to set on the new expression.

Retorna: node, target, errors.

material.add_noise (risco 2, altera, smoke)

Adds a Noise node (procedural noise).

Argumento	Tipo	Descrição
scale	number	Padrão 1.0.
quality	integer	Padrão 1.
function	string	simplex / gradient / fast_gradient / value / voronoi.
levels	integer	Padrão 6.
turbulence	boolean	Padrão true.

Retorna: node, target, errors.

material.add_object_orientation (risco 2, altera, smoke)

Adds an Object Orientation node.

Argumento	Tipo	Descrição
target	string	obrigatório. Material or Material Function asset to add the expression to.
x	integer	Padrão 0.
y	integer	Padrão 0.
desc	string	Optional description; it becomes a stable selector for later calls.
compile	boolean	Recompile the material afterwards (default false; compile once at the end). Padrão false.

Retorna: node, target, errors.

material.add_object_position (risco 2, altera, smoke)

Adds an Object Position (world space) node.

Argumento	Tipo	Descrição
target	string	obrigatório. Material or Material Function asset to add the expression to.
x	integer	Padrão 0.
y	integer	Padrão 0.
desc	string	Optional description; it becomes a stable selector for later calls.
compile	boolean	Recompile the material afterwards (default false; compile once at the end). Padrão false.

Retorna: node, target, errors.

material.add_object_scale (risco 2, altera, smoke)

Adds an Object Bounds node: the world-space bounds of the object, which is how a material reads an object's scale (there is no dedicated ObjectScale expression; that one is a material function).

Argumento	Tipo	Descrição
target	string	obrigatório. Material or Material Function asset to add the expression to.
x	integer	Padrão 0.
y	integer	Padrão 0.
desc	string	Optional description; it becomes a stable selector for later calls.
compile	boolean	Recompile the material afterwards (default false; compile once at the end). Padrão false.

Retorna: node, target, errors.

material.add_panner (risco 2, altera, smoke)

Adds a Panner node (scrolls UVs over time).

Argumento	Tipo	Descrição
speedX	number	Padrão 0.0.
speedY	number	Padrão 0.0.

Retorna: node, target, errors.

material.add_particle_color (risco 2, altera, smoke)

Adds a Particle Color node.

Argumento	Tipo	Descrição
target	string	obrigatório. Material or Material Function asset to add the expression to.
x	integer	Padrão 0.
y	integer	Padrão 0.
desc	string	Optional description; it becomes a stable selector for later calls.
compile	boolean	Recompile the material afterwards (default false; compile once at the end). Padrão false.

Retorna: node, target, errors.

material.add_particle_macro_uv (risco 2, altera, smoke)

Adds a Particle Macro UV node.

Argumento	Tipo	Descrição
target	string	obrigatório. Material or Material Function asset to add the expression to.
x	integer	Padrão 0.
y	integer	Padrão 0.
desc	string	Optional description; it becomes a stable selector for later calls.
compile	boolean	Recompile the material afterwards (default false; compile once at the end). Padrão false.

Retorna: node, target, errors.

material.add_particle_position_ws (risco 2, altera, smoke)

Adds a Particle Position (world space) node.

Argumento	Tipo	Descrição
target	string	obrigatório. Material or Material Function asset to add the expression to.
x	integer	Padrão 0.
y	integer	Padrão 0.
desc	string	Optional description; it becomes a stable selector for later calls.
compile	boolean	Recompile the material afterwards (default false; compile once at the end). Padrão false.

Retorna: node, target, errors.

material.add_particle_radius (risco 2, altera, smoke)

Adds a Particle Radius node.

Argumento	Tipo	Descrição
target	string	obrigatório. Material or Material Function asset to add the expression to.
x	integer	Padrão 0.
y	integer	Padrão 0.
desc	string	Optional description; it becomes a stable selector for later calls.
compile	boolean	Recompile the material afterwards (default false; compile once at the end). Padrão false.

Retorna: node, target, errors.

material.add_particle_subuv (risco 2, altera, smoke)

Adds a Particle SubUV node (sprite sheet sampling).

Argumento	Tipo	Descrição
texture	string
blend	boolean	Padrão true.

Retorna: node, target, errors.

material.add_per_instance_custom_data (risco 2, altera, smoke)

Adds a Per Instance Custom Data node reading one float slot.

Argumento	Tipo	Descrição
index	integer	Index or slot (per-instance custom data index, light index, dynamic-parameter index). Padrão 0.

Retorna: node, target, errors.

material.add_per_instance_fade_amount (risco 2, altera, smoke)

Adds a Per Instance Fade Amount node.

Argumento	Tipo	Descrição
target	string	obrigatório. Material or Material Function asset to add the expression to.
x	integer	Padrão 0.
y	integer	Padrão 0.
desc	string	Optional description; it becomes a stable selector for later calls.
compile	boolean	Recompile the material afterwards (default false; compile once at the end). Padrão false.

Retorna: node, target, errors.

material.add_per_instance_random (risco 2, altera, smoke)

Adds a Per Instance Random node.

Argumento	Tipo	Descrição
target	string	obrigatório. Material or Material Function asset to add the expression to.
x	integer	Padrão 0.
y	integer	Padrão 0.
desc	string	Optional description; it becomes a stable selector for later calls.
compile	boolean	Recompile the material afterwards (default false; compile once at the end). Padrão false.

Retorna: node, target, errors.

material.add_pixel_depth (risco 2, altera, smoke)

Adds a Pixel Depth node.

Argumento	Tipo	Descrição
target	string	obrigatório. Material or Material Function asset to add the expression to.
x	integer	Padrão 0.
y	integer	Padrão 0.
desc	string	Optional description; it becomes a stable selector for later calls.
compile	boolean	Recompile the material afterwards (default false; compile once at the end). Padrão false.

Retorna: node, target, errors.

material.add_pixel_normal_ws (risco 2, altera, smoke)

Adds a Pixel Normal (world space) node.

Argumento	Tipo	Descrição
target	string	obrigatório. Material or Material Function asset to add the expression to.
x	integer	Padrão 0.
y	integer	Padrão 0.
desc	string	Optional description; it becomes a stable selector for later calls.
compile	boolean	Recompile the material afterwards (default false; compile once at the end). Padrão false.

Retorna: node, target, errors.

material.add_previous_frame_switch (risco 2, altera, smoke)

Adds a Previous Frame Switch node.

Argumento	Tipo	Descrição
target	string	obrigatório. Material or Material Function asset to add the expression to.
x	integer	Padrão 0.
y	integer	Padrão 0.
desc	string	Optional description; it becomes a stable selector for later calls.
compile	boolean	Recompile the material afterwards (default false; compile once at the end). Padrão false.

Retorna: node, target, errors.

material.add_quality_switch (risco 2, altera, smoke)

Adds a Quality Switch node.

Argumento	Tipo	Descrição
target	string	obrigatório. Material or Material Function asset to add the expression to.
x	integer	Padrão 0.
y	integer	Padrão 0.
desc	string	Optional description; it becomes a stable selector for later calls.
compile	boolean	Recompile the material afterwards (default false; compile once at the end). Padrão false.

Retorna: node, target, errors.

material.add_ray_tracing_quality_switch (risco 2, altera, smoke)

Adds a Ray Tracing Quality Switch node.

Argumento	Tipo	Descrição
target	string	obrigatório. Material or Material Function asset to add the expression to.
x	integer	Padrão 0.
y	integer	Padrão 0.
desc	string	Optional description; it becomes a stable selector for later calls.
compile	boolean	Recompile the material afterwards (default false; compile once at the end). Padrão false.

Retorna: node, target, errors.

material.add_reflection_vector (risco 2, altera, smoke)

Adds a Reflection Vector (world space) node.

Argumento	Tipo	Descrição
target	string	obrigatório. Material or Material Function asset to add the expression to.
x	integer	Padrão 0.
y	integer	Padrão 0.
desc	string	Optional description; it becomes a stable selector for later calls.
compile	boolean	Recompile the material afterwards (default false; compile once at the end). Padrão false.

Retorna: node, target, errors.

material.add_reroute (risco 2, altera, smoke)

Adds a reroute node (a pass-through used to tidy long wires).

Argumento	Tipo	Descrição
target	string	obrigatório. Material or Material Function asset to add the expression to.
x	integer	Padrão 0.
y	integer	Padrão 0.
desc	string	Optional description; it becomes a stable selector for later calls.
compile	boolean	Recompile the material afterwards (default false; compile once at the end). Padrão false.

Retorna: node, target, errors.

material.add_rotator (risco 2, altera, smoke)

Adds a Rotator node (rotates UVs over time).

Argumento	Tipo	Descrição
centerX	number	Padrão 0.5.
centerY	number	Padrão 0.5.
speed	number	Padrão 0.25.

Retorna: node, target, errors.

material.add_runtime_virtual_texture_sample (risco 2, altera, smoke)

Adds a Runtime Virtual Texture Sample node.

Argumento	Tipo	Descrição
virtualTexture	string	Runtime Virtual Texture asset (optional).
materialType	string	base_color / base_color_normal_roughness / base_color_normal_specular / world_height / ...

Retorna: node, target, errors.

material.add_scalar_parameter (risco 2, altera, smoke)

Adds a scalar parameter with a group, default and slider range.

Argumento	Tipo	Descrição
name	string	obrigatório.
defaultValue	number	Padrão 0.0.
group	string
min	number	Padrão 0.0.
max	number	Padrão 1.0.
sortPriority	integer	Padrão 32.

Retorna: node, target, errors.

material.add_scene_color (risco 2, altera, smoke)

Adds a Scene Color node.

Argumento	Tipo	Descrição
target	string	obrigatório. Material or Material Function asset to add the expression to.
x	integer	Padrão 0.
y	integer	Padrão 0.
desc	string	Optional description; it becomes a stable selector for later calls.
compile	boolean	Recompile the material afterwards (default false; compile once at the end). Padrão false.

Retorna: node, target, errors.

material.add_scene_depth (risco 2, altera, smoke)

Adds a Scene Depth node.

Argumento	Tipo	Descrição
target	string	obrigatório. Material or Material Function asset to add the expression to.
x	integer	Padrão 0.
y	integer	Padrão 0.
desc	string	Optional description; it becomes a stable selector for later calls.
compile	boolean	Recompile the material afterwards (default false; compile once at the end). Padrão false.

Retorna: node, target, errors.

material.add_scene_texture (risco 2, altera, smoke)

Adds a Scene Texture node (post-process domain).

Argumento	Tipo	Descrição
id	string	Scene texture id, e.g. "PostProcessInput0", "SceneColor", "SceneDepth", "WorldNormal".
filtered	boolean	Padrão false.

Retorna: node, target, errors.

material.add_screen_position (risco 2, altera, smoke)

Adds a Screen Position node.

Argumento	Tipo	Descrição
target	string	obrigatório. Material or Material Function asset to add the expression to.
x	integer	Padrão 0.
y	integer	Padrão 0.
desc	string	Optional description; it becomes a stable selector for later calls.
compile	boolean	Recompile the material afterwards (default false; compile once at the end). Padrão false.

Retorna: node, target, errors.

material.add_shading_path_switch (risco 2, altera, smoke)

Adds a Shading Path Switch node (deferred / forward / mobile).

Argumento	Tipo	Descrição
target	string	obrigatório. Material or Material Function asset to add the expression to.
x	integer	Padrão 0.
y	integer	Padrão 0.
desc	string	Optional description; it becomes a stable selector for later calls.
compile	boolean	Recompile the material afterwards (default false; compile once at the end). Padrão false.

Retorna: node, target, errors.

material.add_sky_atmosphere_light_direction (risco 2, altera, smoke)

Adds a Sky Atmosphere Light Direction node.

Argumento	Tipo	Descrição
index	integer	Index or slot (per-instance custom data index, light index, dynamic-parameter index). Padrão 0.

Retorna: node, target, errors.

material.add_sphere_mask (risco 2, altera, smoke)

Adds a Sphere Mask node.

Argumento	Tipo	Descrição
attenuationRadius	number	Padrão 256.0.
hardnessPercent	number	Padrão 100.0.

Retorna: node, target, errors.

material.add_static_bool (risco 2, altera, smoke)

Adds a static bool constant.

Argumento	Tipo	Descrição
defaultValue	boolean	Padrão true.

Retorna: node, target, errors.

material.add_static_switch (risco 2, altera, smoke)

Adds a static switch (compile-time branch driven by a static bool).

Argumento	Tipo	Descrição
defaultValue	boolean	Padrão true.

Retorna: node, target, errors.

material.add_static_switch_parameter (risco 2, altera, smoke)

Adds a static switch parameter (compile-time branch exposed to instances).

Argumento	Tipo	Descrição
name	string	obrigatório.
defaultValue	boolean	Padrão true.
group	string

Retorna: node, target, errors.

material.add_texture_coordinate (risco 2, altera, smoke)

Adds a Texture Coordinate node with a UV channel and tiling.

Argumento	Tipo	Descrição
index	integer	UV channel (default 0). Padrão 0.
uTiling	number	Padrão 1.0.
vTiling	number	Padrão 1.0.

Retorna: node, target, errors.

material.add_texture_object (risco 2, altera, smoke)

Adds a Texture Object node (a texture reference passed into a material function).

Argumento	Tipo	Descrição
texture	string	Texture asset, e.g. "/Engine/EngineResources/DefaultTexture".
samplerType	string	auto (from the texture) / color / linear_color / normal / masks / alpha / grayscale / linear_grayscale / distance_field / virtual_color / virtual_normal / virtual_masks.
mipValueMode	string	none / mip_level / mip_bias / derivative.
uvNode	string	Expression to plug into the Coordinates input.

Retorna: node, target, errors.

material.add_texture_object_parameter (risco 2, altera, smoke)

Adds a Texture Object Parameter node.

Argumento	Tipo	Descrição
name	string	obrigatório.
group	string

Retorna: node, target, errors.

material.add_texture_parameter (risco 2, altera, smoke)

Adds a Texture Sample Parameter (a texture slot instances can override).

Argumento	Tipo	Descrição
name	string	obrigatório.
group	string

Retorna: node, target, errors.

material.add_texture_property (risco 2, altera, smoke)

Adds a Texture Property node (texture size or texel size).

Argumento	Tipo	Descrição
texture	string	Texture asset to read the property from.
property	string	texture_size (default) or texel_size.

Retorna: node, target, errors.

material.add_texture_sample (risco 2, altera, smoke)

Adds a Texture Sample node with a texture, sampler type and optional UV source.

Argumento	Tipo	Descrição
texture	string	Texture asset, e.g. "/Engine/EngineResources/DefaultTexture".
samplerType	string	auto (from the texture) / color / linear_color / normal / masks / alpha / grayscale / linear_grayscale / distance_field / virtual_color / virtual_normal / virtual_masks.
mipValueMode	string	none / mip_level / mip_bias / derivative.
uvNode	string	Expression to plug into the Coordinates input.

Retorna: node, target, errors.

material.add_time (risco 2, altera, smoke)

Adds a Time node.

Argumento	Tipo	Descrição
ignorePause	boolean	Padrão false.
period	number	Period to wrap the time value with (0 = no wrapping). Padrão 0.0.

Retorna: node, target, errors.

material.add_transform (risco 2, altera, smoke)

Adds a Transform node (converts a vector between tangent/local/world/view spaces).

Argumento	Tipo	Descrição
source	string	tangent / local / world / view / camera / particle (position nodes: local / world / translated_world / view / camera / particle).
destination	string	Destination space, same vocabulary as "source".

Retorna: node, target, errors.

material.add_transform_position (risco 2, altera, smoke)

Adds a Transform Position node.

Argumento	Tipo	Descrição
source	string	tangent / local / world / view / camera / particle (position nodes: local / world / translated_world / view / camera / particle).
destination	string	Destination space, same vocabulary as "source".

Retorna: node, target, errors.

material.add_two_sided_sign (risco 2, altera, smoke)

Adds a Two Sided Sign node (+1 on the front face, -1 on the back face).

Argumento	Tipo	Descrição
target	string	obrigatório. Material or Material Function asset to add the expression to.
x	integer	Padrão 0.
y	integer	Padrão 0.
desc	string	Optional description; it becomes a stable selector for later calls.
compile	boolean	Recompile the material afterwards (default false; compile once at the end). Padrão false.

Retorna: node, target, errors.

material.add_vector_noise (risco 2, altera, smoke)

Adds a Vector Noise node.

Argumento	Tipo	Descrição
function	string	cellnoise / perlin_3d / perlin_gradient / perlin_curl / voronoi.

Retorna: node, target, errors.

material.add_vector_parameter (risco 2, altera, smoke)

Adds a vector (colour) parameter.

Argumento	Tipo	Descrição
name	string	obrigatório.
color	UeaMatColor
group	string
sortPriority	integer	Padrão 32.

Retorna: node, target, errors.

material.add_vertex_color (risco 2, altera, smoke)

Adds a Vertex Color node.

Argumento	Tipo	Descrição
target	string	obrigatório. Material or Material Function asset to add the expression to.
x	integer	Padrão 0.
y	integer	Padrão 0.
desc	string	Optional description; it becomes a stable selector for later calls.
compile	boolean	Recompile the material afterwards (default false; compile once at the end). Padrão false.

Retorna: node, target, errors.

material.add_vertex_interpolator (risco 2, altera, smoke)

Adds a Vertex Interpolator node (moves a computation to the vertex shader).

Argumento	Tipo	Descrição
target	string	obrigatório. Material or Material Function asset to add the expression to.
x	integer	Padrão 0.
y	integer	Padrão 0.
desc	string	Optional description; it becomes a stable selector for later calls.
compile	boolean	Recompile the material afterwards (default false; compile once at the end). Padrão false.

Retorna: node, target, errors.

material.add_vertex_normal_ws (risco 2, altera, smoke)

Adds a Vertex Normal (world space) node.

Argumento	Tipo	Descrição
target	string	obrigatório. Material or Material Function asset to add the expression to.
x	integer	Padrão 0.
y	integer	Padrão 0.
desc	string	Optional description; it becomes a stable selector for later calls.
compile	boolean	Recompile the material afterwards (default false; compile once at the end). Padrão false.

Retorna: node, target, errors.

material.add_vertex_tangent_ws (risco 2, altera, smoke)

Adds a Vertex Tangent (world space) node.

Argumento	Tipo	Descrição
target	string	obrigatório. Material or Material Function asset to add the expression to.
x	integer	Padrão 0.
y	integer	Padrão 0.
desc	string	Optional description; it becomes a stable selector for later calls.
compile	boolean	Recompile the material afterwards (default false; compile once at the end). Padrão false.

Retorna: node, target, errors.

material.add_view_size (risco 2, altera, smoke)

Adds a View Size node.

Argumento	Tipo	Descrição
target	string	obrigatório. Material or Material Function asset to add the expression to.
x	integer	Padrão 0.
y	integer	Padrão 0.
desc	string	Optional description; it becomes a stable selector for later calls.
compile	boolean	Recompile the material afterwards (default false; compile once at the end). Padrão false.

Retorna: node, target, errors.

material.add_virtual_texture_feature_switch (risco 2, altera, smoke)

Adds a Virtual Texture Feature Switch node.

Argumento	Tipo	Descrição
target	string	obrigatório. Material or Material Function asset to add the expression to.
x	integer	Padrão 0.
y	integer	Padrão 0.
desc	string	Optional description; it becomes a stable selector for later calls.
compile	boolean	Recompile the material afterwards (default false; compile once at the end). Padrão false.

Retorna: node, target, errors.

material.add_world_position (risco 2, altera, smoke)

Adds a World Position node.

Argumento	Tipo	Descrição
target	string	obrigatório. Material or Material Function asset to add the expression to.
x	integer	Padrão 0.
y	integer	Padrão 0.
desc	string	Optional description; it becomes a stable selector for later calls.
compile	boolean	Recompile the material afterwards (default false; compile once at the end). Padrão false.

Retorna: node, target, errors.

material.arrange_nodes (risco 2, altera, smoke)

Auto-arranges the expressions of a material or function graph.

Argumento	Tipo	Descrição
target	string	obrigatório. Material or Material Function asset path / unique name.

Retorna: count, items.

material.batch_reparent (risco 3, altera, smoke)

Reparents several instances at once.

Argumento	Tipo	Descrição
instances	array of string	obrigatório.
newParent	string	obrigatório.

Retorna: count, items.

material.batch_set_scalar (risco 2, altera, smoke)

Sets the same scalar parameter on every instance of a list or a folder.

Argumento	Tipo	Descrição
instances	array of string	Instances to change; leave empty to use "folder".
folder	string	Content folder whose instances are changed.
name	string	obrigatório.
value	number	Scalar value (material.batch_set_scalar). Padrão 0.0.
texture	string	Texture asset (material.batch_set_texture).

Retorna: count, items.

material.batch_set_texture (risco 2, altera, smoke)

Sets the same texture parameter on every instance of a list or a folder.

Argumento	Tipo	Descrição
instances	array of string	Instances to change; leave empty to use "folder".
folder	string	Content folder whose instances are changed.
name	string	obrigatório.
value	number	Scalar value (material.batch_set_scalar). Padrão 0.0.
texture	string	Texture asset (material.batch_set_texture).

Retorna: count, items.

material.build_graph (risco 3, altera, smoke)

Builds a whole expression graph from a node list and a link list in one call; the fastest way to author a material.

Argumento	Tipo	Descrição
target	string	obrigatório.
nodes	array of UeaMatBuildNode	obrigatório. Expressions to create.
links	array of UeaMatLink	Links between the new nodes and to material properties.
replace	boolean	Delete the existing expressions first. Padrão false.
layout	boolean	Auto-arrange the graph afterwards (default true). Padrão true.
compile	boolean	Recompile afterwards (default true). Padrão true.

Retorna: nodes, links, comments, nodeCount, linkCount, target.

material.clear_all_parameters (risco 5, altera, destrutivo, smoke)

Removes every override of an instance.

Argumento	Tipo	Descrição
instance	string	obrigatório. Material Instance Constant asset.

Retorna: parameters, total, overriddenCount.

material.clear_graph (risco 5, altera, destrutivo, smoke)

Deletes every expression and comment of a graph.

Argumento	Tipo	Descrição
target	string	obrigatório. Material or Material Function asset path / unique name.

Retorna: count, items.

material.clear_parameter (risco 2, altera, smoke)

Removes one override so the parameter inherits the parent value again.

Argumento	Tipo	Descrição
instance	string	obrigatório.
name	string	obrigatório.

Retorna: parameters, total, overriddenCount.

material.compare_instances (risco 0, smoke)

Compares the overrides of two instances.

Argumento	Tipo	Descrição
a	string	obrigatório.
b	string	obrigatório.

Retorna: identical, differences, onlyInA, onlyInB, sameParent.

material.compile (risco 2, altera, smoke)

Recompiles a material (or the base material of an instance) and returns the compile errors and the new statistics. Slow: call it once after a batch of graph edits.

Argumento	Tipo	Descrição
material	string	obrigatório. Material or material instance asset.

Retorna: errors, warnings, errorCount, stats.

material.connect (risco 2, altera, smoke)

Connects an expression output to a material property ("BaseColor") or to another expression input ("Node.Input").

Argumento	Tipo	Descrição
target	string	obrigatório.
node	string	obrigatório. Source expression.
output	string	Output name or index (default the first output).
to	string	obrigatório. Material property ("BaseColor", "Roughness", "CustomizedUV0", ...) or "OtherNode.Input".
compile	boolean	Recompile after the change (default false). Padrão false.

Retorna: node, target, errors.

material.connect_many (risco 2, altera, smoke)

Makes several connections in one call; reports the ones that failed.

Argumento	Tipo	Descrição
target	string	obrigatório.
links	array of UeaMatLink	obrigatório.
compile	boolean	Recompile after the change (default false). Padrão false.

Retorna: count, items.

material.copy_parameters (risco 2, altera, smoke)

Copies parameter overrides from one instance (or material) to another.

Argumento	Tipo	Descrição
from	string	obrigatório. Source instance or material.
to	string	obrigatório. Destination instance.
onlyOverridden	boolean	Only copy the parameters the source overrides (default true). Padrão true.

Retorna: parameters, total, overriddenCount.

material.create (risco 2, altera, smoke)

Creates a Material asset with a domain, blend mode and shading model; optionally copies another material as a template. Returns its settings.

Argumento	Tipo	Descrição
folder	string	obrigatório. Destination content folder, e.g. "/Game/Materials".
name	string	obrigatório. Asset name without path.
domain	string	surface (default) / deferred_decal / light_function / volume / post_process / ui / runtime_virtual_texture.
blendMode	string	opaque (default) / masked / translucent / additive / modulate / alpha_composite / alpha_holdout.
shadingModel	string	default_lit (default) / unlit / subsurface / preintegrated_skin / clear_coat / subsurface_profile / two_sided_foliage / hair / cloth / eye / single_layer_water / thin_translucent / from_material_expression.
twoSided	boolean	Render both faces. Padrão false.
opacityMaskClipValue	number	Alpha threshold of masked materials (default 0.3333). Padrão 0.3333.
template	string	Material to copy the expression graph and settings from.
compile	boolean	Recompile after creation (default true). Padrão true.
save	boolean	Save the package to disk. Padrão false.

Retorna: asset, settings, connectedProperties, stats, errors.

material.create_function (risco 2, altera, smoke)

Creates a Material Function with the given input and output declarations, optionally exposing it to the material palette.

Argumento	Tipo	Descrição
folder	string	obrigatório.
name	string	obrigatório.
description	string
exposeToLibrary	boolean	Publish the function in the material palette. Padrão false.
libraryCategories	array of string	Palette categories when exposed.
inputs	array of UeaMatFunctionParam	Input declarations to create.
outputs	array of string	Output names to create.
save	boolean	Padrão false.

Retorna: asset, description, exposeToLibrary, libraryCategories, inputs, outputs, nodeCount, users.

material.create_function_instance (risco 2, altera, smoke)

Creates a Material Function Instance from a function (or a material layer / layer blend).

Argumento	Tipo	Descrição
function	string	obrigatório. Parent material function (or layer / layer blend).
folder	string	obrigatório.
name	string	obrigatório.
scalars	array of UeaMatScalarValue
vectors	array of UeaMatVectorValue
textures	array of UeaMatTextureValue

Retorna: asset, errors, notes.

material.create_instance (risco 2, altera, smoke)

Creates a Material Instance Constant from a parent material or instance, applying the given parameter overrides.

Argumento	Tipo	Descrição
parent	string	obrigatório. Parent material or material instance.
folder	string	obrigatório.
name	string	obrigatório.
scalars	array of UeaMatScalarValue
vectors	array of UeaMatVectorValue
textures	array of UeaMatTextureValue
switches	array of UeaMatSwitchValue
compile	boolean	Update the instance's shaders after the overrides (default true). Padrão true.
save	boolean	Padrão false.

Retorna: asset, parent, parentChain, baseMaterial, parameters, overriddenCount, overrides.

material.create_instance_variants (risco 2, altera, smoke)

Creates several instances of the same parent, one per variant, each with its own overrides.

Argumento	Tipo	Descrição
parent	string	obrigatório.
folder	string	obrigatório.
variants	array of UeaMatVariant	obrigatório.
save	boolean	Padrão false.

Retorna: assets, total.

material.create_layer (risco 2, altera, UE 5.0+, smoke)

Creates a Material Layer function asset.

Argumento	Tipo	Descrição
folder	string	obrigatório.
name	string	obrigatório.
description	string
save	boolean	Padrão false.

Retorna: asset, errors, notes.

material.create_layer_blend (risco 2, altera, UE 5.0+, smoke)

Creates a Material Layer Blend function asset.

Argumento	Tipo	Descrição
folder	string	obrigatório.
name	string	obrigatório.
description	string
save	boolean	Padrão false.

Retorna: asset, errors, notes.

material.delete (risco 3, altera, destrutivo, smoke)

Deletes a material asset. References to it are broken.

Argumento	Tipo	Descrição
material	string	obrigatório. Material asset path or unique name.

Retorna: count, items.

material.delete_function (risco 3, altera, destrutivo, smoke)

Deletes a material function.

Argumento	Tipo	Descrição
function	string	obrigatório. Material Function asset path or unique name.

Retorna: count, items.

material.delete_instance (risco 3, altera, destrutivo, smoke)

Deletes a material instance.

Argumento	Tipo	Descrição
instance	string	obrigatório. Material Instance Constant asset.

Retorna: count, items.

material.delete_node (risco 3, altera, smoke)

Deletes one expression and breaks every link that touched it.

Argumento	Tipo	Descrição
target	string	obrigatório.
node	string	obrigatório. Expression object name, description, "#index" or parameter name.

Retorna: count, items.

material.delete_nodes (risco 3, altera, destrutivo, smoke)

Deletes several expressions at once.

Argumento	Tipo	Descrição
target	string	obrigatório.
nodes	array of string	obrigatório. Expression selectors.

Retorna: count, items.

material.disconnect (risco 2, altera, smoke)

Breaks the connection feeding a material property or an expression input.

Argumento	Tipo	Descrição
target	string	obrigatório.
to	string	obrigatório. Material property ("BaseColor") or "Node.Input".
compile	boolean	Recompile after the change (default false). Padrão false.

Retorna: count, items.

material.disconnect_node (risco 2, altera, smoke)

Breaks every link that reaches or leaves an expression.

Argumento	Tipo	Descrição
target	string	obrigatório.
node	string	obrigatório.
outgoing	boolean	Also unplug the expressions this one feeds (default true). Padrão true.
incoming	boolean	Also unplug this expression's own inputs (default true). Padrão true.

Retorna: count, items.

material.duplicate (risco 2, altera, smoke)

Duplicates a material into a folder under a new name.

Argumento	Tipo	Descrição
material	string	obrigatório. Source asset.
folder	string	obrigatório. Destination folder.
name	string	obrigatório. Name of the copy.

Retorna: asset, errors, notes.

material.duplicate_function (risco 2, altera, smoke)

Duplicates a material function.

Argumento	Tipo	Descrição
material	string	obrigatório. Source asset.
folder	string	obrigatório. Destination folder.
name	string	obrigatório. Name of the copy.

Retorna: asset, errors, notes.

material.duplicate_instance (risco 2, altera, smoke)

Duplicates a material instance.

Argumento	Tipo	Descrição
material	string	obrigatório. Source asset.
folder	string	obrigatório. Destination folder.
name	string	obrigatório. Name of the copy.

Retorna: asset, errors, notes.

material.duplicate_node (risco 2, altera, smoke)

Duplicates an expression, offset from the original; the copy keeps the property values, not the links.

Argumento	Tipo	Descrição
target	string	obrigatório.
node	string	obrigatório.
offsetX	integer	X offset of the copy (default 40). Padrão 40.
offsetY	integer	Y offset of the copy (default 40). Padrão 40.

Retorna: node, target, errors.

material.export_function_graph (risco 0, smoke)

Exports a function graph as JSON (same format as material.export_graph).

Argumento	Tipo	Descrição
function	string	obrigatório. Material Function asset path or unique name.

Retorna: json, nodeCount, linkCount.

material.export_graph (risco 0, smoke)

Exports the whole expression graph plus the material settings as a JSON document (feed it back to material.import_graph).

Argumento	Tipo	Descrição
material	string	obrigatório. Material asset path or unique name.

Retorna: json, nodeCount, linkCount.

material.find_by_expression_class (risco 0, smoke)

Materials whose graph contains an expression of a given class.

Argumento	Tipo	Descrição
reference	string	obrigatório. Texture, function or expression class to look for.
folder	string	Content folder to search (default "/Game").
limit	integer	Maximum results (default 100). Padrão 100.

Retorna: assets, total.

material.find_by_texture (risco 0, smoke)

Materials whose graph samples a given texture.

Argumento	Tipo	Descrição
reference	string	obrigatório. Texture, function or expression class to look for.
folder	string	Content folder to search (default "/Game").
limit	integer	Maximum results (default 100). Padrão 100.

Retorna: assets, total.

material.find_instances_using_texture (risco 0, smoke)

Material instances referencing a texture through one of their texture parameters.

Argumento	Tipo	Descrição
reference	string	obrigatório. Texture, function or expression class to look for.
folder	string	Content folder to search (default "/Game").
limit	integer	Maximum results (default 100). Padrão 100.

Retorna: assets, total.

material.find_node (risco 0, smoke)

Searches expressions by description, caption, class or parameter name.

Argumento	Tipo	Descrição
target	string	obrigatório.
query	string	Text matched against the object name, description, caption, class and parameter name.
class	string	Restrict to one expression class.
limit	integer	Padrão 50.

Retorna: nodes, total, target.

material.function_from_nodes (risco 3, altera)

Moves a selection of expressions of a material into a new material function, wiring inputs and outputs from the links that crossed the selection. SmokeSkip: it needs an existing multi-node selection in a material, which the sandbox chain only builds in a later class.

Argumento	Tipo	Descrição
material	string	obrigatório. Source material.
nodes	array of string	obrigatório. Expressions to move into the function.
folder	string	obrigatório.
name	string	obrigatório.
replaceWithCall	boolean	Replace the extracted expressions with a call to the new function (default true). Padrão true.

Retorna: asset, description, exposeToLibrary, libraryCategories, inputs, outputs, nodeCount, users.

material.get (risco 0, smoke)

Settings, connected material properties and shader statistics of a material.

Argumento	Tipo	Descrição
material	string	obrigatório. Material asset path or unique name.

Retorna: asset, settings, connectedProperties, stats, errors.

material.get_compile_errors (risco 0, smoke)

Compile errors of a material's current shader map, without triggering a recompile.

Argumento	Tipo	Descrição
material	string	obrigatório. Material or material instance asset.

Retorna: errors, warnings, errorCount, stats.

material.get_dynamic_instances (risco 0, requer mundo, smoke)

Actors of the current level whose components use a dynamic instance created from this material or instance.

Argumento	Tipo	Descrição
material	string	obrigatório. Material asset path or unique name.

Retorna: values, total.

material.get_expression_class_info (risco 0, smoke)

Pins, categories and editable properties of one material expression class.

Argumento	Tipo	Descrição
class	string	obrigatório. Expression class name or short alias ("Multiply", "MaterialExpressionMultiply").

Retorna: info.

material.get_function (risco 0, smoke)

Inputs, outputs, node count, library flags and users of a material function.

Argumento	Tipo	Descrição
function	string	obrigatório. Material Function asset path or unique name.

Retorna: asset, description, exposeToLibrary, libraryCategories, inputs, outputs, nodeCount, users.

material.get_function_inputs (risco 0, smoke)

Input declarations of a material function.

Argumento	Tipo	Descrição
function	string	obrigatório. Material Function asset path or unique name.

Retorna: params, total.

material.get_function_outputs (risco 0, smoke)

Output declarations of a material function.

Argumento	Tipo	Descrição
function	string	obrigatório. Material Function asset path or unique name.

Retorna: params, total.

material.get_graph (risco 0, smoke)

Nodes and links of a graph in one payload: the overview an agent needs before editing.

Argumento	Tipo	Descrição
target	string	obrigatório. Material or Material Function asset path / unique name.

Retorna: nodes, links, comments, nodeCount, linkCount, target.

material.get_hierarchy (risco 0, smoke)

Instances derived from a material, the material functions it calls and the textures it uses.

Argumento	Tipo	Descrição
material	string	obrigatório. Material asset path or unique name.

Retorna: instances, functions, textures.

material.get_input_source (risco 0, smoke)

Expression and output feeding a material property or an expression input.

Argumento	Tipo	Descrição
target	string	obrigatório.
to	string	obrigatório. Material property ("BaseColor") or "Node.Input".

Retorna: connected, fromNode, fromClass, fromOutput, fromOutputName.

material.get_instance (risco 0, smoke)

Parent chain, every parameter with its value, its parent value and whether the instance overrides it.

Argumento	Tipo	Descrição
instance	string	obrigatório. Material Instance Constant asset.

Retorna: asset, parent, parentChain, baseMaterial, parameters, overriddenCount, overrides.

material.get_instance_chain (risco 0, smoke)

Parent chain of an instance, from the instance itself up to the base material.

Argumento	Tipo	Descrição
instance	string	obrigatório. Material Instance Constant asset.

Retorna: chain, baseMaterial.

material.get_instance_overrides (risco 0, smoke)

Base-property overrides currently active on an instance.

Argumento	Tipo	Descrição
instance	string	obrigatório. Material Instance Constant asset.

Retorna: overrides, active.

material.get_layer_parameters (risco 0, UE 5.0+, smoke)

Parameters exposed by the layers of a material instance, per layer.

Argumento	Tipo	Descrição
instance	string	obrigatório.
layerIndex	integer	Layer index; negative lists every layer. Padrão -1.

Retorna: parameters, total, overriddenCount.

material.get_layers (risco 0, UE 5.0+, smoke)

Layer stack of a material (from its layers expression) or of a material instance (from its static parameters).

Argumento	Tipo	Descrição
target	string	obrigatório. Material or Material Instance that owns the layer stack.

Retorna: layers, total, node.

material.get_node (risco 0, smoke)

One expression with its position, description, inputs and outputs.

Argumento	Tipo	Descrição
target	string	obrigatório.
node	string	obrigatório. Expression object name, description, "#index" or parameter name.

Retorna: node, target, errors.

material.get_node_inputs (risco 0, smoke)

Input pins of an expression with what feeds them.

Argumento	Tipo	Descrição
target	string	obrigatório.
node	string	obrigatório. Expression object name, description, "#index" or parameter name.

Retorna: node, target, errors.

material.get_node_outputs (risco 0, smoke)

Output pins of an expression.

Argumento	Tipo	Descrição
target	string	obrigatório.
node	string	obrigatório. Expression object name, description, "#index" or parameter name.

Retorna: node, target, errors.

material.get_node_property (risco 0, smoke)

Reads one property of an expression as text.

Argumento	Tipo	Descrição
target	string	obrigatório.
node	string	obrigatório.
property	string	obrigatório. Property name on the expression class, e.g. "Texture", "SamplerType", "ConstCoordinate".
value	string	New value in text form (numbers, enum names, asset paths).

Retorna: value, overridden, parentValue.

material.get_parameter_info (risco 0, smoke)

Type, group, sort priority, parent default and override state of one parameter.

Argumento	Tipo	Descrição
instance	string	obrigatório.
name	string	obrigatório.

Retorna: parameter.

material.get_properties_connected (risco 0, smoke)

Material properties (BaseColor, Roughness, ...) currently driven by an expression.

Argumento	Tipo	Descrição
material	string	obrigatório. Material asset path or unique name.

Retorna: values, total.

material.get_scalar (risco 0, smoke)

Value of one scalar parameter, with the parent value and whether it is overridden.

Argumento	Tipo	Descrição
instance	string	obrigatório.
name	string	obrigatório.

Retorna: value, overridden, parentValue.

material.get_static_switch (risco 0, smoke)

Value of one static switch parameter.

Argumento	Tipo	Descrição
instance	string	obrigatório.
name	string	obrigatório.

Retorna: value, overridden, parentValue.

material.get_stats (risco 0, smoke)

Shader instruction counts, sampler and interpolator usage of a material or instance, without recompiling.

Argumento	Tipo	Descrição
material	string	obrigatório. Material or material instance asset.

Retorna: stats, material.

material.get_texture (risco 0, smoke)

Value of one texture parameter.

Argumento	Tipo	Descrição
instance	string	obrigatório.
name	string	obrigatório.

Retorna: value, overridden, parentValue.

material.get_texture_samplers (risco 0, smoke)

Texture sampler nodes of a material with the sampler type they declare and the one their texture implies.

Argumento	Tipo	Descrição
material	string	obrigatório. Material asset path or unique name.

Retorna: samplers, total, mismatchCount.

material.get_vector (risco 0, smoke)

Value of one vector parameter.

Argumento	Tipo	Descrição
instance	string	obrigatório.
name	string	obrigatório.

Retorna: value, overridden, parentValue.

material.import_function_graph (risco 3, altera)

Rebuilds a function graph from JSON. SmokeSkip: the argument is a nested JSON document, which cannot be expressed in smoke metadata.

Argumento	Tipo	Descrição
material	string	obrigatório.
json	string	obrigatório. JSON produced by material.export_graph.
replace	boolean	Delete the existing expressions first (default true). Padrão true.
compile	boolean	Recompile after the import (default true). Padrão true.

Retorna: nodes, links, comments, nodeCount, linkCount, target.

material.import_graph (risco 3, altera)

Rebuilds a material's graph from a JSON document produced by material.export_graph. SmokeSkip: the argument is a nested JSON document, which cannot be expressed in smoke metadata.

Argumento	Tipo	Descrição
material	string	obrigatório.
json	string	obrigatório. JSON produced by material.export_graph.
replace	boolean	Delete the existing expressions first (default true). Padrão true.
compile	boolean	Recompile after the import (default true). Padrão true.

Retorna: nodes, links, comments, nodeCount, linkCount, target.

material.inline_function_call (risco 3, altera)

Expands a Material Function Call node into the calling graph. SmokeSkip: it needs an existing function-call node, which the sandbox chain only creates in a later class.

Argumento	Tipo	Descrição
target	string	obrigatório.
node	string	obrigatório. The MaterialFunctionCall expression to expand.

Retorna: nodes, links, comments, nodeCount, linkCount, target.

material.is_connected (risco 0, smoke)

True when a material property or an expression input is driven by something.

Argumento	Tipo	Descrição
target	string	obrigatório.
to	string	obrigatório. Material property ("BaseColor") or "Node.Input".

Retorna: value, detail.

material.list (risco 0, smoke)

Lists Material assets under a folder, filtered by domain, blend mode and name.

Argumento	Tipo	Descrição
folder	string	Content folder to search (default "/Game").
domain	string	Only materials with this domain.
blendMode	string	Only materials with this blend mode.
nameContains	string	Name substring filter.
recursive	boolean	Search subfolders (default true). Padrão true.
limit	integer	Maximum results (default 200). Padrão 200.

Retorna: assets, total.

material.list_comments (risco 0, smoke)

Comment boxes of a graph.

Argumento	Tipo	Descrição
target	string	obrigatório. Material or Material Function asset path / unique name.

Retorna: comments, total.

material.list_engine_functions (risco 0, smoke)

Material functions shipped with the engine, by category (cached asset-registry query).

Argumento	Tipo	Descrição
folder	string	Content folder (default "/Game").
exposedOnly	boolean	Only functions exposed to the material palette. Padrão false.
category	string	Library category filter.
nameContains	string
recursive	boolean	Padrão true.
limit	integer	Padrão 200.

Retorna: functions, total, categories.

material.list_expression_classes (risco 0, smoke)

Every material expression class available on this engine with its pins and editable properties. Use it before material.add_node.

Argumento	Tipo	Descrição
nameContains	string	Name substring filter (e.g. "texture").
category	string	Editor category filter (e.g. "Math").
limit	integer	Maximum results (default 200). Padrão 200.

Retorna: classes, total.

material.list_function_library (risco 0, smoke)

The material function palette: every exposed function grouped by category, with its inputs and outputs.

Argumento	Tipo	Descrição
folder	string	Content folder (default "/Game").
exposedOnly	boolean	Only functions exposed to the material palette. Padrão false.
category	string	Library category filter.
nameContains	string
recursive	boolean	Padrão true.
limit	integer	Padrão 200.

Retorna: functions, total, categories.

material.list_function_users (risco 0, smoke)

Materials and functions that call a given function.

Argumento	Tipo	Descrição
function	string	obrigatório. Material Function asset path or unique name.

Retorna: assets, total.

material.list_functions (risco 0, smoke)

Lists Material Function assets under a folder, optionally only the exposed ones.

Argumento	Tipo	Descrição
folder	string	Content folder (default "/Game").
exposedOnly	boolean	Only functions exposed to the material palette. Padrão false.
category	string	Library category filter.
nameContains	string
recursive	boolean	Padrão true.
limit	integer	Padrão 200.

Retorna: assets, total.

material.list_instance_parameters (risco 0, smoke)

Parameters of an instance, optionally only the ones it overrides.

Argumento	Tipo	Descrição
instance	string	obrigatório.
overriddenOnly	boolean	Only parameters this instance overrides. Padrão false.
type	string	Only parameters of this type (scalar / vector / texture / switch).

Retorna: parameters, total, overriddenCount.

material.list_instances (risco 0, smoke)

Lists Material Instance Constants, optionally only those derived from a given parent.

Argumento	Tipo	Descrição
parent	string	Only instances derived from this material or instance.
folder	string	Content folder (default "/Game").
recursive	boolean	Padrão true.
includeIndirect	boolean	Include grandchildren of the parent (default true). Padrão true.
limit	integer	Padrão 200.

Retorna: assets, total.

material.list_layer_blends (risco 0, UE 5.0+, smoke)

Lists Material Layer Blend assets under a folder.

Argumento	Tipo	Descrição
folder	string	Content folder (default "/Game").
exposedOnly	boolean	Only functions exposed to the material palette. Padrão false.
category	string	Library category filter.
nameContains	string
recursive	boolean	Padrão true.
limit	integer	Padrão 200.

Retorna: assets, total.

material.list_layers (risco 0, UE 5.0+, smoke)

Lists Material Layer assets under a folder.

Argumento	Tipo	Descrição
folder	string	Content folder (default "/Game").
exposedOnly	boolean	Only functions exposed to the material palette. Padrão false.
category	string	Library category filter.
nameContains	string
recursive	boolean	Padrão true.
limit	integer	Padrão 200.

Retorna: assets, total.

material.list_nodes (risco 0, smoke)

Expressions of a material or function graph, with their pins and connections.

Argumento	Tipo	Descrição
target	string	obrigatório.
classFilter	string	Only expressions of this class ("TextureSample", "MaterialExpressionMultiply").
nameContains	string	Name/desc/caption substring filter.
limit	integer	Maximum results (default 500). Padrão 500.

Retorna: nodes, total, target.

material.list_parameters (risco 0, smoke)

Parameters declared by a material or material function graph, with group, default and slider range.

Argumento	Tipo	Descrição
target	string	obrigatório. Material or Material Function asset.
type	string	Only parameters of this type (scalar / vector / texture / switch).
group	string	Only parameters of this group.

Retorna: parameters, total, groups.

material.list_recipes (risco 0, smoke)

Lists the recipes of this kit with the kind of material each produces.

Sem argumentos.

Retorna: recipes, total.

material.list_textures (risco 0, smoke)

Textures referenced by a material's graph.

Argumento	Tipo	Descrição
material	string	obrigatório. Material asset path or unique name.

Retorna: textures, total.

material.list_usages (risco 0, smoke)

Every bUsedWith* flag this engine supports and the ones enabled on the material.

Argumento	Tipo	Descrição
material	string	obrigatório. Material asset path or unique name.

Retorna: available, enabled.

material.move_node (risco 2, altera, smoke)

Moves one expression to an absolute graph position.

Argumento	Tipo	Descrição
target	string	obrigatório.
node	string	obrigatório.
x	integer	Padrão 0.
y	integer	Padrão 0.

Retorna: node, target, errors.

material.move_nodes (risco 2, altera, smoke)

Moves several expressions (or the whole graph) by a delta.

Argumento	Tipo	Descrição
target	string	obrigatório.
nodes	array of string	Expressions to move; empty moves the whole graph.
dx	integer	Padrão 0.
dy	integer	Padrão 0.

Retorna: count, items.

material.recipe_checker (risco 2, altera, smoke)

Procedural checkerboard, no textures needed. The quickest sanity-check material.

Argumento	Tipo	Descrição
colorA	UeaMatColor
colorB	UeaMatColor
scale	number	Padrão 8.0.

Retorna: asset, nodes, parameters, errors, nodeCount.

material.recipe_cloth (risco 2, altera, smoke)

Cloth shading model with a fuzz colour and amount.

Argumento	Tipo	Descrição
baseColor	string
baseColorTint	UeaMatColor
normal	string
roughness	number	Padrão 0.5.
subsurfaceColor	UeaMatColor	Subsurface / fuzz colour depending on the recipe.
amount	number	Cloth fuzz amount or subsurface opacity. Padrão 0.5.

Retorna: asset, nodes, parameters, errors, nodeCount.

material.recipe_decal (risco 2, altera, smoke)

Deferred decal material with base colour, normal and opacity.

Argumento	Tipo	Descrição
baseColor	string
tint	UeaMatColor
normal	string
opacityTexture	string	Texture whose alpha drives the decal opacity.
opacity	number	Padrão 1.0.
dbuffer	boolean	Use a DBuffer decal blend mode. Padrão false.

Retorna: asset, nodes, parameters, errors, nodeCount.

material.recipe_dissolve (risco 2, altera, smoke)

Dissolve effect: a noise source drives an opacity mask with a glowing edge.

Argumento	Tipo	Descrição
baseColor	string
baseColorTint	UeaMatColor
noiseTexture	string	Noise texture; when empty a procedural Noise node is used.
amount	number	Initial dissolve amount (0..1). Padrão 0.5.
edgeColor	UeaMatColor
edgeWidth	number	Padrão 0.05.

Retorna: asset, nodes, parameters, errors, nodeCount.

material.recipe_emissive (risco 2, altera, smoke)

Emissive material with an intensity and an optional sine pulse.

Argumento	Tipo	Descrição
color	UeaMatColor
intensity	number	Padrão 5.0.
pulse	number	Pulse speed; 0 disables the animation. Padrão 0.0.

Retorna: asset, nodes, parameters, errors, nodeCount.

material.recipe_flipbook (risco 2, altera, smoke)

Flipbook animation over a sprite-sheet texture (columns x rows at a frame rate).

Argumento	Tipo	Descrição
texture	string
columns	integer	Padrão 4.
rows	integer	Padrão 4.
fps	number	Padrão 15.0.

Retorna: asset, nodes, parameters, errors, nodeCount.

material.recipe_from_texture_folder (risco 2, altera, dryRun, smoke)

Detects a T_*_BC / _N / _ORM / _R texture set in a folder and builds the matching PBR material.

Argumento	Tipo	Descrição
textureFolder	string	obrigatório. Folder holding the texture set.
nameContains	string	Only textures whose name contains this.
dryRun	boolean	Report the detected mapping without creating anything. Padrão false.

Retorna: asset, nodes, parameters, errors, nodeCount.

material.recipe_glass (risco 2, altera, smoke)

Glass: translucent, low roughness, Fresnel-driven opacity and an index of refraction.

Argumento	Tipo	Descrição
tint	UeaMatColor
roughness	number	Padrão 0.05.
ior	number	Padrão 1.52.
opacity	number	Padrão 0.1.

Retorna: asset, nodes, parameters, errors, nodeCount.

material.recipe_gradient (risco 2, altera, smoke)

Two-colour gradient along the U or V axis.

Argumento	Tipo	Descrição
colorA	UeaMatColor
colorB	UeaMatColor
axis	string	u (default) or v.

Retorna: asset, nodes, parameters, errors, nodeCount.

material.recipe_hologram (risco 2, altera, smoke)

Hologram: translucent scanlines scrolling over an emissive tint.

Argumento	Tipo	Descrição
color	UeaMatColor
scanlineDensity	number	Padrão 40.0.
speed	number	Padrão 0.5.
opacity	number	Padrão 0.6.

Retorna: asset, nodes, parameters, errors, nodeCount.

material.recipe_landscape (risco 2, altera, smoke)

Landscape material blending several layers with a Landscape Layer Blend node.

Argumento	Tipo	Descrição
layers	array of UeaMatRecipeLandscapeLayer	obrigatório.
blendType	string	weight (default) / alpha / height.
macroVariation	boolean	Add a large-scale noise variation on top of the blend. Padrão false.

Retorna: asset, nodes, parameters, errors, nodeCount.

material.recipe_masked (risco 2, altera, smoke)

Masked (cutout) material driven by a texture alpha; optionally two-sided foliage.

Argumento	Tipo	Descrição
texture	string	Texture whose alpha drives the mask (and whose RGB drives base colour).
maskTexture	string	Separate opacity-mask texture.
clipValue	number	Padrão 0.3333.
twoSided	boolean	Padrão true.
foliage	boolean	Use the two-sided foliage shading model with this subsurface colour. Padrão false.
subsurfaceColor	UeaMatColor

Retorna: asset, nodes, parameters, errors, nodeCount.

material.recipe_panner (risco 2, altera, smoke)

Scrolling texture (Panner) feeding base colour.

Argumento	Tipo	Descrição
texture	string
speedX	number	Padrão 0.1.
speedY	number	Padrão 0.0.
tiling	number	Padrão 1.0.

Retorna: asset, nodes, parameters, errors, nodeCount.

material.recipe_parallax (risco 2, altera, smoke)

Parallax (bump offset) material using a height texture.

Argumento	Tipo	Descrição
baseColor	string
height	string
normal	string
heightRatio	number	Padrão 0.05.

Retorna: asset, nodes, parameters, errors, nodeCount.

material.recipe_pbr (risco 2, altera, smoke)

Physically based opaque surface from a texture set (base colour, normal, roughness, metallic, AO, emissive or a packed ORM texture).

Argumento	Tipo	Descrição
baseColor	string	Base colour texture; empty uses the colour below.
baseColorTint	UeaMatColor	Base colour when no texture is given.
normal	string	Normal map texture.
roughness	string	Roughness texture; empty uses roughnessValue.
roughnessValue	number	Padrão 0.5.
metallic	string	Metallic texture; empty uses metallicValue.
metallicValue	number	Padrão 0.0.
ao	string	Ambient occlusion texture.
emissive	string	Emissive texture.
emissiveTint	UeaMatColor
emissiveIntensity	number	Padrão 0.0.
packedOrm	string	Packed occlusion/roughness/metallic texture (R=AO, G=Roughness, B=Metallic).
tiling	number	UV tiling applied to every texture. Padrão 1.0.

Retorna: asset, nodes, parameters, errors, nodeCount.

material.recipe_post_process (risco 2, altera, smoke)

Post-process material applying a tint, a desaturation or a vignette.

Argumento	Tipo	Descrição
effect	string	tint / desaturate / vignette.
color	UeaMatColor
intensity	number	Padrão 1.0.
blendableLocation	string	before_tonemapping (default) / after_tonemapping / before_translucency / replacing_tonemapper.

Retorna: asset, nodes, parameters, errors, nodeCount.

material.recipe_rim_light (risco 2, altera, smoke)

Base colour plus a Fresnel rim light added to the emissive output.

Argumento	Tipo	Descrição
baseColorTint	UeaMatColor
rimColor	UeaMatColor
exponent	number	Padrão 4.0.
intensity	number	Padrão 2.0.

Retorna: asset, nodes, parameters, errors, nodeCount.

material.recipe_subsurface_skin (risco 2, altera, smoke)

Subsurface skin material (preintegrated skin shading model).

Argumento	Tipo	Descrição
baseColor	string
baseColorTint	UeaMatColor
normal	string
roughness	number	Padrão 0.5.
subsurfaceColor	UeaMatColor	Subsurface / fuzz colour depending on the recipe.
amount	number	Cloth fuzz amount or subsurface opacity. Padrão 0.5.

Retorna: asset, nodes, parameters, errors, nodeCount.

material.recipe_translucent (risco 2, altera, smoke)

Translucent material with a colour, an opacity and an optional Fresnel falloff.

Argumento	Tipo	Descrição
color	UeaMatColor
opacity	number	Padrão 0.5.
fresnel	boolean	Add a Fresnel term to the opacity. Padrão false.
ior	number	Padrão 1.0.
unlit	boolean	Use the unlit shading model. Padrão false.

Retorna: asset, nodes, parameters, errors, nodeCount.

material.recipe_triplanar (risco 2, altera, smoke)

Triplanar (world-aligned) projection of a base colour and a normal map.

Argumento	Tipo	Descrição
baseColor	string
normal	string
scale	number	Padrão 256.0.
sharpness	number	Padrão 4.0.

Retorna: asset, nodes, parameters, errors, nodeCount.

material.recipe_two_sided_foliage (risco 2, altera, smoke)

Two-sided foliage: subsurface colour transmitted through thin leaves.

Argumento	Tipo	Descrição
baseColor	string
baseColorTint	UeaMatColor
normal	string
roughness	number	Padrão 0.5.
subsurfaceColor	UeaMatColor	Subsurface / fuzz colour depending on the recipe.
amount	number	Cloth fuzz amount or subsurface opacity. Padrão 0.5.

Retorna: asset, nodes, parameters, errors, nodeCount.

material.recipe_ui (risco 2, altera, smoke)

UI (widget) material: a texture tinted and faded, in the User Interface domain.

Argumento	Tipo	Descrição
texture	string
tint	UeaMatColor
opacity	number	Padrão 1.0.

Retorna: asset, nodes, parameters, errors, nodeCount.

material.recipe_unlit_color (risco 2, altera, smoke)

Flat unlit colour. The cheapest material there is; ideal for blockouts and debug.

Argumento	Tipo	Descrição
color	UeaMatColor

Retorna: asset, nodes, parameters, errors, nodeCount.

material.recipe_vertex_color (risco 2, altera, smoke)

Uses the mesh vertex colour as base colour.

Argumento	Tipo	Descrição
folder	string	Destination folder (ignored when "material" points at an existing asset).
name	string	Name of the material to create.
material	string	Existing material to fill instead of creating one (its graph is cleared).
parameterize	boolean	Expose the recipe's inputs as material parameters (default true). Padrão true.
group	string	Parameter group used when parameterizing.
compile	boolean	Recompile at the end (default true). Padrão true.
save	boolean	Save the package. Padrão false.

Retorna: asset, nodes, parameters, errors, nodeCount.

material.recipe_water_simple (risco 2, altera, smoke)

Simple water surface: scrolling normals, a tinted translucent body and a Fresnel rim.

Argumento	Tipo	Descrição
normal	string	Normal map scrolled over the surface.
speed	number	Padrão 0.05.
color	UeaMatColor
opacity	number	Padrão 0.6.
fresnel	boolean	Padrão true.

Retorna: asset, nodes, parameters, errors, nodeCount.

material.remove_function_input (risco 3, altera, smoke)

Removes one input declaration from a function.

Argumento	Tipo	Descrição
function	string	obrigatório.
name	string	obrigatório.
newName	string	New name (material.rename_function_input).

Retorna: params, total.

material.remove_function_output (risco 3, altera, smoke)

Removes one output declaration from a function.

Argumento	Tipo	Descrição
function	string	obrigatório.
name	string	obrigatório.
newName	string	New name (material.rename_function_input).

Retorna: params, total.

material.remove_layer (risco 3, altera, UE 5.0+, smoke)

Removes one layer (and its blend) from the stack.

Argumento	Tipo	Descrição
target	string	obrigatório.
index	integer	obrigatório.
visible	boolean	Visibility for material.set_layer_visible. Padrão true.
newIndex	integer	New index for material.reorder_layer. Padrão 0.
asset	string	Layer or blend asset for material.set_layer_asset.
slot	string	"layer" (default) or "blend" for material.set_layer_asset.

Retorna: layers, total, node.

material.rename (risco 2, altera, smoke)

Renames a material asset in place.

Argumento	Tipo	Descrição
material	string	obrigatório.
newName	string	obrigatório.

Retorna: asset, errors, notes.

material.rename_function (risco 2, altera, smoke)

Renames a material function.

Argumento	Tipo	Descrição
material	string	obrigatório.
newName	string	obrigatório.

Retorna: asset, errors, notes.

material.rename_function_input (risco 2, altera, smoke)

Renames a function input. Materials calling the function keep their connection by index.

Argumento	Tipo	Descrição
function	string	obrigatório.
name	string	obrigatório.
newName	string	New name (material.rename_function_input).

Retorna: params, total.

material.rename_instance (risco 2, altera, smoke)

Renames a material instance.

Argumento	Tipo	Descrição
material	string	obrigatório.
newName	string	obrigatório.

Retorna: asset, errors, notes.

material.rename_parameter (risco 3, altera, smoke)

Renames a parameter declaration. Instances referencing the old name lose their override.

Argumento	Tipo	Descrição
target	string	obrigatório. Material or Material Function asset.
name	string	obrigatório. Parameter name.
group	string	New parameter group.
value	string	New default value (number, "(R=1,G=0,B=0,A=1)" or a texture asset path).
newName	string	New name (material.rename_parameter).
min	number	Slider minimum (scalar parameters). Padrão 0.0.
max	number	Slider maximum (scalar parameters). Padrão 0.0.
sortPriority	integer	Sort priority in the details panel; negative keeps the current value. Padrão -1.

Retorna: parameter.

material.reorder_layer (risco 2, altera, UE 5.0+, smoke)

Moves one layer to another position in the stack.

Argumento	Tipo	Descrição
target	string	obrigatório.
index	integer	obrigatório.
visible	boolean	Visibility for material.set_layer_visible. Padrão true.
newIndex	integer	New index for material.reorder_layer. Padrão 0.
asset	string	Layer or blend asset for material.set_layer_asset.
slot	string	"layer" (default) or "blend" for material.set_layer_asset.

Retorna: layers, total, node.

material.replace_node_class (risco 3, altera, smoke)

Replaces an expression with another class, reconnecting the inputs whose names match.

Argumento	Tipo	Descrição
target	string	obrigatório.
node	string	obrigatório.
newClass	string	obrigatório. New expression class or alias.

Retorna: node, target, errors.

material.replace_texture (risco 2, altera, smoke)

Replaces every reference to one texture with another across the whole graph. Returns the expressions it changed.

Argumento	Tipo	Descrição
material	string	obrigatório.
from	string	obrigatório. Texture currently referenced.
to	string	obrigatório. Replacement texture.
compile	boolean	Recompile afterwards. Padrão false.

Retorna: count, items.

material.reset_to_parent (risco 5, altera, destrutivo, smoke)

Resets an instance to its parent: every override is dropped.

Argumento	Tipo	Descrição
instance	string	obrigatório. Material Instance Constant asset.

Retorna: asset, parent, parentChain, baseMaterial, parameters, overriddenCount, overrides.

material.save (risco 2, altera, smoke)

Saves a material package to disk.

Argumento	Tipo	Descrição
material	string	obrigatório. Material asset path or unique name.

Retorna: asset, errors, notes.

material.save_function (risco 2, altera, smoke)

Saves a material function package to disk.

Argumento	Tipo	Descrição
function	string	obrigatório. Material Function asset path or unique name.

Retorna: asset, errors, notes.

material.save_instance (risco 2, altera, smoke)

Saves a material instance package to disk.

Argumento	Tipo	Descrição
instance	string	obrigatório. Material Instance Constant asset.

Retorna: asset, errors, notes.

material.set_function_input (risco 2, altera, smoke)

Changes the type, preview value, sort priority and description of one function input.

Argumento	Tipo	Descrição
function	string	obrigatório.
name	string	obrigatório.
type	string
previewValue	UeaMatColor
sortPriority	integer	Negative keeps the current value. Padrão -1.
description	string
usePreviewAsDefault	string	"true" / "false"; empty keeps the current state.

Retorna: params, total.

material.set_function_instance_parameters (risco 2, altera, smoke)

Sets the parameter overrides of a Material Function Instance.

Argumento	Tipo	Descrição
instance	string	obrigatório. Material Function Instance asset.
scalars	array of UeaMatScalarValue
vectors	array of UeaMatVectorValue
textures	array of UeaMatTextureValue

Retorna: asset, errors, notes.

material.set_function_settings (risco 2, altera, smoke)

Changes the description, the expose-to-library flag and the palette categories of a function.

Argumento	Tipo	Descrição
function	string	obrigatório.
description	string
exposeToLibrary	string	"true" / "false"; empty keeps the current state.
categories	array of string

Retorna: asset, description, exposeToLibrary, libraryCategories, inputs, outputs, nodeCount, users.

material.set_instance_overrides (risco 2, altera, smoke)

Overrides blend mode, shading model, two-sided, dithered LOD, opacity mask clip value and shadow flags on an instance. Pass "inherit" to drop an override.

Argumento	Tipo	Descrição
instance	string	obrigatório.
blendMode	string	Blend mode override; "inherit" removes the override.
shadingModel	string	Shading model override; "inherit" removes the override.
twoSided	string	"true" / "false" / "inherit".
ditheredLODTransition	string	"true" / "false" / "inherit".
castDynamicShadowAsMasked	string	"true" / "false" / "inherit".
outputTranslucentVelocity	string	"true" / "false" / "inherit" (5.x only).
opacityMaskClipValue	number	Alpha threshold override; negative keeps the current state. Padrão -1.0.
clearOpacityMaskClipValue	boolean	Remove the opacity-mask-clip-value override. Padrão false.

Retorna: overrides, active.

material.set_instance_physical_material (risco 2, altera, smoke)

Sets (or clears) the physical material override of an instance.

Argumento	Tipo	Descrição
material	string	obrigatório.
physicalMaterial	string	Physical material asset; empty clears it.

Retorna: asset, parent, parentChain, baseMaterial, parameters, overriddenCount, overrides.

material.set_layer_asset (risco 2, altera, UE 5.0+, smoke)

Replaces the layer or blend asset used at one position of the stack.

Argumento	Tipo	Descrição
target	string	obrigatório.
index	integer	obrigatório.
visible	boolean	Visibility for material.set_layer_visible. Padrão true.
newIndex	integer	New index for material.reorder_layer. Padrão 0.
asset	string	Layer or blend asset for material.set_layer_asset.
slot	string	"layer" (default) or "blend" for material.set_layer_asset.

Retorna: layers, total, node.

material.set_layer_parameter (risco 2, altera, UE 5.0+)

Overrides one parameter inside a layer (or its blend) of a material instance. SmokeSkip: it needs an instance whose parent exposes a layer stack with parameters, which the sandbox chain does not build.

Argumento	Tipo	Descrição
instance	string	obrigatório. Material Instance Constant that owns the layer stack.
layerIndex	integer	obrigatório.
name	string	obrigatório.
kind	string	scalar (default) / vector / texture / switch.
value	string	Value as text: a number, "(R=..,G=..,B=..,A=..)", a texture path or true/false.
blend	boolean	Target the blend function of the layer instead of the layer itself. Padrão false.

Retorna: value, overridden, parentValue.

material.set_layer_visible (risco 2, altera, UE 5.0+, smoke)

Shows or hides one layer of the stack.

Argumento	Tipo	Descrição
target	string	obrigatório.
index	integer	obrigatório.
visible	boolean	Visibility for material.set_layer_visible. Padrão true.
newIndex	integer	New index for material.reorder_layer. Padrão 0.
asset	string	Layer or blend asset for material.set_layer_asset.
slot	string	"layer" (default) or "blend" for material.set_layer_asset.

Retorna: layers, total, node.

material.set_layers (risco 3, altera, UE 5.0+, smoke)

Replaces the whole layer stack of a material: layers[0] is the background, blends[i] blends layers[i+1] onto the result.

Argumento	Tipo	Descrição
target	string	obrigatório.
layers	array of string	obrigatório. Material layer function assets, background first.
blends	array of string	Blend function assets; one per layer above the background.
names	array of string	Display names.

Retorna: layers, total, node.

material.set_node_desc (risco 2, altera, smoke)

Sets the description of an expression; it becomes a stable selector for later calls.

Argumento	Tipo	Descrição
target	string	obrigatório.
node	string	obrigatório.
desc	string	New description; it doubles as a stable selector for later calls.

Retorna: node, target, errors.

material.set_node_properties (risco 2, altera, smoke)

Sets several properties of an expression in one call.

Argumento	Tipo	Descrição
target	string	obrigatório.
node	string	obrigatório.
properties	array of UeaKeyValue	obrigatório. Property name/value pairs.

Retorna: node, target, errors.

material.set_node_property (risco 2, altera, smoke)

Sets one property of an expression from text (numbers, enum names, asset paths).

Argumento	Tipo	Descrição
target	string	obrigatório.
node	string	obrigatório.
property	string	obrigatório. Property name on the expression class, e.g. "Texture", "SamplerType", "ConstCoordinate".
value	string	New value in text form (numbers, enum names, asset paths).

Retorna: node, target, errors.

material.set_parameter_default (risco 2, altera, smoke)

Changes the default value of a parameter declaration.

Argumento	Tipo	Descrição
target	string	obrigatório. Material or Material Function asset.
name	string	obrigatório. Parameter name.
group	string	New parameter group.
value	string	New default value (number, "(R=1,G=0,B=0,A=1)" or a texture asset path).
newName	string	New name (material.rename_parameter).
min	number	Slider minimum (scalar parameters). Padrão 0.0.
max	number	Slider maximum (scalar parameters). Padrão 0.0.
sortPriority	integer	Sort priority in the details panel; negative keeps the current value. Padrão -1.

Retorna: parameter.

material.set_parameter_group (risco 2, altera, smoke)

Moves a parameter to another group in the details panel.

Argumento	Tipo	Descrição
target	string	obrigatório. Material or Material Function asset.
name	string	obrigatório. Parameter name.
group	string	New parameter group.
value	string	New default value (number, "(R=1,G=0,B=0,A=1)" or a texture asset path).
newName	string	New name (material.rename_parameter).
min	number	Slider minimum (scalar parameters). Padrão 0.0.
max	number	Slider maximum (scalar parameters). Padrão 0.0.
sortPriority	integer	Sort priority in the details panel; negative keeps the current value. Padrão -1.

Retorna: parameter.

material.set_parameter_range (risco 2, altera, smoke)

Sets the slider minimum and maximum of a scalar parameter.

Argumento	Tipo	Descrição
target	string	obrigatório. Material or Material Function asset.
name	string	obrigatório. Parameter name.
group	string	New parameter group.
value	string	New default value (number, "(R=1,G=0,B=0,A=1)" or a texture asset path).
newName	string	New name (material.rename_parameter).
min	number	Slider minimum (scalar parameters). Padrão 0.0.
max	number	Slider maximum (scalar parameters). Padrão 0.0.
sortPriority	integer	Sort priority in the details panel; negative keeps the current value. Padrão -1.

Retorna: parameter.

material.set_parameters (risco 2, altera, smoke)

Overrides several parameters of an instance in one call.

Argumento	Tipo	Descrição
instance	string	obrigatório.
scalars	array of UeaMatScalarValue
vectors	array of UeaMatVectorValue
textures	array of UeaMatTextureValue
switches	array of UeaMatSwitchValue
compile	boolean	Update the instance afterwards (default true). Padrão true.

Retorna: parameters, total, overriddenCount.

material.set_parent (risco 2, altera, smoke)

Reparents an instance; the overrides whose parameter names still exist are kept.

Argumento	Tipo	Descrição
instance	string	obrigatório.
parent	string	obrigatório.

Retorna: asset, parent, parentChain, baseMaterial, parameters, overriddenCount, overrides.

material.set_physical_material (risco 2, altera, smoke)

Sets (or clears) the physical material of a material.

Argumento	Tipo	Descrição
material	string	obrigatório.
physicalMaterial	string	Physical material asset; empty clears it.

Retorna: asset, settings, connectedProperties, stats, errors.

material.set_preview_mesh (risco 2, altera)

Sets the mesh shown in the material editor preview viewport. SmokeSkip: it only affects editor UI state and needs a viewport.

Argumento	Tipo	Descrição
material	string	obrigatório.
mesh	string	obrigatório. sphere / cube / plane / cylinder, or a static-mesh asset path.

Retorna: asset, errors, notes.

material.set_scalar (risco 2, altera, smoke)

Overrides one scalar parameter.

Argumento	Tipo	Descrição
instance	string	obrigatório.
name	string	obrigatório.
value	number	obrigatório.

Retorna: value, overridden, parentValue.

material.set_settings (risco 2, altera, smoke)

Changes domain, blend mode, shading model, two-sided, opacity mask clip value, customized UVs, decal response, usage flags and more. Only the fields you pass are touched.

Argumento	Tipo	Descrição
material	string	obrigatório.
domain	string
blendMode	string
shadingModel	string
shadingModels	array of string	Extra shading models to allow (5.x, materials using "from_material_expression").
twoSided	string	"true"/"false" to change it; empty to keep.
opacityMaskClipValue	number	Alpha threshold of masked materials; negative keeps the current value. Padrão -1.0.
ditheredLODTransition	string
tangentSpaceNormal	string
numCustomizedUVs	integer	Number of customized UV outputs (0..8); negative keeps the current value. Padrão -1.
allowNegativeEmissive	string
blendableLocation	string	Post-process blendable location (before_tonemapping / after_tonemapping / before_translucency / ...).
refractionMethod	string	Refraction method (5.x only): none / index_of_refraction / pixel_normal_offset.
materialDecalResponse	string	none / color_normal_roughness / color / color_normal / color_roughness / normal / normal_roughness / roughness.
castRayTracedShadows	string
usage	array of string	bUsedWith* flags to enable, by short name ("skeletal_mesh", "particle_sprites", "niagara_sprites", "instanced_static_meshes", "static_lighting", ...).
subsurfaceProfile	string	Subsurface profile asset.
compile	boolean	Recompile after the change (default false: batch settings then call material.compile). Padrão false.

Retorna: asset, settings, connectedProperties, stats, errors.

material.set_sort_priority (risco 2, altera, smoke)

Sets the sort priority of a parameter in the details panel.

Argumento	Tipo	Descrição
target	string	obrigatório. Material or Material Function asset.
name	string	obrigatório. Parameter name.
group	string	New parameter group.
value	string	New default value (number, "(R=1,G=0,B=0,A=1)" or a texture asset path).
newName	string	New name (material.rename_parameter).
min	number	Slider minimum (scalar parameters). Padrão 0.0.
max	number	Slider maximum (scalar parameters). Padrão 0.0.
sortPriority	integer	Sort priority in the details panel; negative keeps the current value. Padrão -1.

Retorna: parameter.

material.set_static_component_mask (risco 2, altera)

Overrides one static component mask parameter. SmokeSkip: it needs a StaticComponentMaskParameter declared in the parent material, which the sandbox chain does not create.

Argumento	Tipo	Descrição
instance	string	obrigatório.
name	string	obrigatório.
r	boolean	Padrão true.
g	boolean	Padrão false.
b	boolean	Padrão false.
a	boolean	Padrão false.

Retorna: value, overridden, parentValue.

material.set_static_switch (risco 2, altera, smoke)

Overrides one static switch parameter (changes the shader permutation).

Argumento	Tipo	Descrição
instance	string	obrigatório.
name	string	obrigatório.
value	boolean	Padrão true.

Retorna: value, overridden, parentValue.

material.set_subsurface_profile (risco 2, altera, smoke)

Sets (or clears, when the asset is empty) the subsurface profile override of an instance.

Argumento	Tipo	Descrição
material	string	obrigatório.
physicalMaterial	string	Physical material asset; empty clears it.

Retorna: asset, parent, parentChain, baseMaterial, parameters, overriddenCount, overrides.

material.set_texture (risco 2, altera, smoke)

Overrides one texture parameter.

Argumento	Tipo	Descrição
instance	string	obrigatório.
name	string	obrigatório.
texture	string	obrigatório. Texture asset path.

Retorna: value, overridden, parentValue.

material.set_usage (risco 2, altera, smoke)

Enables or disables one bUsedWith* flag of a material (skeletal_mesh, particle_sprites, instanced_static_meshes, ...).

Argumento	Tipo	Descrição
material	string	obrigatório.
usage	string	obrigatório. Short usage name: skeletal_mesh, particle_sprites, beam_trails, mesh_particles, static_lighting, morph_targets, spline_mesh, instanced_static_meshes, geometry_collections, clothing, niagara_sprites, niagara_ribbons, niagara_mesh_particles, geometry_cache, water, hair_strands, lidar_point_cloud, virtual_heightfield_mesh (5.x adds nanite, static_mesh, volumetric_cloud, ...).
enabled	boolean	True to enable (default), false to disable. Padrão true.

Retorna: available, enabled.

material.set_vector (risco 2, altera, smoke)

Overrides one vector (colour) parameter.

Argumento	Tipo	Descrição
instance	string	obrigatório.
name	string	obrigatório.
color	UeaMatColor

Retorna: value, overridden, parentValue.

material.update_function (risco 2, altera, smoke)

Recompiles the materials that call a function after its graph changed.

Argumento	Tipo	Descrição
function	string	obrigatório. Material Function asset path or unique name.

Retorna: count, items.

material.validate (risco 0, smoke)

Checks a material for unconnected required inputs, missing textures, sampler-type mismatches and unused parameters.

Argumento	Tipo	Descrição
material	string	obrigatório. Material asset path or unique name.

Retorna: valid, issues, errorCount, warningCount.

material.validate_function (risco 0, smoke)

Checks a function for unconnected outputs, unused inputs and duplicate names.

Argumento	Tipo	Descrição
function	string	obrigatório. Material Function asset path or unique name.

Retorna: valid, issues, errorCount, warningCount.