Pular para o conteúdo principal

Kit skel

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

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

Guia​

Everything about the skeletal side of assets: the skeleton itself (bone tree, virtual bones, skeleton sockets, animation slot groups, curve metadata, blend profiles, per-bone translation retargeting, notify names, compatible skeletons), the deeper parts of a skeletal mesh (LOD info, reduction and build settings, sections, morph targets, skin weight profiles, reference pose, bounds, Niagara sampling, ray tracing, mesh merge, FBX export, import settings), physics assets (bodies, shapes, constraints, profiles, collision pairs) and clothing.

Works on UE 4.27 through 5.8 (~150 tools on 5.8, ~145 on 4.27). The 5.x-only tools are the compatible-skeleton list, the skin weight profile removal and the default mesh deformer; they are hidden from tools/list on 4.27 and refused with E_NOT_SUPPORTED if called anyway. The skel.cloth_* tools require the ChaosCloth plugin and disappear when it is not enabled.

The kit is split over five classes that all expose the skel. namespace:

ClassPrefixWhat
UUeaKit_Skeletonskel.bone tree queries, virtual bones, skeleton sockets, slot groups, curve metadata, blend profiles, retargeting modes, notify names, preview mesh, compatible skeletons, bone-tree merge/recreate
UUeaKit_SkelMeshskel.LOD info / reduction / build settings, sections, material slots, morph targets, skin weight profiles, reference pose, bounds, sampling, ray tracing, merge, export, import settings
UUeaKit_SkelPhysicsskel.pa_bodies and shapes, constraints with limits and motors, constraint and physical-animation profiles, collision pairs, mirroring, auto-generation
UUeaKit_SkelClothskel.cloth_clothing assets: create from a section, bind/unbind, configs, weight maps
UUeaKit_SkelBatchskel.folder-wide audits and bulk edits

This kit does not replace the basic mesh.sk_* tools (info, LOD screen size, materials, mesh-local sockets, bone list, morph target names, physics asset assignment). Those stay in the mesh kit; skel.* goes deeper and never duplicates a mesh.sk_* name.

Not here: animation assets (anim kit), placing skeletal meshes in a level (actor kit), skeletal mesh component settings (component kit), importing a new mesh from FBX (asset kit).

Start here​

  1. skel.get_skeleton {"skeleton":"/Game/Characters/SK_Hero_Skeleton"} — bone count, root, virtual bones, sockets, slot groups, curves, blend profiles, preview mesh, compatible skeletons, notify names, retarget sources.
  2. skel.get_mesh {"mesh":"/Game/Characters/SK_Hero"} — LOD infos, sections per LOD, material slots, morph targets, skin weight profiles, cloth, physics assets, bounds, sampling, ray tracing and the source files.
  3. skel.pa_get {"physicsAsset":"/Game/Characters/PA_Hero"} — bodies with their shapes and physics settings, constraints with limits and drives, profiles, disabled collision pairs, solver settings.
  4. skel.audit_meshes {"folder":"/Game/Characters","requireLods":true,"requirePhysicsAsset":true} — the whole folder in one table.

Everything that changes an asset is transactional (edit.undo works) but nothing is written to disk until you call skel.save_mesh, skel.save_skeleton, skel.pa_save or asset.save_all.

No skeletal mesh of your own to try this on? skel.create_test_mesh {"folder":"/Game/Tmp", "name":"SK_Test"} duplicates the engine's SkeletalCube (bones Bone01, Bone02) and its skeleton into your folder; that is exactly what the self-test uses.

Recipes​

Ragdoll from scratch​

skel.pa_create {"mesh":"/Game/Characters/SK_Hero","folder":"/Game/Characters",
"name":"PA_Hero","geomType":"sphyl","minBoneSize":8,"createConstraints":true}
skel.pa_list_bodies {"physicsAsset":"/Game/Characters/PA_Hero"}
skel.pa_set_body_physics {"physicsAsset":"/Game/Characters/PA_Hero","bone":"pelvis",
"physicsType":"simulated","massScale":1.0}
skel.pa_set_constraint_limits {"physicsAsset":"/Game/Characters/PA_Hero","name":"spine_02",
"swing1Motion":"limited","swing1Limit":25,
"swing2Motion":"limited","swing2Limit":25,
"twistMotion":"limited","twistLimit":10}
skel.pa_disable_collision_below {"physicsAsset":"/Game/Characters/PA_Hero","bone":"spine_01"}
skel.pa_validate {"physicsAsset":"/Game/Characters/PA_Hero"}

skel.pa_create needs the mesh to have skin weights on the bones you want bodies on; bones shorter than minBoneSize are skipped unless bodyForAll is true. Start with sphyl (capsules) — the convex types are much slower and only pay off for hands and props.

For a driven ragdoll, add a physical animation profile:

skel.pa_add_profile {"physicsAsset":"...","name":"Hit","kind":"physicalAnimation"}
skel.pa_set_physical_animation_profile {"physicsAsset":"...","profile":"Hit","bone":"spine_02",
"orientationStrength":2000,"angularVelocityStrength":100,
"isLocalSimulation":true}

Mirroring a half-built physics asset​

Build the left side only, then:

skel.pa_mirror {"physicsAsset":"/Game/Characters/PA_Hero","fromSuffix":"_l","toSuffix":"_r"}

Every body whose bone ends with _l is copied onto the matching _r bone with its shapes mirrored across the YZ plane (X negated, yaw and roll flipped). Use skel.pa_copy_body for a single bone.

Retarget-ready skeleton​

skel.apply_retarget_preset {"skeleton":"/Game/Characters/SK_Hero_Skeleton","preset":"humanoid"}
skel.add_virtual_bone {"skeleton":"...","source":"hand_l","target":"foot_l"}
skel.add_compatible_skeleton {"skeleton":"...","other":"/Game/Mannequin/UE4_Mannequin_Skeleton"}

The humanoid preset puts the root and every IK/virtual bone on Animation, the pelvis on AnimationScaled and everything else on Skeleton, which is what a proportion-independent retarget needs. Pass pelvisBone when the pelvis is not called pelvis/hips/spine_01. skel.add_compatible_skeleton is UE 5 only and lets an animation authored on the other skeleton play directly on this one.

LOD chain and section cleanup​

skel.generate_lods {"mesh":"/Game/Characters/SK_Hero","count":4,
"percents":[0.5,0.25,0.1],"screenSizes":[0.5,0.25,0.1]}
skel.set_lod_info {"mesh":"...","lod":3,"bonesToRemove":["index_03_l","index_03_r"],
"rebuild":true}
skel.list_sections {"mesh":"...","lod":0}
skel.set_section {"mesh":"...","lod":0,"section":2,"generateUpToLod":1}

skel.generate_lods needs a mesh reduction plugin (SkeletalReduction ships with the engine but has to be enabled); it fails with E_INTERNAL otherwise. generateUpToLod on a section makes that section disappear past the given LOD — the cheapest way to drop buckles and buttons at distance. skel.set_lod_reduction and skel.set_lod_build_settings tune the same LOD without rebuilding unless you pass rebuild: true.

Morph target management​

skel.list_morph_targets {"mesh":"/Game/Characters/SK_Hero"}
skel.rename_morph_target {"mesh":"...","name":"blendShape1","newName":"JawOpen"}
skel.copy_morph_targets {"mesh":"/Game/Characters/SK_HeroLod","from":"/Game/Characters/SK_Hero"}
skel.remove_all_morph_targets {"mesh":"/Game/Characters/SK_HeroProxy"}

copy_morph_targets refuses meshes whose LOD 0 vertex counts differ: morph deltas are indexed by vertex, so the topology must match exactly.

Mesh merge for modular characters​

skel.merge_meshes {"meshes":["/Game/Mod/SK_Torso","/Game/Mod/SK_Legs","/Game/Mod/SK_Head"],
"folder":"/Game/Mod","name":"SK_Merged","stripTopLods":0}

Every source must be bound to a compatible skeleton; the merged asset gets the first source's skeleton unless you pass skeleton. Merging is an editor-time bake — for runtime swapping use leader-pose components from the component kit instead.

Cloth​

skel.cloth_create_from_section {"mesh":"...","lod":0,"section":3,"name":"Cloak",
"removeSection":false,"physicsAsset":"/Game/Characters/PA_Hero"}
skel.cloth_set_config {"mesh":"...","name":"Cloak",
"values":[{"key":"BendingStiffness","value":"0.7"}]}
skel.cloth_set_weight_map_value {"mesh":"...","name":"Cloak","lod":0,"map":0,"value":10.0}

skel.cloth_set_config writes by reflection, so it works with any simulator config the enabled cloth plugin exposes; call skel.cloth_get_config first to see the property names. Weight map target 0 is MaxDistance, 1 BackstopDistance, 2 BackstopRadius.

Folder-wide work​

skel.audit_skeletons {"folder":"/Game/Characters"}
skel.batch_set_physics_asset {"folder":"/Game/Crowd","physicsAsset":"/Game/Crowd/PA_Shared",
"onlyMissing":true}
skel.batch_retarget_modes {"folder":"/Game/Characters","preset":"humanoid"}

skel.audit_skeletons scans the registry once and reports how many meshes and animations use each skeleton, so orphaned skeletons stand out immediately.

