Saltar al contenido principal

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​

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

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

Start here​

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

Recipe workflow (fastest path)​

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

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

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

Graph workflow​

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

Compiling​

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

Instances​

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

Functions and the library​

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

Layers (UE 5.0+)​

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

Gotchas​

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

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 MaxAutoRisk requieren "_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 argumento dryRun. smoke = cubierto por edit.self_test.

material.add_actor_position (riesgo 2, modifica, smoke)​

Adds an Actor Position (world space) node.

ArgumentoTipoDescripción
targetstringobligatorio. Material or Material Function asset to add the expression to.
xintegerValor predeterminado 0.
yintegerValor predeterminado 0.
descstringOptional description; it becomes a stable selector for later calls.
compilebooleanRecompile 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).

ArgumentoTipoDescripción
targetstringobligatorio. Material or Material Function asset to add the expression to.
xintegerValor predeterminado 0.
yintegerValor predeterminado 0.
descstringOptional description; it becomes a stable selector for later calls.
compilebooleanRecompile 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.

ArgumentoTipoDescripción
heightRationumberValor predeterminado 0.05.
referencePlanenumberValor predeterminado 0.5.

Devuelve: node, target, errors.

material.add_camera_position (riesgo 2, modifica, smoke)​

Adds a Camera Position (world space) node.

ArgumentoTipoDescripción
targetstringobligatorio. Material or Material Function asset to add the expression to.
xintegerValor predeterminado 0.
yintegerValor predeterminado 0.
descstringOptional description; it becomes a stable selector for later calls.
compilebooleanRecompile 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.

ArgumentoTipoDescripción
targetstringobligatorio. Material or Material Function asset to add the expression to.
xintegerValor predeterminado 0.
yintegerValor predeterminado 0.
descstringOptional description; it becomes a stable selector for later calls.
compilebooleanRecompile 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.

ArgumentoTipoDescripción
collectionstringobligatorio. Material Parameter Collection asset.
namestringobligatorio. Parameter name inside the collection.

Devuelve: node, target, errors.

material.add_comment (riesgo 2, modifica, smoke)​

Adds a comment box to a graph.

ArgumentoTipoDescripción
targetstringobligatorio.
textstringobligatorio.
xintegerValor predeterminado 0.
yintegerValor predeterminado 0.
widthintegerValor predeterminado 400.
heightintegerValor predeterminado 200.
colorUeaMatColor

Devuelve: comment.

material.add_comment_around (riesgo 2, modifica, smoke)​

Adds a comment box sized to enclose the given expressions.

ArgumentoTipoDescripción
targetstringobligatorio.
textstringobligatorio.
nodesarray of stringobligatorio. Expressions to enclose.
paddingintegerExtra margin in graph units (default 40). Valor predeterminado 40.
colorUeaMatColor

Devuelve: comment.

material.add_component_mask (riesgo 2, modifica, smoke)​

Adds a Component Mask node.

ArgumentoTipoDescripción
rbooleanValor predeterminado true.
gbooleanValor predeterminado false.
bbooleanValor predeterminado false.
abooleanValor predeterminado false.

Devuelve: node, target, errors.

material.add_constant (riesgo 2, modifica, smoke)​

Adds a scalar constant.

ArgumentoTipoDescripción
valuenumberValor predeterminado 0.0.

Devuelve: node, target, errors.

material.add_constant2 (riesgo 2, modifica, smoke)​

Adds a two-component constant.

ArgumentoTipoDescripción
rnumberValor predeterminado 0.0.
gnumberValor predeterminado 0.0.

Devuelve: node, target, errors.

material.add_constant3 (riesgo 2, modifica, smoke)​

Adds a three-component (colour) constant.

ArgumentoTipoDescripción
colorUeaMatColor

Devuelve: node, target, errors.

material.add_constant4 (riesgo 2, modifica, smoke)​

Adds a four-component constant.

ArgumentoTipoDescripción
colorUeaMatColor

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).

ArgumentoTipoDescripción
namestringobligatorio.
atlasstringCurve Atlas asset.
curvestringCurve Linear Color asset inside the atlas.
groupstring

Devuelve: node, target, errors.

material.add_custom (riesgo 2, modifica, smoke)​

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

ArgumentoTipoDescripción
codestringobligatorio. HLSL body; it must return a value of the declared output type.
outputTypestringfloat (default) / float2 / float3 / float4 / material_attributes.
inputsarray of stringInput names.
descriptionstringCaption of the node.
additionalOutputsarray of UeaMatCustomOutputExtra named outputs.
includesarray of string.ush files to include (5.x).
definesarray of UeaKeyValuePreprocessor 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).

ArgumentoTipoDescripción
targetstringobligatorio. Material or Material Function asset to add the expression to.
xintegerValor predeterminado 0.
yintegerValor predeterminado 0.
descstringOptional description; it becomes a stable selector for later calls.
compilebooleanRecompile 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).

ArgumentoTipoDescripción
targetstringobligatorio. Material or Material Function asset to add the expression to.
xintegerValor predeterminado 0.
yintegerValor predeterminado 0.
descstringOptional description; it becomes a stable selector for later calls.
compilebooleanRecompile 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.

ArgumentoTipoDescripción
fadeDistancenumberValor predeterminado 100.0.
opacitynumberValor predeterminado 1.0.

Devuelve: node, target, errors.

material.add_depth_of_field_function (riesgo 2, modifica, smoke)​

Adds a Depth Of Field Function node.

ArgumentoTipoDescripción
targetstringobligatorio. Material or Material Function asset to add the expression to.
xintegerValor predeterminado 0.
yintegerValor predeterminado 0.
descstringOptional description; it becomes a stable selector for later calls.
compilebooleanRecompile 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.

ArgumentoTipoDescripción
luminanceFactorsUeaMatColorLuminance 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).

ArgumentoTipoDescripción
targetstringobligatorio. Material or Material Function asset to add the expression to.
xintegerValor predeterminado 0.
yintegerValor predeterminado 0.
descstringOptional description; it becomes a stable selector for later calls.
compilebooleanRecompile 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).

ArgumentoTipoDescripción
namesarray of stringNames of the four parameter channels.
indexintegerValor predeterminado 0.

Devuelve: node, target, errors.

material.add_eye_adaptation (riesgo 2, modifica, smoke)​

Adds an Eye Adaptation node.

ArgumentoTipoDescripción
targetstringobligatorio. Material or Material Function asset to add the expression to.
xintegerValor predeterminado 0.
yintegerValor predeterminado 0.
descstringOptional description; it becomes a stable selector for later calls.
compilebooleanRecompile 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.

ArgumentoTipoDescripción
targetstringobligatorio. Material or Material Function asset to add the expression to.
xintegerValor predeterminado 0.
yintegerValor predeterminado 0.
descstringOptional description; it becomes a stable selector for later calls.
compilebooleanRecompile 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.

ArgumentoTipoDescripción
exponentnumberValor predeterminado 5.0.
baseReflectFractionnumberValor 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.

ArgumentoTipoDescripción
functionstringobligatorio. 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).

ArgumentoTipoDescripción
namestringobligatorio.
typestringscalar / vector2 / vector3 / vector4 / texture2d / texture_cube / texture2d_array / volume_texture / static_bool / material_attributes / bool.
previewValueUeaMatColorPreview value used while editing the function.
sortPriorityintegerValor predeterminado 32.
usePreviewValueAsDefaultbooleanMake the preview value the default when the input is left unconnected. Valor predeterminado false.
descriptionstring

