component kit

121 tools. Generated from the plugin source; do not edit by hand.

Guide

Typed, per-class configuration of components wherever they live: on a Blueprint's construction script (the SCS template) or on a level actor instance. The bp kit adds/removes/attaches components on a Blueprint, the actor kit does the same on a level actor; this kit knows each component class — the right setters, units, enums and presets — plus copy/sync between the two worlds.

Works on UE 4.27 through 5.8 with the same 121 tools on every version. The kit is split over five classes (UUeaKit_Component, UUeaKit_ComponentShapes, UUeaKit_ComponentMovement, UUeaKit_ComponentRendering, UUeaKit_ComponentGameplay) that all expose the component. namespace.

Targets: template vs instance

Every tool that touches one component takes the same three arguments:

Argument	Meaning
blueprint	Blueprint asset path or unique name — edits the construction-script template, i.e. the default for every actor of that class.
actor	Level actor label or object name — edits that one instance in the level.
component	Component name (case-insensitive; a unique class name such as SpringArmComponent or a unique name prefix also works).

Give exactly one of blueprint or actor. A few tools use a different shape:

• component.diff, component.copy_settings take component references as text: blueprint:/Game/BP_Hero/SpringArm or actor:BP_Hero_2/SpringArm.
• component.sync_instance_to_template / component.reset_instance_to_template take actor + component and find the Blueprint themselves.
• component.apply_camera_preset takes springArm + camera instead of component.
• component.set_tick_settings_many / set_activation_many / set_replication_many take components[] (empty = all) plus an optional classFilter.

Argument conventions

• Every optional scalar is text and an empty value means "leave unchanged": 'maxWalkSpeed':'600', 'castShadow':'true', 'location':'0,0,90', 'color':'1,0.5,0,1', 'movementMode':'walking'. Sending a JSON number or boolean also works — the server converts it to text.
• Vectors/rotators are "x,y,z" (rotators are pitch,yaw,roll); colours are "r,g,b[,a]" in 0..1 or #RRGGBB; a single number broadcasts to all axes.
• Enums are lowercase words without the engine prefix: walking, movable, final_color_ldr, overlap, world.
• Object properties take an asset path or a unique asset name.
• Every set_* tool also accepts properties: [{key, value}] for anything not covered by a typed field. Paths support Struct.Field and Array[0] (BodyInstance.bSimulatePhysics, OverrideMaterials[0]).
• Replies always carry component, class, template (true for SCS templates), owner, applied[] (what was written) and warnings[] (assignments that were skipped, with the reason — typically a property that does not exist on the running engine). A warning never fails the call.

Tools

Discovery, generic access, presets (UUeaKit_Component)

Tool	Purpose
component.create_test_rig	Creates a playground: BP_CompRig (Character) with ~55 component types, BP_CompRig_Proj (movement components) and the level actors CompRig_Actor / CompRig_BPActor.
component.list_classes	Component classes of the Add Component palette: class, parent, module, category, scene/primitive/spawnable flags.
component.get_class_info / component.search_properties	Hierarchy, metadata and editable properties (type, category, tooltip, CDO default) of a component class.
component.list_on_blueprint / component.list_on_actor	Components of a Blueprint (templates + inherited native ones) or of an actor.
component.find_by_class	Where a component class is used, in a Blueprint folder and/or in the level.
component.get	Class, owner, transform, visibility, collision summary; includeProperties adds every editable property.
component.get_property / component.set_property / component.set_properties / component.reset_property	Generic property access, including struct and array paths; reset restores the archetype/CDO value.
component.diff	Editable properties that differ between two components (template vs instance included).
component.copy_settings	Copies property values from one component to another, across templates and instances.
component.sync_instance_to_template (risk 3) / component.reset_instance_to_template	Push a tuned level instance back into its Blueprint, or discard the instance overrides.
component.list_presets / component.apply_preset	character_capsule, third_person_camera, top_down_camera, fps_camera, pickup_sphere, trigger_box, projectile, rotating_prop, floating_pawn, physics_prop, static_prop, ui_widget_3d, ambient_sound_3d, security_camera_capture. list_presets shows the exact values each one writes.
component.set_common	active, autoActivate, tick (enabled/interval/group), replicated, editableWhenInherited, tags, editorOnly.
component.set_transform	Relative location/rotation/scale plus the absolute-location/rotation/scale flags.
component.set_visibility / component.set_mobility	visible, hiddenInGame, detailMode, propagation; static/stationary/movable.
component.set_collision / component.get_collision	Enabled state, profile, object type, per-channel responses, overlap events, navigation and occluder flags.
component.set_physics	simulate, mass override, gravity, damping, physical material, per-axis position/rotation locks, max angular velocity.
component.set_rendering	Shadow flags, custom depth + stencil, cull distance, translucency sort priority, lighting channels, ray tracing visibility, bounds scale, main/depth pass.
component.list_material_slots / component.set_materials / component.set_material_parameters	Slots with their current material; assign by order, slotName=path or index=path; scalar/vector parameters on a level instance (creates MIDs).
component.validate	Class-specific sanity check (mesh without asset, audio without sound, camera without spring arm, ISM without instances, overlap events with collision off, zero scale, ...).

Shapes, constraints, forces (UUeaKit_ComponentShapes)

Tool	Purpose
component.set_capsule / component.get_capsule / component.set_box / component.set_sphere	Size and editor draw options of the collision shapes.
component.fit_shape_to_mesh	Sizes a box/sphere/capsule to the bounds of a mesh component of the same owner (padding in cm) and centres it.
component.set_shape_from_preset	small_character, medium_character, large_character, crouched_character, pickup, door_trigger, room_trigger.
component.set_physics_constraint / component.get_physics_constraint	Constrained components (by name, so it survives on a template), linear/angular motion + limits, breaking, projection, linear and angular drives.
component.set_radial_force	Radius, impulse/force strength, falloff, affected object types, auto-activate.
component.set_physics_handle / component.set_physics_thruster / component.set_wind	Grab damping/stiffness, thrust strength, wind speed/strength/gusts.
component.list_collision_profiles / component.list_collision_channels	Project collision setup, to feed component.set_collision.

Movement, spring arm, camera (UUeaKit_ComponentMovement)

Tool	Purpose
component.get_character_movement / component.set_character_movement	Walk/fly/swim speeds, jump, air control, gravity, acceleration, braking, friction, rotation, crouch, step height, walkable floor angle, movement mode, nav agent size.
component.apply_movement_preset	platformer, realistic, floaty, fast_arcade, heavy.
component.set_projectile_movement / component.get_projectile_movement	Initial/max speed, rotation follows velocity, bouncing, friction, gravity scale, homing.
component.set_rotating_movement / component.set_floating_pawn_movement / component.set_interp_movement	Rotation rate and pivot; max speed/acceleration/deceleration; duration, behaviour and control points of a moving platform.
component.set_spring_arm / component.get_spring_arm	Arm length, socket/target offsets, inherit flags, translation and rotation lag, collision probe.
component.set_camera / component.get_camera	FOV, aspect ratio, projection mode, ortho width, pawn control rotation, HMD lock, post-process blend weight and post-process overrides.
component.set_cine_camera	Focal length, aperture, focus method/distance, sensor size, lens and filmback presets (CinematicCamera is a plugin on 4.27).
component.apply_camera_preset	Configures a spring arm + camera pair: third_person, first_person, top_down, side_scroller, isometric.
component.set_nav_movement / component.set_pawn_movement_common	Nav agent flags and size on any movement component; updated component and max speed.

Rendering, effects, audio, lights (UUeaKit_ComponentRendering)

Tool	Purpose
component.set_static_mesh / component.get_static_mesh	Mesh, materials, forced LOD, min LOD, lightmap resolution, reverse culling, default collision, distance field bias.
component.set_skeletal_mesh / component.get_skeletal_mesh	Mesh, animation mode, anim class/asset, loop/play, physics asset, leader (master) pose component, cloth.
component.set_instanced_mesh, add_instances, get_instances, set_instance_transform, set_instance_custom_data, remove_instances, clear_instances	Full instanced/hierarchical mesh workflow; transforms are "x,y,z", "x,y,z|pitch,yaw,roll" or "x,y,z|pitch,yaw,roll|sx,sy,sz".
component.set_spline_mesh	Mesh, start/end positions and tangents, forward axis, scales, roll, material.
component.set_decal / component.set_text_render / component.set_billboard / component.set_arrow	Decal material/size/fade; text, colour, world size, alignment, font; sprite and screen size; arrow colour/size/length.
component.set_widget / component.get_widget	3D widget class, draw size, world/screen space, pivot, two-sided, focusable.
component.set_scene_capture / component.set_scene_capture_cube / component.capture_scene_now	Render target, capture source, FOV, capture triggers, hidden/show-only actor lists, show flags, post process; render one frame on demand (level actors only).
component.set_particle_system / component.set_niagara / component.get_niagara_parameters	Cascade template; Niagara asset, activation and user parameters ("vec3:MyVar", "color:Tint", "bool:Flag", "int:Count").
component.set_audio / component.get_audio	Sound, volume, pitch, auto-activate, attenuation asset or inline overrides (inner radius, falloff distance, shape, spatialize), concurrency, sound class, start time.
component.set_poseable_bone	Moves one bone of a poseable mesh component.
component.set_light / component.get_light	Intensity + units, colour, temperature, attenuation and source sizes, cone angles, rect source, shadows, volumetric scattering, indirect intensity, light function, IES profile, lighting channels, mobility.
component.set_sky_light / component.set_fog / component.set_sky_atmosphere / component.set_volumetric_cloud	Environment components.
component.set_reflection_capture / component.set_planar_reflection / component.set_post_process	Reflections and post-process volume settings (settings[] sets the value and its bOverride_ flag).
component.set_material_slot / component.create_dynamic_material	One slot; a dynamic material instance with parameters (level actors only).
component.set_lightmap_resolution / component.set_cull_distances	Static mesh lightmap override; instance start/end cull distances.