Gotchas​

  • 4.27 vs 5.x accessors. The kit hides every difference behind its own shim, but the tools that simply do not exist below UE 5 are hidden from tools/list: skel.list_compatible_skeletons, skel.add_compatible_skeleton, skel.remove_compatible_skeleton, skel.remove_skin_weight_profile (5.0+) and skel.set_default_mesh_deformer (5.1+).
  • Reduction needs a plugin. skel.generate_lods, skel.regenerate_lod, skel.remove_lod and skel.batch_regenerate_lods all go through the engine's skeletal reduction path. Without a mesh reduction plugin they fail instead of silently doing nothing.
  • Rebuild costs. set_lod_info, set_lod_reduction, set_lod_build_settings and set_ref_pose_bone take rebuild; leave it false while you make several changes, then call skel.rebuild_mesh once. Rebuilding a character mesh takes seconds, not milliseconds.
  • Reference pose edits are dangerous. skel.set_ref_pose_bone changes the bind pose, which breaks existing animations and invalidates the physics asset. Regenerate the physics asset with skel.pa_regenerate afterwards, and use skel.reset_ref_pose to go back to the skeleton's pose.
  • Virtual bone names. The engine names virtual bones VB <source>_<target>. add_virtual_bone returns the actual name in createdName; rename_virtual_bone and remove_virtual_bones accept the name with or without the VB prefix (it is added for you).
  • Curve metadata moved. UE 5.7 removed smart names; the kit uses the new FCurveMetaData API there and the smart-name container below it. The tool shapes are identical, but skel.rename_curve fails on a name that is already taken on both paths.
  • Cloth plugin. Every skel.cloth_* tool declares RequiresPlugin="ChaosCloth". The plugin is off by default; enable it in the project before the tools become callable. The kit never links against the plugin, so its module rename between 4.27 (Chaos) and 5.x (ChaosCloth) does not matter.
  • Material slot removal. skel.remove_material_slot refuses a slot a section still uses; point the sections elsewhere with skel.set_section first. Removing a slot shifts every higher section material index down by one, which the tool does for you.
  • Physics asset deletion. skel.pa_delete fails while a mesh still references the asset; clear it with skel.set_physics_assets {"mesh":"...","physicsAsset":""} first.

Ferramentas​

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

skel.add_compatible_skeleton (risco 2, altera, UE 5.0+, smoke)​

Declares another skeleton compatible with this one (UE 5 only).

ArgumentoTipoDescrição
otherstringobrigatório. The other skeleton asset path or unique name.

Retorna: skeleton, names, count, message, notes.

skel.add_curve (risco 2, altera, smoke)​

Registers a curve name on the skeleton (metadata only; it does not create animation data).

ArgumentoTipoDescrição
namestringobrigatório. Curve name.
morphTargetbooleanMark the curve as driving a morph target. Padrão false.
materialbooleanMark the curve as driving a material parameter. Padrão false.
maxLodintegerLowest-detail LOD the curve is still evaluated on; -1 leaves it unchanged, 255 = always. Padrão -1.
linkedBonesarray of stringBones the curve is linked to (skel.set_curve_metadata only; empty leaves them unchanged).

Retorna: skeleton, curves, count, message, notes.

skel.add_material_slot (risco 2, altera, smoke)​

Adds a material slot to a skeletal mesh.

ArgumentoTipoDescrição
materialstringMaterial asset path; the slot stays empty when omitted.
slotNamestringSlot name; generated when omitted.

Retorna: mesh, materials, count, message, notes.

skel.add_notify_name (risco 2, altera, smoke)​

Adds a notify name to the skeleton's cached list (so it shows up in the notify pickers).

ArgumentoTipoDescrição
namestringobrigatório. Name to operate on.

Retorna: skeleton, names, count, message, notes.

skel.add_skeleton_socket (risco 2, altera, smoke)​

Adds a socket attached to a bone of the skeleton.

ArgumentoTipoDescrição
namestringobrigatório. Socket name.
bonestringBone the socket is attached to (required when adding).
location{x,y,z}Offset from the bone.
rotation{x,y,z}Rotation as pitch/yaw/roll.
scale{x,y,z}Scale; (0,0,0) means 1,1,1.
forceAlwaysAnimatedbooleanKeep the socket's bone animated even when it is not otherwise required. Padrão false.
newNamestringNew socket name (skel.set_skeleton_socket only).

Retorna: skeleton, sockets, count, message, notes.

skel.add_slot (risco 2, altera, smoke)​

Adds an animation slot to a group (DefaultGroup when 'group' is empty).

ArgumentoTipoDescrição
slotstringSlot name (skel.add_slot, skel.set_slot_group, skel.remove_slot).
groupstringSlot group name (defaults to DefaultGroup for skel.add_slot).

Retorna: skeleton, groups, count, message, notes.

skel.add_slot_group (risco 2, altera, smoke)​

Adds a slot group.

ArgumentoTipoDescrição
slotstringSlot name (skel.add_slot, skel.set_slot_group, skel.remove_slot).
groupstringSlot group name (defaults to DefaultGroup for skel.add_slot).

Retorna: skeleton, groups, count, message, notes.

skel.add_virtual_bone (risco 2, altera, smoke)​

Adds a virtual bone parented to 'source' and following 'target'; returns the generated name.

ArgumentoTipoDescrição
sourcestringobrigatório. Bone the virtual bone is parented to.
targetstringobrigatório. Bone the virtual bone follows.
namestringExplicit virtual bone name (UE 5 only; the engine generates one when empty).

Retorna: skeleton, virtualBones, count, createdName, message, notes.

skel.apply_retarget_preset (risco 2, altera, smoke)​

Applies a retargeting preset to the whole bone tree ('humanoid' keeps the root and the IK bones on Animation and scales the pelvis).

ArgumentoTipoDescrição
presetstringobrigatório. humanoid (root=Animation, pelvis=AnimationScaled, IK bones=Animation, rest=Skeleton) or animation / skeleton (everything).
pelvisBonestringName of the pelvis/hips bone; auto-detected when empty.

Retorna: skeleton, modes, count, changed, message, notes.

skel.audit_meshes (risco 0, smoke)​

Audits the skeletal meshes of a folder: triangle budget, LOD count, physics asset, morph targets.

ArgumentoTipoDescrição
folderstringobrigatório. Content folder to audit.
maxTrianglesintegerFlag meshes whose LOD 0 has more triangles than this; 0 disables the check. Padrão 0.
requireLodsbooleanFlag meshes with a single LOD. Padrão false.
requirePhysicsAssetbooleanFlag meshes without a physics asset. Padrão false.
requireMorphsbooleanFlag meshes without morph targets. Padrão false.
offendersOnlybooleanOnly report the meshes that failed a check. Padrão false.
limitintegerMaximum number of meshes inspected. Padrão 200.

Retorna: folder, meshes, count, offenders, totalTriangles, message.

skel.audit_physics_assets (risco 0, smoke)​

Audits the physics assets of a folder: bodies without shapes, constraints, disabled collision pairs.

ArgumentoTipoDescrição
folderstringobrigatório. Content folder to audit.
limitintegerMaximum number of assets inspected. Padrão 200.

Retorna: folder, physicsAssets, count, offenders, message.

skel.audit_skeletons (risco 0, smoke)​

Audits the skeletons of a folder: bones, virtual bones, sockets, and how many meshes and animations use each one.

ArgumentoTipoDescrição
folderstringobrigatório. Content folder to audit.
limitintegerMaximum number of assets inspected. Padrão 200.

Retorna: folder, skeletons, count, orphaned, message.

skel.batch_regenerate_lods (risco 3, altera, destrutivo)​

Regenerates the LOD chain of every skeletal mesh of a folder. Not smoke-tested: skeletal reduction needs a mesh reduction plugin.

ArgumentoTipoDescrição
countintegerTotal number of LODs including LOD0. Padrão 3.

Retorna: folder, changed, skipped, count, message.

skel.batch_retarget_modes (risco 3, altera, smoke)​

Applies a retargeting preset to every skeleton of a folder.

ArgumentoTipoDescrição
presetstringobrigatório. humanoid, animation or skeleton.

Retorna: folder, changed, skipped, count, message.

skel.batch_set_lod_settings (risco 3, altera, smoke)​

Assigns one SkeletalMeshLODSettings asset to every skeletal mesh of a folder.

ArgumentoTipoDescrição
settingsstringobrigatório. SkeletalMeshLODSettings asset path.
applybooleanImmediately copy the settings into the LOD infos. Padrão true.

Retorna: folder, changed, skipped, count, message.

skel.batch_set_physics_asset (risco 3, altera, smoke)​

Assigns one physics asset to every skeletal mesh of a folder (optionally only to those without one).

ArgumentoTipoDescrição
physicsAssetstringobrigatório. Physics asset path.
onlyMissingbooleanOnly touch the meshes that have no physics asset yet. Padrão false.

Retorna: folder, changed, skipped, count, message.

skel.batch_set_skeleton (risco 3, altera, destrutivo, smoke)​

Rebinds every skeletal mesh of a folder to one skeleton (refused when the hierarchies differ unless 'force').

ArgumentoTipoDescrição
skeletonstringobrigatório. Skeleton asset path.
forcebooleanRebind even when the bone hierarchies do not match. Padrão false.

Retorna: folder, changed, skipped, count, message.

skel.cloth_bind (risco 2, altera, requer plugin ChaosCloth)​

Binds an existing clothing asset to a mesh section. Not smoke-tested: needs the ChaosCloth plugin.

ArgumentoTipoDescrição
namestringobrigatório. Clothing asset name.
lodintegerobrigatório. LOD of the section to drive.
sectionintegerobrigatório. Section to drive.
clothLodintegerCloth LOD used for the binding. Padrão 0.

Retorna: mesh, lod, section, clothingAsset, clothLod, bound, message.

skel.cloth_create_from_section (risco 3, altera, requer plugin ChaosCloth)​

Creates a clothing asset from a mesh section and binds it to that section. Not smoke-tested: needs the ChaosCloth plugin.

ArgumentoTipoDescrição
lodintegerobrigatório. LOD the source section lives in.
sectionintegerobrigatório. Section index to turn into cloth.
namestringobrigatório. Name of the new clothing asset.
removeSectionbooleanLeave the source section out of the rendered mesh. Padrão false.
physicsAssetstringPhysics asset the cloth collisions are taken from.

Retorna: mesh, clothingAssets, count, message, notes.

skel.cloth_get (risco 0, requer plugin ChaosCloth)​

One clothing asset in detail. Not smoke-tested: needs the ChaosCloth plugin.

ArgumentoTipoDescrição
namestringobrigatório. Clothing asset name (or index as text).

Retorna: mesh, clothingAssets, count, message, notes.

skel.cloth_get_config (risco 0, requer plugin ChaosCloth)​

Every property of a cloth simulator config, read by reflection. Not smoke-tested: needs the ChaosCloth plugin.