Devuelve: node, target, errors.

material.add_function_output (riesgo 2, modifica, smoke)​

Adds a Function Output node (material functions only).

ArgumentoTipoDescripción
namestringobligatorio.
sortPriorityintegerValor predeterminado 32.
descriptionstring

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).

ArgumentoTipoDescripción
functionstringobligatorio.
descriptionstring
exposeToLibrarystring"true" / "false"; empty keeps the current state.
categoriesarray 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).

ArgumentoTipoDescripción
targetstringobligatorio. Material or Material Function asset to add the expression to.
xintegerValor predeterminado 0.
yintegerValor predeterminado 0.
descstringOptional description; it becomes a stable selector for later calls.
compilebooleanRecompile 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).

ArgumentoTipoDescripción
mappingScalenumberValor predeterminado 1.0.
mappingTypestringauto / 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.

ArgumentoTipoDescripción
layersarray of UeaMatLandscapeLayerobligatorio.

Devuelve: node, target, errors.

material.add_landscape_layer_sample (riesgo 2, modifica, smoke)​

Adds a Landscape Layer Sample node.

ArgumentoTipoDescripción
layerNamestringobligatorio.
previewWeightnumberValor predeterminado 1.0.
previewUsedbooleanPreview 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.

ArgumentoTipoDescripción
layerNamestringobligatorio.
previewWeightnumberValor predeterminado 1.0.
previewUsedbooleanPreview 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.

ArgumentoTipoDescripción
layerNamestringobligatorio.
previewWeightnumberValor predeterminado 1.0.
previewUsedbooleanPreview 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.

ArgumentoTipoDescripción
targetstringobligatorio.
layerstringMaterial layer function asset.
blendstringBlend function asset.
namestringDisplay 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).

ArgumentoTipoDescripción
targetstringobligatorio. Material or Material Function asset to add the expression to.
xintegerValor predeterminado 0.
yintegerValor predeterminado 0.
descstringOptional description; it becomes a stable selector for later calls.
compilebooleanRecompile 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.

ArgumentoTipoDescripción
kindstringobligatorio. make / break / set / get.
attributesarray of stringAttribute 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, ...).

ArgumentoTipoDescripción
opstringobligatorio. 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).
constAnumberConstant fallback of the A input, when the expression has one. Valor predeterminado 0.0.
constBnumberConstant 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.

ArgumentoTipoDescripción
namestringobligatorio. 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.

ArgumentoTipoDescripción
namestringobligatorio. 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.

ArgumentoTipoDescripción
classstringobligatorio. Expression class or short alias ("Multiply", "TextureSample", "MaterialExpressionFresnel").
propertiesarray of UeaKeyValueProperties to set on the new expression.

Devuelve: node, target, errors.

material.add_noise (riesgo 2, modifica, smoke)​

Adds a Noise node (procedural noise).

ArgumentoTipoDescripción
scalenumberValor predeterminado 1.0.
qualityintegerValor predeterminado 1.
functionstringsimplex / gradient / fast_gradient / value / voronoi.
levelsintegerValor predeterminado 6.
turbulencebooleanValor predeterminado true.

Devuelve: node, target, errors.

material.add_object_orientation (riesgo 2, modifica, smoke)​

Adds an Object Orientation node.

ArgumentoTipoDescripción
targetstringobligatorio. Material or Material Function asset to add the expression to.
xintegerValor predeterminado 0.
yintegerValor predeterminado 0.
descstringOptional description; it becomes a stable selector for later calls.
compilebooleanRecompile 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.

ArgumentoTipoDescripción
targetstringobligatorio. Material or Material Function asset to add the expression to.
xintegerValor predeterminado 0.
yintegerValor predeterminado 0.
descstringOptional description; it becomes a stable selector for later calls.
compilebooleanRecompile 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).

ArgumentoTipoDescripción
targetstringobligatorio. Material or Material Function asset to add the expression to.
xintegerValor predeterminado 0.
yintegerValor predeterminado 0.
descstringOptional description; it becomes a stable selector for later calls.
compilebooleanRecompile 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).

ArgumentoTipoDescripción
speedXnumberValor predeterminado 0.0.
speedYnumberValor predeterminado 0.0.

Devuelve: node, target, errors.

material.add_particle_color (riesgo 2, modifica, smoke)​

Adds a Particle Color node.

ArgumentoTipoDescripción
targetstringobligatorio. Material or Material Function asset to add the expression to.
xintegerValor predeterminado 0.
yintegerValor predeterminado 0.
descstringOptional description; it becomes a stable selector for later calls.
compilebooleanRecompile 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.

ArgumentoTipoDescripción
targetstringobligatorio. Material or Material Function asset to add the expression to.
xintegerValor predeterminado 0.
yintegerValor predeterminado 0.
descstringOptional description; it becomes a stable selector for later calls.
compilebooleanRecompile 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.

ArgumentoTipoDescripción
targetstringobligatorio. Material or Material Function asset to add the expression to.
xintegerValor predeterminado 0.
yintegerValor predeterminado 0.
descstringOptional description; it becomes a stable selector for later calls.
compilebooleanRecompile 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.

ArgumentoTipoDescripción
targetstringobligatorio. Material or Material Function asset to add the expression to.
xintegerValor predeterminado 0.
yintegerValor predeterminado 0.
descstringOptional description; it becomes a stable selector for later calls.
compilebooleanRecompile 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).

ArgumentoTipoDescripción
texturestring
blendbooleanValor 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.

ArgumentoTipoDescripción
indexintegerIndex 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.

ArgumentoTipoDescripción
targetstringobligatorio. Material or Material Function asset to add the expression to.
xintegerValor predeterminado 0.
yintegerValor predeterminado 0.
descstringOptional description; it becomes a stable selector for later calls.
compilebooleanRecompile 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.

ArgumentoTipoDescripción
targetstringobligatorio. Material or Material Function asset to add the expression to.
xintegerValor predeterminado 0.
yintegerValor predeterminado 0.
descstringOptional description; it becomes a stable selector for later calls.
compilebooleanRecompile 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.

ArgumentoTipoDescripción
targetstringobligatorio. Material or Material Function asset to add the expression to.
xintegerValor predeterminado 0.
yintegerValor predeterminado 0.
descstringOptional description; it becomes a stable selector for later calls.
compilebooleanRecompile 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.

ArgumentoTipoDescripción
targetstringobligatorio. Material or Material Function asset to add the expression to.
xintegerValor predeterminado 0.
yintegerValor predeterminado 0.
descstringOptional description; it becomes a stable selector for later calls.
compilebooleanRecompile 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.

ArgumentoTipoDescripción
targetstringobligatorio. Material or Material Function asset to add the expression to.
xintegerValor predeterminado 0.
yintegerValor predeterminado 0.
descstringOptional description; it becomes a stable selector for later calls.
compilebooleanRecompile 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.

ArgumentoTipoDescripción
targetstringobligatorio. Material or Material Function asset to add the expression to.
xintegerValor predeterminado 0.
yintegerValor predeterminado 0.
descstringOptional description; it becomes a stable selector for later calls.
compilebooleanRecompile 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.

ArgumentoTipoDescripción
targetstringobligatorio. Material or Material Function asset to add the expression to.
xintegerValor predeterminado 0.
yintegerValor predeterminado 0.
descstringOptional description; it becomes a stable selector for later calls.
compilebooleanRecompile 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.