Gameplay, navigation, AI, bulk (UUeaKit_ComponentGameplay)

Tool	Purpose
component.set_child_actor / component.get_child_actor	Actor class spawned by a child actor component.
component.set_timeline_component	Length, looping, play rate, time dilation of a timeline component.
component.set_nav_modifier / component.set_nav_invoker / component.set_nav_link	Nav area class and failsafe extent; tile generation/removal radii; custom link start/end/direction/area.
component.set_ai_perception / component.get_ai_perception	Senses (sight, hearing, damage, touch, prediction) with radius, lose radius, angle, max age and affiliation filters, plus the dominant sense.
component.set_perception_stimuli_source / component.set_noise_emitter / component.set_pawn_sensing	Being perceived, noise lifetime, classic pawn sensing.
component.set_force_feedback / component.set_motion_controller / component.set_physical_animation	Effect asset and intensity; motion source and device model; physical animation strength.
component.set_spline / component.get_spline	Replaces the spline points (local or world space), point type and closed loop; returns points, tangents, types and length. Works on Blueprint templates.
component.set_hierarchical_instanced_mesh	HISM-specific cull distances, density scaling, min LOD.
component.set_capsule_from_mesh	Sizes a character capsule from the mesh bounds.
component.set_tick_settings_many / component.set_activation_many / component.set_replication_many	Bulk edits over a component list or class filter.

Recipes

Third-person character

1. bp.create_blueprint {"name":"BP_Hero","parentClass":"Character","folder":"/Game/Blueprints"}
2. bp.add_component a SpringArmComponent named SpringArm on the root, then a CameraComponent named Camera parented to SpringArm.
3. component.apply_camera_preset {"blueprint":"/Game/Blueprints/BP_Hero","springArm":"SpringArm","camera":"Camera","preset":"third_person"}
4. component.apply_preset {"blueprint":"...","component":"CapsuleComponent","preset":"character_capsule"}
5. component.apply_movement_preset {"blueprint":"...","component":"CharMoveComp","preset":"platformer"}
6. component.set_character_movement {"blueprint":"...","component":"CharMoveComp","orientRotationToMovement":"true","rotationRate":"0,540,0"}
7. component.set_skeletal_mesh {"blueprint":"...","component":"CharacterMesh0","mesh":"/Game/Characters/SK_Hero","animationMode":"blueprint","animClass":"/Game/Characters/ABP_Hero"}
8. component.validate on the camera and the mesh, then bp.compile.

Projectile Blueprint

1. bp.create_blueprint with parent Actor; add a SphereComponent (root) and a ProjectileMovementComponent named ProjectileMove.
2. component.apply_preset {"component":"Sphere","preset":"pickup_sphere"} (or set_sphere + set_collision with profile:"OverlapAllDynamic").
3. component.apply_preset {"component":"ProjectileMove","preset":"projectile"}, then component.set_projectile_movement for the exact speed and bounce.

Physics prop with a constraint

1. Two StaticMeshComponents (Anchor, Swing) and a PhysicsConstraintComponent (Constraint).
2. component.apply_preset {"component":"Swing","preset":"physics_prop"}
3. component.set_physics_constraint {"component":"Constraint","component1":"Anchor","component2":"Swing","linearX":"locked","linearY":"locked","linearZ":"locked","angularSwing1":"limited","swing1Limit":"45","angularTwist":"free","disableCollision":"true"}

Security camera (3D widget + scene capture)

1. component.set_scene_capture {"component":"Capture","textureTarget":"/Game/UI/RT_Camera","captureSource":"final_color_ldr","captureEveryFrame":"false","captureOnMovement":"false"} (or apply_preset with security_camera_capture).
2. component.set_widget {"component":"Screen","widgetClass":"/Game/UI/WBP_CameraFeed","drawSize":"1024,576","space":"world","twoSided":"true"}
3. Call component.capture_scene_now on the level actor whenever the feed must refresh.

Ambient audio and an ISM field

• component.set_audio {"component":"Audio","sound":"/Game/Audio/S_Wind","volume":"0.6","autoActivate":"true","overrideAttenuation":"true","falloffDistance":"3000","spatialize":"true"}
• component.set_instanced_mesh {"component":"ISM","mesh":"/Game/Meshes/SM_Grass","cullDistanceMin":"2000","cullDistanceMax":"6000"} then component.add_instances with the transform list and component.set_instance_custom_data for per-instance material data.

Gotchas

• Template edits need a compile. Writing on a Blueprint template marks the Blueprint modified; existing level instances pick the new value up when the Blueprint is recompiled (bp.compile). Instance edits apply immediately but only to that actor — use component.sync_instance_to_template to promote them.
• Instance-only tools: component.set_material_parameters, component.create_dynamic_material and component.capture_scene_now need a live component and refuse a blueprint target.
• warnings[] is the place to look when a field seems ignored: the property may not exist on the running engine version or the value did not parse. applied[] lists what actually changed.
• 4.27 differences: leaderPose calls SetMasterPoseComponent (renamed to SetLeaderPoseComponent in 5.1); add_instances with worldSpace converts to component space by hand because AddInstance gained its world-space flag only in UE5; the fog inscattering colour is FogInscatteringColor on 4.27 and FogInscatteringLuminance on UE5 (the tool tries both).
• Build-data GUIDs are never copied. copy_settings, sync_instance_to_template, reset_instance_to_template and diff skip identity properties (MapBuildDataId, LightGuid, every FGuid, CreationMethod, attachment fields, anything transient): copying them corrupts the map build data and makes level.build_reflection_captures / lighting builds assert. Components the kit creates (including the test rig and the actors spawned from it) get fresh GUIDs, because the engine only generates them for non-template objects.
• Plugins: Niagara tools require the Niagara plugin (RequiresPlugin), and CineCamera lives in the CinematicCamera plugin on 4.27. Niagara, UMG widget, motion controller and cine camera properties are all written by reflection, so the kit itself adds no plugin dependency; the tool returns E_NOT_SUPPORTED when the class is missing.
• Use component.create_test_rig in a scratch folder when you want to explore: it builds a Blueprint carrying nearly every component class plus two level actors, which makes every tool of the kit callable without hunting for assets.

Tools

Legend. risk 0 = read-only, 1 = harmless editor op, 2 = modifies asset, 3 = deletes/replaces asset, 4 = project/config/build op, 5 = potentially destructive (calls above MaxAutoRisk need "_confirm": true). mutates = runs in a transaction (edit.undo reverts). requires PIE / requires world = refused without a PIE session / an open level. requires plugin = unavailable while the plugin is disabled. dryRun = honours the dryRun argument. smoke = covered by edit.self_test.

component.add_instances (risk 2, mutates, smoke)

Adds instances to an instanced static mesh component from a list of transforms.

Argument	Type	Description
transforms	array of string	required. One transform per instance: "x,y,z" or "x,y,z
worldSpace	boolean	Treat the transforms as world space (converted to component space on 4.27). Default false.

Returns: instances, count.

component.apply_camera_preset (risk 2, mutates, smoke)

Configures a spring arm + camera pair for a camera style: third_person, first_person, top_down, side_scroller or isometric.

Argument	Type	Description
blueprint	string	Blueprint holding the components (exclusive with actor).
actor	string	Level actor holding the components.
springArm	string	required. Spring arm component name.
camera	string	Camera component name (default: the first camera attached to the spring arm).
preset	string	required. third_person, first_person, top_down, side_scroller or isometric.

Returns: component, class, template, owner, applied, warnings.

component.apply_movement_preset (risk 2, mutates, smoke)

Applies a tuned character movement preset: platformer, realistic, floaty, fast_arcade or heavy.

Argument	Type	Description
preset	string	required. platformer, realistic, floaty, fast_arcade or heavy.

Returns: component, class, template, owner, applied, warnings.

component.apply_preset (risk 2, mutates, smoke)

Applies a documented set of property values to a component (character_capsule, third_person_camera, trigger_box, projectile, ...).

Argument	Type	Description
preset	string	required. Preset id (see component.list_presets).
overrides	array of UeaKeyValue	Property assignments applied after the preset.

Returns: component, class, template, owner, applied, warnings.

component.capture_scene_now (risk 1, mutates)

Renders one frame of a scene capture component into its render target (level actors only; not self-tested because it needs a render target asset and a rendering frame).

Argument	Type	Description
blueprint	string	Blueprint asset path or unique name; the component is edited on its construction-script template.
actor	string	Level actor label or object name; the component is edited on that actor instance.
component	string	required. Component name (case-insensitive; a unique class name or name prefix also works).

Returns: component, class, template, owner, applied, warnings.

component.clear_instances (risk 3, mutates, destructive, smoke)