ArgumentoTipoDescrição
namestringobrigatório. Clothing asset name.
configstringConfig object name (ChaosClothConfig by default).
valuesarray of UeaKeyValueProperties to set, as "PropertyName=Value" pairs (skel.cloth_set_config only).

Retorna: mesh, clothingAsset, config, values, failed, message.

skel.cloth_get_section_binding (risco 0, requer plugin ChaosCloth)​

Which clothing asset (if any) drives a mesh section. Not smoke-tested: needs the ChaosCloth plugin.

ArgumentoTipoDescrição
lodintegerobrigatório. LOD index.
sectionintegerobrigatório. Section index.

Retorna: mesh, lod, section, clothingAsset, clothLod, bound, message.

skel.cloth_list (risco 0, requer plugin ChaosCloth)​

Clothing assets bound to a skeletal mesh, with their LOD count, reference bone and configs. Not smoke-tested: needs the ChaosCloth plugin.

ArgumentoTipoDescrição
meshstringobrigatório. Skeletal mesh asset path or unique name.

Retorna: mesh, clothingAssets, count, message, notes.

skel.cloth_list_weight_maps (risco 0, requer plugin ChaosCloth)​

Weight maps (max distance, backstop, ...) of a cloth LOD with their value ranges. Not smoke-tested: needs the ChaosCloth plugin.

ArgumentoTipoDescrição
namestringobrigatório. Clothing asset name.
lodintegerCloth LOD index; -1 lists every LOD. Padrão -1.

Retorna: mesh, clothingAsset, weightMaps, count, message.

skel.cloth_rebuild (risco 2, altera, requer plugin ChaosCloth)​

Rebuilds the cached simulation data of a clothing asset after a config or weight map change. Not smoke-tested: needs the ChaosCloth plugin.

ArgumentoTipoDescrição
namestringobrigatório. Clothing asset name (or index as text).

Retorna: mesh, clothingAssets, count, message, notes.

skel.cloth_remove (risco 3, altera, destrutivo, requer plugin ChaosCloth)​

Removes a clothing asset from the mesh (and unbinds every section it drove). Not smoke-tested: needs the ChaosCloth plugin.

ArgumentoTipoDescrição
namestringobrigatório. Clothing asset name (or index as text).

Retorna: mesh, clothingAssets, count, message, notes.

skel.cloth_set_config (risco 2, altera, requer plugin ChaosCloth)​

Writes properties of a cloth simulator config by name (reflection, so it works with any simulator). Not smoke-tested: needs the ChaosCloth plugin.

ArgumentoTipoDescrição
namestringobrigatório. Clothing asset name.
configstringConfig object name (ChaosClothConfig by default).
valuesarray of UeaKeyValueProperties to set, as "PropertyName=Value" pairs (skel.cloth_set_config only).

Retorna: mesh, clothingAsset, config, values, failed, message.

skel.cloth_set_weight_map_value (risco 3, altera, requer plugin ChaosCloth)​

Fills a whole weight map of a cloth LOD with one value. Not smoke-tested: needs the ChaosCloth plugin.

ArgumentoTipoDescrição
namestringobrigatório. Clothing asset name.
lodintegerobrigatório. Cloth LOD index.
mapintegerobrigatório. Weight map target (numeric id, e.g. 0 = MaxDistance).
valuenumberobrigatório. Value written into every vertex of the map.

Retorna: mesh, clothingAsset, weightMaps, count, message.

skel.cloth_unbind (risco 2, altera, requer plugin ChaosCloth)​

Removes the cloth simulation from a mesh section. Not smoke-tested: needs the ChaosCloth plugin.

ArgumentoTipoDescrição
lodintegerobrigatório. LOD index.
sectionintegerobrigatório. Section index.

Retorna: mesh, lod, section, clothingAsset, clothLod, bound, message.

skel.copy_lod_settings (risco 2, altera, smoke)​

Copies every LOD info (screen sizes, reduction, bake poses) from another skeletal mesh.

ArgumentoTipoDescrição
fromstringobrigatório. Source skeletal mesh asset path or unique name.

Retorna: mesh, lods, count, message, notes.

skel.copy_morph_targets (risco 2, altera, smoke)​

Copies the morph targets of another mesh (both meshes must have the same vertex count).

ArgumentoTipoDescrição
fromstringobrigatório. Source skeletal mesh asset path or unique name.

Retorna: mesh, morphTargets, count, message, notes.

skel.create_blend_profile (risco 2, altera, smoke)​

Creates a blend profile (mode TimeFactor / WeightFactor / BlendMask; UE 4.27 has no modes).

ArgumentoTipoDescrição
namestringobrigatório. Blend profile name.
modestringTimeFactor (default), WeightFactor or BlendMask. Ignored on UE 4.27, which has no modes.

Retorna: skeleton, profiles, count, message, notes.

skel.create_test_mesh (risco 2, altera, smoke)​

Duplicates the engine's SkeletalCube (and its skeleton) into a folder; the fixture every other skel tool can be tried on.

ArgumentoTipoDescrição
folderstringobrigatório. Destination content folder.
namestringobrigatório. Name of the new skeletal mesh (its skeleton gets "_Skeleton" appended).

Retorna: mesh, name, folder, skeleton, bones, message, notes.

skel.duplicate_mesh (risco 2, altera, smoke)​

Duplicates a skeletal mesh into another folder or under another name.

ArgumentoTipoDescrição
folderstringDestination content folder; the source folder when empty.
namestringobrigatório. Name of the copy.

Retorna: mesh, name, folder, skeleton, bones, message, notes.

skel.export_fbx (risco 1)​

Exports a skeletal mesh to an FBX file. Not smoke-tested: it writes outside the content folder.

ArgumentoTipoDescrição
filestringobrigatório. Destination file path (absolute, or relative to the project directory).
asciibooleanWrite ASCII FBX instead of binary. Padrão false.
exportMorphTargetsbooleanInclude morph targets in the export. Padrão true.
lodintegerLOD to export; negative exports the whole chain. Padrão -1.

Retorna: mesh, message, lods, notes.

skel.find_bones (risco 0, smoke)​

Finds bones by wildcard pattern ("hand_", "_l"); a plain word matches as a substring.

ArgumentoTipoDescrição
patternstringobrigatório. Wildcard pattern ("hand_", "_l"); a plain word matches as a substring.
limitintegerMaximum number of bones returned. Padrão 200.

Retorna: skeleton, bones, count, total, message.

skel.generate_lods (risco 3, altera)​

Builds a whole LOD chain by reduction. Not smoke-tested: skeletal reduction needs a mesh reduction plugin the smoke project does not enable.

ArgumentoTipoDescrição
countintegerobrigatório. Total number of LODs including LOD0.
percentsarray of numberTriangle fraction per generated LOD (default 0.5, 0.25, 0.125...).
screenSizesarray of numberScreen size per generated LOD.

Retorna: mesh, lods, count, message, notes.

skel.get_bone (risco 0, smoke)​

One bone in detail: local and component-space reference transform, children and retargeting mode.

ArgumentoTipoDescrição
bonestringobrigatório. Bone name (case-insensitive).

Retorna: skeleton, bone, componentLocation, componentRotation, componentScale, children, message.

skel.get_bone_chain (risco 0, smoke)​

Bone path between two bones (walks up from 'to' until it reaches 'from').

ArgumentoTipoDescrição
fromstringobrigatório. First bone of the chain.
tostringobrigatório. Last bone of the chain.

Retorna: skeleton, bones, count, message.

skel.get_bone_influences (risco 0, smoke)​

How many vertices of a LOD a bone influences, and the strongest weight found.

ArgumentoTipoDescrição
bonestringobrigatório. Bone name.
lodintegerLOD index (0 when omitted). Padrão 0.

Retorna: mesh, bone, lod, influencedVertices, maxWeight, sections, message.

skel.get_import_settings (risco 0, smoke)​

FBX import settings stored on the mesh (they apply to the next reimport).

ArgumentoTipoDescrição
meshstringobrigatório. Skeletal mesh asset path or unique name.

Retorna: mesh, importDataClass, settings, sourceFiles, canReimport, message, notes.

skel.get_lod_build_settings (risco 0, smoke)​

Build settings of one LOD (normals, tangents, MikkTSpace, welding thresholds).

ArgumentoTipoDescrição
lodintegerobrigatório. LOD index (0-based).

Retorna: mesh, importDataClass, settings, sourceFiles, canReimport, message, notes.

skel.get_lod_info (risco 0, smoke)​

LOD info of one LOD (-1 returns every LOD): screen size, hysteresis, reduction, bake pose, bones to remove.

ArgumentoTipoDescrição
lodintegerLOD index (0-based); -1 means every LOD. Padrão -1.

Retorna: mesh, lods, count, message, notes.

skel.get_mesh (risco 0, smoke)​

Deep information about a skeletal mesh: LOD infos, sections, materials, morph targets, skin weight profiles, cloth, physics, bounds, sampling, ray tracing and import settings.

ArgumentoTipoDescrição
meshstringobrigatório. Skeletal mesh asset path or unique name.

Retorna: mesh, name, skeleton, boneCount, lods, sections, materials, morphTargets, skinWeightProfiles, clothingAssets, physicsAsset, shadowPhysicsAsset, lodSettings, postProcessAnimBlueprint, defaultMeshDeformer, minLod, boundsOrigin, boundsExtent, positiveBoundsExtension, negativeBoundsExtension, samplingRegions, supportRayTracing, rayTracingMinLod, sourceFiles, message.

skel.get_ref_pose (risco 0, smoke)​

Reference pose of a skeletal mesh, in local (default) or component space.

ArgumentoTipoDescrição
bonesarray of stringBones to report; empty reports every bone.
spacestringlocal (relative to the parent, default) or component.
limitintegerMaximum number of bones returned. Padrão 300.

Retorna: mesh, space, bones, count, message, notes.

skel.get_required_bones (risco 0, smoke)​

Bones required to render a LOD, and the bones that actually have weights on it.

