editor.animation

Animation sequence and montage editing

`editor.animation.getInfo`

Returns metadata about an animation sequence.

Parameters:

Name	Type	Required	Description
`asset_path`	string	Yes	AnimSequence asset path

Returns:

Name	Type	Description
`asset_path`	string	Asset path
`name`	string	Animation name
`length`	number	Duration in seconds
`num_frames`	number	Total frame count
`frame_rate`	string	Frame rate as fraction string
`num_bones`	number	Number of bone tracks
`num_curves`	number	Number of curves
`num_notifies`	number	Number of notifies
`is_additive`	bool	Whether animation is additive
`root_motion_enabled`	bool	Whether root motion is enabled

Example Request:

{ "jsonrpc": "2.0", "id": 1, "method": "editor.animation.getInfo", "params": { "asset_path": "/Game/Animations/Anim_Run" } }

`editor.animation.getCurves`

Returns all curves in an animation sequence.

Parameters:

Name	Type	Required	Description
`asset_path`	string	Yes	AnimSequence asset path

Returns:

Name	Type	Description
`asset_path`	string	Asset path
`curves`	array	Each: {curve_name, curve_type} (type is "float" or "transform")

Example Request:

{ "jsonrpc": "2.0", "id": 1, "method": "editor.animation.getCurves", "params": { "asset_path": "/Game/Animations/Anim_Run" } }

`editor.animation.addCurve`

Adds a new curve to an animation sequence.

Parameters:

Name	Type	Required	Description
`asset_path`	string	Yes	AnimSequence asset path
`curve_name`	string	Yes	Name for the new curve
`curve_type`	string	No	"float", "vector", or "transform" (default "float")

Returns:

Name	Type	Description
`success`	bool	Whether curve was added
`curve_name`	string	Curve name
`curve_type`	string	Curve type

Example Request:

{
  "jsonrpc": "2.0", "id": 1, "method": "editor.animation.addCurve",
  "params": { "asset_path": "/Game/Animations/Anim_Run", "curve_name": "FootIK_Alpha", "curve_type": "float" }
}

`editor.animation.removeCurve`

Removes a curve from an animation sequence.

Parameters:

Name	Type	Required	Description
`asset_path`	string	Yes	AnimSequence asset path
`curve_name`	string	Yes	Curve name to remove

Returns:

Name	Type	Description
`success`	bool	Whether curve was removed
`curve_name`	string	Removed curve name

Example Request:

{ "jsonrpc": "2.0", "id": 1, "method": "editor.animation.removeCurve", "params": { "asset_path": "/Game/Animations/Anim_Run", "curve_name": "FootIK_Alpha" } }

`editor.animation.addCurveKey`

Adds a key to a float curve in an animation sequence.

Parameters:

Name	Type	Required	Description
`asset_path`	string	Yes	AnimSequence asset path
`curve_name`	string	Yes	Target curve name
`time`	number	Yes	Key time in seconds
`value`	number	Yes	Key value

Returns:

Name	Type	Description
`success`	bool	Whether key was added
`curve_name`	string	Curve name
`time`	number	Key time
`value`	number	Key value

Example Request:

{
  "jsonrpc": "2.0", "id": 1, "method": "editor.animation.addCurveKey",
  "params": { "asset_path": "/Game/Animations/Anim_Run", "curve_name": "FootIK_Alpha", "time": 0.5, "value": 1.0 }
}

`editor.animation.getCurveKeys`

Returns all keys in a specific curve.

Parameters:

Name	Type	Required	Description
`asset_path`	string	Yes	AnimSequence asset path
`curve_name`	string	Yes	Curve name

Returns:

Name	Type	Description
`asset_path`	string	Asset path
`curve_name`	string	Curve name
`keys`	array	Each: {time, value}

Example Request:

{ "jsonrpc": "2.0", "id": 1, "method": "editor.animation.getCurveKeys", "params": { "asset_path": "/Game/Animations/Anim_Run", "curve_name": "FootIK_Alpha" } }

`editor.animation.getNotifies`

Returns all animation notifies in a sequence.