Removes every instance of an instanced static mesh component.

Argument	Type	Description
blueprint	string	Blueprint asset path or unique name; the component is edited on its construction-script template.
actor	string	Level actor label or object name; the component is edited on that actor instance.
component	string	required. Component name (case-insensitive; a unique class name or name prefix also works).

Returns: instances, count.

component.copy_settings (risk 2, mutates, smoke)

Copies editable property values from one component to another, across templates and instances.

Argument	Type	Description
from	string	required. Source component: "blueprint:/Game/BP_X/Component" or "actor:Label/Component".
to	string	required. Destination component, same syntax.
properties	array of string	Only these properties (empty = every editable property the two classes share).
skip	array of string	Property names never copied.

Returns: component, class, template, owner, applied, warnings.

component.create_dynamic_material (risk 2, mutates, smoke)

Creates a dynamic material instance on a slot of a mesh component and optionally sets parameters (level actors only).

Argument	Type	Description
slot	integer	Material slot index (default 0). Default 0.
sourceMaterial	string	Source material (default: the material currently in the slot).
scalars	array of UeaKeyValue	Scalar parameters set on the new dynamic instance.
vectors	array of UeaKeyValue	Vector parameters "r,g,b,a" set on the new dynamic instance.

Returns: values.

component.create_test_rig (risk 2, mutates, requires world, smoke)

Creates a playground: a Character Blueprint with ~30 component types, a second Blueprint with movement components, and (optionally) two level actors with instance components. Returns the component list.

Argument	Type	Description
folder	string	Content folder for the Blueprints (default "/Game/UeaComponentRig").
name	string	Base name; the tool creates "" (Character) and "_Proj" (Actor). Default "BP_CompRig".
spawnActors	boolean	Also spawn the level actors CompRig_Actor and CompRig_BPActor (default true). Default true.

Returns: blueprint, projectileBlueprint, components, actors, warnings.

component.diff (risk 0, smoke)

Lists the editable properties that differ between two components (template vs instance included).

Argument	Type	Description
a	string	required. First component: "blueprint:/Game/BP_X/Component" or "actor:Label/Component".
b	string	required. Second component, same syntax.
limit	integer	Maximum number of differences returned (default 200). Default 200.

Returns: classA, classB, differences, count.

component.find_by_class (risk 0, smoke)

Finds every Blueprint and level actor that uses a component class.

Argument	Type	Description
class	string	required. Component class to look for.
inBlueprints	string	Search Blueprints under this content folder (empty = skip Blueprints).
inLevel	boolean	Also search the actors of the current level (default true). Default true.
limit	integer	Maximum number of hits (default 200). Default 200.

Returns: components, count.

component.fit_shape_to_mesh (risk 2, mutates, smoke)

Sizes a box/sphere/capsule component to the bounds of a mesh component of the same owner, with optional padding.

Argument	Type	Description
mesh	string	Name of the mesh component to fit to (default: the first mesh component of the same owner).
padding	string	Extra padding in centimetres added to every side (default 0).

Returns: component, class, template, owner, applied, warnings.

component.get (risk 0, smoke)

State of one component: class, owner, transform, visibility, collision and (optionally) every editable property.

Argument	Type	Description
includeProperties	boolean	Also return every editable property of the component (can be long). Default false.
nameContains	string	Case-insensitive substring filter applied when includeProperties is set.
limit	integer	Maximum number of properties returned (default 200). Default 200.

Returns: values.

component.get_ai_perception (risk 0, smoke)

Senses currently configured on an AI perception component with their radii and ages.

Argument	Type	Description
blueprint	string	Blueprint asset path or unique name; the component is edited on its construction-script template.
actor	string	Level actor label or object name; the component is edited on that actor instance.
component	string	required. Component name (case-insensitive; a unique class name or name prefix also works).

Returns: values.

component.get_audio (risk 0, smoke)

Sound asset, volume, pitch and attenuation settings of an audio component.

Argument	Type	Description
blueprint	string	Blueprint asset path or unique name; the component is edited on its construction-script template.
actor	string	Level actor label or object name; the component is edited on that actor instance.
component	string	required. Component name (case-insensitive; a unique class name or name prefix also works).

Returns: values.

component.get_camera (risk 0, smoke)

Current field of view, aspect ratio, projection and post-process blend weight of a camera component.

Argument	Type	Description
blueprint	string	Blueprint asset path or unique name; the component is edited on its construction-script template.
actor	string	Level actor label or object name; the component is edited on that actor instance.
component	string	required. Component name (case-insensitive; a unique class name or name prefix also works).

Returns: values.

component.get_capsule (risk 0, smoke)

Radius, half height, collision and draw settings of a capsule component.

Argument	Type	Description
blueprint	string	Blueprint asset path or unique name; the component is edited on its construction-script template.
actor	string	Level actor label or object name; the component is edited on that actor instance.
component	string	required. Component name (case-insensitive; a unique class name or name prefix also works).

Returns: values.

component.get_character_movement (risk 0, smoke)

Speeds, jump, air control, rotation and nav-agent settings of a character movement component.

Argument	Type	Description
blueprint	string	Blueprint asset path or unique name; the component is edited on its construction-script template.
actor	string	Level actor label or object name; the component is edited on that actor instance.
component	string	required. Component name (case-insensitive; a unique class name or name prefix also works).

Returns: values.

component.get_child_actor (risk 0, smoke)

Actor class and spawned instance of a child actor component.

Argument	Type	Description
blueprint	string	Blueprint asset path or unique name; the component is edited on its construction-script template.
actor	string	Level actor label or object name; the component is edited on that actor instance.
component	string	required. Component name (case-insensitive; a unique class name or name prefix also works).

Returns: values.

component.get_class_info (risk 0, smoke)

Class hierarchy, metadata and editable properties (with type, category, tooltip and CDO default) of a component class.

Argument	Type	Description
class	string	required. Component class name or path ("StaticMeshComponent", "/Script/Engine.PointLightComponent").
nameContains	string	Case-insensitive substring of the property name or category.
limit	integer	Maximum number of properties returned (default 200). Default 200.

Returns: info, hierarchy, properties, count, metadata.

component.get_collision (risk 0, smoke)

Current collision setup of a primitive component, including the response of every channel.

Argument	Type	Description
blueprint	string	Blueprint asset path or unique name; the component is edited on its construction-script template.
actor	string	Level actor label or object name; the component is edited on that actor instance.
component	string	required. Component name (case-insensitive; a unique class name or name prefix also works).

Returns: values.

component.get_instances (risk 0, smoke)

Lists the transforms and custom data of the instances of an instanced static mesh component.

Argument	Type	Description
limit	integer	Maximum number of instances returned (default 200). Default 200.

Returns: instances, count.

component.get_light (risk 0, smoke)

Intensity, colour, radius, cone angles and shadow settings of a light component.

Argument	Type	Description
blueprint	string	Blueprint asset path or unique name; the component is edited on its construction-script template.
actor	string	Level actor label or object name; the component is edited on that actor instance.
component	string	required. Component name (case-insensitive; a unique class name or name prefix also works).

Returns: values.

component.get_niagara_parameters (risk 0, requires plugin Niagara)

Lists the user parameters (name, type, value) exposed by the Niagara system of a Niagara component (not self-tested: needs a Niagara System asset).

Argument	Type	Description
blueprint	string	Blueprint asset path or unique name; the component is edited on its construction-script template.
actor	string	Level actor label or object name; the component is edited on that actor instance.
component	string	required. Component name (case-insensitive; a unique class name or name prefix also works).

Returns: values.

component.get_physics_constraint (risk 0, smoke)

Current motion types, limits, drives and breaking settings of a physics constraint component.

Argument	Type	Description
blueprint	string	Blueprint asset path or unique name; the component is edited on its construction-script template.
actor	string	Level actor label or object name; the component is edited on that actor instance.
component	string	required. Component name (case-insensitive; a unique class name or name prefix also works).

Returns: values.

component.get_projectile_movement (risk 0, smoke)

Speed, bounce, gravity and homing settings of a projectile movement component.

Argument	Type	Description
blueprint	string	Blueprint asset path or unique name; the component is edited on its construction-script template.
actor	string	Level actor label or object name; the component is edited on that actor instance.
component	string	required. Component name (case-insensitive; a unique class name or name prefix also works).

Returns: values.

component.get_property (risk 0, smoke)

Reads one property of a component as text.

Argument	Type	Description
property	string	required. Property path ("RelativeLocation", "BodyInstance.bSimulatePhysics", "OverrideMaterials[0]").
value	string	New value as text (component.set_property only).

Returns: values.

component.get_skeletal_mesh (risk 0, smoke)

Mesh asset, animation mode, anim class and physics asset of a skeletal mesh component.

Argument	Type	Description
blueprint	string	Blueprint asset path or unique name; the component is edited on its construction-script template.
actor	string	Level actor label or object name; the component is edited on that actor instance.
component	string	required. Component name (case-insensitive; a unique class name or name prefix also works).

Returns: values.

component.get_spline (risk 0, smoke)

Points, tangents, types, closed-loop flag and total length of a spline component.

Argument	Type	Description
blueprint	string	Blueprint asset path or unique name; the component is edited on its construction-script template.
actor	string	Level actor label or object name; the component is edited on that actor instance.
component	string	required. Component name (case-insensitive; a unique class name or name prefix also works).

