KeyingSetPaths(bpy_struct)

base class — bpy_struct

class bpy.types.KeyingSetPaths.KeyingSetPaths(bpy_struct)

Collection of keying set paths

active

Active Keying Set used to insert/delete keyframes

Type

KeyingSetPath

active_index

Current Keying Set index

Type

int in [-inf, inf], default 0

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 (string, (never None)) – Data-Path, RNA-Path to destination property

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

  • group_method (enum in ['NAMED', 'NONE', 'KEYINGSET'], (optional)) – Grouping Method, Method used to define which Group-name to use

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

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, (never None)) – Path

clear()

Remove all the paths from the Keying Set

classmethod bl_rna_get_subclass(id, default=None)
Parameters

id (string) – The RNA type identifier.

Returns

The RNA type or default when not found.

Return type

bpy.types.Struct subclass

classmethod bl_rna_get_subclass_py(id, default=None)
Parameters

id (string) – The RNA type identifier.

Returns

The class or default when not found.

Return type

type

Inherited Properties

  • bpy_struct.id_data

Inherited Functions

  • bpy_struct.as_pointer

  • bpy_struct.driver_add

  • bpy_struct.driver_remove

  • bpy_struct.get

  • bpy_struct.is_property_hidden

  • bpy_struct.is_property_overridable_library

  • bpy_struct.is_property_readonly

  • bpy_struct.is_property_set

  • bpy_struct.items

  • bpy_struct.keyframe_delete

  • bpy_struct.keyframe_insert

  • bpy_struct.keys

  • bpy_struct.path_from_id

  • bpy_struct.path_resolve

  • bpy_struct.pop

  • bpy_struct.property_overridable_library_set

  • bpy_struct.property_unset

  • bpy_struct.type_recast

  • bpy_struct.values

References

  • KeyingSet.paths