ArgumentoTipoDescripción
targetstringobligatorio. Material or Material Function asset to add the expression to.
xintegerValor predeterminado 0.
yintegerValor predeterminado 0.
descstringOptional description; it becomes a stable selector for later calls.
compilebooleanRecompile 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).

ArgumentoTipoDescripción
targetstringobligatorio. Material or Material Function asset to add the expression to.
xintegerValor predeterminado 0.
yintegerValor predeterminado 0.
descstringOptional description; it becomes a stable selector for later calls.
compilebooleanRecompile 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).

ArgumentoTipoDescripción
centerXnumberValor predeterminado 0.5.
centerYnumberValor predeterminado 0.5.
speednumberValor predeterminado 0.25.

Devuelve: node, target, errors.

material.add_runtime_virtual_texture_sample (riesgo 2, modifica, smoke)​

Adds a Runtime Virtual Texture Sample node.

ArgumentoTipoDescripción
virtualTexturestringRuntime Virtual Texture asset (optional).
materialTypestringbase_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.

ArgumentoTipoDescripción
namestringobligatorio.
defaultValuenumberValor predeterminado 0.0.
groupstring
minnumberValor predeterminado 0.0.
maxnumberValor predeterminado 1.0.
sortPriorityintegerValor predeterminado 32.

Devuelve: node, target, errors.

material.add_scene_color (riesgo 2, modifica, smoke)​

Adds a Scene Color node.

ArgumentoTipoDescripción
targetstringobligatorio. Material or Material Function asset to add the expression to.
xintegerValor predeterminado 0.
yintegerValor predeterminado 0.
descstringOptional description; it becomes a stable selector for later calls.
compilebooleanRecompile 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.

ArgumentoTipoDescripción
targetstringobligatorio. Material or Material Function asset to add the expression to.
xintegerValor predeterminado 0.
yintegerValor predeterminado 0.
descstringOptional description; it becomes a stable selector for later calls.
compilebooleanRecompile 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).

ArgumentoTipoDescripción
idstringScene texture id, e.g. "PostProcessInput0", "SceneColor", "SceneDepth", "WorldNormal".
filteredbooleanValor predeterminado false.

Devuelve: node, target, errors.

material.add_screen_position (riesgo 2, modifica, smoke)​

Adds a Screen Position node.

ArgumentoTipoDescripción
targetstringobligatorio. Material or Material Function asset to add the expression to.
xintegerValor predeterminado 0.
yintegerValor predeterminado 0.
descstringOptional description; it becomes a stable selector for later calls.
compilebooleanRecompile 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).

ArgumentoTipoDescripción
targetstringobligatorio. Material or Material Function asset to add the expression to.
xintegerValor predeterminado 0.
yintegerValor predeterminado 0.
descstringOptional description; it becomes a stable selector for later calls.
compilebooleanRecompile 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.

ArgumentoTipoDescripción
indexintegerIndex 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.

ArgumentoTipoDescripción
attenuationRadiusnumberValor predeterminado 256.0.
hardnessPercentnumberValor predeterminado 100.0.

Devuelve: node, target, errors.

material.add_static_bool (riesgo 2, modifica, smoke)​

Adds a static bool constant.

ArgumentoTipoDescripción
defaultValuebooleanValor 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).

ArgumentoTipoDescripción
defaultValuebooleanValor 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).

ArgumentoTipoDescripción
namestringobligatorio.
defaultValuebooleanValor predeterminado true.
groupstring

Devuelve: node, target, errors.

material.add_texture_coordinate (riesgo 2, modifica, smoke)​

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

ArgumentoTipoDescripción
indexintegerUV channel (default 0). Valor predeterminado 0.
uTilingnumberValor predeterminado 1.0.
vTilingnumberValor 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).

ArgumentoTipoDescripción
texturestringTexture asset, e.g. "/Engine/EngineResources/DefaultTexture".
samplerTypestringauto (from the texture) / color / linear_color / normal / masks / alpha / grayscale / linear_grayscale / distance_field / virtual_color / virtual_normal / virtual_masks.
mipValueModestringnone / mip_level / mip_bias / derivative.
uvNodestringExpression 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.

ArgumentoTipoDescripción
namestringobligatorio.
groupstring

Devuelve: node, target, errors.

material.add_texture_parameter (riesgo 2, modifica, smoke)​

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

ArgumentoTipoDescripción
namestringobligatorio.
groupstring

Devuelve: node, target, errors.

material.add_texture_property (riesgo 2, modifica, smoke)​

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

ArgumentoTipoDescripción
texturestringTexture asset to read the property from.
propertystringtexture_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.

ArgumentoTipoDescripción
texturestringTexture asset, e.g. "/Engine/EngineResources/DefaultTexture".
samplerTypestringauto (from the texture) / color / linear_color / normal / masks / alpha / grayscale / linear_grayscale / distance_field / virtual_color / virtual_normal / virtual_masks.
mipValueModestringnone / mip_level / mip_bias / derivative.
uvNodestringExpression to plug into the Coordinates input.

Devuelve: node, target, errors.

material.add_time (riesgo 2, modifica, smoke)​

Adds a Time node.

ArgumentoTipoDescripción
ignorePausebooleanValor predeterminado false.
periodnumberPeriod 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).

ArgumentoTipoDescripción
sourcestringtangent / local / world / view / camera / particle (position nodes: local / world / translated_world / view / camera / particle).
destinationstringDestination space, same vocabulary as "source".

Devuelve: node, target, errors.

material.add_transform_position (riesgo 2, modifica, smoke)​

Adds a Transform Position node.

ArgumentoTipoDescripción
sourcestringtangent / local / world / view / camera / particle (position nodes: local / world / translated_world / view / camera / particle).
destinationstringDestination 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).

ArgumentoTipoDescripción
targetstringobligatorio. Material or Material Function asset to add the expression to.
xintegerValor predeterminado 0.
yintegerValor predeterminado 0.
descstringOptional description; it becomes a stable selector for later calls.
compilebooleanRecompile 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.

ArgumentoTipoDescripción
functionstringcellnoise / perlin_3d / perlin_gradient / perlin_curl / voronoi.

Devuelve: node, target, errors.

material.add_vector_parameter (riesgo 2, modifica, smoke)​

Adds a vector (colour) parameter.

ArgumentoTipoDescripción
namestringobligatorio.
colorUeaMatColor
groupstring
sortPriorityintegerValor predeterminado 32.

Devuelve: node, target, errors.

material.add_vertex_color (riesgo 2, modifica, smoke)​

Adds a Vertex Color node.

ArgumentoTipoDescripción
targetstringobligatorio. Material or Material Function asset to add the expression to.
xintegerValor predeterminado 0.
yintegerValor predeterminado 0.
descstringOptional description; it becomes a stable selector for later calls.
compilebooleanRecompile 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).

ArgumentoTipoDescripción
targetstringobligatorio. Material or Material Function asset to add the expression to.
xintegerValor predeterminado 0.
yintegerValor predeterminado 0.
descstringOptional description; it becomes a stable selector for later calls.
compilebooleanRecompile 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.

ArgumentoTipoDescripción
targetstringobligatorio. Material or Material Function asset to add the expression to.
xintegerValor predeterminado 0.
yintegerValor predeterminado 0.
descstringOptional description; it becomes a stable selector for later calls.
compilebooleanRecompile 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.