Returns: points, count, closedLoop, length.

component.get_spring_arm (risk 0, smoke)

Current arm length, offsets, lag and collision settings of a spring arm component.

Argument	Type	Description
blueprint	string	Blueprint asset path or unique name; the component is edited on its construction-script template.
actor	string	Level actor label or object name; the component is edited on that actor instance.
component	string	required. Component name (case-insensitive; a unique class name or name prefix also works).

Returns: values.

component.get_static_mesh (risk 0, smoke)

Mesh asset, LOD overrides, lightmap resolution and material slots of a static mesh component.

Argument	Type	Description
blueprint	string	Blueprint asset path or unique name; the component is edited on its construction-script template.
actor	string	Level actor label or object name; the component is edited on that actor instance.
component	string	required. Component name (case-insensitive; a unique class name or name prefix also works).

Returns: values.

component.get_widget (risk 0, smoke)

Widget class, draw size, space and pivot currently set on a widget component.

Argument	Type	Description
blueprint	string	Blueprint asset path or unique name; the component is edited on its construction-script template.
actor	string	Level actor label or object name; the component is edited on that actor instance.
component	string	required. Component name (case-insensitive; a unique class name or name prefix also works).

Returns: values.

component.list_classes (risk 0, smoke)

Lists component classes of the Add Component palette with their group, parent module and scene/primitive flags.

Argument	Type	Description
category	string	Class-group / category filter as shown in the Add Component menu ("Rendering", "Physics", ...).
nameContains	string	Case-insensitive substring of the class name.
spawnableOnly	boolean	Only classes that carry the BlueprintSpawnableComponent metadata (default true). Default true.
includeAbstract	boolean	Include abstract classes (default false). Default false.
limit	integer	Maximum number of classes returned (default 200). Default 200.

Returns: classes, count.

component.list_collision_channels (risk 0, smoke)

Lists the collision channels of the project (object and trace channels) with their default response.

Argument	Type	Description
filter	string	Case-insensitive substring filter (optional).

Returns: channels, count.

component.list_collision_profiles (risk 0, smoke)

Lists the collision profiles of the project with their collision-enabled state and object type.

Argument	Type	Description
filter	string	Case-insensitive substring filter (optional).

Returns: profiles, count.

component.list_material_slots (risk 0, smoke)

Material slots of a mesh component with the material currently assigned and whether it is an override.

Argument	Type	Description
blueprint	string	Blueprint asset path or unique name; the component is edited on its construction-script template.
actor	string	Level actor label or object name; the component is edited on that actor instance.
component	string	required. Component name (case-insensitive; a unique class name or name prefix also works).

Returns: slots, count.

component.list_on_actor (risk 0, smoke)

Lists the components of a level actor.

Argument	Type	Description
blueprint	string	Blueprint asset path or unique name (component.list_on_blueprint).
actor	string	Level actor label or name (component.list_on_actor).
classFilter	string	Only components of this class (or a subclass).

Returns: components, count.

component.list_on_blueprint (risk 0, smoke)

Lists the components of a Blueprint (construction-script templates plus inherited native components).

Argument	Type	Description
blueprint	string	Blueprint asset path or unique name (component.list_on_blueprint).
actor	string	Level actor label or name (component.list_on_actor).
classFilter	string	Only components of this class (or a subclass).

Returns: components, count.

component.list_presets (risk 0, smoke)

Lists the component presets with their description, target class and the exact property values they write.

Argument	Type	Description
filter	string	Case-insensitive substring filter (optional).

Returns: presets, count.

component.remove_instances (risk 3, mutates, destructive, smoke)

Removes instances by index from an instanced static mesh component.

Argument	Type	Description
indices	array of integer	required. Instance indices to remove (removed from the highest index down).

Returns: instances, count.

component.reset_instance_to_template (risk 2, mutates, smoke)

Restores an actor's component instance to the values of its Blueprint template.

Argument	Type	Description
actor	string	required. Level actor spawned from a Blueprint.
component	string	required. Component name on that actor.

Returns: component, class, template, owner, applied, warnings.

component.reset_property (risk 2, mutates, smoke)

Resets one property of a component to the value of its class default object.

Argument	Type	Description
property	string	required. Property path ("RelativeLocation", "BodyInstance.bSimulatePhysics", "OverrideMaterials[0]").
value	string	New value as text (component.set_property only).

Returns: values.

component.search_properties (risk 0, smoke)

Editable properties of a component class whose name or category matches a substring.

Argument	Type	Description
class	string	required. Component class name or path ("StaticMeshComponent", "/Script/Engine.PointLightComponent").
nameContains	string	Case-insensitive substring of the property name or category.
limit	integer	Maximum number of properties returned (default 200). Default 200.

Returns: info, hierarchy, properties, count, metadata.

component.set_activation_many (risk 2, mutates, smoke)

Sets auto-activate and active state on many components at once.

Argument	Type	Description
autoActivate	string	Auto activate on begin play.
active	string	Active state applied immediately.

Returns: components, count, warnings.

component.set_ai_perception (risk 2, mutates, smoke)

Configures the senses (sight, hearing, damage, touch) and the dominant sense of an AI perception component.

Argument	Type	Description
senses	array of UeaCompSenseConfig	Senses to configure (existing senses of the same class are updated).
dominantSense	string	Sense class used to pick the dominant stimulus location: sight, hearing, damage, touch.

Returns: component, class, template, owner, applied, warnings.

component.set_arrow (risk 2, mutates, smoke)

Colour, size, length and visibility of an editor arrow component.

Argument	Type	Description
color	string	Arrow colour "r,g,b[,a]" in 0..1.
size	string	Arrow thickness scale.
length	string	Arrow length in centimetres.
hiddenInGame	string

Returns: component, class, template, owner, applied, warnings.

component.set_audio (risk 2, mutates, smoke)

Sound, volume, pitch, attenuation (asset or inline overrides), concurrency and start time of an audio component.

Argument	Type	Description
sound	string	Sound asset (SoundCue, SoundWave, MetaSound).
volume	string	Volume multiplier.
pitch	string	Pitch multiplier.
autoActivate	string
attenuation	string	Sound attenuation asset.
overrideAttenuation	string	Use the inline attenuation overrides instead of an asset.
innerRadius	string	Inline attenuation: inner radius in centimetres.
falloffDistance	string	Inline attenuation: falloff distance in centimetres.
attenuationShape	string	Inline attenuation shape: sphere, capsule, box, cone.
spatialize	string	Spatialise the sound.
concurrency	string	Sound concurrency asset.
soundClassOverride	string	Sound class override asset.
startTime	string	Start time in seconds.
uiSound	string	Treat the sound as UI audio (ignores world settings).

Returns: component, class, template, owner, applied, warnings.

component.set_billboard (risk 2, mutates, smoke)

Sprite, screen size and visibility of a billboard component.

Argument	Type	Description
sprite	string	Sprite texture asset.
screenSize	string	Screen size of the sprite when screen-size scaling is on.
screenSizeScaled	string	Scale the sprite with the screen size.
hiddenInGame	string

Returns: component, class, template, owner, applied, warnings.

component.set_box (risk 2, mutates, smoke)

Sets the half extent of a box component ("x,y,z" in centimetres).

Argument	Type	Description
extent	string	Half extent "x,y,z" in centimetres.
shapeColor	string	Editor wireframe colour "r,g,b[,a]" in 0..1.
drawOnlyIfSelected	string

Returns: component, class, template, owner, applied, warnings.

component.set_camera (risk 2, mutates, smoke)

Field of view, aspect ratio, projection, pawn control rotation and post-process overrides of a camera component.

Argument	Type	Description
fov	string	Horizontal field of view in degrees.
aspectRatio	string	Aspect ratio (width / height).
constrainAspectRatio	string
projectionMode	string	perspective or orthographic.
orthoWidth	string	Orthographic width in centimetres.
usePawnControlRotation	string
lockToHmd	string	Lock the camera to the head mounted display.
postProcessBlendWeight	string	Post process blend weight 0..1.
postProcess	array of UeaKeyValue	Post process settings: field name -> value; the matching bOverride_ flag is set automatically.

Returns: component, class, template, owner, applied, warnings.

component.set_capsule (risk 2, mutates, smoke)

Sets the radius and half height of a capsule component (centimetres) plus its editor draw options.

Argument	Type	Description
radius	string	Capsule radius in centimetres.
halfHeight	string	Half height in centimetres (total height = 2 x halfHeight).
shapeColor	string	Editor wireframe colour "r,g,b[,a]" in 0..1.
drawOnlyIfSelected	string	Only draw the shape in the viewport when the actor is selected.

Returns: component, class, template, owner, applied, warnings.

component.set_capsule_from_mesh (risk 2, mutates, smoke)

Sizes a capsule component from the bounds of a mesh component of the same owner and places its centre at the mesh centre.

Argument	Type	Description
mesh	string	Name of the mesh component to fit to (default: the first mesh component of the same owner).
padding	string	Extra padding in centimetres added to every side (default 0).

Returns: component, class, template, owner, applied, warnings.

component.set_character_movement (risk 2, mutates, smoke)

Configures a character movement component: walk/fly/swim speeds, jump, air control, friction, rotation, step height, movement mode.