ArgumentoTipoDescrição
lodintegerobrigatório. LOD index (0-based).

Retorna: mesh, lod, requiredBones, activeBones, count, message.

skel.get_retarget_modes (risco 0, smoke)​

Translation retargeting mode of every bone of the skeleton.

ArgumentoTipoDescrição
skeletonstringobrigatório. Skeleton asset path or unique name.

Retorna: skeleton, modes, count, changed, message, notes.

skel.get_skeleton (risco 0, smoke)​

Everything about a skeleton: bone count, root, virtual bones, sockets, slot groups, curves, blend profiles, preview mesh, compatible skeletons, notify names and retarget sources.

ArgumentoTipoDescrição
skeletonstringobrigatório. Skeleton asset path or unique name.

Retorna: skeleton, name, boneCount, rootBone, virtualBones, sockets, slotGroups, curves, blendProfiles, previewMesh, compatibleSkeletons, notifyNames, retargetSources, message.

skel.get_vertex_info (risco 0, smoke)​

Position, normal, first UV and bone weights of one vertex of a LOD.

ArgumentoTipoDescrição
vertexintegerobrigatório. Vertex index inside the LOD.
lodintegerLOD index (0 when omitted). Padrão 0.

Retorna: mesh, lod, vertex, position, normal, uv, influences, message.

skel.import_lod (risco 3, altera)​

Imports (or reimports) a LOD from an FBX file. Not smoke-tested: it needs an FBX file on disk.

ArgumentoTipoDescrição
lodintegerobrigatório. LOD index to import into.
filestringobrigatório. Absolute path of the FBX file.

Retorna: mesh, lods, count, message, notes.

skel.is_mesh_compatible (risco 0, smoke)​

Whether a skeletal mesh's bone hierarchy matches this skeleton.

ArgumentoTipoDescrição
meshstringobrigatório. Skeletal mesh asset path or unique name.

Retorna: skeleton, other, compatible, message.

skel.list_animations_using_skeleton (risco 0, smoke)​

Animation assets bound to a skeleton (asset registry query, nothing is loaded).

ArgumentoTipoDescrição
classFilterstringKeep only assets of this class (AnimSequence, AnimMontage, BlendSpace...); empty = every animation asset.
limitintegerMaximum number of assets returned. Padrão 200.

Retorna: skeleton, assets, count, message, notes.

skel.list_blend_profiles (risco 0, smoke)​

Blend profiles of a skeleton with their mode and per-bone scales.

ArgumentoTipoDescrição
skeletonstringobrigatório. Skeleton asset path or unique name.

Retorna: skeleton, profiles, count, message, notes.

skel.list_bones (risco 0, smoke)​

Bones of a skeleton with index, parent, depth, reference-pose local transform and retargeting mode.

ArgumentoTipoDescrição
parentstringOnly list this bone and its descendants.
depthintegerMaximum hierarchy depth returned relative to the root (-1 = no limit). Padrão -1.
nameContainsstringKeep only bones whose name contains this text.
limitintegerMaximum number of bones returned. Padrão 300.

Retorna: skeleton, bones, count, total, message.

skel.list_compatible_skeletons (risco 0, UE 5.0+, smoke)​

Skeletons declared compatible with this one (UE 5 only; animations of a compatible skeleton can be played directly).

ArgumentoTipoDescrição
skeletonstringobrigatório. Skeleton asset path or unique name.

Retorna: skeleton, names, count, message, notes.

skel.list_curves (risco 0, smoke)​

Curve metadata of a skeleton: name, morph target / material flags, max LOD and linked bones.

ArgumentoTipoDescrição
skeletonstringobrigatório. Skeleton asset path or unique name.

Retorna: skeleton, curves, count, message, notes.

skel.list_material_slots (risco 0, smoke)​

Material slots of a skeletal mesh, with the slot names and whether a section uses them.

ArgumentoTipoDescrição
meshstringobrigatório. Skeletal mesh asset path or unique name.

Retorna: mesh, materials, count, message, notes.

skel.list_meshes_using_skeleton (risco 0, smoke)​

Skeletal meshes bound to a skeleton (asset registry query, nothing is loaded).

ArgumentoTipoDescrição
skeletonstringobrigatório. Skeleton asset path or unique name.

Retorna: skeleton, assets, count, message, notes.

skel.list_morph_targets (risco 0, smoke)​

Morph targets of a skeletal mesh with the number of vertex deltas per LOD.

ArgumentoTipoDescrição
meshstringobrigatório. Skeletal mesh asset path or unique name.

Retorna: mesh, morphTargets, count, message, notes.

skel.list_notify_names (risco 0, smoke)​

Animation notify names cached on the skeleton.

ArgumentoTipoDescrição
skeletonstringobrigatório. Skeleton asset path or unique name.

Retorna: skeleton, names, count, message, notes.

skel.list_sections (risco 0, smoke)​

Sections of a LOD (-1 = every LOD) with material slot, counts and per-section flags.

ArgumentoTipoDescrição
lodintegerLOD index (0-based); -1 means every LOD. Padrão -1.

Retorna: mesh, sections, count, message, notes.

skel.list_skeleton_sockets (risco 0, smoke)​

Sockets stored on the skeleton (shared by every mesh bound to it).

ArgumentoTipoDescrição
skeletonstringobrigatório. Skeleton asset path or unique name.

Retorna: skeleton, sockets, count, message, notes.

skel.list_skeletons (risco 0, smoke)​

Lists skeleton assets under a content folder.

ArgumentoTipoDescrição
folderstringContent folder to search ("/Game" when empty).
nameContainsstringKeep only skeletons whose name contains this text.
limitintegerMaximum number of skeletons returned. Padrão 100.

Retorna: skeletons, count, message.

skel.list_skin_weight_profiles (risco 0, smoke)​

Skin weight profiles of a skeletal mesh.

ArgumentoTipoDescrição
meshstringobrigatório. Skeletal mesh asset path or unique name.

Retorna: mesh, profiles, count, message, notes.

skel.list_slot_groups (risco 0, smoke)​

Animation slot groups of a skeleton and the slots they contain.

ArgumentoTipoDescrição
skeletonstringobrigatório. Skeleton asset path or unique name.

Retorna: skeleton, groups, count, message, notes.

skel.list_virtual_bones (risco 0, smoke)​

Virtual bones of a skeleton (derived bones between a source and a target bone).

ArgumentoTipoDescrição
skeletonstringobrigatório. Skeleton asset path or unique name.

Retorna: skeleton, virtualBones, count, createdName, message, notes.

skel.merge_bones_from_mesh (risco 2, altera, smoke)​

Adds the bones of a mesh that the skeleton does not know yet to its bone tree.

ArgumentoTipoDescrição
meshstringobrigatório. Skeletal mesh asset path or unique name.

Retorna: skeleton, message, notes.

skel.merge_meshes (risco 2, altera, smoke)​

Merges several skeletal meshes into a new asset (modular characters).

ArgumentoTipoDescrição
meshesarray of stringobrigatório. Source skeletal meshes, in draw order.
folderstringobrigatório. Destination content folder.
namestringobrigatório. Name of the merged asset.
skeletonstringSkeleton for the merged mesh; the first source mesh's skeleton when empty.
stripTopLodsintegerNumber of top LODs to strip from the sources. Padrão 0.

Retorna: mesh, name, folder, skeleton, bones, message, notes.

skel.pa_add_body (risco 2, altera, smoke)​

Adds a physics body on a bone with one default shape.

ArgumentoTipoDescrição
bonestringobrigatório. Bone the body is attached to.
shapestringcapsule (default), box or sphere.
sizenumberShape size: radius for sphere/capsule, half-extent for box. Padrão 5.0.
physicsTypestringdefault, kinematic or simulated.

Retorna: physicsAsset, bodies, count, message, notes.

skel.pa_add_constraint (risco 2, altera, smoke)​

Creates a constraint between two bones (preset locked, free or ragdoll).

ArgumentoTipoDescrição
bone1stringobrigatório. Child bone.
bone2stringobrigatório. Parent bone.
namestringJoint name; the child bone name when empty.
presetstringlocked, free or ragdoll (limited swings and twist).

Retorna: physicsAsset, constraints, count, message, notes.

skel.pa_add_profile (risco 2, altera, smoke)​

Adds a constraint or physical animation profile.

ArgumentoTipoDescrição
namestringobrigatório. Profile name.
kindstringobrigatório. constraint or physicalAnimation.
newNamestringNew name (skel.pa_rename_profile only).

Retorna: physicsAsset, constraintProfiles, physicalAnimationProfiles, message, notes.

skel.pa_add_shape (risco 2, altera, smoke)​

Adds a collision shape to a body.

ArgumentoTipoDescrição
bonestringobrigatório. Bone the body is attached to.
typestringobrigatório. box, sphere or capsule.
indexintegerShape index inside its type list (skel.pa_set_shape / skel.pa_remove_shape). Padrão 0.
center{x,y,z}Shape centre relative to the bone.
rotation{x,y,z}Shape rotation as pitch/yaw/roll.
extent{x,y,z}Full extents of a box shape; (0,0,0) leaves them unchanged.
radiusnumberRadius of a sphere or capsule; negative leaves it unchanged. Padrão -1.0.
lengthnumberLength of a capsule's line segment; negative leaves it unchanged. Padrão -1.0.
namestringOptional shape name.
contributeToMassbooleanWhether the shape adds to the body's mass. Padrão true.

Retorna: physicsAsset, bone, shapes, count, message, notes.

skel.pa_assign_to_mesh (risco 2, altera, smoke)​

Assigns the physics asset to a skeletal mesh (as the main or the shadow physics asset).

ArgumentoTipoDescrição
meshstringobrigatório. Skeletal mesh asset path or unique name.
shadowbooleanAssign it as the shadow physics asset instead of the main one. Padrão false.

Retorna: physicsAsset, message, notes.

skel.pa_copy_body (risco 2, altera, smoke)​

Copies the shapes and settings of one body onto another bone, optionally mirrored.