Parameters:

Name	Type	Required	Description
`asset_path`	string	Yes	AnimSequence asset path

Returns:

Name	Type	Description
`asset_path`	string	Asset path
`notifies`	array	Each: {notify_name, trigger_time, duration, track_name}

Example Request:

{ "jsonrpc": "2.0", "id": 1, "method": "editor.animation.getNotifies", "params": { "asset_path": "/Game/Animations/Anim_Run" } }

`editor.animation.addNotify`

Adds a notify at the specified time.

Parameters:

Name	Type	Required	Description
`asset_path`	string	Yes	AnimSequence asset path
`notify_name`	string	Yes	Notify name
`time`	number	Yes	Trigger time in seconds
`track_name`	string	No	Target notify track (default: creates/uses default track)

Returns:

Name	Type	Description
`success`	bool	Whether notify was added
`notify_name`	string	Notify name
`time`	number	Trigger time
`track_name`	string	Track where notify was placed

Example Request:

{
  "jsonrpc": "2.0", "id": 1, "method": "editor.animation.addNotify",
  "params": { "asset_path": "/Game/Animations/Anim_Run", "notify_name": "FootstepSound", "time": 0.25 }
}

`editor.animation.removeNotify`

Removes all notifies with the specified name.

Parameters:

Name	Type	Required	Description
`asset_path`	string	Yes	AnimSequence asset path
`notify_name`	string	Yes	Notify name to remove

Returns:

Name	Type	Description
`success`	bool	Whether any notifies were removed
`notify_name`	string	Notify name
`removed_count`	number	Number of notifies removed

Example Request:

{ "jsonrpc": "2.0", "id": 1, "method": "editor.animation.removeNotify", "params": { "asset_path": "/Game/Animations/Anim_Run", "notify_name": "FootstepSound" } }

`editor.animation.getNotifyTracks`

Returns all notify tracks in an animation sequence.

Parameters:

Name	Type	Required	Description
`asset_path`	string	Yes	AnimSequence asset path

Returns:

Name	Type	Description
`asset_path`	string	Asset path
`tracks`	array	Each: {track_name, notify_count}

Example Request:

{ "jsonrpc": "2.0", "id": 1, "method": "editor.animation.getNotifyTracks", "params": { "asset_path": "/Game/Animations/Anim_Run" } }

`editor.animation.addNotifyTrack`

Adds a new notify track to an animation sequence.

Parameters:

Name	Type	Required	Description
`asset_path`	string	Yes	AnimSequence asset path
`track_name`	string	Yes	Name for the new track

Returns:

Name	Type	Description
`success`	bool	Whether track was created
`track_name`	string	Track name

Example Request:

{ "jsonrpc": "2.0", "id": 1, "method": "editor.animation.addNotifyTrack", "params": { "asset_path": "/Game/Animations/Anim_Run", "track_name": "SFX" } }

`editor.animation.getBoneTracks`

Returns all bone tracks in an animation sequence.

Parameters:

Name	Type	Required	Description
`asset_path`	string	Yes	AnimSequence asset path

Returns:

Name	Type	Description
`asset_path`	string	Asset path
`bone_tracks`	array	Each: {bone_name}

Example Request:

{ "jsonrpc": "2.0", "id": 1, "method": "editor.animation.getBoneTracks", "params": { "asset_path": "/Game/Animations/Anim_Run" } }

`editor.animation.removeBoneTrack`

Removes all animation data for a bone (and optionally its children).

Parameters:

Name	Type	Required	Description
`asset_path`	string	Yes	AnimSequence asset path
`bone_name`	string	Yes	Bone name to remove
`include_children`	bool	No	Also remove child bone tracks (default true)

Returns:

Name	Type	Description
`success`	bool	Whether bone track was removed
`bone_name`	string	Bone name
`include_children`	bool	Whether children were included

Example Request:

{ "jsonrpc": "2.0", "id": 1, "method": "editor.animation.removeBoneTrack", "params": { "asset_path": "/Game/Animations/Anim_Run", "bone_name": "ik_foot_l", "include_children": false } }

