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:
| Class | Prefix | What |
|---|---|---|
UUeaKit_Skeleton | skel. | 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_SkelMesh | skel. | LOD info / reduction / build settings, sections, material slots, morph targets, skin weight profiles, reference pose, bounds, sampling, ray tracing, merge, export, import settings |
UUeaKit_SkelPhysics | skel.pa_ | bodies and shapes, constraints with limits and motors, constraint and physical-animation profiles, collision pairs, mirroring, auto-generation |
UUeaKit_SkelCloth | skel.cloth_ | clothing assets: create from a section, bind/unbind, configs, weight maps |
UUeaKit_SkelBatch | skel. | 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
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.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.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.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+) andskel.set_default_mesh_deformer(5.1+). - Reduction needs a plugin.
skel.generate_lods,skel.regenerate_lod,skel.remove_lodandskel.batch_regenerate_lodsall 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_settingsandset_ref_pose_bonetakerebuild; leave it false while you make several changes, then callskel.rebuild_meshonce. Rebuilding a character mesh takes seconds, not milliseconds. - Reference pose edits are dangerous.
skel.set_ref_pose_bonechanges the bind pose, which breaks existing animations and invalidates the physics asset. Regenerate the physics asset withskel.pa_regenerateafterwards, and useskel.reset_ref_poseto go back to the skeleton's pose. - Virtual bone names. The engine names virtual bones
VB <source>_<target>.add_virtual_bonereturns the actual name increatedName;rename_virtual_boneandremove_virtual_bonesaccept the name with or without theVBprefix (it is added for you). - Curve metadata moved. UE 5.7 removed smart names; the kit uses the new
FCurveMetaDataAPI there and the smart-name container below it. The tool shapes are identical, butskel.rename_curvefails on a name that is already taken on both paths. - Cloth plugin. Every
skel.cloth_*tool declaresRequiresPlugin="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_slotrefuses a slot a section still uses; point the sections elsewhere withskel.set_sectionfirst. Removing a slot shifts every higher section material index down by one, which the tool does for you. - Physics asset deletion.
skel.pa_deletefails while a mesh still references the asset; clear it withskel.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
MaxAutoRiskexigem"_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 argumentodryRun. smoke = coberto poredit.self_test.
skel.add_compatible_skeleton (risco 2, altera, UE 5.0+, smoke)
Declares another skeleton compatible with this one (UE 5 only).
| Argumento | Tipo | Descrição |
|---|---|---|
other | string | obrigató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).
| Argumento | Tipo | Descrição |
|---|---|---|
name | string | obrigatório. Curve name. |
morphTarget | boolean | Mark the curve as driving a morph target. Padrão false. |
material | boolean | Mark the curve as driving a material parameter. Padrão false. |
maxLod | integer | Lowest-detail LOD the curve is still evaluated on; -1 leaves it unchanged, 255 = always. Padrão -1. |
linkedBones | array of string | Bones 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.
| Argumento | Tipo | Descrição |
|---|---|---|
material | string | Material asset path; the slot stays empty when omitted. |
slotName | string | Slot 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).
| Argumento | Tipo | Descrição |
|---|---|---|
name | string | obrigató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.
| Argumento | Tipo | Descrição |
|---|---|---|
name | string | obrigatório. Socket name. |
bone | string | Bone 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. |
forceAlwaysAnimated | boolean | Keep the socket's bone animated even when it is not otherwise required. Padrão false. |
newName | string | New 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).
| Argumento | Tipo | Descrição |
|---|---|---|
slot | string | Slot name (skel.add_slot, skel.set_slot_group, skel.remove_slot). |
group | string | Slot 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.
| Argumento | Tipo | Descrição |
|---|---|---|
slot | string | Slot name (skel.add_slot, skel.set_slot_group, skel.remove_slot). |
group | string | Slot 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.
| Argumento | Tipo | Descrição |
|---|---|---|
source | string | obrigatório. Bone the virtual bone is parented to. |
target | string | obrigatório. Bone the virtual bone follows. |
name | string | Explicit 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).
| Argumento | Tipo | Descrição |
|---|---|---|
preset | string | obrigatório. humanoid (root=Animation, pelvis=AnimationScaled, IK bones=Animation, rest=Skeleton) or animation / skeleton (everything). |
pelvisBone | string | Name 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.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | obrigatório. Content folder to audit. |
maxTriangles | integer | Flag meshes whose LOD 0 has more triangles than this; 0 disables the check. Padrão 0. |
requireLods | boolean | Flag meshes with a single LOD. Padrão false. |
requirePhysicsAsset | boolean | Flag meshes without a physics asset. Padrão false. |
requireMorphs | boolean | Flag meshes without morph targets. Padrão false. |
offendersOnly | boolean | Only report the meshes that failed a check. Padrão false. |
limit | integer | Maximum 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.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | obrigatório. Content folder to audit. |
limit | integer | Maximum 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.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | obrigatório. Content folder to audit. |
limit | integer | Maximum 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.
| Argumento | Tipo | Descrição |
|---|---|---|
count | integer | Total 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.
| Argumento | Tipo | Descrição |
|---|---|---|
preset | string | obrigató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.
| Argumento | Tipo | Descrição |
|---|---|---|
settings | string | obrigatório. SkeletalMeshLODSettings asset path. |
apply | boolean | Immediately 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).
| Argumento | Tipo | Descrição |
|---|---|---|
physicsAsset | string | obrigatório. Physics asset path. |
onlyMissing | boolean | Only 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').
| Argumento | Tipo | Descrição |
|---|---|---|
skeleton | string | obrigatório. Skeleton asset path. |
force | boolean | Rebind 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.
| Argumento | Tipo | Descrição |
|---|---|---|
name | string | obrigatório. Clothing asset name. |
lod | integer | obrigatório. LOD of the section to drive. |
section | integer | obrigatório. Section to drive. |
clothLod | integer | Cloth 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.
| Argumento | Tipo | Descrição |
|---|---|---|
lod | integer | obrigatório. LOD the source section lives in. |
section | integer | obrigatório. Section index to turn into cloth. |
name | string | obrigatório. Name of the new clothing asset. |
removeSection | boolean | Leave the source section out of the rendered mesh. Padrão false. |
physicsAsset | string | Physics 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.
| Argumento | Tipo | Descrição |
|---|---|---|
name | string | obrigató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.
| Argumento | Tipo | Descrição |
|---|---|---|
name | string | obrigatório. Clothing asset name. |
config | string | Config object name (ChaosClothConfig by default). |
values | array of UeaKeyValue | Properties 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.
| Argumento | Tipo | Descrição |
|---|---|---|
lod | integer | obrigatório. LOD index. |
section | integer | obrigató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.
| Argumento | Tipo | Descrição |
|---|---|---|
mesh | string | obrigató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.
| Argumento | Tipo | Descrição |
|---|---|---|
name | string | obrigatório. Clothing asset name. |
lod | integer | Cloth 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.
| Argumento | Tipo | Descrição |
|---|---|---|
name | string | obrigató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.
| Argumento | Tipo | Descrição |
|---|---|---|
name | string | obrigató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.
| Argumento | Tipo | Descrição |
|---|---|---|
name | string | obrigatório. Clothing asset name. |
config | string | Config object name (ChaosClothConfig by default). |
values | array of UeaKeyValue | Properties 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.
| Argumento | Tipo | Descrição |
|---|---|---|
name | string | obrigatório. Clothing asset name. |
lod | integer | obrigatório. Cloth LOD index. |
map | integer | obrigatório. Weight map target (numeric id, e.g. 0 = MaxDistance). |
value | number | obrigató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.
| Argumento | Tipo | Descrição |
|---|---|---|
lod | integer | obrigatório. LOD index. |
section | integer | obrigató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.
| Argumento | Tipo | Descrição |
|---|---|---|
from | string | obrigató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).
| Argumento | Tipo | Descrição |
|---|---|---|
from | string | obrigató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).
| Argumento | Tipo | Descrição |
|---|---|---|
name | string | obrigatório. Blend profile name. |
mode | string | TimeFactor (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.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | obrigatório. Destination content folder. |
name | string | obrigató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.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | Destination content folder; the source folder when empty. |
name | string | obrigató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.
| Argumento | Tipo | Descrição |
|---|---|---|
file | string | obrigatório. Destination file path (absolute, or relative to the project directory). |
ascii | boolean | Write ASCII FBX instead of binary. Padrão false. |
exportMorphTargets | boolean | Include morph targets in the export. Padrão true. |
lod | integer | LOD 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.
| Argumento | Tipo | Descrição |
|---|---|---|
pattern | string | obrigatório. Wildcard pattern ("hand_", "_l"); a plain word matches as a substring. |
limit | integer | Maximum 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.
| Argumento | Tipo | Descrição |
|---|---|---|
count | integer | obrigatório. Total number of LODs including LOD0. |
percents | array of number | Triangle fraction per generated LOD (default 0.5, 0.25, 0.125...). |
screenSizes | array of number | Screen 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.
| Argumento | Tipo | Descrição |
|---|---|---|
bone | string | obrigató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').
| Argumento | Tipo | Descrição |
|---|---|---|
from | string | obrigatório. First bone of the chain. |
to | string | obrigató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.
| Argumento | Tipo | Descrição |
|---|---|---|
bone | string | obrigatório. Bone name. |
lod | integer | LOD 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).
| Argumento | Tipo | Descrição |
|---|---|---|
mesh | string | obrigató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).
| Argumento | Tipo | Descrição |
|---|---|---|
lod | integer | obrigató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.
| Argumento | Tipo | Descrição |
|---|---|---|
lod | integer | LOD 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.
| Argumento | Tipo | Descrição |
|---|---|---|
mesh | string | obrigató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.
| Argumento | Tipo | Descrição |
|---|---|---|
bones | array of string | Bones to report; empty reports every bone. |
space | string | local (relative to the parent, default) or component. |
limit | integer | Maximum 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.
| Argumento | Tipo | Descrição |
|---|---|---|
lod | integer | obrigató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.
| Argumento | Tipo | Descrição |
|---|---|---|
skeleton | string | obrigató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.
| Argumento | Tipo | Descrição |
|---|---|---|
skeleton | string | obrigató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.
| Argumento | Tipo | Descrição |
|---|---|---|
vertex | integer | obrigatório. Vertex index inside the LOD. |
lod | integer | LOD 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.
| Argumento | Tipo | Descrição |
|---|---|---|
lod | integer | obrigatório. LOD index to import into. |
file | string | obrigató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.
| Argumento | Tipo | Descrição |
|---|---|---|
mesh | string | obrigató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).
| Argumento | Tipo | Descrição |
|---|---|---|
classFilter | string | Keep only assets of this class (AnimSequence, AnimMontage, BlendSpace...); empty = every animation asset. |
limit | integer | Maximum 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.
| Argumento | Tipo | Descrição |
|---|---|---|
skeleton | string | obrigató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.
| Argumento | Tipo | Descrição |
|---|---|---|
parent | string | Only list this bone and its descendants. |
depth | integer | Maximum hierarchy depth returned relative to the root (-1 = no limit). Padrão -1. |
nameContains | string | Keep only bones whose name contains this text. |
limit | integer | Maximum 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).
| Argumento | Tipo | Descrição |
|---|---|---|
skeleton | string | obrigató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.
| Argumento | Tipo | Descrição |
|---|---|---|
skeleton | string | obrigató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.
| Argumento | Tipo | Descrição |
|---|---|---|
mesh | string | obrigató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).
| Argumento | Tipo | Descrição |
|---|---|---|
skeleton | string | obrigató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.
| Argumento | Tipo | Descrição |
|---|---|---|
mesh | string | obrigató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.
| Argumento | Tipo | Descrição |
|---|---|---|
skeleton | string | obrigató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.
| Argumento | Tipo | Descrição |
|---|---|---|
lod | integer | LOD 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).
| Argumento | Tipo | Descrição |
|---|---|---|
skeleton | string | obrigató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.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | Content folder to search ("/Game" when empty). |
nameContains | string | Keep only skeletons whose name contains this text. |
limit | integer | Maximum 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.
| Argumento | Tipo | Descrição |
|---|---|---|
mesh | string | obrigató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.
| Argumento | Tipo | Descrição |
|---|---|---|
skeleton | string | obrigató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).
| Argumento | Tipo | Descrição |
|---|---|---|
skeleton | string | obrigató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.
| Argumento | Tipo | Descrição |
|---|---|---|
mesh | string | obrigató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).
| Argumento | Tipo | Descrição |
|---|---|---|
meshes | array of string | obrigatório. Source skeletal meshes, in draw order. |
folder | string | obrigatório. Destination content folder. |
name | string | obrigatório. Name of the merged asset. |
skeleton | string | Skeleton for the merged mesh; the first source mesh's skeleton when empty. |
stripTopLods | integer | Number 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.
| Argumento | Tipo | Descrição |
|---|---|---|
bone | string | obrigatório. Bone the body is attached to. |
shape | string | capsule (default), box or sphere. |
size | number | Shape size: radius for sphere/capsule, half-extent for box. Padrão 5.0. |
physicsType | string | default, 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).
| Argumento | Tipo | Descrição |
|---|---|---|
bone1 | string | obrigatório. Child bone. |
bone2 | string | obrigatório. Parent bone. |
name | string | Joint name; the child bone name when empty. |
preset | string | locked, 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.
| Argumento | Tipo | Descrição |
|---|---|---|
name | string | obrigatório. Profile name. |
kind | string | obrigatório. constraint or physicalAnimation. |
newName | string | New 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.
| Argumento | Tipo | Descrição |
|---|---|---|
bone | string | obrigatório. Bone the body is attached to. |
type | string | obrigatório. box, sphere or capsule. |
index | integer | Shape 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. |
radius | number | Radius of a sphere or capsule; negative leaves it unchanged. Padrão -1.0. |
length | number | Length of a capsule's line segment; negative leaves it unchanged. Padrão -1.0. |
name | string | Optional shape name. |
contributeToMass | boolean | Whether 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).
| Argumento | Tipo | Descrição |
|---|---|---|
mesh | string | obrigatório. Skeletal mesh asset path or unique name. |
shadow | boolean | Assign 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.
| Argumento | Tipo | Descrição |
|---|---|---|
from | string | obrigatório. Source bone. |
to | string | obrigatório. Destination bone (its body is created when missing). |
mirror | boolean | Mirror 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.
| Argumento | Tipo | Descrição |
|---|---|---|
mesh | string | obrigatório. Skeletal mesh the bodies are generated from. |
folder | string | Destination content folder (skel.pa_create only). |
name | string | Name of the new physics asset (skel.pa_create only). |
minBoneSize | number | Bones shorter than this are skipped. Padrão 20.0. |
geomType | string | sphyl (capsule, default), box, sphere, singleConvex, multiConvex or taperedCapsule. |
vertWeight | string | anyWeight or dominantWeight (default). |
autoOrient | boolean | Orient the created bodies along their bone. Padrão true. |
createConstraints | boolean | Create constraints between adjacent bodies. Padrão true. |
walkPastSmall | boolean | Keep walking past bones that are too small instead of stopping. Padrão true. |
bodyForAll | boolean | Create a body for every bone, even the small ones. Padrão false. |
disableCollisionsByDefault | boolean | Disable collision between the created bodies by default. Padrão true. |
hullCount | integer | Number of hulls for the convex geometry types. Padrão 4. |
maxHullVerts | integer | Maximum vertices per convex hull. Padrão 16. |
assign | boolean | Also 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.
| Argumento | Tipo | Descrição |
|---|---|---|
physicsAsset | string | obrigató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.
| Argumento | Tipo | Descrição |
|---|---|---|
bone | string | obrigató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.
| Argumento | Tipo | Descrição |
|---|---|---|
physicsAsset | string | obrigató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.
| Argumento | Tipo | Descrição |
|---|---|---|
physicsAsset | string | obrigató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.
| Argumento | Tipo | Descrição |
|---|---|---|
bone | string | obrigató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).
| Argumento | Tipo | Descrição |
|---|---|---|
name | string | obrigató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.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | Content folder to search ("/Game" when empty). |
limit | integer | Maximum 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.
| Argumento | Tipo | Descrição |
|---|---|---|
physicsAsset | string | obrigató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).
| Argumento | Tipo | Descrição |
|---|---|---|
disabledOnly | boolean | Only 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.
| Argumento | Tipo | Descrição |
|---|---|---|
physicsAsset | string | obrigató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.
| Argumento | Tipo | Descrição |
|---|---|---|
physicsAsset | string | obrigató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.
| Argumento | Tipo | Descrição |
|---|---|---|
bone | string | obrigató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.
| Argumento | Tipo | Descrição |
|---|---|---|
fromSuffix | string | obrigatório. Suffix of the source bones (e.g. "_l"). |
toSuffix | string | obrigató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.
| Argumento | Tipo | Descrição |
|---|---|---|
physicsAsset | string | obrigató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).
| Argumento | Tipo | Descrição |
|---|---|---|
bone | string | obrigató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.
| Argumento | Tipo | Descrição |
|---|---|---|
name | string | obrigató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.
| Argumento | Tipo | Descrição |
|---|---|---|
name | string | obrigatório. Profile name. |
kind | string | obrigatório. constraint or physicalAnimation. |
newName | string | New 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.
| Argumento | Tipo | Descrição |
|---|---|---|
bone | string | obrigatório. Bone the body is attached to. |
type | string | obrigatório. box, sphere or capsule. |
index | integer | Shape 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. |
radius | number | Radius of a sphere or capsule; negative leaves it unchanged. Padrão -1.0. |
length | number | Length of a capsule's line segment; negative leaves it unchanged. Padrão -1.0. |
name | string | Optional shape name. |
contributeToMass | boolean | Whether 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.
| Argumento | Tipo | Descrição |
|---|---|---|
name | string | obrigatório. Profile name. |
kind | string | obrigatório. constraint or physicalAnimation. |
newName | string | New 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.
| Argumento | Tipo | Descrição |
|---|---|---|
physicsAsset | string | obrigató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.
| Argumento | Tipo | Descrição |
|---|---|---|
factor | number | obrigatório. Scale factor applied to every radius/extent. |
bones | array of string | Bones 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.
| Argumento | Tipo | Descrição |
|---|---|---|
bone | string | obrigatório. Bone the body is attached to. |
collisionEnabled | string | noCollision, queryOnly, physicsOnly or queryAndPhysics ("" leaves it unchanged). |
objectType | string | Collision object type channel name (WorldStatic, Pawn, PhysicsBody...). |
responses | array of UeaKeyValue | Per-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.
| Argumento | Tipo | Descrição |
|---|---|---|
bone | string | obrigatório. Bone the body is attached to. |
physicsType | string | default, kinematic or simulated ("" leaves it unchanged). |
massScale | number | Multiplier applied to the computed mass; negative leaves it unchanged. Padrão -1.0. |
massKg | number | Explicit mass in kilograms; negative leaves the computed mass. Padrão -1.0. |
linearDamping | number | Linear damping; negative leaves it unchanged. Padrão -1.0. |
angularDamping | number | Angular damping; negative leaves it unchanged. Padrão -1.0. |
enableGravity | boolean | Whether gravity acts on the body. Padrão true. |
simulatePhysics | boolean | Whether the body simulates by default. Padrão false. |
startAwake | boolean | Whether the body starts awake. Padrão true. |
useCCD | boolean | Use continuous collision detection. Padrão false. |
centerOfMassOffset | {x,y,z} | Offset applied to the centre of mass. |
physicalMaterial | string | Physical 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.
| Argumento | Tipo | Descrição |
|---|---|---|
bone1 | string | obrigatório. First bone. |
bone2 | string | obrigatório. Second bone. |
enabled | boolean | True 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.
| Argumento | Tipo | Descrição |
|---|---|---|
name | string | obrigatório. Joint name. |
disableCollision | boolean | Make the two bodies ignore each other. Padrão true. |
projectionEnabled | boolean | Enable joint projection (keeps long chains from stretching). Padrão false. |
linearBreakable | boolean | Let the constraint break under linear force. Padrão false. |
linearBreakThreshold | number | Force above which the constraint breaks; negative leaves it unchanged. Padrão -1.0. |
angularBreakable | boolean | Let the constraint break under torque. Padrão false. |
angularBreakThreshold | number | Torque above which the constraint breaks; negative leaves it unchanged. Padrão -1.0. |
parentDominates | boolean | Let 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.
| Argumento | Tipo | Descrição |
|---|---|---|
name | string | obrigatório. Joint name. |
swing1Motion | string | free, limited or locked ("" leaves it unchanged). |
swing1Limit | number | Swing 1 limit in degrees; negative leaves it unchanged. Padrão -1.0. |
swing2Motion | string | free, limited or locked ("" leaves it unchanged). |
swing2Limit | number | Swing 2 limit in degrees; negative leaves it unchanged. Padrão -1.0. |
twistMotion | string | free, limited or locked ("" leaves it unchanged). |
twistLimit | number | Twist limit in degrees; negative leaves it unchanged. Padrão -1.0. |
linearXMotion | string | free, limited or locked ("" leaves it unchanged). |
linearYMotion | string | free, limited or locked ("" leaves it unchanged). |
linearZMotion | string | free, limited or locked ("" leaves it unchanged). |
linearLimit | number | Linear limit distance; negative leaves it unchanged. Padrão -1.0. |
softSwing | boolean | Make the swing limit soft. Padrão false. |
swingStiffness | number | Soft swing stiffness; negative leaves it unchanged. Padrão -1.0. |
swingDamping | number | Soft swing damping; negative leaves it unchanged. Padrão -1.0. |
softTwist | boolean | Make the twist limit soft. Padrão false. |
twistStiffness | number | Soft twist stiffness; negative leaves it unchanged. Padrão -1.0. |
twistDamping | number | Soft twist damping; negative leaves it unchanged. Padrão -1.0. |
softLinear | boolean | Make the linear limit soft. Padrão false. |
linearStiffness | number | Soft linear stiffness; negative leaves it unchanged. Padrão -1.0. |
linearDamping | number | Soft 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.
| Argumento | Tipo | Descrição |
|---|---|---|
name | string | obrigatório. Joint name. |
angularDriveMode | string | slerp or twistAndSwing ("" leaves it unchanged). |
orientationDrive | boolean | Enable the angular orientation drive. Padrão false. |
velocityDrive | boolean | Enable the angular velocity drive. Padrão false. |
strength | number | Angular drive spring strength; negative leaves it unchanged. Padrão -1.0. |
damping | number | Angular drive damping; negative leaves it unchanged. Padrão -1.0. |
maxForce | number | Maximum force the drives may apply; negative leaves it unchanged. Padrão -1.0. |
target | {x,y,z} | Target orientation as pitch/yaw/roll. |
linearPositionDrive | boolean | Enable the linear position drive on all three axes. Padrão false. |
linearVelocityDrive | boolean | Enable 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.
| Argumento | Tipo | Descrição |
|---|---|---|
profile | string | obrigatório. Physical animation profile name. |
bone | string | obrigatório. Bone the settings apply to. |
orientationStrength | number | Strength of the orientation drive. Padrão 0.0. |
angularVelocityStrength | number | Strength of the angular velocity drive. Padrão 0.0. |
positionStrength | number | Strength of the position drive. Padrão 0.0. |
velocityStrength | number | Strength of the linear velocity drive. Padrão 0.0. |
maxLinearForce | number | Maximum linear force the drives may apply. Padrão 0.0. |
maxAngularForce | number | Maximum angular force the drives may apply. Padrão 0.0. |
isLocalSimulation | boolean | Simulate 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.
| Argumento | Tipo | Descrição |
|---|---|---|
bone | string | Bone to change; every body when empty. |
material | string | obrigató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.
| Argumento | Tipo | Descrição |
|---|---|---|
mesh | string | obrigató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.
| Argumento | Tipo | Descrição |
|---|---|---|
profile | string | obrigatório. Constraint profile name. |
constraint | string | obrigatório. Joint name. |
swing1Motion | string | free, limited or locked ("" leaves it unchanged). |
swing1Limit | number | Swing 1 limit in degrees; negative leaves it unchanged. Padrão -1.0. |
swing2Motion | string | free, limited or locked ("" leaves it unchanged). |
swing2Limit | number | Swing 2 limit in degrees; negative leaves it unchanged. Padrão -1.0. |
twistMotion | string | free, limited or locked ("" leaves it unchanged). |
twistLimit | number | Twist limit in degrees; negative leaves it unchanged. Padrão -1.0. |
strength | number | Angular drive spring strength; negative leaves it unchanged. Padrão -1.0. |
damping | number | Angular 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.
| Argumento | Tipo | Descrição |
|---|---|---|
bone | string | obrigatório. Bone the body is attached to. |
type | string | obrigatório. box, sphere or capsule. |
index | integer | Shape 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. |
radius | number | Radius of a sphere or capsule; negative leaves it unchanged. Padrão -1.0. |
length | number | Length of a capsule's line segment; negative leaves it unchanged. Padrão -1.0. |
name | string | Optional shape name. |
contributeToMass | boolean | Whether 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).
| Argumento | Tipo | Descrição |
|---|---|---|
positionIterations | integer | Position iterations (UE 5) / solver iterations (UE 4.27); negative leaves it unchanged. Padrão -1. |
velocityIterations | integer | Velocity iterations (UE 5) / joint iterations (UE 4.27); negative leaves it unchanged. Padrão -1. |
projectionIterations | integer | Projection iterations (UE 5) / collision iterations (UE 4.27); negative leaves it unchanged. Padrão -1. |
solverType | string | World 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.
| Argumento | Tipo | Descrição |
|---|---|---|
physicsAsset | string | obrigató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.
| Argumento | Tipo | Descrição |
|---|---|---|
parent | string | obrigatório. Bone that keeps its body. |
child | string | obrigató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.
| Argumento | Tipo | Descrição |
|---|---|---|
mesh | string | obrigató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).
| Argumento | Tipo | Descrição |
|---|---|---|
mesh | string | obrigató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.
| Argumento | Tipo | Descrição |
|---|---|---|
lod | integer | obrigató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.
| Argumento | Tipo | Descrição |
|---|---|---|
file | string | Source 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.
| Argumento | Tipo | Descrição |
|---|---|---|
mesh | string | obrigató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.
| Argumento | Tipo | Descrição |
|---|---|---|
name | string | obrigató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).
| Argumento | Tipo | Descrição |
|---|---|---|
other | string | obrigató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.
| Argumento | Tipo | Descrição |
|---|---|---|
name | string | obrigató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.
| Argumento | Tipo | Descrição |
|---|---|---|
lod | integer | obrigató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.
| Argumento | Tipo | Descrição |
|---|---|---|
slot | string | obrigató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.
| Argumento | Tipo | Descrição |
|---|---|---|
name | string | obrigató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.
| Argumento | Tipo | Descrição |
|---|---|---|
name | string | obrigató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.
| Argumento | Tipo | Descrição |
|---|---|---|
name | string | obrigató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.
| Argumento | Tipo | Descrição |
|---|---|---|
name | string | obrigatório. Name to operate on. |
Retorna: mesh, profiles, count, message, notes.
skel.remove_slot (risco 3, altera, destrutivo, smoke)
Removes an animation slot.
| Argumento | Tipo | Descrição |
|---|---|---|
slot | string | Slot name (skel.add_slot, skel.set_slot_group, skel.remove_slot). |
group | string | Slot 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.
| Argumento | Tipo | Descrição |
|---|---|---|
names | array of string | obrigatório. Names to operate on. |
Retorna: skeleton, virtualBones, count, createdName, message, notes.
skel.rename_curve (risco 2, altera, smoke)
Renames a curve.
| Argumento | Tipo | Descrição |
|---|---|---|
name | string | obrigatório. Current name. |
newName | string | obrigató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.
| Argumento | Tipo | Descrição |
|---|---|---|
name | string | obrigatório. Current name. |
newName | string | obrigatório. New name. |
Retorna: mesh, morphTargets, count, message, notes.
skel.rename_virtual_bone (risco 2, altera, smoke)
Renames a virtual bone.
| Argumento | Tipo | Descrição |
|---|---|---|
name | string | obrigatório. Current name. |
newName | string | obrigató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.
| Argumento | Tipo | Descrição |
|---|---|---|
mesh | string | obrigató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.
| Argumento | Tipo | Descrição |
|---|---|---|
mesh | string | obrigatório. Skeletal mesh asset path or unique name. |
Retorna: mesh, message, lods, notes.
skel.save_skeleton (risco 1)
Saves the skeleton package to disk.
| Argumento | Tipo | Descrição |
|---|---|---|
skeleton | string | obrigató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).
| Argumento | Tipo | Descrição |
|---|---|---|
enabled | boolean | Value 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.
| Argumento | Tipo | Descrição |
|---|---|---|
profile | string | obrigatório. Blend profile name. |
bone | string | obrigatório. Bone name. |
scale | number | obrigatório. Blend scale (1 = normal speed/weight, 0 = the bone does not blend). |
recurse | boolean | Also 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).
| Argumento | Tipo | Descriçã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).
| Argumento | Tipo | Descrição |
|---|---|---|
name | string | obrigatório. Curve name. |
morphTarget | boolean | Mark the curve as driving a morph target. Padrão false. |
material | boolean | Mark the curve as driving a material parameter. Padrão false. |
maxLod | integer | Lowest-detail LOD the curve is still evaluated on; -1 leaves it unchanged, 255 = always. Padrão -1. |
linkedBones | array of string | Bones 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).
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | Asset 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).
| Argumento | Tipo | Descrição |
|---|---|---|
importMorphTargets | boolean | Import morph targets on the next reimport. Padrão true. |
updateSkeletonReferencePose | boolean | Update the skeleton's reference pose from the file. Padrão false. |
useT0AsRefPose | boolean | Use frame 0 of the file as the reference pose. Padrão false. |
preserveSmoothingGroups | boolean | Keep the file's smoothing groups. Padrão true. |
importMeshesInBoneHierarchy | boolean | Import meshes that live inside the bone hierarchy. Padrão true. |
thresholdPosition | number | Weld distance for positions; negative leaves it unchanged. Padrão -1.0. |
thresholdTangentNormal | number | Weld threshold for tangents/normals; negative leaves it unchanged. Padrão -1.0. |
thresholdUv | number | Weld threshold for UVs; negative leaves it unchanged. Padrão -1.0. |
normalImportMethod | string | ComputeNormals / ImportNormals / ImportNormalsAndTangents ("" leaves it unchanged). |
normalGenerationMethod | string | BuiltIn / MikkTSpace ("" leaves it unchanged). |
computeWeightedNormals | boolean | Weight 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).
| Argumento | Tipo | Descrição |
|---|---|---|
lod | integer | obrigatório. LOD index. |
recomputeNormals | boolean | Recompute normals when building. Padrão false. |
recomputeTangents | boolean | Recompute tangents when building. Padrão true. |
useMikkTSpace | boolean | Use MikkTSpace to generate tangents. Padrão true. |
computeWeightedNormals | boolean | Weight generated normals by triangle area. Padrão false. |
removeDegenerates | boolean | Drop degenerate triangles. Padrão true. |
useHighPrecisionTangentBasis | boolean | Store tangents with higher precision. Padrão false. |
useFullPrecisionUVs | boolean | Store UVs with full precision. Padrão false. |
thresholdPosition | number | Weld distance for positions; negative leaves it unchanged. Padrão -1.0. |
thresholdTangentNormal | number | Weld threshold for tangents/normals; negative leaves it unchanged. Padrão -1.0. |
thresholdUv | number | Weld threshold for UVs; negative leaves it unchanged. Padrão -1.0. |
rebuild | boolean | Rebuild 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.
| Argumento | Tipo | Descrição |
|---|---|---|
lod | integer | obrigatório. LOD index (0-based). |
screenSize | number | Screen size at which the LOD becomes active; negative leaves it unchanged. Padrão -1.0. |
hysteresis | number | LOD hysteresis; negative leaves it unchanged. Padrão -1.0. |
allowCpuAccess | boolean | Keep the LOD's vertex buffers readable on the CPU. Padrão false. |
supportUniformSampling | boolean | Support uniformly distributed sampling (Niagara). Padrão false. |
bakePose | string | Animation whose pose is baked into the LOD ("" clears it, omitted leaves it unchanged). |
bakePoseOverride | string | Animation whose pose overrides the baked one. |
bonesToRemove | array of string | Bones removed at this LOD (replaces the current list when non-empty). |
bonesToPrioritize | array of string | Bones the reduction tries to preserve (replaces the current list when non-empty). |
weightOfPrioritization | number | Weight given to the prioritized bones; negative leaves it unchanged. Padrão -1.0. |
rebuild | boolean | Rebuild 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).
| Argumento | Tipo | Descrição |
|---|---|---|
lod | integer | obrigatório. LOD index (0-based). |
terminationCriterion | string | NumOfTriangles, NumOfVerts, NumOfTrianglesPercent, NumOfVertsPercent... ("" leaves it unchanged). |
percentTriangles | number | Fraction of triangles to keep (0-1); negative leaves it unchanged. Padrão -1.0. |
percentVertices | number | Fraction of vertices to keep (0-1); negative leaves it unchanged. Padrão -1.0. |
maxDeviation | number | Maximum deviation in percent; negative leaves it unchanged. Padrão -1.0. |
maxBonesPerVertex | integer | Maximum bone influences per vertex; negative leaves it unchanged. Padrão -1. |
weldingThreshold | number | Distance below which vertices are welded; negative leaves it unchanged. Padrão -1.0. |
hardAngle | number | Normal split angle in degrees; negative leaves it unchanged. Padrão -1.0. |
baseLod | integer | LOD the reduction reads from; negative leaves it unchanged. Padrão -1. |
lockEdges | boolean | Keep boundary edges. Padrão false. |
enforceBoneBoundaries | boolean | Do not collapse vertices across bone boundaries. Padrão false. |
rebuild | boolean | Rebuild 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.
| Argumento | Tipo | Descrição |
|---|---|---|
settings | string | SkeletalMeshLODSettings asset path; "" clears it. |
apply | boolean | Immediately 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.
| Argumento | Tipo | Descrição |
|---|---|---|
minLod | integer | obrigatório. Default minimum LOD the renderer may use. |
perPlatform | array of UeaKeyValue | Per-platform overrides as "platform=lod" (e.g. "Mobile=2"). |
disableBelowMinLodStripping | boolean | Keep 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.
| Argumento | Tipo | Descrição |
|---|---|---|
physicsAsset | string | Physics asset path; "" clears it. |
shadowPhysicsAsset | string | Cheaper 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.
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | Asset 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.
| Argumento | Tipo | Descrição |
|---|---|---|
mesh | string | obrigató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.
| Argumento | Tipo | Descrição |
|---|---|---|
support | boolean | obrigatório. Build a ray tracing acceleration structure for this mesh. |
minLod | integer | Lowest 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.
| Argumento | Tipo | Descrição |
|---|---|---|
bone | string | obrigató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. |
rebuild | boolean | Rebuild 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).
| Argumento | Tipo | Descrição |
|---|---|---|
bone | string | obrigatório. Bone name. |
mode | string | obrigatório. Animation, Skeleton, AnimationScaled, AnimationRelative or OrientAndScale. |
recurse | boolean | Also 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).
| Argumento | Tipo | Descrição |
|---|---|---|
regions | array of UeaSkelSamplingRegion | The 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.
| Argumento | Tipo | Descrição |
|---|---|---|
lod | integer | obrigatório. LOD index. |
section | integer | obrigatório. Section index inside the LOD. |
materialSlot | integer | Material slot the section draws with; negative leaves it unchanged. Padrão -1. |
disabled | boolean | Skip the section in the renderer. Padrão false. |
castShadow | boolean | Section casts shadows. Padrão true. |
recomputeTangent | boolean | Recompute tangents every frame (needed by some cloth/morph setups). Padrão false. |
visibleInRayTracing | boolean | Section is visible to ray tracing (UE 5 only). Padrão true. |
generateUpToLod | integer | The 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).
| Argumento | Tipo | Descrição |
|---|---|---|
name | string | obrigatório. Socket name. |
bone | string | Bone 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. |
forceAlwaysAnimated | boolean | Keep the socket's bone animated even when it is not otherwise required. Padrão false. |
newName | string | New 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.
| Argumento | Tipo | Descrição |
|---|---|---|
name | string | obrigatório. Profile name. |
defaultProfile | boolean | Make the profile replace the default skin weights. Padrão false. |
defaultProfileFromLod | integer | LOD 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.
| Argumento | Tipo | Descrição |
|---|---|---|
slot | string | Slot name (skel.add_slot, skel.set_slot_group, skel.remove_slot). |
group | string | Slot 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.
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | Asset 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).
| Argumento | Tipo | Descrição |
|---|---|---|
lod | integer | obrigatório. LOD index. |
color | string | obrigató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.
| Argumento | Tipo | Descrição |
|---|---|---|
lod | integer | obrigatório. LOD index. |
textureMask | string | obrigatório. Texture asset used as the mask. |
threshold | number | Threshold 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.
| Argumento | Tipo | Descrição |
|---|---|---|
mesh | string | obrigatório. Skeletal mesh asset path or unique name. |
Retorna: mesh, errors, warnings, valid, message.