ArgumentoTipoDescrição
fromstringobrigatório. Source bone.
tostringobrigatório. Destination bone (its body is created when missing).
mirrorbooleanMirror the shapes across the YZ plane (X is negated). Padrão false.

Retorna: physicsAsset, bodies, count, message, notes.

skel.pa_create (risco 3, altera, smoke)​

Creates a physics asset from a skeletal mesh's bones (geometry type, minimum bone size, constraints) and optionally assigns it.

ArgumentoTipoDescrição
meshstringobrigatório. Skeletal mesh the bodies are generated from.
folderstringDestination content folder (skel.pa_create only).
namestringName of the new physics asset (skel.pa_create only).
minBoneSizenumberBones shorter than this are skipped. Padrão 20.0.
geomTypestringsphyl (capsule, default), box, sphere, singleConvex, multiConvex or taperedCapsule.
vertWeightstringanyWeight or dominantWeight (default).
autoOrientbooleanOrient the created bodies along their bone. Padrão true.
createConstraintsbooleanCreate constraints between adjacent bodies. Padrão true.
walkPastSmallbooleanKeep walking past bones that are too small instead of stopping. Padrão true.
bodyForAllbooleanCreate a body for every bone, even the small ones. Padrão false.
disableCollisionsByDefaultbooleanDisable collision between the created bodies by default. Padrão true.
hullCountintegerNumber of hulls for the convex geometry types. Padrão 4.
maxHullVertsintegerMaximum vertices per convex hull. Padrão 16.
assignbooleanAlso assign the asset to the mesh (skel.pa_create only). Padrão true.

Retorna: physicsAsset, name, folder, bodies, constraints, boneNames, message, notes.

skel.pa_delete (risco 3, altera, destrutivo)​

Deletes the physics asset. Not smoke-tested: deleting an asset inside the self-test transaction is unsafe.

ArgumentoTipoDescrição
physicsAssetstringobrigatório. Physics asset path or unique name.

Retorna: physicsAsset, message, notes.

skel.pa_disable_collision_below (risco 2, altera, smoke)​

Disables collision between a bone's body and every body below it in the hierarchy.

ArgumentoTipoDescrição
bonestringobrigatório. Bone the body is attached to.

Retorna: physicsAsset, pairs, count, message, notes.

skel.pa_enable_all_collision (risco 3, altera, smoke)​

Clears the whole collision-disable table, so every body collides with every other one.

ArgumentoTipoDescrição
physicsAssetstringobrigatório. Physics asset path or unique name.

Retorna: physicsAsset, pairs, count, message, notes.

skel.pa_get (risco 0, smoke)​

Everything about a physics asset: bodies, shapes, constraints, profiles, disabled collision pairs and solver settings.

ArgumentoTipoDescrição
physicsAssetstringobrigatório. Physics asset path or unique name.

Retorna: physicsAsset, name, previewMesh, bodies, constraints, constraintProfiles, physicalAnimationProfiles, disabledCollisionPairs, solverSettings, message, notes.

skel.pa_get_body (risco 0, smoke)​

One body in detail.

ArgumentoTipoDescrição
bonestringobrigatório. Bone the body is attached to.

Retorna: physicsAsset, bodies, count, message, notes.

skel.pa_get_constraint (risco 0, smoke)​

One constraint in detail (by joint name or index).

ArgumentoTipoDescrição
namestringobrigatório. Joint name (or index as text).

Retorna: physicsAsset, constraints, count, message, notes.

skel.pa_list (risco 0, smoke)​

Lists physics assets under a content folder.

ArgumentoTipoDescrição
folderstringContent folder to search ("/Game" when empty).
limitintegerMaximum number of assets returned. Padrão 100.

Retorna: physicsAssets, count, message, notes.

skel.pa_list_bodies (risco 0, smoke)​

Bodies of a physics asset with their shapes and physics settings.

ArgumentoTipoDescrição
physicsAssetstringobrigatório. Physics asset path or unique name.

Retorna: physicsAsset, bodies, count, message, notes.

skel.pa_list_collision_pairs (risco 0, smoke)​

Body pairs whose collision is disabled (or every pair).

ArgumentoTipoDescrição
disabledOnlybooleanOnly report the pairs whose collision is disabled. Padrão true.

Retorna: physicsAsset, pairs, count, message, notes.

skel.pa_list_constraints (risco 0, smoke)​

Constraints of a physics asset with their limits and drives.

ArgumentoTipoDescrição
physicsAssetstringobrigatório. Physics asset path or unique name.

Retorna: physicsAsset, constraints, count, message, notes.

skel.pa_list_profiles (risco 0, smoke)​

Constraint and physical animation profile names.

ArgumentoTipoDescrição
physicsAssetstringobrigatório. Physics asset path or unique name.

Retorna: physicsAsset, constraintProfiles, physicalAnimationProfiles, message, notes.

skel.pa_list_shapes (risco 0, smoke)​

Collision shapes of one body.

ArgumentoTipoDescrição
bonestringobrigatório. Bone the body is attached to.

Retorna: physicsAsset, bone, shapes, count, message, notes.

skel.pa_mirror (risco 2, altera, smoke)​

Mirrors every body whose bone ends with one suffix onto the bone with the other suffix.

ArgumentoTipoDescrição
fromSuffixstringobrigatório. Suffix of the source bones (e.g. "_l").
toSuffixstringobrigatório. Suffix of the destination bones (e.g. "_r").

Retorna: physicsAsset, bodies, count, message, notes.

skel.pa_regenerate (risco 3, altera, destrutivo, smoke)​

Regenerates the bodies and constraints of an existing physics asset from a mesh.

ArgumentoTipoDescrição
physicsAssetstringobrigatório. Physics asset to regenerate.

Retorna: physicsAsset, name, folder, bodies, constraints, boneNames, message, notes.

skel.pa_remove_body (risco 3, altera, destrutivo, smoke)​

Removes the physics body of a bone (and the constraints that used it).

ArgumentoTipoDescrição
bonestringobrigatório. Bone the body is attached to.

Retorna: physicsAsset, bodies, count, message, notes.

skel.pa_remove_constraint (risco 3, altera, destrutivo, smoke)​

Removes a constraint.

ArgumentoTipoDescrição
namestringobrigatório. Joint name (or index as text).

Retorna: physicsAsset, constraints, count, message, notes.

skel.pa_remove_profile (risco 3, altera, destrutivo, smoke)​

Removes a constraint or physical animation profile.

ArgumentoTipoDescrição
namestringobrigatório. Profile name.
kindstringobrigatório. constraint or physicalAnimation.
newNamestringNew name (skel.pa_rename_profile only).

Retorna: physicsAsset, constraintProfiles, physicalAnimationProfiles, message, notes.

skel.pa_remove_shape (risco 3, altera, destrutivo, smoke)​

Removes a collision shape from a body.

ArgumentoTipoDescrição
bonestringobrigatório. Bone the body is attached to.
typestringobrigatório. box, sphere or capsule.
indexintegerShape index inside its type list (skel.pa_set_shape / skel.pa_remove_shape). Padrão 0.
center{x,y,z}Shape centre relative to the bone.
rotation{x,y,z}Shape rotation as pitch/yaw/roll.
extent{x,y,z}Full extents of a box shape; (0,0,0) leaves them unchanged.
radiusnumberRadius of a sphere or capsule; negative leaves it unchanged. Padrão -1.0.
lengthnumberLength of a capsule's line segment; negative leaves it unchanged. Padrão -1.0.
namestringOptional shape name.
contributeToMassbooleanWhether the shape adds to the body's mass. Padrão true.

Retorna: physicsAsset, bone, shapes, count, message, notes.

skel.pa_rename_profile (risco 2, altera, smoke)​

Renames a constraint or physical animation profile.

ArgumentoTipoDescrição
namestringobrigatório. Profile name.
kindstringobrigatório. constraint or physicalAnimation.
newNamestringNew name (skel.pa_rename_profile only).

Retorna: physicsAsset, constraintProfiles, physicalAnimationProfiles, message, notes.

skel.pa_save (risco 1)​

Saves the physics asset package to disk. Not smoke-tested: the self-test never writes to disk.

ArgumentoTipoDescrição
physicsAssetstringobrigatório. Physics asset path or unique name.

Retorna: physicsAsset, message, notes.

skel.pa_scale_shapes (risco 2, altera, smoke)​

Scales every collision shape of the asset (or of some bones) by a factor.

ArgumentoTipoDescrição
factornumberobrigatório. Scale factor applied to every radius/extent.
bonesarray of stringBones to scale; empty scales every body.

Retorna: physicsAsset, bodies, count, message, notes.

skel.pa_set_body_collision (risco 2, altera, smoke)​

Collision settings of one body: collision enabled mode, object type and per-channel responses.

ArgumentoTipoDescrição
bonestringobrigatório. Bone the body is attached to.
collisionEnabledstringnoCollision, queryOnly, physicsOnly or queryAndPhysics ("" leaves it unchanged).
objectTypestringCollision object type channel name (WorldStatic, Pawn, PhysicsBody...).
responsesarray of UeaKeyValuePer-channel responses as "Channel=ignore

Retorna: physicsAsset, bodies, count, message, notes.

skel.pa_set_body_physics (risco 2, altera, smoke)​

Physics settings of one body: simulation type, mass, damping, gravity, CCD, centre of mass, physical material.

ArgumentoTipoDescrição
bonestringobrigatório. Bone the body is attached to.
physicsTypestringdefault, kinematic or simulated ("" leaves it unchanged).
massScalenumberMultiplier applied to the computed mass; negative leaves it unchanged. Padrão -1.0.
massKgnumberExplicit mass in kilograms; negative leaves the computed mass. Padrão -1.0.
linearDampingnumberLinear damping; negative leaves it unchanged. Padrão -1.0.
angularDampingnumberAngular damping; negative leaves it unchanged. Padrão -1.0.
enableGravitybooleanWhether gravity acts on the body. Padrão true.
simulatePhysicsbooleanWhether the body simulates by default. Padrão false.
startAwakebooleanWhether the body starts awake. Padrão true.
useCCDbooleanUse continuous collision detection. Padrão false.
centerOfMassOffset{x,y,z}Offset applied to the centre of mass.
physicalMaterialstringPhysical material asset path ("" leaves it unchanged).

