Skip to main content

`motion` kit

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

Guide

Enable MotionWarping (UE5). The tools work on any placed actor that owns a UMotionWarpingComponent, in the editor world or in PIE while it runs.

Need a test subject? motion.spawn_character {"label":"Hero"} spawns an engine Character (or characterClass) with a MotionWarpingComponent; motion.add_component {"actor":"Hero"} adds one to an existing actor. In PIE use motion.spawn_test_character (transient).
motion.list_targets / motion.audit_component show current targets and modifiers.
Add or update named targets: motion.add_update_transform, motion.add_update_location, motion.add_update_location_rotation, or motion.add_update_component to follow another actor's root component (follow, optional bone).
motion.get_target reads one target; motion.remove_target / motion.clear_targets reset them.
In PIE, motion.disable_all_modifiers stops active root-motion modifiers when an interrupted traversal must be reset.
Remove test actors with motion.delete_actors {"actors":["Hero"]}.

Target names must match the warp target names used by the montage's Motion Warping notifies. Camera shakes and rigs stay in camera; root-motion asset setup and animation runtime inspection stay in anim.

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.

`motion.add_component` (risk 2, mutates, UE 5.5+, requires plugin MotionWarping, requires world, smoke)

Adds a MotionWarpingComponent instance to a placed actor that has none (editor world, or PIE while it runs).

Argument	Type	Description
`actor`	string	required. Character/actor with MotionWarpingComponent.

Returns: actor, values, count.

`motion.add_update_component` (risk 2, mutates, UE 5.5+, requires plugin MotionWarping, requires world, smoke)

No description.

Argument	Type	Description
`targetActor`	string	required. Actor supplying its root scene component.
`follow`	boolean	Follow target component while warping. Default `true`.
`bone`	string	Optional bone/socket name.

Returns: actor, values, count.

`motion.add_update_location` (risk 2, mutates, UE 5.5+, requires plugin MotionWarping, requires world, smoke)

No description.

Argument	Type	Description
`location`	{x,y,z}	required. Target location cm.
`rotation`	{x,y,z}	Target rotation pitch/yaw/roll.

Returns: actor, values, count.

`motion.add_update_location_rotation` (risk 2, mutates, UE 5.5+, requires plugin MotionWarping, requires world, smoke)

No description.

Argument	Type	Description
`location`	{x,y,z}	required. Target location cm.
`rotation`	{x,y,z}	Target rotation pitch/yaw/roll.

Returns: actor, values, count.

`motion.add_update_transform` (risk 2, mutates, UE 5.5+, requires plugin MotionWarping, requires world, smoke)

No description.

Argument	Type	Description
`location`	{x,y,z}	required. Target location cm.
`rotation`	{x,y,z}	Target rotation pitch/yaw/roll.

Returns: actor, values, count.

`motion.audit_component` (risk 0, UE 5.5+, requires plugin MotionWarping, requires world, smoke)

No description.

Argument	Type	Description
`actor`	string	required. Character/actor with MotionWarpingComponent.

Returns: actor, values, count.

`motion.clear_targets` (risk 2, mutates, UE 5.5+, requires plugin MotionWarping, requires world, smoke)

No description.

Argument	Type	Description
`actor`	string	required. Character/actor with MotionWarpingComponent.

Returns: actor, values, count.

`motion.delete_actors` (risk 3, mutates, destructive, UE 5.5+, requires plugin MotionWarping, requires world, smoke)

Deletes editor-world actors that own a MotionWarpingComponent.

Argument	Type	Description
`actors`	array of string	required. Labels/names of actors that own a MotionWarpingComponent.

Returns: actor, values, count.

`motion.disable_all_modifiers` (risk 2, mutates, UE 5.5+, requires plugin MotionWarping, requires PIE, smoke)

No description.

Argument	Type	Description
`actor`	string	required. Character/actor with MotionWarpingComponent.

Returns: actor, values, count.

`motion.get_target` (risk 0, UE 5.5+, requires plugin MotionWarping, requires world, smoke)

No description.

Argument	Type	Description
`target`	string	required. Warp target name.

Returns: actor, values, count.

`motion.list_targets` (risk 0, UE 5.5+, requires plugin MotionWarping, requires world, smoke)

No description.

Argument	Type	Description
`actor`	string	required. Character/actor with MotionWarpingComponent.

Returns: actor, values, count.

`motion.remove_target` (risk 2, mutates, UE 5.5+, requires plugin MotionWarping, requires world, smoke)

No description.

Argument	Type	Description
`target`	string	required. Warp target name.

Returns: actor, values, count.

`motion.spawn_character` (risk 2, mutates, UE 5.5+, requires plugin MotionWarping, requires world, smoke)

Spawns a Character (engine class or a Character Blueprint) in the editor world and, by default, gives it a MotionWarpingComponent.

Argument	Type	Description
`label`	string	required. Actor label for the spawned character.
`location`	{x,y,z}	Spawn location in centimetres.
`characterClass`	string	Character class or Blueprint; empty uses the engine Character class.
`addMotionWarping`	boolean	Add a MotionWarpingComponent when the class has none. Default `true`.

Returns: actor, values, count.

`motion.spawn_test_character` (risk 1, UE 5.5+, requires plugin MotionWarping, requires PIE, smoke)

PIE only: spawns a transient Character with a MotionWarpingComponent for runtime warp-target and modifier tests.

Argument	Type	Description
`label`	string	required. Actor label for the spawned character.
`location`	{x,y,z}	Spawn location in centimetres.
`characterClass`	string	Character class or Blueprint; empty uses the engine Character class.
`addMotionWarping`	boolean	Add a MotionWarpingComponent when the class has none. Default `true`.

Returns: actor, values, count.

Guide
Tools