Argument	Type	Description
maxWalkSpeed	string	Maximum ground speed in cm/s.
maxWalkSpeedCrouched	string	Maximum ground speed while crouched in cm/s.
jumpZVelocity	string	Initial upward speed of a jump in cm/s.
airControl	string	Air control factor 0..1.
gravityScale	string	Gravity multiplier.
maxAcceleration	string	Maximum acceleration in cm/s^2.
brakingDecelerationWalking	string	Braking deceleration while walking in cm/s^2.
groundFriction	string	Ground friction.
orientRotationToMovement	string	Rotate the character towards its movement direction.
rotationRate	string	Rotation rate "pitch,yaw,roll" in degrees per second.
useControllerDesiredRotation	string	Rotate towards the controller's desired rotation.
canCrouch	string	Whether the character may crouch (NavAgentProps).
canJump	string	Whether the character may jump (NavAgentProps).
maxStepHeight	string	Maximum step height in centimetres.
walkableFloorAngle	string	Maximum walkable floor angle in degrees.
movementMode	string	Movement mode: none, walking, navwalking, falling, swimming, flying, custom.
defaultLandMovementMode	string	Movement mode used when landing: walking, navwalking, falling, ...
maxFlySpeed	string	Maximum flying speed in cm/s.
maxSwimSpeed	string	Maximum swimming speed in cm/s.
brakingFrictionFactor	string	Braking friction factor.
fallingLateralFriction	string	Lateral friction while falling.
mass	string	Mass in kilograms.
crouchedHalfHeight	string	Capsule half height while crouched.
canWalkOffLedges	string	Whether the character may walk off ledges.
navAgentRadius	string	Navigation agent radius.
navAgentHeight	string	Navigation agent height.

Returns: component, class, template, owner, applied, warnings.

component.set_child_actor (risk 2, mutates, smoke)

Actor class spawned by a child actor component.

Argument	Type	Description
childActorClass	string	Actor class (or Blueprint) spawned by the child actor component.
editorOnly	string	Only spawn the child actor in the editor.

Returns: component, class, template, owner, applied, warnings.

component.set_cine_camera (risk 2, mutates)

Focal length, aperture, focus method and filmback/lens presets of a cine camera component (not self-tested: CinematicCamera is a plugin on 4.27 and may be disabled).

Argument	Type	Description
focalLength	string	Focal length in millimetres.
aperture	string	Aperture (f-stop).
focusMethod	string	Focus method: none, manual, tracking, disable.
focusDistance	string	Manual focus distance in centimetres.
sensorWidth	string	Sensor width in millimetres.
sensorHeight	string	Sensor height in millimetres.
lensPreset	string	Lens preset name (e.g. "35mm Prime f/1.8").
filmbackPreset	string	Filmback preset name (e.g. "16:9 DSLR").

Returns: component, class, template, owner, applied, warnings.

component.set_collision (risk 2, mutates, smoke)

Collision of a primitive component: enabled state, profile, object type, per-channel responses and the overlap/navigation flags.

Argument	Type	Description
enabled	string	Collision enabled: none, query, physics, queryandphysics.
profile	string	Collision profile name (BlockAll, OverlapAllDynamic, NoCollision, Pawn, Trigger, ...).
objectType	string	Object type channel (WorldStatic, WorldDynamic, Pawn, PhysicsBody, ...).
responses	array of UeaKeyValue	Per-channel responses: channel name -> ignore
generateOverlapEvents	string	Generate begin/end overlap events.
notifyRigidBodyCollision	string	Call Hit events for physics collisions.
canEverAffectNavigation	string	Whether the component affects navmesh generation.
useAsOccluder	string	Use the component as an occluder for occlusion culling.

Returns: component, class, template, owner, applied, warnings.

component.set_common (risk 2, mutates, smoke)

UActorComponent basics: active, auto-activate, tick, replication, tags, editor-only, editable-when-inherited.

Argument	Type	Description
active	string	Component active flag ("true"/"false"; empty = unchanged).
autoActivate	string	Auto activate on begin play.
tickEnabled	string	Whether the component ticks.
tickInterval	string	Tick interval in seconds (0 = every frame).
tickGroup	string	Tick group: prephysics, duringphysics, postphysics, postupdatework.
replicated	string	Replicate the component to clients.
editableWhenInherited	string	Whether child Blueprints may edit this component (templates).
tags	array of string	Component tags (replaces the whole list when given).
editorOnly	string	Editor-only component (stripped from cooked builds).

Returns: component, class, template, owner, applied, warnings.

component.set_cull_distances (risk 2, mutates, smoke)

Sets the instance start/end cull distances of an instanced (or hierarchical) static mesh component.

Argument	Type	Description
min	string	Distance at which instances start to fade.
max	string	Distance at which instances are culled.

Returns: component, class, template, owner, applied, warnings.

component.set_decal (risk 2, mutates, smoke)

Material, size, sort order and fading of a decal component.

Argument	Type	Description
material	string	Decal material asset.
size	string	Decal size "x,y,z" (x is the projection depth).
sortOrder	string	Sort order between overlapping decals.
fadeScreenSize	string	Screen size at which the decal fades out.
fadeIn	string	Fade-in duration in seconds.
fadeOut	string	Fade-out duration in seconds.

Returns: component, class, template, owner, applied, warnings.

component.set_floating_pawn_movement (risk 2, mutates, smoke)

Max speed, acceleration, deceleration and turning boost of a floating pawn movement component.

Argument	Type	Description
maxSpeed	string	Maximum speed in cm/s.
acceleration	string	Acceleration in cm/s^2.
deceleration	string	Deceleration in cm/s^2.
turningBoost	string	Turning boost factor.

Returns: component, class, template, owner, applied, warnings.

component.set_fog (risk 2, mutates, smoke)

Density, falloff, colour, start distance and volumetric settings of an exponential height fog component.

Argument	Type	Description
density	string	Global fog density.
heightFalloff	string	Height falloff.
color	string	Inscattering colour "r,g,b".
startDistance	string	Distance at which the fog starts, in centimetres.
volumetric	string	Enable volumetric fog.
extinction	string	Volumetric fog extinction scale.
scatteringDistribution	string	Volumetric fog scattering distribution.
maxOpacity	string	Fog max opacity 0..1.

Returns: component, class, template, owner, applied, warnings.

component.set_force_feedback (risk 2, mutates, smoke)

Effect asset, intensity, looping and activation of a force feedback component.

Argument	Type	Description
effect	string	Force feedback effect asset.
intensity	string	Intensity multiplier.
autoActivate	string
looping	string

Returns: component, class, template, owner, applied, warnings.

component.set_hierarchical_instanced_mesh (risk 2, mutates, smoke)

Cull distances, density scaling and LOD settings specific to a hierarchical instanced static mesh component.

Argument	Type	Description
cullDistanceMin	string	Distance at which instances start to fade.
cullDistanceMax	string	Distance at which instances are culled.
enableDensityScaling	string	Enable per-instance density scaling.
minLod	string	Minimum screen size an instance LOD cluster must cover.

Returns: component, class, template, owner, applied, warnings.

component.set_instance_custom_data (risk 2, mutates, smoke)

Sets the per-instance custom data floats of one instance.

Argument	Type	Description
index	integer	required. Instance index.
values	array of number	required. Custom data floats, one per channel starting at channel 0.

Returns: instances, count.

component.set_instance_transform (risk 2, mutates, smoke)

Moves, rotates or scales one instance of an instanced static mesh component.

Argument	Type	Description
index	integer	required. Instance index.
location	string	New location "x,y,z".
rotation	string	New rotation "pitch,yaw,roll".
scale	string	New scale "x,y,z".
worldSpace	boolean	Interpret the transform in world space. Default false.

Returns: instances, count.

component.set_instanced_mesh (risk 2, mutates, smoke)

Mesh, cull distances and custom data channel count of an instanced (or hierarchical) static mesh component.

Argument	Type	Description
mesh	string	Static mesh asset used by every instance.
cullDistanceMin	string	Distance at which instances start to fade out.
cullDistanceMax	string	Distance at which instances are fully culled.
numCustomDataFloats	string	Number of per-instance custom data floats.

Returns: component, class, template, owner, applied, warnings.

component.set_interp_movement (risk 2, mutates, smoke)

Duration, behaviour and control points of an interp-to-movement component (moving platforms, lifts).

Argument	Type	Description
duration	string	Time in seconds to travel the whole path.
behaviourType	string	Behaviour: oneshot, oneshot_reverse, loop, loop_reset, pingpong.
controlPoints	array of string	Control points as "x,y,z" (relative to the start) or "x,y,z,world" for absolute ones; replaces the whole list.

Returns: component, class, template, owner, applied, warnings.

component.set_light (risk 2, mutates, smoke)

Intensity, colour, temperature, attenuation, cone angles, shadows and IES profile of any light component.