Retorna: physicsAsset, bodies, count, message, notes.

skel.pa_set_collision_pair (risco 2, altera, smoke)​

Enables or disables collision between the bodies of two bones.

ArgumentoTipoDescrição
bone1stringobrigatório. First bone.
bone2stringobrigatório. Second bone.
enabledbooleanTrue to let the two bodies collide. Padrão true.

Retorna: physicsAsset, pairs, count, message, notes.

skel.pa_set_constraint (risco 2, altera, smoke)​

General constraint settings: collision, projection, break thresholds, parent dominance, frame rotation.

ArgumentoTipoDescrição
namestringobrigatório. Joint name.
disableCollisionbooleanMake the two bodies ignore each other. Padrão true.
projectionEnabledbooleanEnable joint projection (keeps long chains from stretching). Padrão false.
linearBreakablebooleanLet the constraint break under linear force. Padrão false.
linearBreakThresholdnumberForce above which the constraint breaks; negative leaves it unchanged. Padrão -1.0.
angularBreakablebooleanLet the constraint break under torque. Padrão false.
angularBreakThresholdnumberTorque above which the constraint breaks; negative leaves it unchanged. Padrão -1.0.
parentDominatesbooleanLet the parent body dominate the child. Padrão false.
frameRotation{x,y,z}Rotation offset applied to the constraint frame, as pitch/yaw/roll.

Retorna: physicsAsset, constraints, count, message, notes.

skel.pa_set_constraint_limits (risco 2, altera, smoke)​

Angular and linear limits of a constraint, with the soft-limit parameters.

ArgumentoTipoDescrição
namestringobrigatório. Joint name.
swing1Motionstringfree, limited or locked ("" leaves it unchanged).
swing1LimitnumberSwing 1 limit in degrees; negative leaves it unchanged. Padrão -1.0.
swing2Motionstringfree, limited or locked ("" leaves it unchanged).
swing2LimitnumberSwing 2 limit in degrees; negative leaves it unchanged. Padrão -1.0.
twistMotionstringfree, limited or locked ("" leaves it unchanged).
twistLimitnumberTwist limit in degrees; negative leaves it unchanged. Padrão -1.0.
linearXMotionstringfree, limited or locked ("" leaves it unchanged).
linearYMotionstringfree, limited or locked ("" leaves it unchanged).
linearZMotionstringfree, limited or locked ("" leaves it unchanged).
linearLimitnumberLinear limit distance; negative leaves it unchanged. Padrão -1.0.
softSwingbooleanMake the swing limit soft. Padrão false.
swingStiffnessnumberSoft swing stiffness; negative leaves it unchanged. Padrão -1.0.
swingDampingnumberSoft swing damping; negative leaves it unchanged. Padrão -1.0.
softTwistbooleanMake the twist limit soft. Padrão false.
twistStiffnessnumberSoft twist stiffness; negative leaves it unchanged. Padrão -1.0.
twistDampingnumberSoft twist damping; negative leaves it unchanged. Padrão -1.0.
softLinearbooleanMake the linear limit soft. Padrão false.
linearStiffnessnumberSoft linear stiffness; negative leaves it unchanged. Padrão -1.0.
linearDampingnumberSoft linear damping; negative leaves it unchanged. Padrão -1.0.

Retorna: physicsAsset, constraints, count, message, notes.

skel.pa_set_constraint_motor (risco 2, altera, smoke)​

Angular and linear drives (motors) of a constraint.

ArgumentoTipoDescrição
namestringobrigatório. Joint name.
angularDriveModestringslerp or twistAndSwing ("" leaves it unchanged).
orientationDrivebooleanEnable the angular orientation drive. Padrão false.
velocityDrivebooleanEnable the angular velocity drive. Padrão false.
strengthnumberAngular drive spring strength; negative leaves it unchanged. Padrão -1.0.
dampingnumberAngular drive damping; negative leaves it unchanged. Padrão -1.0.
maxForcenumberMaximum force the drives may apply; negative leaves it unchanged. Padrão -1.0.
target{x,y,z}Target orientation as pitch/yaw/roll.
linearPositionDrivebooleanEnable the linear position drive on all three axes. Padrão false.
linearVelocityDrivebooleanEnable the linear velocity drive on all three axes. Padrão false.

Retorna: physicsAsset, constraints, count, message, notes.

skel.pa_set_physical_animation_profile (risco 2, altera, smoke)​

Physical animation drive strengths of one bone inside a physical animation profile.

ArgumentoTipoDescrição
profilestringobrigatório. Physical animation profile name.
bonestringobrigatório. Bone the settings apply to.
orientationStrengthnumberStrength of the orientation drive. Padrão 0.0.
angularVelocityStrengthnumberStrength of the angular velocity drive. Padrão 0.0.
positionStrengthnumberStrength of the position drive. Padrão 0.0.
velocityStrengthnumberStrength of the linear velocity drive. Padrão 0.0.
maxLinearForcenumberMaximum linear force the drives may apply. Padrão 0.0.
maxAngularForcenumberMaximum angular force the drives may apply. Padrão 0.0.
isLocalSimulationbooleanSimulate in the space of the body's parent instead of world space. Padrão true.

Retorna: physicsAsset, constraintProfiles, physicalAnimationProfiles, message, notes.

skel.pa_set_physical_material (risco 2, altera)​

Assigns a physical material to one body or to every body. Not smoke-tested: no physical material ships in engine content.

ArgumentoTipoDescrição
bonestringBone to change; every body when empty.
materialstringobrigatório. Physical material asset path.

Retorna: physicsAsset, bodies, count, message, notes.

skel.pa_set_preview_mesh (risco 2, altera, smoke)​

Sets the skeletal mesh the physics asset editor previews.

ArgumentoTipoDescrição
meshstringobrigatório. Skeletal mesh asset path or unique name.

Retorna: physicsAsset, message, notes.

skel.pa_set_profile_constraint (risco 2, altera, smoke)​

Stores constraint limits and drive strengths inside a constraint profile.

ArgumentoTipoDescrição
profilestringobrigatório. Constraint profile name.
constraintstringobrigatório. Joint name.
swing1Motionstringfree, limited or locked ("" leaves it unchanged).
swing1LimitnumberSwing 1 limit in degrees; negative leaves it unchanged. Padrão -1.0.
swing2Motionstringfree, limited or locked ("" leaves it unchanged).
swing2LimitnumberSwing 2 limit in degrees; negative leaves it unchanged. Padrão -1.0.
twistMotionstringfree, limited or locked ("" leaves it unchanged).
twistLimitnumberTwist limit in degrees; negative leaves it unchanged. Padrão -1.0.
strengthnumberAngular drive spring strength; negative leaves it unchanged. Padrão -1.0.
dampingnumberAngular drive damping; negative leaves it unchanged. Padrão -1.0.

Retorna: physicsAsset, constraintProfiles, physicalAnimationProfiles, message, notes.

skel.pa_set_shape (risco 2, altera, smoke)​

Edits an existing collision shape.

ArgumentoTipoDescrição
bonestringobrigatório. Bone the body is attached to.
typestringobrigatório. box, sphere or capsule.
indexintegerShape index inside its type list (skel.pa_set_shape / skel.pa_remove_shape). Padrão 0.
center{x,y,z}Shape centre relative to the bone.
rotation{x,y,z}Shape rotation as pitch/yaw/roll.
extent{x,y,z}Full extents of a box shape; (0,0,0) leaves them unchanged.
radiusnumberRadius of a sphere or capsule; negative leaves it unchanged. Padrão -1.0.
lengthnumberLength of a capsule's line segment; negative leaves it unchanged. Padrão -1.0.
namestringOptional shape name.
contributeToMassbooleanWhether the shape adds to the body's mass. Padrão true.

Retorna: physicsAsset, bone, shapes, count, message, notes.

skel.pa_set_solver (risco 2, altera, smoke)​

Solver settings of the physics asset (iteration counts and solver type).

ArgumentoTipoDescrição
positionIterationsintegerPosition iterations (UE 5) / solver iterations (UE 4.27); negative leaves it unchanged. Padrão -1.
velocityIterationsintegerVelocity iterations (UE 5) / joint iterations (UE 4.27); negative leaves it unchanged. Padrão -1.
projectionIterationsintegerProjection iterations (UE 5) / collision iterations (UE 4.27); negative leaves it unchanged. Padrão -1.
solverTypestringWorld or RBAN ("" leaves it unchanged).

Retorna: physicsAsset, message, notes.

skel.pa_validate (risco 0, smoke)​

Sanity check: bodies without shapes, constraints pointing at missing bodies, bones without a body.

ArgumentoTipoDescrição
physicsAssetstringobrigatório. Physics asset path or unique name.

Retorna: physicsAsset, errors, warnings, valid, message.

skel.pa_weld_bodies (risco 3, altera)​

Merges the body of a child bone into its parent's. Not smoke-tested: it needs a live skeletal mesh component.

ArgumentoTipoDescrição
parentstringobrigatório. Bone that keeps its body.
childstringobrigatório. Bone whose body is merged into the parent's.

Retorna: physicsAsset, bodies, count, message, notes.

skel.rebuild_mesh (risco 2, altera, smoke)​

Rebuilds the mesh's render data after low-level edits.

ArgumentoTipoDescrição
meshstringobrigatório. Skeletal mesh asset path or unique name.

Retorna: mesh, message, lods, notes.

skel.recreate_bone_tree (risco 3, altera, destrutivo, smoke)​

Rebuilds the bone tree from a mesh, discarding the current hierarchy (breaks existing animations).

ArgumentoTipoDescrição
meshstringobrigatório. Skeletal mesh asset path or unique name.

Retorna: skeleton, message, notes.

skel.regenerate_lod (risco 3, altera)​

Regenerates one LOD from its reduction settings. Not smoke-tested: skeletal reduction needs a mesh reduction plugin the smoke project does not enable.

ArgumentoTipoDescrição
lodintegerobrigatório. LOD index (0-based).