`editor.animation.getCompressionSettings`

Returns compression settings for bones and curves.

Parameters:

Name	Type	Required	Description
`asset_path`	string	Yes	AnimSequence asset path

Returns:

Name	Type	Description
`asset_path`	string	Asset path
`bone_compression`	object	{name, class}
`curve_compression`	object	{name, class}

Example Request:

{ "jsonrpc": "2.0", "id": 1, "method": "editor.animation.getCompressionSettings", "params": { "asset_path": "/Game/Animations/Anim_Run" } }

`editor.animation.setAdditiveType`

Sets whether the animation is additive and its additive type.

Parameters:

Name	Type	Required	Description
`asset_path`	string	Yes	AnimSequence asset path
`additive_type`	string	Yes	One of: "none", "local_space", "mesh_space"

Returns:

Name	Type	Description
`success`	bool	Whether type was set
`additive_type`	string	New additive type

Example Request:

{ "jsonrpc": "2.0", "id": 1, "method": "editor.animation.setAdditiveType", "params": { "asset_path": "/Game/Animations/Anim_Hit", "additive_type": "local_space" } }

`editor.animation.getRootMotionSettings`

Returns root motion settings and lock type.

Parameters:

Name	Type	Required	Description
`asset_path`	string	Yes	AnimSequence asset path

Returns:

Name	Type	Description
`asset_path`	string	Asset path
`root_motion_enabled`	bool	Whether root motion is enabled
`root_motion_lock_type`	string	One of: "ref_pose", "anim_first_frame", "zero", "unknown"
`force_root_lock`	bool	Whether root lock is forced

Example Request:

{ "jsonrpc": "2.0", "id": 1, "method": "editor.animation.getRootMotionSettings", "params": { "asset_path": "/Game/Animations/Anim_Run" } }

`editor.animation.getMetadata`

Returns all metadata objects attached to an animation sequence.

Parameters:

Name	Type	Required	Description
`asset_path`	string	Yes	AnimSequence asset path

Returns:

Name	Type	Description
`asset_path`	string	Asset path
`metadata`	array	Each: {class_name, name}

Example Request:

{ "jsonrpc": "2.0", "id": 1, "method": "editor.animation.getMetadata", "params": { "asset_path": "/Game/Animations/Anim_Run" } }

`editor.animation.addMetadata`

Adds a metadata object of the specified class to the animation.

Parameters:

Name	Type	Required	Description
`asset_path`	string	Yes	AnimSequence asset path
`metadata_class`	string	Yes	UAnimMetaData subclass name

Returns:

Name	Type	Description
`success`	bool	Whether metadata was added
`metadata_class`	string	Metadata class name

Example Request:

{ "jsonrpc": "2.0", "id": 1, "method": "editor.animation.addMetadata", "params": { "asset_path": "/Game/Animations/Anim_Run", "metadata_class": "AnimMetaData_CurveCompressionSettings" } }

`editor.animation.setPlayRate`

Sets the playback rate scale for the animation.

Parameters:

Name	Type	Required	Description
`asset_path`	string	Yes	AnimSequence asset path
`rate`	number	Yes	Playback rate multiplier

Returns:

Name	Type	Description
`success`	bool	Whether rate was set
`rate`	number	New playback rate

Example Request:

{ "jsonrpc": "2.0", "id": 1, "method": "editor.animation.setPlayRate", "params": { "asset_path": "/Game/Animations/Anim_Run", "rate": 1.5 } }

`editor.animation.getVirtualBones`

Returns all virtual bones defined in the skeleton used by this animation.

Parameters:

Name	Type	Required	Description
`asset_path`	string	Yes	AnimSequence asset path

Returns:

Name	Type	Description
`asset_path`	string	Asset path
`virtual_bones`	array	Each: {virtual_bone_name, source_bone_name, target_bone_name}

Example Request:

{ "jsonrpc": "2.0", "id": 1, "method": "editor.animation.getVirtualBones", "params": { "asset_path": "/Game/Animations/Anim_Run" } }