ArgumentoTipoDescripción
targetstringobligatorio. Material or Material Function asset to add the expression to.
xintegerValor predeterminado 0.
yintegerValor predeterminado 0.
descstringOptional description; it becomes a stable selector for later calls.
compilebooleanRecompile 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.

ArgumentoTipoDescripción
targetstringobligatorio. Material or Material Function asset to add the expression to.
xintegerValor predeterminado 0.
yintegerValor predeterminado 0.
descstringOptional description; it becomes a stable selector for later calls.
compilebooleanRecompile 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.

ArgumentoTipoDescripción
targetstringobligatorio. Material or Material Function asset to add the expression to.
xintegerValor predeterminado 0.
yintegerValor predeterminado 0.
descstringOptional description; it becomes a stable selector for later calls.
compilebooleanRecompile 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.

ArgumentoTipoDescripción
targetstringobligatorio. Material or Material Function asset to add the expression to.
xintegerValor predeterminado 0.
yintegerValor predeterminado 0.
descstringOptional description; it becomes a stable selector for later calls.
compilebooleanRecompile 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.

ArgumentoTipoDescripción
targetstringobligatorio. Material or Material Function asset path / unique name.

Devuelve: count, items.

material.batch_reparent (riesgo 3, modifica, smoke)​

Reparents several instances at once.

ArgumentoTipoDescripción
instancesarray of stringobligatorio.
newParentstringobligatorio.

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.

ArgumentoTipoDescripción
instancesarray of stringInstances to change; leave empty to use "folder".
folderstringContent folder whose instances are changed.
namestringobligatorio.
valuenumberScalar value (material.batch_set_scalar). Valor predeterminado 0.0.
texturestringTexture 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.

ArgumentoTipoDescripción
instancesarray of stringInstances to change; leave empty to use "folder".
folderstringContent folder whose instances are changed.
namestringobligatorio.
valuenumberScalar value (material.batch_set_scalar). Valor predeterminado 0.0.
texturestringTexture 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.

ArgumentoTipoDescripción
targetstringobligatorio.
nodesarray of UeaMatBuildNodeobligatorio. Expressions to create.
linksarray of UeaMatLinkLinks between the new nodes and to material properties.
replacebooleanDelete the existing expressions first. Valor predeterminado false.
layoutbooleanAuto-arrange the graph afterwards (default true). Valor predeterminado true.
compilebooleanRecompile 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.

ArgumentoTipoDescripción
instancestringobligatorio. Material Instance Constant asset.

Devuelve: parameters, total, overriddenCount.

material.clear_graph (riesgo 5, modifica, destructivo, smoke)​

Deletes every expression and comment of a graph.

ArgumentoTipoDescripción
targetstringobligatorio. 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.

ArgumentoTipoDescripción
instancestringobligatorio.
namestringobligatorio.

Devuelve: parameters, total, overriddenCount.

material.compare_instances (riesgo 0, smoke)​

Compares the overrides of two instances.

ArgumentoTipoDescripción
astringobligatorio.
bstringobligatorio.

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.

ArgumentoTipoDescripción
materialstringobligatorio. 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").

ArgumentoTipoDescripción
targetstringobligatorio.
nodestringobligatorio. Source expression.
outputstringOutput name or index (default the first output).
tostringobligatorio. Material property ("BaseColor", "Roughness", "CustomizedUV0", ...) or "OtherNode.Input".
compilebooleanRecompile 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.

ArgumentoTipoDescripción
targetstringobligatorio.
linksarray of UeaMatLinkobligatorio.
compilebooleanRecompile 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.

ArgumentoTipoDescripción
fromstringobligatorio. Source instance or material.
tostringobligatorio. Destination instance.
onlyOverriddenbooleanOnly 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.

ArgumentoTipoDescripción
folderstringobligatorio. Destination content folder, e.g. "/Game/Materials".
namestringobligatorio. Asset name without path.
domainstringsurface (default) / deferred_decal / light_function / volume / post_process / ui / runtime_virtual_texture.
blendModestringopaque (default) / masked / translucent / additive / modulate / alpha_composite / alpha_holdout.
shadingModelstringdefault_lit (default) / unlit / subsurface / preintegrated_skin / clear_coat / subsurface_profile / two_sided_foliage / hair / cloth / eye / single_layer_water / thin_translucent / from_material_expression.
twoSidedbooleanRender both faces. Valor predeterminado false.
opacityMaskClipValuenumberAlpha threshold of masked materials (default 0.3333). Valor predeterminado 0.3333.
templatestringMaterial to copy the expression graph and settings from.
compilebooleanRecompile after creation (default true). Valor predeterminado true.
savebooleanSave 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.

ArgumentoTipoDescripción
folderstringobligatorio.
namestringobligatorio.
descriptionstring
exposeToLibrarybooleanPublish the function in the material palette. Valor predeterminado false.
libraryCategoriesarray of stringPalette categories when exposed.
inputsarray of UeaMatFunctionParamInput declarations to create.
outputsarray of stringOutput names to create.
savebooleanValor 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).

ArgumentoTipoDescripción
functionstringobligatorio. Parent material function (or layer / layer blend).
folderstringobligatorio.
namestringobligatorio.
scalarsarray of UeaMatScalarValue
vectorsarray of UeaMatVectorValue
texturesarray 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.

ArgumentoTipoDescripción
parentstringobligatorio. Parent material or material instance.
folderstringobligatorio.
namestringobligatorio.
scalarsarray of UeaMatScalarValue
vectorsarray of UeaMatVectorValue
texturesarray of UeaMatTextureValue
switchesarray of UeaMatSwitchValue
compilebooleanUpdate the instance's shaders after the overrides (default true). Valor predeterminado true.
savebooleanValor 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.

ArgumentoTipoDescripción
parentstringobligatorio.
folderstringobligatorio.
variantsarray of UeaMatVariantobligatorio.
savebooleanValor predeterminado false.

Devuelve: assets, total.

material.create_layer (riesgo 2, modifica, UE 5.0+, smoke)​

Creates a Material Layer function asset.

ArgumentoTipoDescripción
folderstringobligatorio.
namestringobligatorio.
descriptionstring
savebooleanValor predeterminado false.

Devuelve: asset, errors, notes.

material.create_layer_blend (riesgo 2, modifica, UE 5.0+, smoke)​

Creates a Material Layer Blend function asset.

ArgumentoTipoDescripción
folderstringobligatorio.
namestringobligatorio.
descriptionstring
savebooleanValor predeterminado false.

Devuelve: asset, errors, notes.

material.delete (riesgo 3, modifica, destructivo, smoke)​

Deletes a material asset. References to it are broken.

ArgumentoTipoDescripción
materialstringobligatorio. Material asset path or unique name.

Devuelve: count, items.

material.delete_function (riesgo 3, modifica, destructivo, smoke)​

Deletes a material function.

ArgumentoTipoDescripción
functionstringobligatorio. Material Function asset path or unique name.

Devuelve: count, items.

material.delete_instance (riesgo 3, modifica, destructivo, smoke)​

Deletes a material instance.

ArgumentoTipoDescripción
instancestringobligatorio. Material Instance Constant asset.

Devuelve: count, items.

material.delete_node (riesgo 3, modifica, smoke)​

Deletes one expression and breaks every link that touched it.

ArgumentoTipoDescripción
targetstringobligatorio.
nodestringobligatorio. Expression object name, description, "#index" or parameter name.

Devuelve: count, items.

material.delete_nodes (riesgo 3, modifica, destructivo, smoke)​