Retorna: mesh, lods, count, message, notes.

skel.reimport_mesh (risco 3, altera)​

Reimports the mesh from its source file (or from a new one). Not smoke-tested: it needs an FBX file on disk.

ArgumentoTipoDescrição
filestringSource file to reimport from ("" uses the stored one).

Retorna: mesh, message, lods, notes.

skel.remove_all_morph_targets (risco 3, altera, destrutivo, smoke)​

Removes every morph target of a skeletal mesh.

ArgumentoTipoDescrição
meshstringobrigatório. Skeletal mesh asset path or unique name.

Retorna: mesh, morphTargets, count, message, notes.

skel.remove_blend_profile (risco 3, altera, destrutivo, smoke)​

Deletes a blend profile.

ArgumentoTipoDescrição
namestringobrigatório. Name to operate on.

Retorna: skeleton, profiles, count, message, notes.

skel.remove_compatible_skeleton (risco 2, altera, UE 5.0+, smoke)​

Removes a skeleton from the compatible list (UE 5 only).

ArgumentoTipoDescrição
otherstringobrigatório. The other skeleton asset path or unique name.

Retorna: skeleton, names, count, message, notes.

skel.remove_curve (risco 3, altera, destrutivo, smoke)​

Removes a curve and its metadata from the skeleton.

ArgumentoTipoDescrição
namestringobrigatório. Name to operate on.

Retorna: skeleton, curves, count, message, notes.

skel.remove_lod (risco 3, altera, destrutivo)​

Removes one LOD. Not smoke-tested: the engine cube fixture only has LOD0 and LOD removal needs a reduction plugin.

ArgumentoTipoDescrição
lodintegerobrigatório. LOD index (0-based).

Retorna: mesh, lods, count, message, notes.

skel.remove_material_slot (risco 3, altera, destrutivo, smoke)​

Removes a material slot; refused while a section still uses it.

ArgumentoTipoDescrição
slotstringobrigatório. Slot index or slot name.

Retorna: mesh, materials, count, message, notes.

skel.remove_morph_target (risco 3, altera, destrutivo)​

Removes one morph target. Not smoke-tested: the engine cube fixture has no morph targets.

ArgumentoTipoDescrição
namestringobrigatório. Name to operate on.

Retorna: mesh, morphTargets, count, message, notes.

skel.remove_notify_name (risco 2, altera, smoke)​

Removes a notify name from the skeleton's cached list.

ArgumentoTipoDescrição
namestringobrigatório. Name to operate on.

Retorna: skeleton, names, count, message, notes.

skel.remove_skeleton_socket (risco 3, altera, destrutivo, smoke)​

Removes a socket from the skeleton.

ArgumentoTipoDescrição
namestringobrigatório. Name to operate on.

Retorna: skeleton, sockets, count, message, notes.

skel.remove_skin_weight_profile (risco 3, altera, destrutivo, UE 5.0+)​

Removes a skin weight profile (UE 5 only; UE 4.27 has no removal API). Not smoke-tested: the engine cube fixture has no skin weight profiles.

ArgumentoTipoDescrição
namestringobrigatório. Name to operate on.

Retorna: mesh, profiles, count, message, notes.

skel.remove_slot (risco 3, altera, destrutivo, smoke)​

Removes an animation slot.

ArgumentoTipoDescrição
slotstringSlot name (skel.add_slot, skel.set_slot_group, skel.remove_slot).
groupstringSlot group name (defaults to DefaultGroup for skel.add_slot).

Retorna: skeleton, groups, count, message, notes.

skel.remove_virtual_bones (risco 3, altera, destrutivo, smoke)​

Removes virtual bones by name.

ArgumentoTipoDescrição
namesarray of stringobrigatório. Names to operate on.

Retorna: skeleton, virtualBones, count, createdName, message, notes.

skel.rename_curve (risco 2, altera, smoke)​

Renames a curve.

ArgumentoTipoDescrição
namestringobrigatório. Current name.
newNamestringobrigatório. New name.

Retorna: skeleton, curves, count, message, notes.

skel.rename_morph_target (risco 2, altera)​

Renames a morph target. Not smoke-tested: the engine cube fixture has no morph targets.

ArgumentoTipoDescrição
namestringobrigatório. Current name.
newNamestringobrigatório. New name.

Retorna: mesh, morphTargets, count, message, notes.

skel.rename_virtual_bone (risco 2, altera, smoke)​

Renames a virtual bone.

ArgumentoTipoDescrição
namestringobrigatório. Current name.
newNamestringobrigatório. New name.

Retorna: skeleton, virtualBones, count, createdName, message, notes.

skel.reset_ref_pose (risco 3, altera, smoke)​

Resets the mesh's reference pose to the skeleton's one.

ArgumentoTipoDescrição
meshstringobrigatório. Skeletal mesh asset path or unique name.

Retorna: mesh, space, bones, count, message, notes.

skel.save_mesh (risco 1)​

Saves the skeletal mesh package to disk. Not smoke-tested: the self-test never writes to disk.

ArgumentoTipoDescrição
meshstringobrigatório. Skeletal mesh asset path or unique name.

Retorna: mesh, message, lods, notes.

skel.save_skeleton (risco 1)​

Saves the skeleton package to disk.

ArgumentoTipoDescrição
skeletonstringobrigatório. Skeleton asset path or unique name.

Retorna: skeleton, message, notes.

skel.set_allow_cpu_access (risco 2, altera, smoke)​

Keeps the mesh's vertex buffers readable on the CPU (needed by some Niagara and trace setups).

ArgumentoTipoDescrição
enabledbooleanValue of the flag. Padrão true.

Retorna: mesh, message, lods, notes.

skel.set_blend_profile_bone (risco 2, altera, smoke)​

Sets the blend scale of one bone (optionally its whole subtree) in a blend profile.

ArgumentoTipoDescrição
profilestringobrigatório. Blend profile name.
bonestringobrigatório. Bone name.
scalenumberobrigatório. Blend scale (1 = normal speed/weight, 0 = the bone does not blend).
recursebooleanAlso apply the scale to every descendant of the bone. Padrão false.

Retorna: skeleton, profiles, count, message, notes.

skel.set_bounds (risco 2, altera, smoke)​

Extra padding added to the rendered bounds (fixes meshes that disappear when animated).

ArgumentoTipoDescrição
positiveExtension{x,y,z}Padding added on +X/+Y/+Z.
negativeExtension{x,y,z}Padding added on -X/-Y/-Z.

Retorna: mesh, message, lods, notes.

skel.set_curve_metadata (risco 2, altera, smoke)​

Updates the metadata of an existing curve (morph target / material flags, max LOD, linked bones).

ArgumentoTipoDescrição
namestringobrigatório. Curve name.
morphTargetbooleanMark the curve as driving a morph target. Padrão false.
materialbooleanMark the curve as driving a material parameter. Padrão false.
maxLodintegerLowest-detail LOD the curve is still evaluated on; -1 leaves it unchanged, 255 = always. Padrão -1.
linkedBonesarray of stringBones the curve is linked to (skel.set_curve_metadata only; empty leaves them unchanged).

Retorna: skeleton, curves, count, message, notes.

skel.set_default_mesh_deformer (risco 2, altera, UE 5.1+, smoke)​

Assigns (or clears) the default mesh deformer (UE 5.1+ deformer graph).

ArgumentoTipoDescrição
assetstringAsset path; "" clears the reference.

Retorna: mesh, message, lods, notes.

skel.set_import_settings (risco 2, altera, smoke)​

Edits the FBX import settings stored on the mesh (they apply to the next reimport).

ArgumentoTipoDescrição
importMorphTargetsbooleanImport morph targets on the next reimport. Padrão true.
updateSkeletonReferencePosebooleanUpdate the skeleton's reference pose from the file. Padrão false.
useT0AsRefPosebooleanUse frame 0 of the file as the reference pose. Padrão false.
preserveSmoothingGroupsbooleanKeep the file's smoothing groups. Padrão true.
importMeshesInBoneHierarchybooleanImport meshes that live inside the bone hierarchy. Padrão true.
thresholdPositionnumberWeld distance for positions; negative leaves it unchanged. Padrão -1.0.
thresholdTangentNormalnumberWeld threshold for tangents/normals; negative leaves it unchanged. Padrão -1.0.
thresholdUvnumberWeld threshold for UVs; negative leaves it unchanged. Padrão -1.0.
normalImportMethodstringComputeNormals / ImportNormals / ImportNormalsAndTangents ("" leaves it unchanged).
normalGenerationMethodstringBuiltIn / MikkTSpace ("" leaves it unchanged).
computeWeightedNormalsbooleanWeight generated normals by triangle area. Padrão false.

Retorna: mesh, importDataClass, settings, sourceFiles, canReimport, message, notes.

skel.set_lod_build_settings (risco 2, altera, smoke)​

Edits the build settings of one LOD (normals, tangents, MikkTSpace, welding thresholds).

ArgumentoTipoDescrição
lodintegerobrigatório. LOD index.
recomputeNormalsbooleanRecompute normals when building. Padrão false.
recomputeTangentsbooleanRecompute tangents when building. Padrão true.
useMikkTSpacebooleanUse MikkTSpace to generate tangents. Padrão true.
computeWeightedNormalsbooleanWeight generated normals by triangle area. Padrão false.
removeDegeneratesbooleanDrop degenerate triangles. Padrão true.
useHighPrecisionTangentBasisbooleanStore tangents with higher precision. Padrão false.
useFullPrecisionUVsbooleanStore UVs with full precision. Padrão false.
thresholdPositionnumberWeld distance for positions; negative leaves it unchanged. Padrão -1.0.
thresholdTangentNormalnumberWeld threshold for tangents/normals; negative leaves it unchanged. Padrão -1.0.
thresholdUvnumberWeld threshold for UVs; negative leaves it unchanged. Padrão -1.0.
rebuildbooleanRebuild the mesh after the change. Padrão false.

Retorna: mesh, lods, count, message, notes.

skel.set_lod_info (risco 2, altera, smoke)​

