KeyingSet(bpy_struct)

base class — bpy_struct

class bpy.types.KeyingSet(bpy_struct)

Settings that should be keyframed together

bl_description

A short description of the keying set (default “”, never None)

Type:

str

bl_idname

If this is set, the Keying Set gets a custom ID, otherwise it takes the name of the class used to define the Keying Set (for example, if the class name is “BUILTIN_KSI_location”, and bl_idname is not set by the script, then bl_idname = “BUILTIN_KSI_location”) (default “”, never None)

Type:

str

bl_label

(default “”, never None)

Type:

str

is_path_absolute

Keying Set defines specific paths/settings to be keyframed (i.e. is not reliant on context info) (default False, readonly)

Type:

bool

paths

Keying Set Paths to define settings that get keyframed together (default None, readonly)

Type:

KeyingSetPaths[KeyingSetPath]

type_info

Callback function defines for built-in Keying Sets (readonly)

Type:

KeyingSetInfo

use_insertkey_needed

Only insert keyframes where they’re needed in the relevant F-Curves (default False)

Type:

bool

use_insertkey_override_needed

Override default setting to only insert keyframes where they’re needed in the relevant F-Curves (default False)

Type:

bool

use_insertkey_override_visual

Override default setting to insert keyframes based on ‘visual transforms’ (default False)

Type:

bool

use_insertkey_visual

Insert keyframes based on ‘visual transforms’ (default False)

Type:

bool

refresh()

Refresh Keying Set to ensure that it is valid for the current context (call before each use of one)

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