KeyingSetPaths(bpy_prop_collection)

base classes — bpy_prop, bpy_prop_collection

class bpy.types.KeyingSetPaths(bpy_prop_collection)

Collection of keying set paths

active

Active Keying Set used to insert/delete keyframes

Type:

KeyingSetPath

active_index

Current Keying Set index (in [-inf, inf], default 0)

Type:

int

add(target_id, data_path, *, index=-1, group_method='KEYINGSET', group_name='')

Add a new path for the Keying Set

Parameters:

  • target_id (ID) – Target ID, ID data-block for the destination

  • data_path (str) – Data-Path, RNA-Path to destination property (never None)

  • index (int) – Index, The index of the destination property (i.e. axis of Location/Rotation/etc.), or -1 for the entire array (in [-1, inf], optional)

  • group_method (Literal[Keyingset Path Grouping Items]) – Grouping Method, Method used to define which Group-name to use (optional)

  • group_name (str) – Group Name, Name of Action Group to assign destination to (only if grouping mode is to use this name) (optional, never None)

Returns:

New Path, Path created and added to the Keying Set

Return type:

KeyingSetPath

remove(path)

Remove the given path from the Keying Set

Parameters:

path (KeyingSetPath) – Path, (never None)

clear()

Remove all the paths from the Keying Set

classmethod bl_rna_get_subclass(id, default=None, /)
Parameters:

  • id (str) – The RNA type identifier.

  • default (bpy.types.Struct | None) – The value to return when not found.

Returns:

The RNA type or default when not found.

Return type:

bpy.types.Struct

classmethod bl_rna_get_subclass_py(id, default=None, /)
Parameters:

  • id (str) – The RNA type identifier.

  • default (type | None) – The value to return when not found.

Returns:

The class or default when not found.

Return type:

type

Inherited Properties

Inherited Functions

References