Deletes several expressions at once.

ArgumentoTipoDescripción
targetstringobligatorio.
nodesarray of stringobligatorio. Expression selectors.

Devuelve: count, items.

material.disconnect (riesgo 2, modifica, smoke)​

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

ArgumentoTipoDescripción
targetstringobligatorio.
tostringobligatorio. Material property ("BaseColor") or "Node.Input".
compilebooleanRecompile 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.

ArgumentoTipoDescripción
targetstringobligatorio.
nodestringobligatorio.
outgoingbooleanAlso unplug the expressions this one feeds (default true). Valor predeterminado true.
incomingbooleanAlso 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.

ArgumentoTipoDescripción
materialstringobligatorio. Source asset.
folderstringobligatorio. Destination folder.
namestringobligatorio. Name of the copy.

Devuelve: asset, errors, notes.

material.duplicate_function (riesgo 2, modifica, smoke)​

Duplicates a material function.

ArgumentoTipoDescripción
materialstringobligatorio. Source asset.
folderstringobligatorio. Destination folder.
namestringobligatorio. Name of the copy.

Devuelve: asset, errors, notes.

material.duplicate_instance (riesgo 2, modifica, smoke)​

Duplicates a material instance.

ArgumentoTipoDescripción
materialstringobligatorio. Source asset.
folderstringobligatorio. Destination folder.
namestringobligatorio. 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.

ArgumentoTipoDescripción
targetstringobligatorio.
nodestringobligatorio.
offsetXintegerX offset of the copy (default 40). Valor predeterminado 40.
offsetYintegerY 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).

ArgumentoTipoDescripción
functionstringobligatorio. 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).

ArgumentoTipoDescripción
materialstringobligatorio. 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.

ArgumentoTipoDescripción
referencestringobligatorio. Texture, function or expression class to look for.
folderstringContent folder to search (default "/Game").
limitintegerMaximum results (default 100). Valor predeterminado 100.

Devuelve: assets, total.

material.find_by_texture (riesgo 0, smoke)​

Materials whose graph samples a given texture.

ArgumentoTipoDescripción
referencestringobligatorio. Texture, function or expression class to look for.
folderstringContent folder to search (default "/Game").
limitintegerMaximum 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.

ArgumentoTipoDescripción
referencestringobligatorio. Texture, function or expression class to look for.
folderstringContent folder to search (default "/Game").
limitintegerMaximum results (default 100). Valor predeterminado 100.

Devuelve: assets, total.

material.find_node (riesgo 0, smoke)​

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

ArgumentoTipoDescripción
targetstringobligatorio.
querystringText matched against the object name, description, caption, class and parameter name.
classstringRestrict to one expression class.
limitintegerValor 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.

ArgumentoTipoDescripción
materialstringobligatorio. Source material.
nodesarray of stringobligatorio. Expressions to move into the function.
folderstringobligatorio.
namestringobligatorio.
replaceWithCallbooleanReplace 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.

ArgumentoTipoDescripción
materialstringobligatorio. 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.

ArgumentoTipoDescripción
materialstringobligatorio. 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.

ArgumentoTipoDescripción
materialstringobligatorio. 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.

ArgumentoTipoDescripción
classstringobligatorio. 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.

ArgumentoTipoDescripción
functionstringobligatorio. 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.

ArgumentoTipoDescripción
functionstringobligatorio. Material Function asset path or unique name.

Devuelve: params, total.

material.get_function_outputs (riesgo 0, smoke)​

Output declarations of a material function.

ArgumentoTipoDescripción
functionstringobligatorio. 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.

ArgumentoTipoDescripción
targetstringobligatorio. 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.

ArgumentoTipoDescripción
materialstringobligatorio. 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.

ArgumentoTipoDescripción
targetstringobligatorio.
tostringobligatorio. 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.

ArgumentoTipoDescripción
instancestringobligatorio. 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.

ArgumentoTipoDescripción
instancestringobligatorio. Material Instance Constant asset.

Devuelve: chain, baseMaterial.

material.get_instance_overrides (riesgo 0, smoke)​

Base-property overrides currently active on an instance.

ArgumentoTipoDescripción
instancestringobligatorio. 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.

ArgumentoTipoDescripción
instancestringobligatorio.
layerIndexintegerLayer 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).

ArgumentoTipoDescripción
targetstringobligatorio. 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.

ArgumentoTipoDescripción
targetstringobligatorio.
nodestringobligatorio. 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.

ArgumentoTipoDescripción
targetstringobligatorio.
nodestringobligatorio. Expression object name, description, "#index" or parameter name.

Devuelve: node, target, errors.

material.get_node_outputs (riesgo 0, smoke)​

Output pins of an expression.

ArgumentoTipoDescripción
targetstringobligatorio.
nodestringobligatorio. 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.

ArgumentoTipoDescripción
targetstringobligatorio.
nodestringobligatorio.
propertystringobligatorio. Property name on the expression class, e.g. "Texture", "SamplerType", "ConstCoordinate".
valuestringNew 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.

ArgumentoTipoDescripción
instancestringobligatorio.
namestringobligatorio.

Devuelve: parameter.

material.get_properties_connected (riesgo 0, smoke)​

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

ArgumentoTipoDescripción
materialstringobligatorio. 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.

ArgumentoTipoDescripción
instancestringobligatorio.
namestringobligatorio.

Devuelve: value, overridden, parentValue.

material.get_static_switch (riesgo 0, smoke)​

Value of one static switch parameter.

ArgumentoTipoDescripción
instancestringobligatorio.
namestringobligatorio.

Devuelve: value, overridden, parentValue.

material.get_stats (riesgo 0, smoke)​

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

ArgumentoTipoDescripción
materialstringobligatorio. Material or material instance asset.

Devuelve: stats, material.

material.get_texture (riesgo 0, smoke)​

Value of one texture parameter.

ArgumentoTipoDescripción
instancestringobligatorio.
namestringobligatorio.

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.

ArgumentoTipoDescripción
materialstringobligatorio. Material asset path or unique name.

Devuelve: samplers, total, mismatchCount.

material.get_vector (riesgo 0, smoke)​

Value of one vector parameter.

ArgumentoTipoDescripción
instancestringobligatorio.
namestringobligatorio.

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.

ArgumentoTipoDescripción
materialstringobligatorio.
jsonstringobligatorio. JSON produced by material.export_graph.
replacebooleanDelete the existing expressions first (default true). Valor predeterminado true.
compilebooleanRecompile 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.

ArgumentoTipoDescripción
materialstringobligatorio.
jsonstringobligatorio. JSON produced by material.export_graph.
replacebooleanDelete the existing expressions first (default true). Valor predeterminado true.
compilebooleanRecompile 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.

ArgumentoTipoDescripción
targetstringobligatorio.
nodestringobligatorio. 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.

ArgumentoTipoDescripción
targetstringobligatorio.
tostringobligatorio. 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.

ArgumentoTipoDescripción
folderstringContent folder to search (default "/Game").
domainstringOnly materials with this domain.
blendModestringOnly materials with this blend mode.
nameContainsstringName substring filter.
recursivebooleanSearch subfolders (default true). Valor predeterminado true.
limitintegerMaximum results (default 200). Valor predeterminado 200.

Devuelve: assets, total.

material.list_comments (riesgo 0, smoke)​

Comment boxes of a graph.

ArgumentoTipoDescripción
targetstringobligatorio. 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).

