KeyingSetInfo(bpy_struct)

base class — bpy_struct

class bpy.types.KeyingSetInfo(bpy_struct)

Callback function defines for builtin Keying Sets

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

bl_options

Keying Set options to use when inserting keyframes (default set())

Type:

set[Literal[Keying Flag Items]]

poll(context)

Test if Keying Set can be used or not

Parameters:

context (Context | None) – The context

Return type:

bool

iterator(context, ks)

Call generate() on the structs which have properties to be keyframed

Parameters:

  • context (Context | None) – The context

  • ks (KeyingSet | None) – Keying set this iterator runs on

generate(context, ks, data)

Add Paths to the Keying Set to keyframe the properties of the given data

Parameters:

  • context (Context | None) – The context

  • ks (KeyingSet | None) – Keying set to add paths to

  • data (AnyType | None) – Data to add paths from (never None)

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