Argument	Type	Description
intensity	string	Brightness (unit depends on intensityUnits).
intensityUnits	string	Intensity units: unitless, candelas, lumens, ev (point/spot/rect only).
color	string	Light colour "r,g,b" in 0..1.
temperature	string	Colour temperature in Kelvin.
useTemperature	string	Use the colour temperature.
attenuationRadius	string	Attenuation radius in centimetres (point/spot).
sourceRadius	string	Source radius in centimetres.
sourceLength	string	Source length in centimetres.
softSourceRadius	string	Soft source radius in centimetres.
innerCone	string	Inner cone angle in degrees (spot).
outerCone	string	Outer cone angle in degrees (spot).
sourceWidth	string	Source width in centimetres (rect).
sourceHeight	string	Source height in centimetres (rect).
barnDoorAngle	string	Barn door angle in degrees (rect).
castShadows	string
castVolumetricShadow	string
volumetricScattering	string	Volumetric scattering intensity.
indirectIntensity	string	Indirect lighting intensity.
specularScale	string	Specular scale.
lightFunction	string	Light function material asset.
iesTexture	string	IES profile texture asset.
useIesBrightness	string
iesBrightnessScale	string
affectsWorld	string	Whether the light affects the world at all.
lightingChannels	string	Lighting channels "1,0,0".
mobility	string	Mobility: static, stationary or movable.

Returns: component, class, template, owner, applied, warnings.

component.set_lightmap_resolution (risk 2, mutates, smoke)

Overrides the lightmap resolution of a static mesh component.

Argument	Type	Description
override	string	Override the lightmap resolution of the mesh asset.
resolution	string	Lightmap resolution in texels.

Returns: component, class, template, owner, applied, warnings.

component.set_material_parameters (risk 2, mutates, smoke)

Sets scalar and vector parameters on the materials of a mesh component (creates dynamic instances; level actors only).

Argument	Type	Description
scalars	array of UeaKeyValue	Scalar parameters: name -> number.
vectors	array of UeaKeyValue	Vector parameters: name -> "r,g,b,a" (0-1).

Returns: component, class, template, owner, applied, warnings.

component.set_material_slot (risk 2, mutates, smoke)

Assigns a material to one slot of a mesh component (empty material clears the override).

Argument	Type	Description
slot	string	required. Slot index or slot name.
material	string	Material asset path (empty clears the override).

Returns: slots, count.

component.set_materials (risk 2, mutates, smoke)

Assigns materials to a mesh component by slot order, "slotName=path" or "index=path".

Argument	Type	Description
materials	array of string	required. Material asset paths in slot order; an entry may also be "slotName=/Game/M_X" or "2=/Game/M_X". An empty entry leaves the slot alone.

Returns: slots, count.

component.set_mobility (risk 2, mutates, smoke)

Mobility of a scene component: static, stationary or movable.

Argument	Type	Description
mobility	string	required. static, stationary or movable.

Returns: component, class, template, owner, applied, warnings.

component.set_motion_controller (risk 2, mutates)

Motion source and device model of a motion controller component (not self-tested: the component only exists when the HeadMountedDisplay module is available).

Argument	Type	Description
motionSource	string	Motion source: Left, Right, HMD, LeftAim, RightAim, ...
displayDeviceModel	string	Show the device model mesh.
hand	string	Tracking source hand (legacy field on older engines): left or right.

Returns: component, class, template, owner, applied, warnings.

component.set_nav_invoker (risk 2, mutates, smoke)

Tile generation and removal radii of a navigation invoker component.

Argument	Type	Description
tileGenerationRadius	string	Radius around the owner where navmesh tiles are generated.
tileRemovalRadius	string	Radius beyond which navmesh tiles may be discarded.

Returns: component, class, template, owner, applied, warnings.

component.set_nav_link (risk 2, mutates, smoke)

Start, end, direction and area class of a custom nav link component.

Argument	Type	Description
start	string	Link start "x,y,z" relative to the component.
end	string	Link end "x,y,z" relative to the component.
direction	string	Direction: both, left_to_right or right_to_left.
areaClass	string	Navigation area class used while the link is enabled.

Returns: component, class, template, owner, applied, warnings.

component.set_nav_modifier (risk 2, mutates, smoke)

Navigation area class and failsafe extent of a nav modifier component.

Argument	Type	Description
areaClass	string	Navigation area class (NavArea_Null, NavArea_Obstacle, NavArea_Default or a custom class).
failsafeExtent	string	Failsafe extent "x,y,z" used when the owner has no bounds.
includeAgentHeight	string	Include the agent's height in the modifier bounds.

Returns: component, class, template, owner, applied, warnings.

component.set_nav_movement (risk 2, mutates, smoke)

Navigation agent properties of any movement component: can crouch/jump/walk/swim/fly, radius, height, step height.

Argument	Type	Description
canCrouch	string
canJump	string
canWalk	string
canSwim	string
canFly	string
radius	string	Navigation agent radius in centimetres.
height	string	Navigation agent height in centimetres.
stepHeight	string	Navigation step height in centimetres.

Returns: component, class, template, owner, applied, warnings.

component.set_niagara (risk 2, mutates, requires plugin Niagara)

Niagara system asset, activation and user parameters of a Niagara component (set by reflection, no plugin dependency; not self-tested because it needs a Niagara System asset).

Argument	Type	Description
asset	string	Niagara system asset.
autoActivate	string
parameters	array of UeaKeyValue	User parameters: "name" -> value; use "type:name" (float/vec3/color/bool/int) to force the type.

Returns: component, class, template, owner, applied, warnings.

component.set_noise_emitter (risk 2, mutates, smoke)

Noise lifetime of a pawn noise emitter component.

Argument	Type	Description
noiseLifetime	string	How long a noise stays relevant, in seconds.

Returns: component, class, template, owner, applied, warnings.

component.set_particle_system (risk 2, mutates, smoke)

Cascade particle system template and activation settings of a particle system component.

Argument	Type	Description
template	string	Cascade particle system asset.
autoActivate	string
secondsBeforeInactive	string	Seconds the system may stay inactive before being deactivated.

Returns: component, class, template, owner, applied, warnings.

component.set_pawn_movement_common (risk 2, mutates, smoke)

Common pawn movement settings: which scene component is moved and the maximum speed.

Argument	Type	Description
updatedComponent	string	Name of the scene component the movement drives (usually the root).
maxSpeed	string	Maximum speed in cm/s (movement components that expose it).

Returns: component, class, template, owner, applied, warnings.

component.set_pawn_sensing (risk 2, mutates, smoke)

Sight radius, hearing thresholds, interval and vision angle of a pawn sensing component.

Argument	Type	Description
sightRadius	string	Sight radius in centimetres.
hearingThreshold	string	Hearing threshold in centimetres.
losHearingThreshold	string	Line-of-sight hearing threshold in centimetres.
sensingInterval	string	Seconds between sensing updates.
peripheralVisionAngle	string	Peripheral vision half angle in degrees.
seePawns	string
hearNoises	string

Returns: component, class, template, owner, applied, warnings.

component.set_perception_stimuli_source (risk 2, mutates, smoke)

Senses an AI perception stimuli source component registers for, and auto-registration.

Argument	Type	Description
registerAs	array of string	Senses this actor can be perceived by: sight, hearing, damage, touch.
autoRegister	string	Register automatically on begin play.

Returns: component, class, template, owner, applied, warnings.

component.set_physical_animation (risk 2, mutates, smoke)

Strength multiplier and driven skeletal mesh of a physical animation component.

Argument	Type	Description
strengthMultiplier	string	Global strength multiplier of the physical animation.
skeletalMesh	string	Name of the skeletal mesh component driven by this component.

Returns: component, class, template, owner, applied, warnings.

component.set_physics (risk 2, mutates, smoke)

Rigid-body physics of a primitive component: simulate, mass, gravity, damping, physical material, axis locks.

Argument	Type	Description
simulate	string	Simulate rigid-body physics.
mass	string	Mass override in kilograms (also sets the mass override flag).
gravity	string	Whether gravity applies.
linearDamping	string	Linear damping.
angularDamping	string	Angular damping.
physMaterial	string	Physical material asset path.
lockPosition	string	Lock linear axes, "x,y,z" with 1/0 per axis (e.g. "0,0,1").
lockRotation	string	Lock angular axes, "x,y,z" with 1/0 per axis.
maxAngularVelocity	string	Maximum angular velocity in degrees per second.

Returns: component, class, template, owner, applied, warnings.

component.set_physics_constraint (risk 2, mutates, smoke)

Configures a physics constraint component: constrained components, linear/angular motion and limits, breaking, projection and drives.

Argument	Type	Description
component1	string	First constrained component (name on the same actor/Blueprint; empty = unchanged).
component2	string	Second constrained component (empty = world).
linearX	string	Linear X motion: free, limited or locked.
linearY	string
linearZ	string
linearLimit	string	Linear limit size in centimetres (used by the "limited" axes).
angularSwing1	string	Angular swing 1 motion: free, limited or locked.
angularSwing2	string
angularTwist	string
swing1Limit	string	Swing 1 limit angle in degrees.
swing2Limit	string
twistLimit	string
disableCollision	string	Disable collision between the two constrained bodies.
linearBreakable	string	Whether the constraint breaks under linear force.
linearBreakThreshold	string
angularBreakable	string
angularBreakThreshold	string
projection	string	Enable projection (teleports the child body to fix large joint errors).
linearDrivePosition	string	Enable the linear position drive on all three axes.
linearDriveVelocity	string	Enable the linear velocity drive on all three axes.
linearDriveStrength	string	Linear drive position strength (spring).
linearDriveDamping	string	Linear drive velocity strength (damping).
angularDriveMode	string	Angular drive mode: slerp or twistswing.
angularDriveOrientation	string	Enable the angular orientation drive.
angularDriveStrength	string	Angular drive spring.
angularDriveDamping	string	Angular drive damping.