ArgumentoTipoDescripción
folderstringContent folder (default "/Game").
exposedOnlybooleanOnly functions exposed to the material palette. Valor predeterminado false.
categorystringLibrary category filter.
nameContainsstring
recursivebooleanValor predeterminado true.
limitintegerValor 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.

ArgumentoTipoDescripción
nameContainsstringName substring filter (e.g. "texture").
categorystringEditor category filter (e.g. "Math").
limitintegerMaximum 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.

ArgumentoTipoDescripción
folderstringContent folder (default "/Game").
exposedOnlybooleanOnly functions exposed to the material palette. Valor predeterminado false.
categorystringLibrary category filter.
nameContainsstring
recursivebooleanValor predeterminado true.
limitintegerValor predeterminado 200.

Devuelve: functions, total, categories.

material.list_function_users (riesgo 0, smoke)​

Materials and functions that call a given function.

ArgumentoTipoDescripción
functionstringobligatorio. 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.

ArgumentoTipoDescripción
folderstringContent folder (default "/Game").
exposedOnlybooleanOnly functions exposed to the material palette. Valor predeterminado false.
categorystringLibrary category filter.
nameContainsstring
recursivebooleanValor predeterminado true.
limitintegerValor predeterminado 200.

Devuelve: assets, total.

material.list_instance_parameters (riesgo 0, smoke)​

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

ArgumentoTipoDescripción
instancestringobligatorio.
overriddenOnlybooleanOnly parameters this instance overrides. Valor predeterminado false.
typestringOnly 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.

ArgumentoTipoDescripción
parentstringOnly instances derived from this material or instance.
folderstringContent folder (default "/Game").
recursivebooleanValor predeterminado true.
includeIndirectbooleanInclude grandchildren of the parent (default true). Valor predeterminado true.
limitintegerValor predeterminado 200.

Devuelve: assets, total.

material.list_layer_blends (riesgo 0, UE 5.0+, smoke)​

Lists Material Layer Blend assets under a folder.

ArgumentoTipoDescripción
folderstringContent folder (default "/Game").
exposedOnlybooleanOnly functions exposed to the material palette. Valor predeterminado false.
categorystringLibrary category filter.
nameContainsstring
recursivebooleanValor predeterminado true.
limitintegerValor predeterminado 200.

Devuelve: assets, total.

material.list_layers (riesgo 0, UE 5.0+, smoke)​

Lists Material Layer assets under a folder.

ArgumentoTipoDescripción
folderstringContent folder (default "/Game").
exposedOnlybooleanOnly functions exposed to the material palette. Valor predeterminado false.
categorystringLibrary category filter.
nameContainsstring
recursivebooleanValor predeterminado true.
limitintegerValor predeterminado 200.

Devuelve: assets, total.

material.list_nodes (riesgo 0, smoke)​

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

ArgumentoTipoDescripción
targetstringobligatorio.
classFilterstringOnly expressions of this class ("TextureSample", "MaterialExpressionMultiply").
nameContainsstringName/desc/caption substring filter.
limitintegerMaximum 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.

ArgumentoTipoDescripción
targetstringobligatorio. Material or Material Function asset.
typestringOnly parameters of this type (scalar / vector / texture / switch).
groupstringOnly 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.

ArgumentoTipoDescripción
materialstringobligatorio. 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.

ArgumentoTipoDescripción
materialstringobligatorio. Material asset path or unique name.

Devuelve: available, enabled.

material.move_node (riesgo 2, modifica, smoke)​

Moves one expression to an absolute graph position.

ArgumentoTipoDescripción
targetstringobligatorio.
nodestringobligatorio.
xintegerValor predeterminado 0.
yintegerValor predeterminado 0.

Devuelve: node, target, errors.

material.move_nodes (riesgo 2, modifica, smoke)​

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

ArgumentoTipoDescripción
targetstringobligatorio.
nodesarray of stringExpressions to move; empty moves the whole graph.
dxintegerValor predeterminado 0.
dyintegerValor predeterminado 0.

Devuelve: count, items.

material.recipe_checker (riesgo 2, modifica, smoke)​

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

ArgumentoTipoDescripción
colorAUeaMatColor
colorBUeaMatColor
scalenumberValor 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.

ArgumentoTipoDescripción
baseColorstring
baseColorTintUeaMatColor
normalstring
roughnessnumberValor predeterminado 0.5.
subsurfaceColorUeaMatColorSubsurface / fuzz colour depending on the recipe.
amountnumberCloth 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.

ArgumentoTipoDescripción
baseColorstring
tintUeaMatColor
normalstring
opacityTexturestringTexture whose alpha drives the decal opacity.
opacitynumberValor predeterminado 1.0.
dbufferbooleanUse 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.

ArgumentoTipoDescripción
baseColorstring
baseColorTintUeaMatColor
noiseTexturestringNoise texture; when empty a procedural Noise node is used.
amountnumberInitial dissolve amount (0..1). Valor predeterminado 0.5.
edgeColorUeaMatColor
edgeWidthnumberValor 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.

ArgumentoTipoDescripción
colorUeaMatColor
intensitynumberValor predeterminado 5.0.
pulsenumberPulse 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).

ArgumentoTipoDescripción
texturestring
columnsintegerValor predeterminado 4.
rowsintegerValor predeterminado 4.
fpsnumberValor 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.

ArgumentoTipoDescripción
textureFolderstringobligatorio. Folder holding the texture set.
nameContainsstringOnly textures whose name contains this.
dryRunbooleanReport 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.

ArgumentoTipoDescripción
tintUeaMatColor
roughnessnumberValor predeterminado 0.05.
iornumberValor predeterminado 1.52.
opacitynumberValor 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.

ArgumentoTipoDescripción
colorAUeaMatColor
colorBUeaMatColor
axisstringu (default) or v.

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

material.recipe_hologram (riesgo 2, modifica, smoke)​

Hologram: translucent scanlines scrolling over an emissive tint.

ArgumentoTipoDescripción
colorUeaMatColor
scanlineDensitynumberValor predeterminado 40.0.
speednumberValor predeterminado 0.5.
opacitynumberValor 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.

ArgumentoTipoDescripción
layersarray of UeaMatRecipeLandscapeLayerobligatorio.
blendTypestringweight (default) / alpha / height.
macroVariationbooleanAdd 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.

ArgumentoTipoDescripción
texturestringTexture whose alpha drives the mask (and whose RGB drives base colour).
maskTexturestringSeparate opacity-mask texture.
clipValuenumberValor predeterminado 0.3333.
twoSidedbooleanValor predeterminado true.
foliagebooleanUse the two-sided foliage shading model with this subsurface colour. Valor predeterminado false.
subsurfaceColorUeaMatColor

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

material.recipe_panner (riesgo 2, modifica, smoke)​

Scrolling texture (Panner) feeding base colour.

ArgumentoTipoDescripción
texturestring
speedXnumberValor predeterminado 0.1.
speedYnumberValor predeterminado 0.0.
tilingnumberValor predeterminado 1.0.

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

material.recipe_parallax (riesgo 2, modifica, smoke)​

Parallax (bump offset) material using a height texture.

ArgumentoTipoDescripción
baseColorstring
heightstring
normalstring
heightRationumberValor 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).

