Kit material
252 herramientas. Generado a partir del código fuente del plugin; no lo edites a mano.
Las descripciones de las herramientas y de los argumentos se muestran en inglés porque reflejan el schema de las herramientas (el mismo texto que el agente recibe en
tools/list).
Guía
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
material.list_recipes— see what can be built in one call.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.material.create_instance {"parent":"/Game/Materials/M_Rock","folder":"/Game/Materials","name":"MI_RockMossy","scalars":[{"name":"Roughness","value":0.8}]}.- Need something custom?
material.get_graphto see the current state, thenmaterial.build_graphto author nodes and links declaratively, thenmaterial.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 withdescwhen creating, ormaterial.set_node_desc), a#index, or a parameter name. Descriptions are the most readable and survive renames. material.build_graphis the batch form:nodes[]with a localidand akind(Multiply,TextureSample,ScalarParameter, ... — the class name without theMaterialExpressionprefix),links[]withfrom/output/to/input.tomay 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_manybatches them.material.add_nodeis the escape hatch for any class the typed factories do not cover; usematerial.list_expression_classes/material.get_expression_class_infoto discover names, pins and editable properties first.material.arrange_nodestidies the layout,material.add_comment_arounddocuments 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_instancereturns every parameter with its value, the parent value and anoverriddenflag: the one call an agent needs before changing anything.material.set_scalar/set_vector/set_texture/set_static_switchfail withE_NOT_FOUNDwhen the name is not a parameter of the parent, which is the usual typo signal.material.set_instance_overrideshandles 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: falseon node tools; onematerial.compileat the end. - Sampler types.
material.add_texture_samplewithsamplerType: "auto"derives the type from the texture. A normal map sampled ascolorcompiles but looks wrong —material.get_texture_samplerslists the mismatches. - Parameter names are unique per material. Two declarations with the same name are a compile
error;
material.validatereports them asduplicate_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) returnE_NOT_SUPPORTED. - Named reroutes need UE 5.0. On 4.27 use
material.add_reroute. - Math ops differ per engine.
material.add_mathacceptslength,exp,log,moduloonly from UE 5.x; on 4.27 the call returnsE_NOT_SUPPORTEDwith the list of known operations. material.clear_graphandmaterial.delete_nodesare destructive and break every link that touched the removed expressions. Export first withmaterial.export_graphif in doubt.- Names with spaces work for expression inputs (
"to":"Blend.Layer Grass"); quote them in JSON as usual.
Herramientas
Leyenda. riesgo 0 = solo lectura, 1 = operación inofensiva del editor, 2 = modifica un asset, 3 = elimina/reemplaza un asset, 4 = proyecto/configuración/build, 5 = potencialmente destructivo (las llamadas por encima de
MaxAutoRiskrequieren"_confirm": true). modifica = se ejecuta en una transacción (edit.undo la revierte). requiere PIE / requiere mundo = se rechaza sin una sesión PIE / sin un nivel abierto. requiere el plugin = no disponible cuando el plugin está desactivado. dryRun = acepta el argumentodryRun. smoke = cubierto poredit.self_test.
material.add_actor_position (riesgo 2, modifica, smoke)
Adds an Actor Position (world space) node.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. Material or Material Function asset to add the expression to. |
x | integer | Valor predeterminado 0. |
y | integer | Valor predeterminado 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). Valor predeterminado false. |
Devuelve: node, target, errors.
material.add_blackbody (riesgo 2, modifica, smoke)
Adds a Blackbody node (colour of a temperature in kelvin).
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. Material or Material Function asset to add the expression to. |
x | integer | Valor predeterminado 0. |
y | integer | Valor predeterminado 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). Valor predeterminado false. |
Devuelve: node, target, errors.
material.add_bump_offset (riesgo 2, modifica, smoke)
Adds a Bump Offset (parallax) node.
| Argumento | Tipo | Descripción |
|---|---|---|
heightRatio | number | Valor predeterminado 0.05. |
referencePlane | number | Valor predeterminado 0.5. |
Devuelve: node, target, errors.
material.add_camera_position (riesgo 2, modifica, smoke)
Adds a Camera Position (world space) node.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. Material or Material Function asset to add the expression to. |
x | integer | Valor predeterminado 0. |
y | integer | Valor predeterminado 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). Valor predeterminado false. |
Devuelve: node, target, errors.
material.add_camera_vector (riesgo 2, modifica, smoke)
Adds a Camera Vector node.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. Material or Material Function asset to add the expression to. |
x | integer | Valor predeterminado 0. |
y | integer | Valor predeterminado 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). Valor predeterminado false. |
Devuelve: node, target, errors.
material.add_collection_parameter (riesgo 2, modifica)
Adds a Material Parameter Collection parameter node. SmokeSkip: it needs a Material Parameter Collection asset, which the sandbox does not provide.
| Argumento | Tipo | Descripción |
|---|---|---|
collection | string | obligatorio. Material Parameter Collection asset. |
name | string | obligatorio. Parameter name inside the collection. |
Devuelve: node, target, errors.
material.add_comment (riesgo 2, modifica, smoke)
Adds a comment box to a graph.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. |
text | string | obligatorio. |
x | integer | Valor predeterminado 0. |
y | integer | Valor predeterminado 0. |
width | integer | Valor predeterminado 400. |
height | integer | Valor predeterminado 200. |
color | UeaMatColor |
Devuelve: comment.
material.add_comment_around (riesgo 2, modifica, smoke)
Adds a comment box sized to enclose the given expressions.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. |
text | string | obligatorio. |
nodes | array of string | obligatorio. Expressions to enclose. |
padding | integer | Extra margin in graph units (default 40). Valor predeterminado 40. |
color | UeaMatColor |
Devuelve: comment.
material.add_component_mask (riesgo 2, modifica, smoke)
Adds a Component Mask node.
| Argumento | Tipo | Descripción |
|---|---|---|
r | boolean | Valor predeterminado true. |
g | boolean | Valor predeterminado false. |
b | boolean | Valor predeterminado false. |
a | boolean | Valor predeterminado false. |
Devuelve: node, target, errors.
material.add_constant (riesgo 2, modifica, smoke)
Adds a scalar constant.
| Argumento | Tipo | Descripción |
|---|---|---|
value | number | Valor predeterminado 0.0. |
Devuelve: node, target, errors.
material.add_constant2 (riesgo 2, modifica, smoke)
Adds a two-component constant.
| Argumento | Tipo | Descripción |
|---|---|---|
r | number | Valor predeterminado 0.0. |
g | number | Valor predeterminado 0.0. |
Devuelve: node, target, errors.
material.add_constant3 (riesgo 2, modifica, smoke)
Adds a three-component (colour) constant.
| Argumento | Tipo | Descripción |
|---|---|---|
color | UeaMatColor |
Devuelve: node, target, errors.
material.add_constant4 (riesgo 2, modifica, smoke)
Adds a four-component constant.
| Argumento | Tipo | Descripción |
|---|---|---|
color | UeaMatColor |
Devuelve: node, target, errors.
material.add_curve_atlas_row_parameter (riesgo 2, modifica, smoke)
Adds a Curve Atlas Row Parameter node (the atlas and curve assets are optional).
| Argumento | Tipo | Descripción |
|---|---|---|
name | string | obligatorio. |
atlas | string | Curve Atlas asset. |
curve | string | Curve Linear Color asset inside the atlas. |
group | string |
Devuelve: node, target, errors.
material.add_custom (riesgo 2, modifica, smoke)
Adds a Custom HLSL node with named inputs and an output type.
| Argumento | Tipo | Descripción |
|---|---|---|
code | string | obligatorio. 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). |
Devuelve: node, target, errors.
material.add_ddx (riesgo 2, modifica, smoke)
Adds a DDX node (screen-space horizontal derivative).
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. Material or Material Function asset to add the expression to. |
x | integer | Valor predeterminado 0. |
y | integer | Valor predeterminado 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). Valor predeterminado false. |
Devuelve: node, target, errors.
material.add_ddy (riesgo 2, modifica, smoke)
Adds a DDY node (screen-space vertical derivative).
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. Material or Material Function asset to add the expression to. |
x | integer | Valor predeterminado 0. |
y | integer | Valor predeterminado 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). Valor predeterminado false. |
Devuelve: node, target, errors.
material.add_depth_fade (riesgo 2, modifica, smoke)
Adds a Depth Fade node.
| Argumento | Tipo | Descripción |
|---|---|---|
fadeDistance | number | Valor predeterminado 100.0. |
opacity | number | Valor predeterminado 1.0. |
Devuelve: node, target, errors.
material.add_depth_of_field_function (riesgo 2, modifica, smoke)
Adds a Depth Of Field Function node.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. Material or Material Function asset to add the expression to. |
x | integer | Valor predeterminado 0. |
y | integer | Valor predeterminado 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). Valor predeterminado false. |
Devuelve: node, target, errors.
material.add_desaturation (riesgo 2, modifica, smoke)
Adds a Desaturation node with luminance weights.
| Argumento | Tipo | Descripción |
|---|---|---|
luminanceFactors | UeaMatColor | Luminance weights (default 0.3/0.59/0.11). |
Devuelve: node, target, errors.
material.add_distance_to_nearest_surface (riesgo 2, modifica, smoke)
Adds a Distance To Nearest Surface node (needs distance fields).
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. Material or Material Function asset to add the expression to. |
x | integer | Valor predeterminado 0. |
y | integer | Valor predeterminado 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). Valor predeterminado false. |
Devuelve: node, target, errors.
material.add_dynamic_parameter (riesgo 2, modifica, smoke)
Adds a Dynamic Parameter node (four named channels driven by the particle system).
| Argumento | Tipo | Descripción |
|---|---|---|
names | array of string | Names of the four parameter channels. |
index | integer | Valor predeterminado 0. |
Devuelve: node, target, errors.
material.add_eye_adaptation (riesgo 2, modifica, smoke)
Adds an Eye Adaptation node.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. Material or Material Function asset to add the expression to. |
x | integer | Valor predeterminado 0. |
y | integer | Valor predeterminado 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). Valor predeterminado false. |
Devuelve: node, target, errors.
material.add_feature_level_switch (riesgo 2, modifica, smoke)
Adds a Feature Level Switch node.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. Material or Material Function asset to add the expression to. |
x | integer | Valor predeterminado 0. |
y | integer | Valor predeterminado 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). Valor predeterminado false. |
Devuelve: node, target, errors.
material.add_fresnel (riesgo 2, modifica, smoke)
Adds a Fresnel node.
| Argumento | Tipo | Descripción |
|---|---|---|
exponent | number | Valor predeterminado 5.0. |
baseReflectFraction | number | Valor predeterminado 0.04. |
Devuelve: node, target, errors.
material.add_function_call (riesgo 2, modifica, smoke)
Adds a Material Function Call node bound to a function asset.
| Argumento | Tipo | Descripción |
|---|---|---|
function | string | obligatorio. Material Function asset, e.g. "/Engine/Functions/Engine_MaterialFunctions02/Utility/BlendAngleCorrectedNormals". |
Devuelve: node, target, errors.
material.add_function_input (riesgo 2, modifica, smoke)
Adds a Function Input node (material functions only).
| Argumento | Tipo | Descripción |
|---|---|---|
name | string | obligatorio. |
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 | Valor predeterminado 32. |
usePreviewValueAsDefault | boolean | Make the preview value the default when the input is left unconnected. Valor predeterminado false. |
description | string |
Devuelve: node, target, errors.
material.add_function_output (riesgo 2, modifica, smoke)
Adds a Function Output node (material functions only).
| Argumento | Tipo | Descripción |
|---|---|---|
name | string | obligatorio. |
sortPriority | integer | Valor predeterminado 32. |
description | string |
Devuelve: node, target, errors.
material.add_function_to_library (riesgo 2, modifica, smoke)
Exposes a function in the material palette under the given categories (shortcut for set_function_settings).
| Argumento | Tipo | Descripción |
|---|---|---|
function | string | obligatorio. |
description | string | |
exposeToLibrary | string | "true" / "false"; empty keeps the current state. |
categories | array of string |
Devuelve: asset, description, exposeToLibrary, libraryCategories, inputs, outputs, nodeCount, users.
material.add_if (riesgo 2, modifica, smoke)
Adds an If node (branch on a comparison).
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. Material or Material Function asset to add the expression to. |
x | integer | Valor predeterminado 0. |
y | integer | Valor predeterminado 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). Valor predeterminado false. |
Devuelve: node, target, errors.
material.add_landscape_coords (riesgo 2, modifica, smoke)
Adds a Landscape Layer Coords node (world-aligned landscape UVs).
| Argumento | Tipo | Descripción |
|---|---|---|
mappingScale | number | Valor predeterminado 1.0. |
mappingType | string | auto / xy / xz / yz. |
Devuelve: node, target, errors.
material.add_landscape_layer_blend (riesgo 2, modifica, smoke)
Adds a Landscape Layer Blend node with its layer list.
| Argumento | Tipo | Descripción |
|---|---|---|
layers | array of UeaMatLandscapeLayer | obligatorio. |
Devuelve: node, target, errors.
material.add_landscape_layer_sample (riesgo 2, modifica, smoke)
Adds a Landscape Layer Sample node.
| Argumento | Tipo | Descripción |
|---|---|---|
layerName | string | obligatorio. |
previewWeight | number | Valor predeterminado 1.0. |
previewUsed | boolean | Preview the "used" branch of a layer switch (default true). Valor predeterminado true. |
Devuelve: node, target, errors.
material.add_landscape_layer_switch (riesgo 2, modifica, smoke)
Adds a Landscape Layer Switch node.
| Argumento | Tipo | Descripción |
|---|---|---|
layerName | string | obligatorio. |
previewWeight | number | Valor predeterminado 1.0. |
previewUsed | boolean | Preview the "used" branch of a layer switch (default true). Valor predeterminado true. |
Devuelve: node, target, errors.
material.add_landscape_layer_weight (riesgo 2, modifica, smoke)
Adds a Landscape Layer Weight node.
| Argumento | Tipo | Descripción |
|---|---|---|
layerName | string | obligatorio. |
previewWeight | number | Valor predeterminado 1.0. |
previewUsed | boolean | Preview the "used" branch of a layer switch (default true). Valor predeterminado true. |
Devuelve: node, target, errors.
material.add_layer (riesgo 2, modifica, UE 5.0+, smoke)
Appends one layer (and its blend) to the stack of a material.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. |
layer | string | Material layer function asset. |
blend | string | Blend function asset. |
name | string | Display name. |
Devuelve: layers, total, node.
material.add_material_attribute_layers_node (riesgo 2, modifica, UE 5.0+, smoke)
Adds a Material Attribute Layers expression to a material (the node that hosts the layer stack).
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. Material or Material Function asset to add the expression to. |
x | integer | Valor predeterminado 0. |
y | integer | Valor predeterminado 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). Valor predeterminado false. |
Devuelve: node, target, errors.
material.add_material_attributes_node (riesgo 2, modifica, smoke)
Adds a Make / Break / Set / Get Material Attributes node.
| Argumento | Tipo | Descripción |
|---|---|---|
kind | string | obligatorio. make / break / set / get. |
attributes | array of string | Attribute names for the set/get variants ("BaseColor", "Roughness", ...). |
Devuelve: node, target, errors.
material.add_math (riesgo 2, modifica, smoke)
Adds a math expression by operation name (multiply, lerp, clamp, dot, append, ...).
| Argumento | Tipo | Descripción |
|---|---|---|
op | string | obligatorio. 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. Valor predeterminado 0.0. |
constB | number | Constant fallback of the B input, when the expression has one. Valor predeterminado 1.0. |
Devuelve: node, target, errors.
material.add_named_reroute (riesgo 2, modifica, UE 5.0+, smoke)
Adds a named reroute declaration; usages reference it by name.
| Argumento | Tipo | Descripción |
|---|---|---|
name | string | obligatorio. Name of the reroute variable. |
Devuelve: node, target, errors.
material.add_named_reroute_usage (riesgo 2, modifica, UE 5.0+, smoke)
Adds a usage of an existing named reroute declaration.
| Argumento | Tipo | Descripción |
|---|---|---|
name | string | obligatorio. Name of the reroute variable. |
Devuelve: node, target, errors.
material.add_node (riesgo 2, modifica, 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 | Descripción |
|---|---|---|
class | string | obligatorio. Expression class or short alias ("Multiply", "TextureSample", "MaterialExpressionFresnel"). |
properties | array of UeaKeyValue | Properties to set on the new expression. |
Devuelve: node, target, errors.
material.add_noise (riesgo 2, modifica, smoke)
Adds a Noise node (procedural noise).
| Argumento | Tipo | Descripción |
|---|---|---|
scale | number | Valor predeterminado 1.0. |
quality | integer | Valor predeterminado 1. |
function | string | simplex / gradient / fast_gradient / value / voronoi. |
levels | integer | Valor predeterminado 6. |
turbulence | boolean | Valor predeterminado true. |
Devuelve: node, target, errors.
material.add_object_orientation (riesgo 2, modifica, smoke)
Adds an Object Orientation node.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. Material or Material Function asset to add the expression to. |
x | integer | Valor predeterminado 0. |
y | integer | Valor predeterminado 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). Valor predeterminado false. |
Devuelve: node, target, errors.
material.add_object_position (riesgo 2, modifica, smoke)
Adds an Object Position (world space) node.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. Material or Material Function asset to add the expression to. |
x | integer | Valor predeterminado 0. |
y | integer | Valor predeterminado 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). Valor predeterminado false. |
Devuelve: node, target, errors.
material.add_object_scale (riesgo 2, modifica, 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 | Descripción |
|---|---|---|
target | string | obligatorio. Material or Material Function asset to add the expression to. |
x | integer | Valor predeterminado 0. |
y | integer | Valor predeterminado 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). Valor predeterminado false. |
Devuelve: node, target, errors.
material.add_panner (riesgo 2, modifica, smoke)
Adds a Panner node (scrolls UVs over time).
| Argumento | Tipo | Descripción |
|---|---|---|
speedX | number | Valor predeterminado 0.0. |
speedY | number | Valor predeterminado 0.0. |
Devuelve: node, target, errors.
material.add_particle_color (riesgo 2, modifica, smoke)
Adds a Particle Color node.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. Material or Material Function asset to add the expression to. |
x | integer | Valor predeterminado 0. |
y | integer | Valor predeterminado 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). Valor predeterminado false. |
Devuelve: node, target, errors.
material.add_particle_macro_uv (riesgo 2, modifica, smoke)
Adds a Particle Macro UV node.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. Material or Material Function asset to add the expression to. |
x | integer | Valor predeterminado 0. |
y | integer | Valor predeterminado 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). Valor predeterminado false. |
Devuelve: node, target, errors.
material.add_particle_position_ws (riesgo 2, modifica, smoke)
Adds a Particle Position (world space) node.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. Material or Material Function asset to add the expression to. |
x | integer | Valor predeterminado 0. |
y | integer | Valor predeterminado 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). Valor predeterminado false. |
Devuelve: node, target, errors.
material.add_particle_radius (riesgo 2, modifica, smoke)
Adds a Particle Radius node.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. Material or Material Function asset to add the expression to. |
x | integer | Valor predeterminado 0. |
y | integer | Valor predeterminado 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). Valor predeterminado false. |
Devuelve: node, target, errors.
material.add_particle_subuv (riesgo 2, modifica, smoke)
Adds a Particle SubUV node (sprite sheet sampling).
| Argumento | Tipo | Descripción |
|---|---|---|
texture | string | |
blend | boolean | Valor predeterminado true. |
Devuelve: node, target, errors.
material.add_per_instance_custom_data (riesgo 2, modifica, smoke)
Adds a Per Instance Custom Data node reading one float slot.
| Argumento | Tipo | Descripción |
|---|---|---|
index | integer | Index or slot (per-instance custom data index, light index, dynamic-parameter index). Valor predeterminado 0. |
Devuelve: node, target, errors.
material.add_per_instance_fade_amount (riesgo 2, modifica, smoke)
Adds a Per Instance Fade Amount node.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. Material or Material Function asset to add the expression to. |
x | integer | Valor predeterminado 0. |
y | integer | Valor predeterminado 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). Valor predeterminado false. |
Devuelve: node, target, errors.
material.add_per_instance_random (riesgo 2, modifica, smoke)
Adds a Per Instance Random node.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. Material or Material Function asset to add the expression to. |
x | integer | Valor predeterminado 0. |
y | integer | Valor predeterminado 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). Valor predeterminado false. |
Devuelve: node, target, errors.
material.add_pixel_depth (riesgo 2, modifica, smoke)
Adds a Pixel Depth node.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. Material or Material Function asset to add the expression to. |
x | integer | Valor predeterminado 0. |
y | integer | Valor predeterminado 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). Valor predeterminado false. |
Devuelve: node, target, errors.
material.add_pixel_normal_ws (riesgo 2, modifica, smoke)
Adds a Pixel Normal (world space) node.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. Material or Material Function asset to add the expression to. |
x | integer | Valor predeterminado 0. |
y | integer | Valor predeterminado 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). Valor predeterminado false. |
Devuelve: node, target, errors.
material.add_previous_frame_switch (riesgo 2, modifica, smoke)
Adds a Previous Frame Switch node.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. Material or Material Function asset to add the expression to. |
x | integer | Valor predeterminado 0. |
y | integer | Valor predeterminado 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). Valor predeterminado false. |
Devuelve: node, target, errors.
material.add_quality_switch (riesgo 2, modifica, smoke)
Adds a Quality Switch node.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. Material or Material Function asset to add the expression to. |
x | integer | Valor predeterminado 0. |
y | integer | Valor predeterminado 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). Valor predeterminado false. |
Devuelve: node, target, errors.
material.add_ray_tracing_quality_switch (riesgo 2, modifica, smoke)
Adds a Ray Tracing Quality Switch node.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. Material or Material Function asset to add the expression to. |
x | integer | Valor predeterminado 0. |
y | integer | Valor predeterminado 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). Valor predeterminado false. |
Devuelve: node, target, errors.
material.add_reflection_vector (riesgo 2, modifica, smoke)
Adds a Reflection Vector (world space) node.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. Material or Material Function asset to add the expression to. |
x | integer | Valor predeterminado 0. |
y | integer | Valor predeterminado 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). Valor predeterminado false. |
Devuelve: node, target, errors.
material.add_reroute (riesgo 2, modifica, smoke)
Adds a reroute node (a pass-through used to tidy long wires).
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. Material or Material Function asset to add the expression to. |
x | integer | Valor predeterminado 0. |
y | integer | Valor predeterminado 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). Valor predeterminado false. |
Devuelve: node, target, errors.
material.add_rotator (riesgo 2, modifica, smoke)
Adds a Rotator node (rotates UVs over time).
| Argumento | Tipo | Descripción |
|---|---|---|
centerX | number | Valor predeterminado 0.5. |
centerY | number | Valor predeterminado 0.5. |
speed | number | Valor predeterminado 0.25. |
Devuelve: node, target, errors.
material.add_runtime_virtual_texture_sample (riesgo 2, modifica, smoke)
Adds a Runtime Virtual Texture Sample node.
| Argumento | Tipo | Descripción |
|---|---|---|
virtualTexture | string | Runtime Virtual Texture asset (optional). |
materialType | string | base_color / base_color_normal_roughness / base_color_normal_specular / world_height / ... |
Devuelve: node, target, errors.
material.add_scalar_parameter (riesgo 2, modifica, smoke)
Adds a scalar parameter with a group, default and slider range.
| Argumento | Tipo | Descripción |
|---|---|---|
name | string | obligatorio. |
defaultValue | number | Valor predeterminado 0.0. |
group | string | |
min | number | Valor predeterminado 0.0. |
max | number | Valor predeterminado 1.0. |
sortPriority | integer | Valor predeterminado 32. |
Devuelve: node, target, errors.
material.add_scene_color (riesgo 2, modifica, smoke)
Adds a Scene Color node.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. Material or Material Function asset to add the expression to. |
x | integer | Valor predeterminado 0. |
y | integer | Valor predeterminado 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). Valor predeterminado false. |
Devuelve: node, target, errors.
material.add_scene_depth (riesgo 2, modifica, smoke)
Adds a Scene Depth node.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. Material or Material Function asset to add the expression to. |
x | integer | Valor predeterminado 0. |
y | integer | Valor predeterminado 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). Valor predeterminado false. |
Devuelve: node, target, errors.
material.add_scene_texture (riesgo 2, modifica, smoke)
Adds a Scene Texture node (post-process domain).
| Argumento | Tipo | Descripción |
|---|---|---|
id | string | Scene texture id, e.g. "PostProcessInput0", "SceneColor", "SceneDepth", "WorldNormal". |
filtered | boolean | Valor predeterminado false. |
Devuelve: node, target, errors.
material.add_screen_position (riesgo 2, modifica, smoke)
Adds a Screen Position node.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. Material or Material Function asset to add the expression to. |
x | integer | Valor predeterminado 0. |
y | integer | Valor predeterminado 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). Valor predeterminado false. |
Devuelve: node, target, errors.
material.add_shading_path_switch (riesgo 2, modifica, smoke)
Adds a Shading Path Switch node (deferred / forward / mobile).
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. Material or Material Function asset to add the expression to. |
x | integer | Valor predeterminado 0. |
y | integer | Valor predeterminado 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). Valor predeterminado false. |
Devuelve: node, target, errors.
material.add_sky_atmosphere_light_direction (riesgo 2, modifica, smoke)
Adds a Sky Atmosphere Light Direction node.
| Argumento | Tipo | Descripción |
|---|---|---|
index | integer | Index or slot (per-instance custom data index, light index, dynamic-parameter index). Valor predeterminado 0. |
Devuelve: node, target, errors.
material.add_sphere_mask (riesgo 2, modifica, smoke)
Adds a Sphere Mask node.
| Argumento | Tipo | Descripción |
|---|---|---|
attenuationRadius | number | Valor predeterminado 256.0. |
hardnessPercent | number | Valor predeterminado 100.0. |
Devuelve: node, target, errors.
material.add_static_bool (riesgo 2, modifica, smoke)
Adds a static bool constant.
| Argumento | Tipo | Descripción |
|---|---|---|
defaultValue | boolean | Valor predeterminado true. |
Devuelve: node, target, errors.
material.add_static_switch (riesgo 2, modifica, smoke)
Adds a static switch (compile-time branch driven by a static bool).
| Argumento | Tipo | Descripción |
|---|---|---|
defaultValue | boolean | Valor predeterminado true. |
Devuelve: node, target, errors.
material.add_static_switch_parameter (riesgo 2, modifica, smoke)
Adds a static switch parameter (compile-time branch exposed to instances).
| Argumento | Tipo | Descripción |
|---|---|---|
name | string | obligatorio. |
defaultValue | boolean | Valor predeterminado true. |
group | string |
Devuelve: node, target, errors.
material.add_texture_coordinate (riesgo 2, modifica, smoke)
Adds a Texture Coordinate node with a UV channel and tiling.
| Argumento | Tipo | Descripción |
|---|---|---|
index | integer | UV channel (default 0). Valor predeterminado 0. |
uTiling | number | Valor predeterminado 1.0. |
vTiling | number | Valor predeterminado 1.0. |
Devuelve: node, target, errors.
material.add_texture_object (riesgo 2, modifica, smoke)
Adds a Texture Object node (a texture reference passed into a material function).
| Argumento | Tipo | Descripción |
|---|---|---|
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. |
Devuelve: node, target, errors.
material.add_texture_object_parameter (riesgo 2, modifica, smoke)
Adds a Texture Object Parameter node.
| Argumento | Tipo | Descripción |
|---|---|---|
name | string | obligatorio. |
group | string |
Devuelve: node, target, errors.
material.add_texture_parameter (riesgo 2, modifica, smoke)
Adds a Texture Sample Parameter (a texture slot instances can override).
| Argumento | Tipo | Descripción |
|---|---|---|
name | string | obligatorio. |
group | string |
Devuelve: node, target, errors.
material.add_texture_property (riesgo 2, modifica, smoke)
Adds a Texture Property node (texture size or texel size).
| Argumento | Tipo | Descripción |
|---|---|---|
texture | string | Texture asset to read the property from. |
property | string | texture_size (default) or texel_size. |
Devuelve: node, target, errors.
material.add_texture_sample (riesgo 2, modifica, smoke)
Adds a Texture Sample node with a texture, sampler type and optional UV source.
| Argumento | Tipo | Descripción |
|---|---|---|
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. |
Devuelve: node, target, errors.
material.add_time (riesgo 2, modifica, smoke)
Adds a Time node.
| Argumento | Tipo | Descripción |
|---|---|---|
ignorePause | boolean | Valor predeterminado false. |
period | number | Period to wrap the time value with (0 = no wrapping). Valor predeterminado 0.0. |
Devuelve: node, target, errors.
material.add_transform (riesgo 2, modifica, smoke)
Adds a Transform node (converts a vector between tangent/local/world/view spaces).
| Argumento | Tipo | Descripción |
|---|---|---|
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". |
Devuelve: node, target, errors.
material.add_transform_position (riesgo 2, modifica, smoke)
Adds a Transform Position node.
| Argumento | Tipo | Descripción |
|---|---|---|
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". |
Devuelve: node, target, errors.
material.add_two_sided_sign (riesgo 2, modifica, smoke)
Adds a Two Sided Sign node (+1 on the front face, -1 on the back face).
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. Material or Material Function asset to add the expression to. |
x | integer | Valor predeterminado 0. |
y | integer | Valor predeterminado 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). Valor predeterminado false. |
Devuelve: node, target, errors.
material.add_vector_noise (riesgo 2, modifica, smoke)
Adds a Vector Noise node.
| Argumento | Tipo | Descripción |
|---|---|---|
function | string | cellnoise / perlin_3d / perlin_gradient / perlin_curl / voronoi. |
Devuelve: node, target, errors.
material.add_vector_parameter (riesgo 2, modifica, smoke)
Adds a vector (colour) parameter.
| Argumento | Tipo | Descripción |
|---|---|---|
name | string | obligatorio. |
color | UeaMatColor | |
group | string | |
sortPriority | integer | Valor predeterminado 32. |
Devuelve: node, target, errors.
material.add_vertex_color (riesgo 2, modifica, smoke)
Adds a Vertex Color node.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. Material or Material Function asset to add the expression to. |
x | integer | Valor predeterminado 0. |
y | integer | Valor predeterminado 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). Valor predeterminado false. |
Devuelve: node, target, errors.
material.add_vertex_interpolator (riesgo 2, modifica, smoke)
Adds a Vertex Interpolator node (moves a computation to the vertex shader).
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. Material or Material Function asset to add the expression to. |
x | integer | Valor predeterminado 0. |
y | integer | Valor predeterminado 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). Valor predeterminado false. |
Devuelve: node, target, errors.
material.add_vertex_normal_ws (riesgo 2, modifica, smoke)
Adds a Vertex Normal (world space) node.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. Material or Material Function asset to add the expression to. |
x | integer | Valor predeterminado 0. |
y | integer | Valor predeterminado 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). Valor predeterminado false. |
Devuelve: node, target, errors.
material.add_vertex_tangent_ws (riesgo 2, modifica, smoke)
Adds a Vertex Tangent (world space) node.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. Material or Material Function asset to add the expression to. |
x | integer | Valor predeterminado 0. |
y | integer | Valor predeterminado 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). Valor predeterminado false. |
Devuelve: node, target, errors.
material.add_view_size (riesgo 2, modifica, smoke)
Adds a View Size node.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. Material or Material Function asset to add the expression to. |
x | integer | Valor predeterminado 0. |
y | integer | Valor predeterminado 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). Valor predeterminado false. |
Devuelve: node, target, errors.
material.add_virtual_texture_feature_switch (riesgo 2, modifica, smoke)
Adds a Virtual Texture Feature Switch node.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. Material or Material Function asset to add the expression to. |
x | integer | Valor predeterminado 0. |
y | integer | Valor predeterminado 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). Valor predeterminado false. |
Devuelve: node, target, errors.
material.add_world_position (riesgo 2, modifica, smoke)
Adds a World Position node.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. Material or Material Function asset to add the expression to. |
x | integer | Valor predeterminado 0. |
y | integer | Valor predeterminado 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). Valor predeterminado false. |
Devuelve: node, target, errors.
material.arrange_nodes (riesgo 2, modifica, smoke)
Auto-arranges the expressions of a material or function graph.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. Material or Material Function asset path / unique name. |
Devuelve: count, items.
material.batch_reparent (riesgo 3, modifica, smoke)
Reparents several instances at once.
| Argumento | Tipo | Descripción |
|---|---|---|
instances | array of string | obligatorio. |
newParent | string | obligatorio. |
Devuelve: count, items.
material.batch_set_scalar (riesgo 2, modifica, smoke)
Sets the same scalar parameter on every instance of a list or a folder.
| Argumento | Tipo | Descripción |
|---|---|---|
instances | array of string | Instances to change; leave empty to use "folder". |
folder | string | Content folder whose instances are changed. |
name | string | obligatorio. |
value | number | Scalar value (material.batch_set_scalar). Valor predeterminado 0.0. |
texture | string | Texture asset (material.batch_set_texture). |
Devuelve: count, items.
material.batch_set_texture (riesgo 2, modifica, smoke)
Sets the same texture parameter on every instance of a list or a folder.
| Argumento | Tipo | Descripción |
|---|---|---|
instances | array of string | Instances to change; leave empty to use "folder". |
folder | string | Content folder whose instances are changed. |
name | string | obligatorio. |
value | number | Scalar value (material.batch_set_scalar). Valor predeterminado 0.0. |
texture | string | Texture asset (material.batch_set_texture). |
Devuelve: count, items.
material.build_graph (riesgo 3, modifica, 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 | Descripción |
|---|---|---|
target | string | obligatorio. |
nodes | array of UeaMatBuildNode | obligatorio. Expressions to create. |
links | array of UeaMatLink | Links between the new nodes and to material properties. |
replace | boolean | Delete the existing expressions first. Valor predeterminado false. |
layout | boolean | Auto-arrange the graph afterwards (default true). Valor predeterminado true. |
compile | boolean | Recompile afterwards (default true). Valor predeterminado true. |
Devuelve: nodes, links, comments, nodeCount, linkCount, target.
material.clear_all_parameters (riesgo 5, modifica, destructivo, smoke)
Removes every override of an instance.
| Argumento | Tipo | Descripción |
|---|---|---|
instance | string | obligatorio. Material Instance Constant asset. |
Devuelve: parameters, total, overriddenCount.
material.clear_graph (riesgo 5, modifica, destructivo, smoke)
Deletes every expression and comment of a graph.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. Material or Material Function asset path / unique name. |
Devuelve: count, items.
material.clear_parameter (riesgo 2, modifica, smoke)
Removes one override so the parameter inherits the parent value again.
| Argumento | Tipo | Descripción |
|---|---|---|
instance | string | obligatorio. |
name | string | obligatorio. |
Devuelve: parameters, total, overriddenCount.
material.compare_instances (riesgo 0, smoke)
Compares the overrides of two instances.
| Argumento | Tipo | Descripción |
|---|---|---|
a | string | obligatorio. |
b | string | obligatorio. |
Devuelve: identical, differences, onlyInA, onlyInB, sameParent.
material.compile (riesgo 2, modifica, 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 | Descripción |
|---|---|---|
material | string | obligatorio. Material or material instance asset. |
Devuelve: errors, warnings, errorCount, stats.
material.connect (riesgo 2, modifica, smoke)
Connects an expression output to a material property ("BaseColor") or to another expression input ("Node.Input").
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. |
node | string | obligatorio. Source expression. |
output | string | Output name or index (default the first output). |
to | string | obligatorio. Material property ("BaseColor", "Roughness", "CustomizedUV0", ...) or "OtherNode.Input". |
compile | boolean | Recompile after the change (default false). Valor predeterminado false. |
Devuelve: node, target, errors.
material.connect_many (riesgo 2, modifica, smoke)
Makes several connections in one call; reports the ones that failed.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. |
links | array of UeaMatLink | obligatorio. |
compile | boolean | Recompile after the change (default false). Valor predeterminado false. |
Devuelve: count, items.
material.copy_parameters (riesgo 2, modifica, smoke)
Copies parameter overrides from one instance (or material) to another.
| Argumento | Tipo | Descripción |
|---|---|---|
from | string | obligatorio. Source instance or material. |
to | string | obligatorio. Destination instance. |
onlyOverridden | boolean | Only copy the parameters the source overrides (default true). Valor predeterminado true. |
Devuelve: parameters, total, overriddenCount.
material.create (riesgo 2, modifica, 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 | Descripción |
|---|---|---|
folder | string | obligatorio. Destination content folder, e.g. "/Game/Materials". |
name | string | obligatorio. 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. Valor predeterminado false. |
opacityMaskClipValue | number | Alpha threshold of masked materials (default 0.3333). Valor predeterminado 0.3333. |
template | string | Material to copy the expression graph and settings from. |
compile | boolean | Recompile after creation (default true). Valor predeterminado true. |
save | boolean | Save the package to disk. Valor predeterminado false. |
Devuelve: asset, settings, connectedProperties, stats, errors.
material.create_function (riesgo 2, modifica, smoke)
Creates a Material Function with the given input and output declarations, optionally exposing it to the material palette.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | obligatorio. |
name | string | obligatorio. |
description | string | |
exposeToLibrary | boolean | Publish the function in the material palette. Valor predeterminado 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 | Valor predeterminado false. |
Devuelve: asset, description, exposeToLibrary, libraryCategories, inputs, outputs, nodeCount, users.
material.create_function_instance (riesgo 2, modifica, smoke)
Creates a Material Function Instance from a function (or a material layer / layer blend).
| Argumento | Tipo | Descripción |
|---|---|---|
function | string | obligatorio. Parent material function (or layer / layer blend). |
folder | string | obligatorio. |
name | string | obligatorio. |
scalars | array of UeaMatScalarValue | |
vectors | array of UeaMatVectorValue | |
textures | array of UeaMatTextureValue |
Devuelve: asset, errors, notes.
material.create_instance (riesgo 2, modifica, smoke)
Creates a Material Instance Constant from a parent material or instance, applying the given parameter overrides.
| Argumento | Tipo | Descripción |
|---|---|---|
parent | string | obligatorio. Parent material or material instance. |
folder | string | obligatorio. |
name | string | obligatorio. |
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). Valor predeterminado true. |
save | boolean | Valor predeterminado false. |
Devuelve: asset, parent, parentChain, baseMaterial, parameters, overriddenCount, overrides.
material.create_instance_variants (riesgo 2, modifica, smoke)
Creates several instances of the same parent, one per variant, each with its own overrides.
| Argumento | Tipo | Descripción |
|---|---|---|
parent | string | obligatorio. |
folder | string | obligatorio. |
variants | array of UeaMatVariant | obligatorio. |
save | boolean | Valor predeterminado false. |
Devuelve: assets, total.
material.create_layer (riesgo 2, modifica, UE 5.0+, smoke)
Creates a Material Layer function asset.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | obligatorio. |
name | string | obligatorio. |
description | string | |
save | boolean | Valor predeterminado false. |
Devuelve: asset, errors, notes.
material.create_layer_blend (riesgo 2, modifica, UE 5.0+, smoke)
Creates a Material Layer Blend function asset.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | obligatorio. |
name | string | obligatorio. |
description | string | |
save | boolean | Valor predeterminado false. |
Devuelve: asset, errors, notes.
material.delete (riesgo 3, modifica, destructivo, smoke)
Deletes a material asset. References to it are broken.
| Argumento | Tipo | Descripción |
|---|---|---|
material | string | obligatorio. Material asset path or unique name. |
Devuelve: count, items.
material.delete_function (riesgo 3, modifica, destructivo, smoke)
Deletes a material function.
| Argumento | Tipo | Descripción |
|---|---|---|
function | string | obligatorio. Material Function asset path or unique name. |
Devuelve: count, items.
material.delete_instance (riesgo 3, modifica, destructivo, smoke)
Deletes a material instance.
| Argumento | Tipo | Descripción |
|---|---|---|
instance | string | obligatorio. Material Instance Constant asset. |
Devuelve: count, items.
material.delete_node (riesgo 3, modifica, smoke)
Deletes one expression and breaks every link that touched it.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. |
node | string | obligatorio. Expression object name, description, "#index" or parameter name. |
Devuelve: count, items.
material.delete_nodes (riesgo 3, modifica, destructivo, smoke)
Deletes several expressions at once.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. |
nodes | array of string | obligatorio. Expression selectors. |
Devuelve: count, items.
material.disconnect (riesgo 2, modifica, smoke)
Breaks the connection feeding a material property or an expression input.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. |
to | string | obligatorio. Material property ("BaseColor") or "Node.Input". |
compile | boolean | Recompile after the change (default false). Valor predeterminado false. |
Devuelve: count, items.
material.disconnect_node (riesgo 2, modifica, smoke)
Breaks every link that reaches or leaves an expression.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. |
node | string | obligatorio. |
outgoing | boolean | Also unplug the expressions this one feeds (default true). Valor predeterminado true. |
incoming | boolean | Also unplug this expression's own inputs (default true). Valor predeterminado true. |
Devuelve: count, items.
material.duplicate (riesgo 2, modifica, smoke)
Duplicates a material into a folder under a new name.
| Argumento | Tipo | Descripción |
|---|---|---|
material | string | obligatorio. Source asset. |
folder | string | obligatorio. Destination folder. |
name | string | obligatorio. Name of the copy. |
Devuelve: asset, errors, notes.
material.duplicate_function (riesgo 2, modifica, smoke)
Duplicates a material function.
| Argumento | Tipo | Descripción |
|---|---|---|
material | string | obligatorio. Source asset. |
folder | string | obligatorio. Destination folder. |
name | string | obligatorio. Name of the copy. |
Devuelve: asset, errors, notes.
material.duplicate_instance (riesgo 2, modifica, smoke)
Duplicates a material instance.
| Argumento | Tipo | Descripción |
|---|---|---|
material | string | obligatorio. Source asset. |
folder | string | obligatorio. Destination folder. |
name | string | obligatorio. Name of the copy. |
Devuelve: asset, errors, notes.
material.duplicate_node (riesgo 2, modifica, smoke)
Duplicates an expression, offset from the original; the copy keeps the property values, not the links.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. |
node | string | obligatorio. |
offsetX | integer | X offset of the copy (default 40). Valor predeterminado 40. |
offsetY | integer | Y offset of the copy (default 40). Valor predeterminado 40. |
Devuelve: node, target, errors.
material.export_function_graph (riesgo 0, smoke)
Exports a function graph as JSON (same format as material.export_graph).
| Argumento | Tipo | Descripción |
|---|---|---|
function | string | obligatorio. Material Function asset path or unique name. |
Devuelve: json, nodeCount, linkCount.
material.export_graph (riesgo 0, smoke)
Exports the whole expression graph plus the material settings as a JSON document (feed it back to material.import_graph).
| Argumento | Tipo | Descripción |
|---|---|---|
material | string | obligatorio. Material asset path or unique name. |
Devuelve: json, nodeCount, linkCount.
material.find_by_expression_class (riesgo 0, smoke)
Materials whose graph contains an expression of a given class.
| Argumento | Tipo | Descripción |
|---|---|---|
reference | string | obligatorio. Texture, function or expression class to look for. |
folder | string | Content folder to search (default "/Game"). |
limit | integer | Maximum results (default 100). Valor predeterminado 100. |
Devuelve: assets, total.
material.find_by_texture (riesgo 0, smoke)
Materials whose graph samples a given texture.
| Argumento | Tipo | Descripción |
|---|---|---|
reference | string | obligatorio. Texture, function or expression class to look for. |
folder | string | Content folder to search (default "/Game"). |
limit | integer | Maximum results (default 100). Valor predeterminado 100. |
Devuelve: assets, total.
material.find_instances_using_texture (riesgo 0, smoke)
Material instances referencing a texture through one of their texture parameters.
| Argumento | Tipo | Descripción |
|---|---|---|
reference | string | obligatorio. Texture, function or expression class to look for. |
folder | string | Content folder to search (default "/Game"). |
limit | integer | Maximum results (default 100). Valor predeterminado 100. |
Devuelve: assets, total.
material.find_node (riesgo 0, smoke)
Searches expressions by description, caption, class or parameter name.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. |
query | string | Text matched against the object name, description, caption, class and parameter name. |
class | string | Restrict to one expression class. |
limit | integer | Valor predeterminado 50. |
Devuelve: nodes, total, target.
material.function_from_nodes (riesgo 3, modifica)
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 | Descripción |
|---|---|---|
material | string | obligatorio. Source material. |
nodes | array of string | obligatorio. Expressions to move into the function. |
folder | string | obligatorio. |
name | string | obligatorio. |
replaceWithCall | boolean | Replace the extracted expressions with a call to the new function (default true). Valor predeterminado true. |
Devuelve: asset, description, exposeToLibrary, libraryCategories, inputs, outputs, nodeCount, users.
material.get (riesgo 0, smoke)
Settings, connected material properties and shader statistics of a material.
| Argumento | Tipo | Descripción |
|---|---|---|
material | string | obligatorio. Material asset path or unique name. |
Devuelve: asset, settings, connectedProperties, stats, errors.
material.get_compile_errors (riesgo 0, smoke)
Compile errors of a material's current shader map, without triggering a recompile.
| Argumento | Tipo | Descripción |
|---|---|---|
material | string | obligatorio. Material or material instance asset. |
Devuelve: errors, warnings, errorCount, stats.
material.get_dynamic_instances (riesgo 0, requiere mundo, smoke)
Actors of the current level whose components use a dynamic instance created from this material or instance.
| Argumento | Tipo | Descripción |
|---|---|---|
material | string | obligatorio. Material asset path or unique name. |
Devuelve: values, total.
material.get_expression_class_info (riesgo 0, smoke)
Pins, categories and editable properties of one material expression class.
| Argumento | Tipo | Descripción |
|---|---|---|
class | string | obligatorio. Expression class name or short alias ("Multiply", "MaterialExpressionMultiply"). |
Devuelve: info.
material.get_function (riesgo 0, smoke)
Inputs, outputs, node count, library flags and users of a material function.
| Argumento | Tipo | Descripción |
|---|---|---|
function | string | obligatorio. Material Function asset path or unique name. |
Devuelve: asset, description, exposeToLibrary, libraryCategories, inputs, outputs, nodeCount, users.
material.get_function_inputs (riesgo 0, smoke)
Input declarations of a material function.
| Argumento | Tipo | Descripción |
|---|---|---|
function | string | obligatorio. Material Function asset path or unique name. |
Devuelve: params, total.
material.get_function_outputs (riesgo 0, smoke)
Output declarations of a material function.
| Argumento | Tipo | Descripción |
|---|---|---|
function | string | obligatorio. Material Function asset path or unique name. |
Devuelve: params, total.
material.get_graph (riesgo 0, smoke)
Nodes and links of a graph in one payload: the overview an agent needs before editing.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. Material or Material Function asset path / unique name. |
Devuelve: nodes, links, comments, nodeCount, linkCount, target.
material.get_hierarchy (riesgo 0, smoke)
Instances derived from a material, the material functions it calls and the textures it uses.
| Argumento | Tipo | Descripción |
|---|---|---|
material | string | obligatorio. Material asset path or unique name. |
Devuelve: instances, functions, textures.
material.get_input_source (riesgo 0, smoke)
Expression and output feeding a material property or an expression input.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. |
to | string | obligatorio. Material property ("BaseColor") or "Node.Input". |
Devuelve: connected, fromNode, fromClass, fromOutput, fromOutputName.
material.get_instance (riesgo 0, smoke)
Parent chain, every parameter with its value, its parent value and whether the instance overrides it.
| Argumento | Tipo | Descripción |
|---|---|---|
instance | string | obligatorio. Material Instance Constant asset. |
Devuelve: asset, parent, parentChain, baseMaterial, parameters, overriddenCount, overrides.
material.get_instance_chain (riesgo 0, smoke)
Parent chain of an instance, from the instance itself up to the base material.
| Argumento | Tipo | Descripción |
|---|---|---|
instance | string | obligatorio. Material Instance Constant asset. |
Devuelve: chain, baseMaterial.
material.get_instance_overrides (riesgo 0, smoke)
Base-property overrides currently active on an instance.
| Argumento | Tipo | Descripción |
|---|---|---|
instance | string | obligatorio. Material Instance Constant asset. |
Devuelve: overrides, active.
material.get_layer_parameters (riesgo 0, UE 5.0+, smoke)
Parameters exposed by the layers of a material instance, per layer.
| Argumento | Tipo | Descripción |
|---|---|---|
instance | string | obligatorio. |
layerIndex | integer | Layer index; negative lists every layer. Valor predeterminado -1. |
Devuelve: parameters, total, overriddenCount.
material.get_layers (riesgo 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 | Descripción |
|---|---|---|
target | string | obligatorio. Material or Material Instance that owns the layer stack. |
Devuelve: layers, total, node.
material.get_node (riesgo 0, smoke)
One expression with its position, description, inputs and outputs.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. |
node | string | obligatorio. Expression object name, description, "#index" or parameter name. |
Devuelve: node, target, errors.
material.get_node_inputs (riesgo 0, smoke)
Input pins of an expression with what feeds them.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. |
node | string | obligatorio. Expression object name, description, "#index" or parameter name. |
Devuelve: node, target, errors.
material.get_node_outputs (riesgo 0, smoke)
Output pins of an expression.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. |
node | string | obligatorio. Expression object name, description, "#index" or parameter name. |
Devuelve: node, target, errors.
material.get_node_property (riesgo 0, smoke)
Reads one property of an expression as text.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. |
node | string | obligatorio. |
property | string | obligatorio. Property name on the expression class, e.g. "Texture", "SamplerType", "ConstCoordinate". |
value | string | New value in text form (numbers, enum names, asset paths). |
Devuelve: value, overridden, parentValue.
material.get_parameter_info (riesgo 0, smoke)
Type, group, sort priority, parent default and override state of one parameter.
| Argumento | Tipo | Descripción |
|---|---|---|
instance | string | obligatorio. |
name | string | obligatorio. |
Devuelve: parameter.
material.get_properties_connected (riesgo 0, smoke)
Material properties (BaseColor, Roughness, ...) currently driven by an expression.
| Argumento | Tipo | Descripción |
|---|---|---|
material | string | obligatorio. Material asset path or unique name. |
Devuelve: values, total.
material.get_scalar (riesgo 0, smoke)
Value of one scalar parameter, with the parent value and whether it is overridden.
| Argumento | Tipo | Descripción |
|---|---|---|
instance | string | obligatorio. |
name | string | obligatorio. |
Devuelve: value, overridden, parentValue.
material.get_static_switch (riesgo 0, smoke)
Value of one static switch parameter.
| Argumento | Tipo | Descripción |
|---|---|---|
instance | string | obligatorio. |
name | string | obligatorio. |
Devuelve: value, overridden, parentValue.
material.get_stats (riesgo 0, smoke)
Shader instruction counts, sampler and interpolator usage of a material or instance, without recompiling.
| Argumento | Tipo | Descripción |
|---|---|---|
material | string | obligatorio. Material or material instance asset. |
Devuelve: stats, material.
material.get_texture (riesgo 0, smoke)
Value of one texture parameter.
| Argumento | Tipo | Descripción |
|---|---|---|
instance | string | obligatorio. |
name | string | obligatorio. |
Devuelve: value, overridden, parentValue.
material.get_texture_samplers (riesgo 0, smoke)
Texture sampler nodes of a material with the sampler type they declare and the one their texture implies.
| Argumento | Tipo | Descripción |
|---|---|---|
material | string | obligatorio. Material asset path or unique name. |
Devuelve: samplers, total, mismatchCount.
material.get_vector (riesgo 0, smoke)
Value of one vector parameter.
| Argumento | Tipo | Descripción |
|---|---|---|
instance | string | obligatorio. |
name | string | obligatorio. |
Devuelve: value, overridden, parentValue.
material.import_function_graph (riesgo 3, modifica)
Rebuilds a function graph from JSON. SmokeSkip: the argument is a nested JSON document, which cannot be expressed in smoke metadata.
| Argumento | Tipo | Descripción |
|---|---|---|
material | string | obligatorio. |
json | string | obligatorio. JSON produced by material.export_graph. |
replace | boolean | Delete the existing expressions first (default true). Valor predeterminado true. |
compile | boolean | Recompile after the import (default true). Valor predeterminado true. |
Devuelve: nodes, links, comments, nodeCount, linkCount, target.
material.import_graph (riesgo 3, modifica)
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 | Descripción |
|---|---|---|
material | string | obligatorio. |
json | string | obligatorio. JSON produced by material.export_graph. |
replace | boolean | Delete the existing expressions first (default true). Valor predeterminado true. |
compile | boolean | Recompile after the import (default true). Valor predeterminado true. |
Devuelve: nodes, links, comments, nodeCount, linkCount, target.
material.inline_function_call (riesgo 3, modifica)
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 | Descripción |
|---|---|---|
target | string | obligatorio. |
node | string | obligatorio. The MaterialFunctionCall expression to expand. |
Devuelve: nodes, links, comments, nodeCount, linkCount, target.
material.is_connected (riesgo 0, smoke)
True when a material property or an expression input is driven by something.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. |
to | string | obligatorio. Material property ("BaseColor") or "Node.Input". |
Devuelve: value, detail.
material.list (riesgo 0, smoke)
Lists Material assets under a folder, filtered by domain, blend mode and name.
| Argumento | Tipo | Descripción |
|---|---|---|
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). Valor predeterminado true. |
limit | integer | Maximum results (default 200). Valor predeterminado 200. |
Devuelve: assets, total.
material.list_comments (riesgo 0, smoke)
Comment boxes of a graph.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. Material or Material Function asset path / unique name. |
Devuelve: comments, total.
material.list_engine_functions (riesgo 0, smoke)
Material functions shipped with the engine, by category (cached asset-registry query).
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | Content folder (default "/Game"). |
exposedOnly | boolean | Only functions exposed to the material palette. Valor predeterminado false. |
category | string | Library category filter. |
nameContains | string | |
recursive | boolean | Valor predeterminado true. |
limit | integer | Valor predeterminado 200. |
Devuelve: functions, total, categories.
material.list_expression_classes (riesgo 0, smoke)
Every material expression class available on this engine with its pins and editable properties. Use it before material.add_node.
| Argumento | Tipo | Descripción |
|---|---|---|
nameContains | string | Name substring filter (e.g. "texture"). |
category | string | Editor category filter (e.g. "Math"). |
limit | integer | Maximum results (default 200). Valor predeterminado 200. |
Devuelve: classes, total.
material.list_function_library (riesgo 0, smoke)
The material function palette: every exposed function grouped by category, with its inputs and outputs.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | Content folder (default "/Game"). |
exposedOnly | boolean | Only functions exposed to the material palette. Valor predeterminado false. |
category | string | Library category filter. |
nameContains | string | |
recursive | boolean | Valor predeterminado true. |
limit | integer | Valor predeterminado 200. |
Devuelve: functions, total, categories.
material.list_function_users (riesgo 0, smoke)
Materials and functions that call a given function.
| Argumento | Tipo | Descripción |
|---|---|---|
function | string | obligatorio. Material Function asset path or unique name. |
Devuelve: assets, total.
material.list_functions (riesgo 0, smoke)
Lists Material Function assets under a folder, optionally only the exposed ones.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | Content folder (default "/Game"). |
exposedOnly | boolean | Only functions exposed to the material palette. Valor predeterminado false. |
category | string | Library category filter. |
nameContains | string | |
recursive | boolean | Valor predeterminado true. |
limit | integer | Valor predeterminado 200. |
Devuelve: assets, total.
material.list_instance_parameters (riesgo 0, smoke)
Parameters of an instance, optionally only the ones it overrides.
| Argumento | Tipo | Descripción |
|---|---|---|
instance | string | obligatorio. |
overriddenOnly | boolean | Only parameters this instance overrides. Valor predeterminado false. |
type | string | Only parameters of this type (scalar / vector / texture / switch). |
Devuelve: parameters, total, overriddenCount.
material.list_instances (riesgo 0, smoke)
Lists Material Instance Constants, optionally only those derived from a given parent.
| Argumento | Tipo | Descripción |
|---|---|---|
parent | string | Only instances derived from this material or instance. |
folder | string | Content folder (default "/Game"). |
recursive | boolean | Valor predeterminado true. |
includeIndirect | boolean | Include grandchildren of the parent (default true). Valor predeterminado true. |
limit | integer | Valor predeterminado 200. |
Devuelve: assets, total.
material.list_layer_blends (riesgo 0, UE 5.0+, smoke)
Lists Material Layer Blend assets under a folder.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | Content folder (default "/Game"). |
exposedOnly | boolean | Only functions exposed to the material palette. Valor predeterminado false. |
category | string | Library category filter. |
nameContains | string | |
recursive | boolean | Valor predeterminado true. |
limit | integer | Valor predeterminado 200. |
Devuelve: assets, total.
material.list_layers (riesgo 0, UE 5.0+, smoke)
Lists Material Layer assets under a folder.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | Content folder (default "/Game"). |
exposedOnly | boolean | Only functions exposed to the material palette. Valor predeterminado false. |
category | string | Library category filter. |
nameContains | string | |
recursive | boolean | Valor predeterminado true. |
limit | integer | Valor predeterminado 200. |
Devuelve: assets, total.
material.list_nodes (riesgo 0, smoke)
Expressions of a material or function graph, with their pins and connections.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. |
classFilter | string | Only expressions of this class ("TextureSample", "MaterialExpressionMultiply"). |
nameContains | string | Name/desc/caption substring filter. |
limit | integer | Maximum results (default 500). Valor predeterminado 500. |
Devuelve: nodes, total, target.
material.list_parameters (riesgo 0, smoke)
Parameters declared by a material or material function graph, with group, default and slider range.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. Material or Material Function asset. |
type | string | Only parameters of this type (scalar / vector / texture / switch). |
group | string | Only parameters of this group. |
Devuelve: parameters, total, groups.
material.list_recipes (riesgo 0, smoke)
Lists the recipes of this kit with the kind of material each produces.
Sin argumentos.
Devuelve: recipes, total.
material.list_textures (riesgo 0, smoke)
Textures referenced by a material's graph.
| Argumento | Tipo | Descripción |
|---|---|---|
material | string | obligatorio. Material asset path or unique name. |
Devuelve: textures, total.
material.list_usages (riesgo 0, smoke)
Every bUsedWith* flag this engine supports and the ones enabled on the material.
| Argumento | Tipo | Descripción |
|---|---|---|
material | string | obligatorio. Material asset path or unique name. |
Devuelve: available, enabled.
material.move_node (riesgo 2, modifica, smoke)
Moves one expression to an absolute graph position.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. |
node | string | obligatorio. |
x | integer | Valor predeterminado 0. |
y | integer | Valor predeterminado 0. |
Devuelve: node, target, errors.
material.move_nodes (riesgo 2, modifica, smoke)
Moves several expressions (or the whole graph) by a delta.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. |
nodes | array of string | Expressions to move; empty moves the whole graph. |
dx | integer | Valor predeterminado 0. |
dy | integer | Valor predeterminado 0. |
Devuelve: count, items.
material.recipe_checker (riesgo 2, modifica, smoke)
Procedural checkerboard, no textures needed. The quickest sanity-check material.
| Argumento | Tipo | Descripción |
|---|---|---|
colorA | UeaMatColor | |
colorB | UeaMatColor | |
scale | number | Valor predeterminado 8.0. |
Devuelve: asset, nodes, parameters, errors, nodeCount.
material.recipe_cloth (riesgo 2, modifica, smoke)
Cloth shading model with a fuzz colour and amount.
| Argumento | Tipo | Descripción |
|---|---|---|
baseColor | string | |
baseColorTint | UeaMatColor | |
normal | string | |
roughness | number | Valor predeterminado 0.5. |
subsurfaceColor | UeaMatColor | Subsurface / fuzz colour depending on the recipe. |
amount | number | Cloth fuzz amount or subsurface opacity. Valor predeterminado 0.5. |
Devuelve: asset, nodes, parameters, errors, nodeCount.
material.recipe_decal (riesgo 2, modifica, smoke)
Deferred decal material with base colour, normal and opacity.
| Argumento | Tipo | Descripción |
|---|---|---|
baseColor | string | |
tint | UeaMatColor | |
normal | string | |
opacityTexture | string | Texture whose alpha drives the decal opacity. |
opacity | number | Valor predeterminado 1.0. |
dbuffer | boolean | Use a DBuffer decal blend mode. Valor predeterminado false. |
Devuelve: asset, nodes, parameters, errors, nodeCount.
material.recipe_dissolve (riesgo 2, modifica, smoke)
Dissolve effect: a noise source drives an opacity mask with a glowing edge.
| Argumento | Tipo | Descripción |
|---|---|---|
baseColor | string | |
baseColorTint | UeaMatColor | |
noiseTexture | string | Noise texture; when empty a procedural Noise node is used. |
amount | number | Initial dissolve amount (0..1). Valor predeterminado 0.5. |
edgeColor | UeaMatColor | |
edgeWidth | number | Valor predeterminado 0.05. |
Devuelve: asset, nodes, parameters, errors, nodeCount.
material.recipe_emissive (riesgo 2, modifica, smoke)
Emissive material with an intensity and an optional sine pulse.
| Argumento | Tipo | Descripción |
|---|---|---|
color | UeaMatColor | |
intensity | number | Valor predeterminado 5.0. |
pulse | number | Pulse speed; 0 disables the animation. Valor predeterminado 0.0. |
Devuelve: asset, nodes, parameters, errors, nodeCount.
material.recipe_flipbook (riesgo 2, modifica, smoke)
Flipbook animation over a sprite-sheet texture (columns x rows at a frame rate).
| Argumento | Tipo | Descripción |
|---|---|---|
texture | string | |
columns | integer | Valor predeterminado 4. |
rows | integer | Valor predeterminado 4. |
fps | number | Valor predeterminado 15.0. |
Devuelve: asset, nodes, parameters, errors, nodeCount.
material.recipe_from_texture_folder (riesgo 2, modifica, dryRun, smoke)
Detects a T_*_BC / _N / _ORM / _R texture set in a folder and builds the matching PBR material.
| Argumento | Tipo | Descripción |
|---|---|---|
textureFolder | string | obligatorio. Folder holding the texture set. |
nameContains | string | Only textures whose name contains this. |
dryRun | boolean | Report the detected mapping without creating anything. Valor predeterminado false. |
Devuelve: asset, nodes, parameters, errors, nodeCount.
material.recipe_glass (riesgo 2, modifica, smoke)
Glass: translucent, low roughness, Fresnel-driven opacity and an index of refraction.
| Argumento | Tipo | Descripción |
|---|---|---|
tint | UeaMatColor | |
roughness | number | Valor predeterminado 0.05. |
ior | number | Valor predeterminado 1.52. |
opacity | number | Valor predeterminado 0.1. |
Devuelve: asset, nodes, parameters, errors, nodeCount.
material.recipe_gradient (riesgo 2, modifica, smoke)
Two-colour gradient along the U or V axis.
| Argumento | Tipo | Descripción |
|---|---|---|
colorA | UeaMatColor | |
colorB | UeaMatColor | |
axis | string | u (default) or v. |
Devuelve: asset, nodes, parameters, errors, nodeCount.
material.recipe_hologram (riesgo 2, modifica, smoke)
Hologram: translucent scanlines scrolling over an emissive tint.
| Argumento | Tipo | Descripción |
|---|---|---|
color | UeaMatColor | |
scanlineDensity | number | Valor predeterminado 40.0. |
speed | number | Valor predeterminado 0.5. |
opacity | number | Valor predeterminado 0.6. |
Devuelve: asset, nodes, parameters, errors, nodeCount.
material.recipe_landscape (riesgo 2, modifica, smoke)
Landscape material blending several layers with a Landscape Layer Blend node.
| Argumento | Tipo | Descripción |
|---|---|---|
layers | array of UeaMatRecipeLandscapeLayer | obligatorio. |
blendType | string | weight (default) / alpha / height. |
macroVariation | boolean | Add a large-scale noise variation on top of the blend. Valor predeterminado false. |
Devuelve: asset, nodes, parameters, errors, nodeCount.
material.recipe_masked (riesgo 2, modifica, smoke)
Masked (cutout) material driven by a texture alpha; optionally two-sided foliage.
| Argumento | Tipo | Descripción |
|---|---|---|
texture | string | Texture whose alpha drives the mask (and whose RGB drives base colour). |
maskTexture | string | Separate opacity-mask texture. |
clipValue | number | Valor predeterminado 0.3333. |
twoSided | boolean | Valor predeterminado true. |
foliage | boolean | Use the two-sided foliage shading model with this subsurface colour. Valor predeterminado false. |
subsurfaceColor | UeaMatColor |
Devuelve: asset, nodes, parameters, errors, nodeCount.
material.recipe_panner (riesgo 2, modifica, smoke)
Scrolling texture (Panner) feeding base colour.
| Argumento | Tipo | Descripción |
|---|---|---|
texture | string | |
speedX | number | Valor predeterminado 0.1. |
speedY | number | Valor predeterminado 0.0. |
tiling | number | Valor predeterminado 1.0. |
Devuelve: asset, nodes, parameters, errors, nodeCount.
material.recipe_parallax (riesgo 2, modifica, smoke)
Parallax (bump offset) material using a height texture.
| Argumento | Tipo | Descripción |
|---|---|---|
baseColor | string | |
height | string | |
normal | string | |
heightRatio | number | Valor predeterminado 0.05. |
Devuelve: asset, nodes, parameters, errors, nodeCount.
material.recipe_pbr (riesgo 2, modifica, smoke)
Physically based opaque surface from a texture set (base colour, normal, roughness, metallic, AO, emissive or a packed ORM texture).
| Argumento | Tipo | Descripción |
|---|---|---|
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 | Valor predeterminado 0.5. |
metallic | string | Metallic texture; empty uses metallicValue. |
metallicValue | number | Valor predeterminado 0.0. |
ao | string | Ambient occlusion texture. |
emissive | string | Emissive texture. |
emissiveTint | UeaMatColor | |
emissiveIntensity | number | Valor predeterminado 0.0. |
packedOrm | string | Packed occlusion/roughness/metallic texture (R=AO, G=Roughness, B=Metallic). |
tiling | number | UV tiling applied to every texture. Valor predeterminado 1.0. |
Devuelve: asset, nodes, parameters, errors, nodeCount.
material.recipe_post_process (riesgo 2, modifica, smoke)
Post-process material applying a tint, a desaturation or a vignette.
| Argumento | Tipo | Descripción |
|---|---|---|
effect | string | tint / desaturate / vignette. |
color | UeaMatColor | |
intensity | number | Valor predeterminado 1.0. |
blendableLocation | string | before_tonemapping (default) / after_tonemapping / before_translucency / replacing_tonemapper. |
Devuelve: asset, nodes, parameters, errors, nodeCount.
material.recipe_rim_light (riesgo 2, modifica, smoke)
Base colour plus a Fresnel rim light added to the emissive output.
| Argumento | Tipo | Descripción |
|---|---|---|
baseColorTint | UeaMatColor | |
rimColor | UeaMatColor | |
exponent | number | Valor predeterminado 4.0. |
intensity | number | Valor predeterminado 2.0. |
Devuelve: asset, nodes, parameters, errors, nodeCount.
material.recipe_subsurface_skin (riesgo 2, modifica, smoke)
Subsurface skin material (preintegrated skin shading model).
| Argumento | Tipo | Descripción |
|---|---|---|
baseColor | string | |
baseColorTint | UeaMatColor | |
normal | string | |
roughness | number | Valor predeterminado 0.5. |
subsurfaceColor | UeaMatColor | Subsurface / fuzz colour depending on the recipe. |
amount | number | Cloth fuzz amount or subsurface opacity. Valor predeterminado 0.5. |
Devuelve: asset, nodes, parameters, errors, nodeCount.
material.recipe_translucent (riesgo 2, modifica, smoke)
Translucent material with a colour, an opacity and an optional Fresnel falloff.
| Argumento | Tipo | Descripción |
|---|---|---|
color | UeaMatColor | |
opacity | number | Valor predeterminado 0.5. |
fresnel | boolean | Add a Fresnel term to the opacity. Valor predeterminado false. |
ior | number | Valor predeterminado 1.0. |
unlit | boolean | Use the unlit shading model. Valor predeterminado false. |
Devuelve: asset, nodes, parameters, errors, nodeCount.
material.recipe_triplanar (riesgo 2, modifica, smoke)
Triplanar (world-aligned) projection of a base colour and a normal map.
| Argumento | Tipo | Descripción |
|---|---|---|
baseColor | string | |
normal | string | |
scale | number | Valor predeterminado 256.0. |
sharpness | number | Valor predeterminado 4.0. |
Devuelve: asset, nodes, parameters, errors, nodeCount.
material.recipe_two_sided_foliage (riesgo 2, modifica, smoke)
Two-sided foliage: subsurface colour transmitted through thin leaves.
| Argumento | Tipo | Descripción |
|---|---|---|
baseColor | string | |
baseColorTint | UeaMatColor | |
normal | string | |
roughness | number | Valor predeterminado 0.5. |
subsurfaceColor | UeaMatColor | Subsurface / fuzz colour depending on the recipe. |
amount | number | Cloth fuzz amount or subsurface opacity. Valor predeterminado 0.5. |
Devuelve: asset, nodes, parameters, errors, nodeCount.
material.recipe_ui (riesgo 2, modifica, smoke)
UI (widget) material: a texture tinted and faded, in the User Interface domain.
| Argumento | Tipo | Descripción |
|---|---|---|
texture | string | |
tint | UeaMatColor | |
opacity | number | Valor predeterminado 1.0. |
Devuelve: asset, nodes, parameters, errors, nodeCount.
material.recipe_unlit_color (riesgo 2, modifica, smoke)
Flat unlit colour. The cheapest material there is; ideal for blockouts and debug.
| Argumento | Tipo | Descripción |
|---|---|---|
color | UeaMatColor |
Devuelve: asset, nodes, parameters, errors, nodeCount.
material.recipe_vertex_color (riesgo 2, modifica, smoke)
Uses the mesh vertex colour as base colour.
| Argumento | Tipo | Descripción |
|---|---|---|
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). Valor predeterminado true. |
group | string | Parameter group used when parameterizing. |
compile | boolean | Recompile at the end (default true). Valor predeterminado true. |
save | boolean | Save the package. Valor predeterminado false. |
Devuelve: asset, nodes, parameters, errors, nodeCount.
material.recipe_water_simple (riesgo 2, modifica, smoke)
Simple water surface: scrolling normals, a tinted translucent body and a Fresnel rim.
| Argumento | Tipo | Descripción |
|---|---|---|
normal | string | Normal map scrolled over the surface. |
speed | number | Valor predeterminado 0.05. |
color | UeaMatColor | |
opacity | number | Valor predeterminado 0.6. |
fresnel | boolean | Valor predeterminado true. |
Devuelve: asset, nodes, parameters, errors, nodeCount.
material.remove_function_input (riesgo 3, modifica, smoke)
Removes one input declaration from a function.
| Argumento | Tipo | Descripción |
|---|---|---|
function | string | obligatorio. |
name | string | obligatorio. |
newName | string | New name (material.rename_function_input). |
Devuelve: params, total.
material.remove_function_output (riesgo 3, modifica, smoke)
Removes one output declaration from a function.
| Argumento | Tipo | Descripción |
|---|---|---|
function | string | obligatorio. |
name | string | obligatorio. |
newName | string | New name (material.rename_function_input). |
Devuelve: params, total.
material.remove_layer (riesgo 3, modifica, UE 5.0+, smoke)
Removes one layer (and its blend) from the stack.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. |
index | integer | obligatorio. |
visible | boolean | Visibility for material.set_layer_visible. Valor predeterminado true. |
newIndex | integer | New index for material.reorder_layer. Valor predeterminado 0. |
asset | string | Layer or blend asset for material.set_layer_asset. |
slot | string | "layer" (default) or "blend" for material.set_layer_asset. |
Devuelve: layers, total, node.
material.rename (riesgo 2, modifica, smoke)
Renames a material asset in place.
| Argumento | Tipo | Descripción |
|---|---|---|
material | string | obligatorio. |
newName | string | obligatorio. |
Devuelve: asset, errors, notes.
material.rename_function (riesgo 2, modifica, smoke)
Renames a material function.
| Argumento | Tipo | Descripción |
|---|---|---|
material | string | obligatorio. |
newName | string | obligatorio. |
Devuelve: asset, errors, notes.
material.rename_function_input (riesgo 2, modifica, smoke)
Renames a function input. Materials calling the function keep their connection by index.
| Argumento | Tipo | Descripción |
|---|---|---|
function | string | obligatorio. |
name | string | obligatorio. |
newName | string | New name (material.rename_function_input). |
Devuelve: params, total.
material.rename_instance (riesgo 2, modifica, smoke)
Renames a material instance.
| Argumento | Tipo | Descripción |
|---|---|---|
material | string | obligatorio. |
newName | string | obligatorio. |
Devuelve: asset, errors, notes.
material.rename_parameter (riesgo 3, modifica, smoke)
Renames a parameter declaration. Instances referencing the old name lose their override.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. Material or Material Function asset. |
name | string | obligatorio. 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). Valor predeterminado 0.0. |
max | number | Slider maximum (scalar parameters). Valor predeterminado 0.0. |
sortPriority | integer | Sort priority in the details panel; negative keeps the current value. Valor predeterminado -1. |
Devuelve: parameter.
material.reorder_layer (riesgo 2, modifica, UE 5.0+, smoke)
Moves one layer to another position in the stack.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. |
index | integer | obligatorio. |
visible | boolean | Visibility for material.set_layer_visible. Valor predeterminado true. |
newIndex | integer | New index for material.reorder_layer. Valor predeterminado 0. |
asset | string | Layer or blend asset for material.set_layer_asset. |
slot | string | "layer" (default) or "blend" for material.set_layer_asset. |
Devuelve: layers, total, node.
material.replace_node_class (riesgo 3, modifica, smoke)
Replaces an expression with another class, reconnecting the inputs whose names match.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. |
node | string | obligatorio. |
newClass | string | obligatorio. New expression class or alias. |
Devuelve: node, target, errors.
material.replace_texture (riesgo 2, modifica, smoke)
Replaces every reference to one texture with another across the whole graph. Returns the expressions it changed.
| Argumento | Tipo | Descripción |
|---|---|---|
material | string | obligatorio. |
from | string | obligatorio. Texture currently referenced. |
to | string | obligatorio. Replacement texture. |
compile | boolean | Recompile afterwards. Valor predeterminado false. |
Devuelve: count, items.
material.reset_to_parent (riesgo 5, modifica, destructivo, smoke)
Resets an instance to its parent: every override is dropped.
| Argumento | Tipo | Descripción |
|---|---|---|
instance | string | obligatorio. Material Instance Constant asset. |
Devuelve: asset, parent, parentChain, baseMaterial, parameters, overriddenCount, overrides.
material.save (riesgo 2, modifica, smoke)
Saves a material package to disk.
| Argumento | Tipo | Descripción |
|---|---|---|
material | string | obligatorio. Material asset path or unique name. |
Devuelve: asset, errors, notes.
material.save_function (riesgo 2, modifica, smoke)
Saves a material function package to disk.
| Argumento | Tipo | Descripción |
|---|---|---|
function | string | obligatorio. Material Function asset path or unique name. |
Devuelve: asset, errors, notes.
material.save_instance (riesgo 2, modifica, smoke)
Saves a material instance package to disk.
| Argumento | Tipo | Descripción |
|---|---|---|
instance | string | obligatorio. Material Instance Constant asset. |
Devuelve: asset, errors, notes.
material.set_function_input (riesgo 2, modifica, smoke)
Changes the type, preview value, sort priority and description of one function input.
| Argumento | Tipo | Descripción |
|---|---|---|
function | string | obligatorio. |
name | string | obligatorio. |
type | string | |
previewValue | UeaMatColor | |
sortPriority | integer | Negative keeps the current value. Valor predeterminado -1. |
description | string | |
usePreviewAsDefault | string | "true" / "false"; empty keeps the current state. |
Devuelve: params, total.
material.set_function_instance_parameters (riesgo 2, modifica, smoke)
Sets the parameter overrides of a Material Function Instance.
| Argumento | Tipo | Descripción |
|---|---|---|
instance | string | obligatorio. Material Function Instance asset. |
scalars | array of UeaMatScalarValue | |
vectors | array of UeaMatVectorValue | |
textures | array of UeaMatTextureValue |
Devuelve: asset, errors, notes.
material.set_function_settings (riesgo 2, modifica, smoke)
Changes the description, the expose-to-library flag and the palette categories of a function.
| Argumento | Tipo | Descripción |
|---|---|---|
function | string | obligatorio. |
description | string | |
exposeToLibrary | string | "true" / "false"; empty keeps the current state. |
categories | array of string |
Devuelve: asset, description, exposeToLibrary, libraryCategories, inputs, outputs, nodeCount, users.
material.set_instance_overrides (riesgo 2, modifica, 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 | Descripción |
|---|---|---|
instance | string | obligatorio. |
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. Valor predeterminado -1.0. |
clearOpacityMaskClipValue | boolean | Remove the opacity-mask-clip-value override. Valor predeterminado false. |
Devuelve: overrides, active.
material.set_instance_physical_material (riesgo 2, modifica, smoke)
Sets (or clears) the physical material override of an instance.
| Argumento | Tipo | Descripción |
|---|---|---|
material | string | obligatorio. |
physicalMaterial | string | Physical material asset; empty clears it. |
Devuelve: asset, parent, parentChain, baseMaterial, parameters, overriddenCount, overrides.
material.set_layer_asset (riesgo 2, modifica, UE 5.0+, smoke)
Replaces the layer or blend asset used at one position of the stack.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. |
index | integer | obligatorio. |
visible | boolean | Visibility for material.set_layer_visible. Valor predeterminado true. |
newIndex | integer | New index for material.reorder_layer. Valor predeterminado 0. |
asset | string | Layer or blend asset for material.set_layer_asset. |
slot | string | "layer" (default) or "blend" for material.set_layer_asset. |
Devuelve: layers, total, node.
material.set_layer_parameter (riesgo 2, modifica, 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 | Descripción |
|---|---|---|
instance | string | obligatorio. Material Instance Constant that owns the layer stack. |
layerIndex | integer | obligatorio. |
name | string | obligatorio. |
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. Valor predeterminado false. |
Devuelve: value, overridden, parentValue.
material.set_layer_visible (riesgo 2, modifica, UE 5.0+, smoke)
Shows or hides one layer of the stack.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. |
index | integer | obligatorio. |
visible | boolean | Visibility for material.set_layer_visible. Valor predeterminado true. |
newIndex | integer | New index for material.reorder_layer. Valor predeterminado 0. |
asset | string | Layer or blend asset for material.set_layer_asset. |
slot | string | "layer" (default) or "blend" for material.set_layer_asset. |
Devuelve: layers, total, node.
material.set_layers (riesgo 3, modifica, 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 | Descripción |
|---|---|---|
target | string | obligatorio. |
layers | array of string | obligatorio. 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. |
Devuelve: layers, total, node.
material.set_node_desc (riesgo 2, modifica, smoke)
Sets the description of an expression; it becomes a stable selector for later calls.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. |
node | string | obligatorio. |
desc | string | New description; it doubles as a stable selector for later calls. |
Devuelve: node, target, errors.
material.set_node_properties (riesgo 2, modifica, smoke)
Sets several properties of an expression in one call.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. |
node | string | obligatorio. |
properties | array of UeaKeyValue | obligatorio. Property name/value pairs. |
Devuelve: node, target, errors.
material.set_node_property (riesgo 2, modifica, smoke)
Sets one property of an expression from text (numbers, enum names, asset paths).
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. |
node | string | obligatorio. |
property | string | obligatorio. Property name on the expression class, e.g. "Texture", "SamplerType", "ConstCoordinate". |
value | string | New value in text form (numbers, enum names, asset paths). |
Devuelve: node, target, errors.
material.set_parameter_default (riesgo 2, modifica, smoke)
Changes the default value of a parameter declaration.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. Material or Material Function asset. |
name | string | obligatorio. 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). Valor predeterminado 0.0. |
max | number | Slider maximum (scalar parameters). Valor predeterminado 0.0. |
sortPriority | integer | Sort priority in the details panel; negative keeps the current value. Valor predeterminado -1. |
Devuelve: parameter.
material.set_parameter_group (riesgo 2, modifica, smoke)
Moves a parameter to another group in the details panel.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. Material or Material Function asset. |
name | string | obligatorio. 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). Valor predeterminado 0.0. |
max | number | Slider maximum (scalar parameters). Valor predeterminado 0.0. |
sortPriority | integer | Sort priority in the details panel; negative keeps the current value. Valor predeterminado -1. |
Devuelve: parameter.
material.set_parameter_range (riesgo 2, modifica, smoke)
Sets the slider minimum and maximum of a scalar parameter.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. Material or Material Function asset. |
name | string | obligatorio. 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). Valor predeterminado 0.0. |
max | number | Slider maximum (scalar parameters). Valor predeterminado 0.0. |
sortPriority | integer | Sort priority in the details panel; negative keeps the current value. Valor predeterminado -1. |
Devuelve: parameter.
material.set_parameters (riesgo 2, modifica, smoke)
Overrides several parameters of an instance in one call.
| Argumento | Tipo | Descripción |
|---|---|---|
instance | string | obligatorio. |
scalars | array of UeaMatScalarValue | |
vectors | array of UeaMatVectorValue | |
textures | array of UeaMatTextureValue | |
switches | array of UeaMatSwitchValue | |
compile | boolean | Update the instance afterwards (default true). Valor predeterminado true. |
Devuelve: parameters, total, overriddenCount.
material.set_parent (riesgo 2, modifica, smoke)
Reparents an instance; the overrides whose parameter names still exist are kept.
| Argumento | Tipo | Descripción |
|---|---|---|
instance | string | obligatorio. |
parent | string | obligatorio. |
Devuelve: asset, parent, parentChain, baseMaterial, parameters, overriddenCount, overrides.
material.set_physical_material (riesgo 2, modifica, smoke)
Sets (or clears) the physical material of a material.
| Argumento | Tipo | Descripción |
|---|---|---|
material | string | obligatorio. |
physicalMaterial | string | Physical material asset; empty clears it. |
Devuelve: asset, settings, connectedProperties, stats, errors.
material.set_preview_mesh (riesgo 2, modifica)
Sets the mesh shown in the material editor preview viewport. SmokeSkip: it only affects editor UI state and needs a viewport.
| Argumento | Tipo | Descripción |
|---|---|---|
material | string | obligatorio. |
mesh | string | obligatorio. sphere / cube / plane / cylinder, or a static-mesh asset path. |
Devuelve: asset, errors, notes.
material.set_scalar (riesgo 2, modifica, smoke)
Overrides one scalar parameter.
| Argumento | Tipo | Descripción |
|---|---|---|
instance | string | obligatorio. |
name | string | obligatorio. |
value | number | obligatorio. |
Devuelve: value, overridden, parentValue.
material.set_settings (riesgo 2, modifica, 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 | Descripción |
|---|---|---|
material | string | obligatorio. |
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. Valor predeterminado -1.0. |
ditheredLODTransition | string | |
tangentSpaceNormal | string | |
numCustomizedUVs | integer | Number of customized UV outputs (0..8); negative keeps the current value. Valor predeterminado -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). Valor predeterminado false. |
Devuelve: asset, settings, connectedProperties, stats, errors.
material.set_sort_priority (riesgo 2, modifica, smoke)
Sets the sort priority of a parameter in the details panel.
| Argumento | Tipo | Descripción |
|---|---|---|
target | string | obligatorio. Material or Material Function asset. |
name | string | obligatorio. 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). Valor predeterminado 0.0. |
max | number | Slider maximum (scalar parameters). Valor predeterminado 0.0. |
sortPriority | integer | Sort priority in the details panel; negative keeps the current value. Valor predeterminado -1. |
Devuelve: parameter.
material.set_static_component_mask (riesgo 2, modifica)
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 | Descripción |
|---|---|---|
instance | string | obligatorio. |
name | string | obligatorio. |
r | boolean | Valor predeterminado true. |
g | boolean | Valor predeterminado false. |
b | boolean | Valor predeterminado false. |
a | boolean | Valor predeterminado false. |
Devuelve: value, overridden, parentValue.
material.set_static_switch (riesgo 2, modifica, smoke)
Overrides one static switch parameter (changes the shader permutation).
| Argumento | Tipo | Descripción |
|---|---|---|
instance | string | obligatorio. |
name | string | obligatorio. |
value | boolean | Valor predeterminado true. |
Devuelve: value, overridden, parentValue.
material.set_subsurface_profile (riesgo 2, modifica, smoke)
Sets (or clears, when the asset is empty) the subsurface profile override of an instance.
| Argumento | Tipo | Descripción |
|---|---|---|
material | string | obligatorio. |
physicalMaterial | string | Physical material asset; empty clears it. |
Devuelve: asset, parent, parentChain, baseMaterial, parameters, overriddenCount, overrides.
material.set_texture (riesgo 2, modifica, smoke)
Overrides one texture parameter.
| Argumento | Tipo | Descripción |
|---|---|---|
instance | string | obligatorio. |
name | string | obligatorio. |
texture | string | obligatorio. Texture asset path. |
Devuelve: value, overridden, parentValue.
material.set_usage (riesgo 2, modifica, smoke)
Enables or disables one bUsedWith* flag of a material (skeletal_mesh, particle_sprites, instanced_static_meshes, ...).
| Argumento | Tipo | Descripción |
|---|---|---|
material | string | obligatorio. |
usage | string | obligatorio. 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. Valor predeterminado true. |
Devuelve: available, enabled.
material.set_vector (riesgo 2, modifica, smoke)
Overrides one vector (colour) parameter.
| Argumento | Tipo | Descripción |
|---|---|---|
instance | string | obligatorio. |
name | string | obligatorio. |
color | UeaMatColor |
Devuelve: value, overridden, parentValue.
material.update_function (riesgo 2, modifica, smoke)
Recompiles the materials that call a function after its graph changed.
| Argumento | Tipo | Descripción |
|---|---|---|
function | string | obligatorio. Material Function asset path or unique name. |
Devuelve: count, items.
material.validate (riesgo 0, smoke)
Checks a material for unconnected required inputs, missing textures, sampler-type mismatches and unused parameters.
| Argumento | Tipo | Descripción |
|---|---|---|
material | string | obligatorio. Material asset path or unique name. |
Devuelve: valid, issues, errorCount, warningCount.
material.validate_function (riesgo 0, smoke)
Checks a function for unconnected outputs, unused inputs and duplicate names.
| Argumento | Tipo | Descripción |
|---|---|---|
function | string | obligatorio. Material Function asset path or unique name. |
Devuelve: valid, issues, errorCount, warningCount.