Returns: component, class, template, owner, applied, warnings.

component.set_physics_handle (risk 2, mutates, smoke)

Damping, stiffness, interpolation speed and soft-constraint flags of a physics handle component.

Argument	Type	Description
linearDamping	string
linearStiffness	string
angularDamping	string
angularStiffness	string
interpolationSpeed	string	Interpolation speed of the grabbed target.
softConstraints	string	Use soft linear and angular constraints instead of hard ones.

Returns: component, class, template, owner, applied, warnings.

component.set_physics_thruster (risk 2, mutates, smoke)

Thrust strength and auto-activation of a physics thruster component.

Argument	Type	Description
thrustStrength	string	Thrust strength along the component's -X axis.
autoActivate	string	Activate the thruster on begin play.

Returns: component, class, template, owner, applied, warnings.

component.set_planar_reflection (risk 2, mutates, smoke)

Distortion, roughness, screen percentage and fade settings of a planar reflection component.

Argument	Type	Description
normalDistortionStrength	string	Normal distortion strength.
prefilterRoughness	string	Prefilter roughness.
screenPercentage	string	Screen percentage of the reflection render.
distanceFromPlaneFadeEnd	string	Distance from the plane at which the reflection fades out.
renderSceneTwoSided	string	Render scene two-sided.

Returns: component, class, template, owner, applied, warnings.

component.set_poseable_bone (risk 2, mutates)

Moves one bone of a poseable mesh component (not self-tested: requires a skeletal mesh asset with a known bone).

Argument	Type	Description
bone	string	required. Bone name.
location	string	Location "x,y,z".
rotation	string	Rotation "pitch,yaw,roll".
scale	string	Scale "x,y,z".
space	string	Bone space: world, component or local (default component).

Returns: component, class, template, owner, applied, warnings.

component.set_post_process (risk 2, mutates, smoke)

Unbound flag, priority, blend settings and post process overrides of a post process component.

Argument	Type	Description
unbound	string	Affect the whole level regardless of the component's shape.
priority	string	Priority against other post process volumes.
blendRadius	string	Blend radius in centimetres.
blendWeight	string	Blend weight 0..1.
settings	array of UeaKeyValue	Post process settings: field name -> value; the matching bOverride_ flag is set automatically.

Returns: component, class, template, owner, applied, warnings.

component.set_projectile_movement (risk 2, mutates, smoke)

Configures a projectile movement component: initial/max speed, bouncing, friction, gravity, homing.

Argument	Type	Description
initialSpeed	string	Initial speed in cm/s.
maxSpeed	string	Maximum speed in cm/s (0 = unlimited).
rotationFollowsVelocity	string	Rotate the owner to face the velocity.
shouldBounce	string	Bounce off surfaces instead of stopping.
bounciness	string	Bounce restitution 0..1.
friction	string	Surface friction 0..1.
gravityScale	string	Gravity multiplier (0 = straight line).
velocity	string	Initial velocity "x,y,z" in cm/s.
homingEnabled	string	Enable homing (needs a homing target actor at runtime).
homingAcceleration	string	Homing acceleration magnitude.
initialVelocityInLocalSpace	string	Interpret the initial velocity in local space.

Returns: component, class, template, owner, applied, warnings.

component.set_properties (risk 2, mutates, smoke)

Writes several properties on a component ("Struct.Field" and "Array[0]" paths supported); returns what was applied and what failed.

Argument	Type	Description
values	array of UeaKeyValue	required. Property assignments: name (or "Struct.Field", "Array[0]") -> value text.

Returns: component, class, template, owner, applied, warnings.

component.set_property (risk 2, mutates, smoke)

Writes one property of a component from loose text (numbers, true/false, "x,y,z", enum names, asset paths).

Argument	Type	Description
property	string	required. Property path ("RelativeLocation", "BodyInstance.bSimulatePhysics", "OverrideMaterials[0]").
value	string	New value as text (component.set_property only).

Returns: component, class, template, owner, applied, warnings.

component.set_radial_force (risk 2, mutates, smoke)

Radius, impulse/force strength, falloff and affected object types of a radial force component.

Argument	Type	Description
radius	string	Force/impulse radius in centimetres.
impulseStrength	string	One-shot impulse strength (used by FireImpulse).
forceStrength	string	Continuous force strength applied while active.
impulseVelChange	string	Treat the impulse as a velocity change (ignores mass).
falloff	string	Falloff: constant or linear.
objectTypes	array of string	Object type channels affected (WorldDynamic, PhysicsBody, ...); replaces the list.
autoActivate	string	Activate the force on begin play.
destructibleDamage	string	Damage applied to destructible actors (legacy APEX field; present but inert on UE5).

Returns: component, class, template, owner, applied, warnings.

component.set_reflection_capture (risk 2, mutates, smoke)

Brightness, influence radius and cubemap of a reflection capture component.

Argument	Type	Description
brightness	string	Brightness multiplier of the captured cubemap.
influenceRadius	string	Influence radius in centimetres (sphere captures).
boxTransitionDistance	string	Box transition distance (box captures).
cubemap	string	Source cubemap asset (when the capture uses a specified cubemap).

Returns: component, class, template, owner, applied, warnings.

component.set_rendering (risk 2, mutates, smoke)

Rendering flags of a primitive component: shadows, custom depth, cull distance, lighting channels, bounds scale.

Argument	Type	Description
castShadow	string	Cast any shadow.
castDynamicShadow	string
castStaticShadow	string
castInsetShadow	string
castHiddenShadow	string	Cast a shadow even when the component itself is hidden.
receivesDecals	string
renderCustomDepth	string	Render into the custom depth buffer (outlines).
customDepthStencil	string	Custom depth stencil value (0-255).
cullDistance	string	Desired max draw distance in centimetres (0 = unlimited).
translucencySortPriority	string	Translucency sort priority.
lightingChannels	string	Lighting channels "0,1,0" (channel 0, 1, 2 as 1/0).
visibleInReflectionCaptures	string
visibleInRayTracing	string	Visible to ray tracing / Lumen hardware tracing.
boundsScale	string	Bounds scale multiplier.
renderInMainPass	string
renderInDepthPass	string

Returns: component, class, template, owner, applied, warnings.

component.set_replication_many (risk 2, mutates, smoke)

Sets the replication flag on many components at once.

Argument	Type	Description
replicated	string	required. Replicate the components to clients.

Returns: components, count, warnings.

component.set_rotating_movement (risk 2, mutates, smoke)

Rotation rate, pivot offset and local-space flag of a rotating movement component.

Argument	Type	Description
rotationRate	string	Rotation rate "pitch,yaw,roll" in degrees per second.
pivotTranslation	string	Pivot offset "x,y,z" in centimetres.
rotationInLocalSpace	string	Rotate in the component's local space.

Returns: component, class, template, owner, applied, warnings.

component.set_scene_capture (risk 2, mutates, smoke)

Render target, capture source, field of view, capture triggers, actor filters and show flags of a scene capture 2D component.

Argument	Type	Description
textureTarget	string	Render target texture asset written by the capture.
captureSource	string	Capture source: scene_color_hdr, final_color_ldr, scene_depth, device_depth, normal, base_color, ...
fov	string	Field of view in degrees.
captureEveryFrame	string	Capture every frame (expensive).
captureOnMovement	string	Capture when the component moves.
primitiveRenderMode	string	Primitive render mode: legacy_scene_capture, render_scene_primitives, use_show_only_list.
hiddenActors	array of string	Actor labels hidden from the capture (replaces the list).
showOnlyActors	array of string	Actor labels the capture is restricted to (replaces the list).
showFlags	array of UeaKeyValue	Show flag overrides: flag name -> true/false.
postProcess	array of UeaKeyValue	Post process settings: field name -> value.
maxViewDistance	string	Maximum view distance override in centimetres.

Returns: component, class, template, owner, applied, warnings.

component.set_scene_capture_cube (risk 2, mutates, smoke)

Cube render target and capture triggers of a scene capture cube component.

Argument	Type	Description
textureTarget	string	Cube render target asset.
captureEveryFrame	string
captureOnMovement	string
captureSource	string	Capture source: scene_color_hdr, final_color_ldr, ...

Returns: component, class, template, owner, applied, warnings.

component.set_shape_from_preset (risk 2, mutates, smoke)

Applies a named size preset to a shape component (small/medium/large/crouched character, pickup, door_trigger, room_trigger).

Argument	Type	Description
preset	string	required. small_character, medium_character, large_character, crouched_character, pickup, door_trigger or room_trigger.

Returns: component, class, template, owner, applied, warnings.

component.set_skeletal_mesh (risk 2, mutates, smoke)

Assigns a skeletal mesh, animation mode, anim class/asset, physics asset and leader pose component.

Argument	Type	Description
mesh	string	Skeletal mesh asset path or unique name.
animationMode	string	Animation mode: blueprint (AnimationBlueprint), asset (AnimationSingleNode) or custom.
animClass	string	Animation Blueprint / AnimInstance class.
animAsset	string	Animation asset played in single-node mode.
loop	string	Loop the single-node animation.
playing	string	Play the single-node animation.
physicsAsset	string	Physics asset override.
leaderPose	string	Name of the skeletal mesh component to copy the pose from (SetLeaderPoseComponent on 5.1+, SetMasterPoseComponent below).
clothing	string	Enable clothing simulation.