ArgumentoTipoDescripción
baseColorstringBase colour texture; empty uses the colour below.
baseColorTintUeaMatColorBase colour when no texture is given.
normalstringNormal map texture.
roughnessstringRoughness texture; empty uses roughnessValue.
roughnessValuenumberValor predeterminado 0.5.
metallicstringMetallic texture; empty uses metallicValue.
metallicValuenumberValor predeterminado 0.0.
aostringAmbient occlusion texture.
emissivestringEmissive texture.
emissiveTintUeaMatColor
emissiveIntensitynumberValor predeterminado 0.0.
packedOrmstringPacked occlusion/roughness/metallic texture (R=AO, G=Roughness, B=Metallic).
tilingnumberUV 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.

ArgumentoTipoDescripción
effectstringtint / desaturate / vignette.
colorUeaMatColor
intensitynumberValor predeterminado 1.0.
blendableLocationstringbefore_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.

ArgumentoTipoDescripción
baseColorTintUeaMatColor
rimColorUeaMatColor
exponentnumberValor predeterminado 4.0.
intensitynumberValor predeterminado 2.0.

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

material.recipe_subsurface_skin (riesgo 2, modifica, smoke)​

Subsurface skin material (preintegrated skin shading model).

ArgumentoTipoDescripción
baseColorstring
baseColorTintUeaMatColor
normalstring
roughnessnumberValor predeterminado 0.5.
subsurfaceColorUeaMatColorSubsurface / fuzz colour depending on the recipe.
amountnumberCloth 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.

ArgumentoTipoDescripción
colorUeaMatColor
opacitynumberValor predeterminado 0.5.
fresnelbooleanAdd a Fresnel term to the opacity. Valor predeterminado false.
iornumberValor predeterminado 1.0.
unlitbooleanUse 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.

ArgumentoTipoDescripción
baseColorstring
normalstring
scalenumberValor predeterminado 256.0.
sharpnessnumberValor 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.

ArgumentoTipoDescripción
baseColorstring
baseColorTintUeaMatColor
normalstring
roughnessnumberValor predeterminado 0.5.
subsurfaceColorUeaMatColorSubsurface / fuzz colour depending on the recipe.
amountnumberCloth 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.

ArgumentoTipoDescripción
texturestring
tintUeaMatColor
opacitynumberValor 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.

ArgumentoTipoDescripción
colorUeaMatColor

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

material.recipe_vertex_color (riesgo 2, modifica, smoke)​

Uses the mesh vertex colour as base colour.

ArgumentoTipoDescripción
folderstringDestination folder (ignored when "material" points at an existing asset).
namestringName of the material to create.
materialstringExisting material to fill instead of creating one (its graph is cleared).
parameterizebooleanExpose the recipe's inputs as material parameters (default true). Valor predeterminado true.
groupstringParameter group used when parameterizing.
compilebooleanRecompile at the end (default true). Valor predeterminado true.
savebooleanSave 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.

ArgumentoTipoDescripción
normalstringNormal map scrolled over the surface.
speednumberValor predeterminado 0.05.
colorUeaMatColor
opacitynumberValor predeterminado 0.6.
fresnelbooleanValor predeterminado true.

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

material.remove_function_input (riesgo 3, modifica, smoke)​

Removes one input declaration from a function.

ArgumentoTipoDescripción
functionstringobligatorio.
namestringobligatorio.
newNamestringNew name (material.rename_function_input).

Devuelve: params, total.

material.remove_function_output (riesgo 3, modifica, smoke)​

Removes one output declaration from a function.

ArgumentoTipoDescripción
functionstringobligatorio.
namestringobligatorio.
newNamestringNew 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.

ArgumentoTipoDescripción
targetstringobligatorio.
indexintegerobligatorio.
visiblebooleanVisibility for material.set_layer_visible. Valor predeterminado true.
newIndexintegerNew index for material.reorder_layer. Valor predeterminado 0.
assetstringLayer or blend asset for material.set_layer_asset.
slotstring"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.

ArgumentoTipoDescripción
materialstringobligatorio.
newNamestringobligatorio.

Devuelve: asset, errors, notes.

material.rename_function (riesgo 2, modifica, smoke)​

Renames a material function.

ArgumentoTipoDescripción
materialstringobligatorio.
newNamestringobligatorio.

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.

ArgumentoTipoDescripción
functionstringobligatorio.
namestringobligatorio.
newNamestringNew name (material.rename_function_input).

Devuelve: params, total.

material.rename_instance (riesgo 2, modifica, smoke)​

Renames a material instance.

ArgumentoTipoDescripción
materialstringobligatorio.
newNamestringobligatorio.

Devuelve: asset, errors, notes.

material.rename_parameter (riesgo 3, modifica, smoke)​

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

ArgumentoTipoDescripción
targetstringobligatorio. Material or Material Function asset.
namestringobligatorio. Parameter name.
groupstringNew parameter group.
valuestringNew default value (number, "(R=1,G=0,B=0,A=1)" or a texture asset path).
newNamestringNew name (material.rename_parameter).
minnumberSlider minimum (scalar parameters). Valor predeterminado 0.0.
maxnumberSlider maximum (scalar parameters). Valor predeterminado 0.0.
sortPriorityintegerSort 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.

ArgumentoTipoDescripción
targetstringobligatorio.
indexintegerobligatorio.
visiblebooleanVisibility for material.set_layer_visible. Valor predeterminado true.
newIndexintegerNew index for material.reorder_layer. Valor predeterminado 0.
assetstringLayer or blend asset for material.set_layer_asset.
slotstring"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.

ArgumentoTipoDescripción
targetstringobligatorio.
nodestringobligatorio.
newClassstringobligatorio. 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.

ArgumentoTipoDescripción
materialstringobligatorio.
fromstringobligatorio. Texture currently referenced.
tostringobligatorio. Replacement texture.
compilebooleanRecompile 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.

ArgumentoTipoDescripción
instancestringobligatorio. Material Instance Constant asset.

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

material.save (riesgo 2, modifica, smoke)​

Saves a material package to disk.

ArgumentoTipoDescripción
materialstringobligatorio. Material asset path or unique name.

Devuelve: asset, errors, notes.

material.save_function (riesgo 2, modifica, smoke)​

Saves a material function package to disk.

ArgumentoTipoDescripción
functionstringobligatorio. 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.

ArgumentoTipoDescripción
instancestringobligatorio. 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.

ArgumentoTipoDescripción
functionstringobligatorio.
namestringobligatorio.
typestring
previewValueUeaMatColor
sortPriorityintegerNegative keeps the current value. Valor predeterminado -1.
descriptionstring
usePreviewAsDefaultstring"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.

ArgumentoTipoDescripción
instancestringobligatorio. Material Function Instance asset.
scalarsarray of UeaMatScalarValue
vectorsarray of UeaMatVectorValue
texturesarray 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.

ArgumentoTipoDescripción
functionstringobligatorio.
descriptionstring
exposeToLibrarystring"true" / "false"; empty keeps the current state.
categoriesarray 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.

ArgumentoTipoDescripción
instancestringobligatorio.
blendModestringBlend mode override; "inherit" removes the override.
shadingModelstringShading model override; "inherit" removes the override.
twoSidedstring"true" / "false" / "inherit".
ditheredLODTransitionstring"true" / "false" / "inherit".
castDynamicShadowAsMaskedstring"true" / "false" / "inherit".
outputTranslucentVelocitystring"true" / "false" / "inherit" (5.x only).
opacityMaskClipValuenumberAlpha threshold override; negative keeps the current state. Valor predeterminado -1.0.
clearOpacityMaskClipValuebooleanRemove 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.