Edits the LOD info of one LOD: screen size, hysteresis, CPU access, sampling, bake pose, bones to remove/prioritize.

ArgumentoTipoDescrição
lodintegerobrigatório. LOD index (0-based).
screenSizenumberScreen size at which the LOD becomes active; negative leaves it unchanged. Padrão -1.0.
hysteresisnumberLOD hysteresis; negative leaves it unchanged. Padrão -1.0.
allowCpuAccessbooleanKeep the LOD's vertex buffers readable on the CPU. Padrão false.
supportUniformSamplingbooleanSupport uniformly distributed sampling (Niagara). Padrão false.
bakePosestringAnimation whose pose is baked into the LOD ("" clears it, omitted leaves it unchanged).
bakePoseOverridestringAnimation whose pose overrides the baked one.
bonesToRemovearray of stringBones removed at this LOD (replaces the current list when non-empty).
bonesToPrioritizearray of stringBones the reduction tries to preserve (replaces the current list when non-empty).
weightOfPrioritizationnumberWeight given to the prioritized bones; negative leaves it unchanged. Padrão -1.0.
rebuildbooleanRebuild the mesh after the change (slower, but the result is immediately visible). Padrão false.

Retorna: mesh, lods, count, message, notes.

skel.set_lod_reduction (risco 2, altera, smoke)​

Edits the reduction settings of one LOD (termination criterion, percentages, deviation, bone limits).

ArgumentoTipoDescrição
lodintegerobrigatório. LOD index (0-based).
terminationCriterionstringNumOfTriangles, NumOfVerts, NumOfTrianglesPercent, NumOfVertsPercent... ("" leaves it unchanged).
percentTrianglesnumberFraction of triangles to keep (0-1); negative leaves it unchanged. Padrão -1.0.
percentVerticesnumberFraction of vertices to keep (0-1); negative leaves it unchanged. Padrão -1.0.
maxDeviationnumberMaximum deviation in percent; negative leaves it unchanged. Padrão -1.0.
maxBonesPerVertexintegerMaximum bone influences per vertex; negative leaves it unchanged. Padrão -1.
weldingThresholdnumberDistance below which vertices are welded; negative leaves it unchanged. Padrão -1.0.
hardAnglenumberNormal split angle in degrees; negative leaves it unchanged. Padrão -1.0.
baseLodintegerLOD the reduction reads from; negative leaves it unchanged. Padrão -1.
lockEdgesbooleanKeep boundary edges. Padrão false.
enforceBoneBoundariesbooleanDo not collapse vertices across bone boundaries. Padrão false.
rebuildbooleanRebuild the mesh after the change. Padrão false.

Retorna: mesh, lods, count, message, notes.

skel.set_lod_settings_asset (risco 2, altera)​

Assigns a SkeletalMeshLODSettings asset and optionally copies its settings into the LOD infos. Not smoke-tested: no LOD settings asset ships in engine content.

ArgumentoTipoDescrição
settingsstringSkeletalMeshLODSettings asset path; "" clears it.
applybooleanImmediately copy the settings into the mesh's LOD infos. Padrão true.

Retorna: mesh, lods, count, message, notes.

skel.set_min_lod_per_platform (risco 2, altera, smoke)​

Minimum LOD with per-platform overrides and the below-minimum stripping switch.

ArgumentoTipoDescrição
minLodintegerobrigatório. Default minimum LOD the renderer may use.
perPlatformarray of UeaKeyValuePer-platform overrides as "platform=lod" (e.g. "Mobile=2").
disableBelowMinLodStrippingbooleanKeep the LODs below the minimum in cooked builds. Padrão false.

Retorna: mesh, message, lods, notes.

skel.set_physics_assets (risco 2, altera, smoke)​

Assigns the physics asset and the shadow physics asset in one call.

ArgumentoTipoDescrição
physicsAssetstringPhysics asset path; "" clears it.
shadowPhysicsAssetstringCheaper physics asset used for shadow computations; "" clears it.

Retorna: mesh, message, lods, notes.

skel.set_post_process_anim_blueprint (risco 2, altera, smoke)​

Assigns (or clears) the post-process animation blueprint run after the main anim graph.

ArgumentoTipoDescrição
assetstringAsset path; "" clears the reference.

Retorna: mesh, message, lods, notes.

skel.set_preview_mesh (risco 2, altera, smoke)​

Sets the mesh shown when the skeleton is opened in Persona.

ArgumentoTipoDescrição
meshstringobrigatório. Skeletal mesh asset path or unique name.

Retorna: skeleton, message, notes.

skel.set_ray_tracing (risco 2, altera, smoke)​

Whether a ray tracing acceleration structure is built for the mesh, and from which LOD.

ArgumentoTipoDescrição
supportbooleanobrigatório. Build a ray tracing acceleration structure for this mesh.
minLodintegerLowest LOD used by ray tracing (UE 5 only); negative leaves it unchanged. Padrão -1.

Retorna: mesh, message, lods, notes.

skel.set_ref_pose_bone (risco 3, altera, smoke)​

Moves one bone of the mesh's reference pose. Breaks existing animations and invalidates the physics asset.

ArgumentoTipoDescrição
bonestringobrigatório. Bone name.
location{x,y,z}New translation relative to the parent bone.
rotation{x,y,z}New rotation relative to the parent bone, as pitch/yaw/roll.
scale{x,y,z}New scale; (0,0,0) means 1,1,1.
rebuildbooleanRebuild the mesh after the change. Padrão true.

Retorna: mesh, space, bones, count, message, notes.

skel.set_retarget_mode (risco 2, altera, smoke)​

Sets the translation retargeting mode of a bone (Animation, Skeleton, AnimationScaled, AnimationRelative, OrientAndScale).

ArgumentoTipoDescrição
bonestringobrigatório. Bone name.
modestringobrigatório. Animation, Skeleton, AnimationScaled, AnimationRelative or OrientAndScale.
recursebooleanAlso apply the mode to every descendant of the bone. Padrão false.

Retorna: skeleton, modes, count, changed, message, notes.

skel.set_sampling_regions (risco 2, altera, smoke)​

Replaces the Niagara sampling regions of a skeletal mesh (an empty list clears them).

ArgumentoTipoDescrição
regionsarray of UeaSkelSamplingRegionThe regions; an empty array clears them.

Retorna: mesh, message, lods, notes.

skel.set_section (risco 2, altera, smoke)​

Edits one section of a LOD: material slot, disabled, cast shadow, recompute tangent, ray tracing visibility, generate-up-to LOD.

ArgumentoTipoDescrição
lodintegerobrigatório. LOD index.
sectionintegerobrigatório. Section index inside the LOD.
materialSlotintegerMaterial slot the section draws with; negative leaves it unchanged. Padrão -1.
disabledbooleanSkip the section in the renderer. Padrão false.
castShadowbooleanSection casts shadows. Padrão true.
recomputeTangentbooleanRecompute tangents every frame (needed by some cloth/morph setups). Padrão false.
visibleInRayTracingbooleanSection is visible to ray tracing (UE 5 only). Padrão true.
generateUpToLodintegerThe section disappears past this LOD; negative leaves it unchanged. Padrão -1.

Retorna: mesh, sections, count, message, notes.

skel.set_skeleton_socket (risco 2, altera, smoke)​

Changes an existing skeleton socket (bone, transform, name).

ArgumentoTipoDescrição
namestringobrigatório. Socket name.
bonestringBone the socket is attached to (required when adding).
location{x,y,z}Offset from the bone.
rotation{x,y,z}Rotation as pitch/yaw/roll.
scale{x,y,z}Scale; (0,0,0) means 1,1,1.
forceAlwaysAnimatedbooleanKeep the socket's bone animated even when it is not otherwise required. Padrão false.
newNamestringNew socket name (skel.set_skeleton_socket only).

Retorna: skeleton, sockets, count, message, notes.

skel.set_skin_weight_profile (risco 2, altera)​

Changes the flags of a skin weight profile. Not smoke-tested: the engine cube fixture has no skin weight profiles.

ArgumentoTipoDescrição
namestringobrigatório. Profile name.
defaultProfilebooleanMake the profile replace the default skin weights. Padrão false.
defaultProfileFromLodintegerLOD index from which the profile overrides the default weights. Padrão 0.

Retorna: mesh, profiles, count, message, notes.

skel.set_slot_group (risco 2, altera, smoke)​

Moves an existing slot to another group.

ArgumentoTipoDescrição
slotstringSlot name (skel.add_slot, skel.set_slot_group, skel.remove_slot).
groupstringSlot group name (defaults to DefaultGroup for skel.add_slot).

Retorna: skeleton, groups, count, message, notes.

skel.set_source_file (risco 2, altera)​

Points the mesh at another source file for the next reimport. Not smoke-tested: it needs an FBX file on disk.

ArgumentoTipoDescrição
assetstringAsset path; "" clears the reference.

Retorna: mesh, message, lods, notes.

skel.set_vertex_color_lod (risco 3, altera, smoke)​

Paints every vertex of a LOD with one colour (useful to prime a vertex colour channel).

ArgumentoTipoDescrição
lodintegerobrigatório. LOD index.
colorstringobrigatório. Colour as "#RRGGBB", "#RRGGBBAA" or "R,G,B,A" with 0-255 components.

Retorna: mesh, message, lods, notes.

skel.strip_lod_geometry (risco 3, altera)​

Strips the geometry of a LOD using a texture mask. Not smoke-tested: it needs a mask texture and a reducible mesh.

ArgumentoTipoDescrição
lodintegerobrigatório. LOD index.
textureMaskstringobrigatório. Texture asset used as the mask.
thresholdnumberThreshold above which a triangle is kept (0-1). Padrão 0.5.

Retorna: mesh, lods, count, message, notes.

skel.validate_mesh (risco 0, smoke)​

Sanity check: missing skeleton, sections without a material, LOD ordering, degenerate bounds, physics asset mismatch.

ArgumentoTipoDescrição
meshstringobrigatório. Skeletal mesh asset path or unique name.

Retorna: mesh, errors, warnings, valid, message.