Returns: component, class, template, owner, applied, warnings.

component.set_sky_atmosphere (risk 2, mutates, smoke)

Planet radius, atmosphere height, ground albedo and scattering of a sky atmosphere component.

Argument	Type	Description
bottomRadius	string	Ground radius in kilometres.
atmosphereHeight	string	Atmosphere height in kilometres.
groundAlbedo	string	Ground albedo "r,g,b".
rayleighScattering	string	Rayleigh scattering scale.
mieScattering	string	Mie scattering scale.
multiScattering	string	Multi-scattering factor.

Returns: component, class, template, owner, applied, warnings.

component.set_sky_light (risk 2, mutates, smoke)

Intensity, colour, source type, cubemap and capture settings of a sky light component.

Argument	Type	Description
intensity	string
color	string	Light colour "r,g,b" in 0..1.
sourceType	string	Source type: captured_scene or specified_cubemap.
cubemap	string	Cubemap texture asset.
lowerHemisphereColor	string	Lower hemisphere colour "r,g,b".
realTimeCapture	string	Recapture the sky every frame (expensive).
occlusion	string	Distance field ambient occlusion maximum distance in centimetres.
skyDistanceThreshold	string	Sky distance threshold in centimetres.

Returns: component, class, template, owner, applied, warnings.

component.set_sphere (risk 2, mutates, smoke)

Sets the radius of a sphere component (centimetres).

Argument	Type	Description
radius	string	Sphere radius in centimetres.
shapeColor	string	Editor wireframe colour "r,g,b[,a]" in 0..1.
drawOnlyIfSelected	string

Returns: component, class, template, owner, applied, warnings.

component.set_spline (risk 2, mutates, smoke)

Replaces the points of a spline component and sets the closed-loop flag (works on Blueprint templates too).

Argument	Type	Description
closedLoop	string	Close the spline into a loop.
points	array of string	Spline points "x,y,z" (replaces the whole spline when given).
pointType	string	Point type applied to every new point: linear, curve, constant, curveclamped or curvecustomtangent.
space	string	Coordinate space of the points: local or world (default local).

Returns: points, count, closedLoop, length.

component.set_spline_mesh (risk 2, mutates, smoke)

Start/end points, tangents, scales, roll and forward axis of a spline mesh component.

Argument	Type	Description
staticMesh	string	Static mesh deformed along the spline.
startPos	string	Start position "x,y,z" in component space.
startTangent	string	Start tangent "x,y,z".
endPos	string	End position "x,y,z".
endTangent	string	End tangent "x,y,z".
forwardAxis	string	Forward axis: x, y, z, -x, -y or -z.
startScale	string	Scale at the start "x,y".
endScale	string	Scale at the end "x,y".
startRoll	string	Roll at the start in radians.
endRoll	string	Roll at the end in radians.
material	string	Material override for slot 0.

Returns: component, class, template, owner, applied, warnings.

component.set_spring_arm (risk 2, mutates, smoke)

Arm length, offsets, lag and collision probe of a spring arm component.

Argument	Type	Description
targetArmLength	string	Distance from the pivot in centimetres.
socketOffset	string	Socket-space offset "x,y,z" applied at the end of the arm.
targetOffset	string	World-space offset "x,y,z" applied at the pivot.
usePawnControlRotation	string	Use the pawn's controller rotation.
inheritPitch	string
inheritYaw	string
inheritRoll	string
enableCameraLag	string	Smooth the camera translation.
cameraLagSpeed	string
cameraLagMaxDistance	string
enableCameraRotationLag	string	Smooth the camera rotation.
cameraRotationLagSpeed	string
doCollisionTest	string	Pull the camera in when the arm collides with geometry.
probeSize	string	Radius of the collision probe.
probeChannel	string	Collision channel of the probe (Camera, Visibility, ...).

Returns: component, class, template, owner, applied, warnings.

component.set_static_mesh (risk 2, mutates, smoke)

Assigns a static mesh plus LOD, lightmap, culling and collision options to a static mesh component.

Argument	Type	Description
mesh	string	Static mesh asset path or unique name.
materials	array of string	Material overrides in slot order (also "slotName=path").
forcedLod	string	Force a specific LOD (0 = automatic).
minLod	string	Minimum LOD override (also enables bOverrideMinLOD).
lightmapResolution	string	Overridden lightmap resolution in texels (also enables bOverrideLightMapRes).
reverseCulling	string	Flip the triangle winding (for mirrored meshes).
useDefaultCollision	string	Use the collision setup stored in the mesh asset.
distanceFieldSelfShadowBias	string	Distance field self shadow bias.

Returns: component, class, template, owner, applied, warnings.

component.set_text_render (risk 2, mutates, smoke)

Text, colour, world size, alignment, font and material of a text render component.

Argument	Type	Description
text	string	Text to display.
color	string	Colour "r,g,b[,a]" in 0..1.
worldSize	string	World size of the text in centimetres.
horizontalAlignment	string	Horizontal alignment: left, center, right.
verticalAlignment	string	Vertical alignment: top, center, bottom, quadtop.
xScale	string
yScale	string
material	string	Text material asset.
font	string	Font asset.

Returns: component, class, template, owner, applied, warnings.

component.set_tick_settings_many (risk 2, mutates, smoke)

Sets tick enabled, interval and tick group on many components of a Blueprint or actor at once.

Argument	Type	Description
enabled	string	Enable or disable ticking.
interval	string	Tick interval in seconds.
tickGroup	string	Tick group: prephysics, duringphysics, postphysics, postupdatework.

Returns: components, count, warnings.

component.set_timeline_component (risk 2, mutates)

Length, looping, play rate and time dilation of a timeline component (not self-tested: timelines are created by the Blueprint editor, not as construction-script components).

Argument	Type	Description
length	string	Timeline length in seconds.
looping	string	Loop the timeline.
playRate	string	Play rate multiplier.
ignoreTimeDilation	string	Ignore global time dilation.

Returns: component, class, template, owner, applied, warnings.

component.set_transform (risk 2, mutates, smoke)

Relative transform of a scene component plus the absolute-location/rotation/scale flags.

Argument	Type	Description
location	string	Relative location "x,y,z" in centimetres (empty = unchanged).
rotation	string	Relative rotation "pitch,yaw,roll" in degrees.
scale	string	Relative scale "x,y,z".
absoluteLocation	string	Treat the location as world-absolute instead of relative to the parent.
absoluteRotation	string	Treat the rotation as world-absolute.
absoluteScale	string	Treat the scale as world-absolute.

Returns: component, class, template, owner, applied, warnings.

component.set_visibility (risk 2, mutates, smoke)

Visibility, hidden-in-game and detail mode of a scene component.

Argument	Type	Description
visible	string	Visible in the editor and at runtime.
hiddenInGame	string	Hidden during play but visible in the editor.
propagateToChildren	boolean	Apply the visibility change to attached children (default true). Default true.
detailMode	string	Detail mode: low, medium, high, epic.

Returns: component, class, template, owner, applied, warnings.

component.set_volumetric_cloud (risk 2, mutates, smoke)

Layer altitude, height, planet radius and material of a volumetric cloud component.

Argument	Type	Description
layerBottomAltitude	string	Bottom altitude of the cloud layer in kilometres.
layerHeight	string	Layer height in kilometres.
planetRadius	string	Planet radius in kilometres.
groundAlbedo	string	Ground albedo "r,g,b".
material	string	Cloud material asset.

Returns: component, class, template, owner, applied, warnings.

component.set_widget (risk 2, mutates, smoke)

Widget class, draw size, space, pivot and rendering flags of a 3D widget component.

Argument	Type	Description
widgetClass	string	UserWidget Blueprint class shown by the component.
drawSize	string	Draw size in pixels "width,height".
space	string	world or screen.
pivot	string	Pivot "x,y" in 0..1.
twoSided	string	Render the widget on both sides of the quad.
drawAtDesiredSize	string	Size the quad from the widget's desired size.
windowFocusable	string	Whether the virtual window can take focus.
backgroundColor	string	Background colour "r,g,b,a" in 0..1.

Returns: component, class, template, owner, applied, warnings.

component.set_wind (risk 2, mutates, smoke)

Speed, strength, gusts and point-wind radius of a wind directional source component.

Argument	Type	Description
speed	string	Wind speed.
strength	string	Wind strength.
pointWind	string	Point wind (radial) instead of directional.
radius	string	Radius of the point wind in centimetres.
minGust	string
maxGust	string

Returns: component, class, template, owner, applied, warnings.

component.sync_instance_to_template (risk 3, mutates, smoke)

Writes the property values of an actor's component instance back onto its Blueprint's construction-script template.

Argument	Type	Description
actor	string	required. Level actor spawned from the Blueprint.
component	string	required. Component name on that actor.
blueprint	string	Blueprint to write to (default: the actor's own generated class Blueprint).
skip	array of string	Property names never written.

Returns: component, class, template, owner, applied, warnings.

component.validate (risk 0, smoke)

Class-specific sanity check of a component (mesh without asset, audio without sound, camera without spring arm, ISM without mesh, ...).

Argument	Type	Description
blueprint	string	Blueprint asset path or unique name; the component is edited on its construction-script template.
actor	string	Level actor label or object name; the component is edited on that actor instance.
component	string	required. Component name (case-insensitive; a unique class name or name prefix also works).

Returns: issues, valid.