ArgumentoTipoDescripción
materialstringobligatorio.
physicalMaterialstringPhysical 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.

ArgumentoTipoDescripción
targetstringobligatorio.
indexintegerobligatorio.
visiblebooleanVisibility for material.set_layer_visible. Valor predeterminado true.
newIndexintegerNew index for material.reorder_layer. Valor predeterminado 0.
assetstringLayer or blend asset for material.set_layer_asset.
slotstring"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.

ArgumentoTipoDescripción
instancestringobligatorio. Material Instance Constant that owns the layer stack.
layerIndexintegerobligatorio.
namestringobligatorio.
kindstringscalar (default) / vector / texture / switch.
valuestringValue as text: a number, "(R=..,G=..,B=..,A=..)", a texture path or true/false.
blendbooleanTarget 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.

ArgumentoTipoDescripción
targetstringobligatorio.
indexintegerobligatorio.
visiblebooleanVisibility for material.set_layer_visible. Valor predeterminado true.
newIndexintegerNew index for material.reorder_layer. Valor predeterminado 0.
assetstringLayer or blend asset for material.set_layer_asset.
slotstring"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.

ArgumentoTipoDescripción
targetstringobligatorio.
layersarray of stringobligatorio. Material layer function assets, background first.
blendsarray of stringBlend function assets; one per layer above the background.
namesarray of stringDisplay 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.

ArgumentoTipoDescripción
targetstringobligatorio.
nodestringobligatorio.
descstringNew 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.

ArgumentoTipoDescripción
targetstringobligatorio.
nodestringobligatorio.
propertiesarray of UeaKeyValueobligatorio. 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).

ArgumentoTipoDescripción
targetstringobligatorio.
nodestringobligatorio.
propertystringobligatorio. Property name on the expression class, e.g. "Texture", "SamplerType", "ConstCoordinate".
valuestringNew 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.

ArgumentoTipoDescripción
targetstringobligatorio. Material or Material Function asset.
namestringobligatorio. Parameter name.
groupstringNew parameter group.
valuestringNew default value (number, "(R=1,G=0,B=0,A=1)" or a texture asset path).
newNamestringNew name (material.rename_parameter).
minnumberSlider minimum (scalar parameters). Valor predeterminado 0.0.
maxnumberSlider maximum (scalar parameters). Valor predeterminado 0.0.
sortPriorityintegerSort 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.

ArgumentoTipoDescripción
targetstringobligatorio. Material or Material Function asset.
namestringobligatorio. Parameter name.
groupstringNew parameter group.
valuestringNew default value (number, "(R=1,G=0,B=0,A=1)" or a texture asset path).
newNamestringNew name (material.rename_parameter).
minnumberSlider minimum (scalar parameters). Valor predeterminado 0.0.
maxnumberSlider maximum (scalar parameters). Valor predeterminado 0.0.
sortPriorityintegerSort 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.

ArgumentoTipoDescripción
targetstringobligatorio. Material or Material Function asset.
namestringobligatorio. Parameter name.
groupstringNew parameter group.
valuestringNew default value (number, "(R=1,G=0,B=0,A=1)" or a texture asset path).
newNamestringNew name (material.rename_parameter).
minnumberSlider minimum (scalar parameters). Valor predeterminado 0.0.
maxnumberSlider maximum (scalar parameters). Valor predeterminado 0.0.
sortPriorityintegerSort 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.

ArgumentoTipoDescripción
instancestringobligatorio.
scalarsarray of UeaMatScalarValue
vectorsarray of UeaMatVectorValue
texturesarray of UeaMatTextureValue
switchesarray of UeaMatSwitchValue
compilebooleanUpdate 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.

ArgumentoTipoDescripción
instancestringobligatorio.
parentstringobligatorio.

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.

ArgumentoTipoDescripción
materialstringobligatorio.
physicalMaterialstringPhysical 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.

ArgumentoTipoDescripción
materialstringobligatorio.
meshstringobligatorio. 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.

ArgumentoTipoDescripción
instancestringobligatorio.
namestringobligatorio.
valuenumberobligatorio.

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.

ArgumentoTipoDescripción
materialstringobligatorio.
domainstring
blendModestring
shadingModelstring
shadingModelsarray of stringExtra shading models to allow (5.x, materials using "from_material_expression").
twoSidedstring"true"/"false" to change it; empty to keep.
opacityMaskClipValuenumberAlpha threshold of masked materials; negative keeps the current value. Valor predeterminado -1.0.
ditheredLODTransitionstring
tangentSpaceNormalstring
numCustomizedUVsintegerNumber of customized UV outputs (0..8); negative keeps the current value. Valor predeterminado -1.
allowNegativeEmissivestring
blendableLocationstringPost-process blendable location (before_tonemapping / after_tonemapping / before_translucency / ...).
refractionMethodstringRefraction method (5.x only): none / index_of_refraction / pixel_normal_offset.
materialDecalResponsestringnone / color_normal_roughness / color / color_normal / color_roughness / normal / normal_roughness / roughness.
castRayTracedShadowsstring
usagearray of stringbUsedWith* flags to enable, by short name ("skeletal_mesh", "particle_sprites", "niagara_sprites", "instanced_static_meshes", "static_lighting", ...).
subsurfaceProfilestringSubsurface profile asset.
compilebooleanRecompile 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.

ArgumentoTipoDescripción
targetstringobligatorio. Material or Material Function asset.
namestringobligatorio. Parameter name.
groupstringNew parameter group.
valuestringNew default value (number, "(R=1,G=0,B=0,A=1)" or a texture asset path).
newNamestringNew name (material.rename_parameter).
minnumberSlider minimum (scalar parameters). Valor predeterminado 0.0.
maxnumberSlider maximum (scalar parameters). Valor predeterminado 0.0.
sortPriorityintegerSort 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.

ArgumentoTipoDescripción
instancestringobligatorio.
namestringobligatorio.
rbooleanValor predeterminado true.
gbooleanValor predeterminado false.
bbooleanValor predeterminado false.
abooleanValor predeterminado false.

Devuelve: value, overridden, parentValue.

material.set_static_switch (riesgo 2, modifica, smoke)​

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

ArgumentoTipoDescripción
instancestringobligatorio.
namestringobligatorio.
valuebooleanValor 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.

ArgumentoTipoDescripción
materialstringobligatorio.
physicalMaterialstringPhysical material asset; empty clears it.

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

material.set_texture (riesgo 2, modifica, smoke)​

Overrides one texture parameter.

ArgumentoTipoDescripción
instancestringobligatorio.
namestringobligatorio.
texturestringobligatorio. 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, ...).

ArgumentoTipoDescripción
materialstringobligatorio.
usagestringobligatorio. 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, ...).
enabledbooleanTrue to enable (default), false to disable. Valor predeterminado true.

Devuelve: available, enabled.

material.set_vector (riesgo 2, modifica, smoke)​

Overrides one vector (colour) parameter.

ArgumentoTipoDescripción
instancestringobligatorio.
namestringobligatorio.
colorUeaMatColor

Devuelve: value, overridden, parentValue.

material.update_function (riesgo 2, modifica, smoke)​

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

ArgumentoTipoDescripción
functionstringobligatorio. 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.

ArgumentoTipoDescripción
materialstringobligatorio. 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.

ArgumentoTipoDescripción
functionstringobligatorio. Material Function asset path or unique name.

Devuelve: valid, issues, errorCount, warningCount.