Function(bpy_struct)

base class — bpy_struct

class bpy.types.Function(bpy_struct)

RNA function definition

description

Description of the Function’s purpose (default “”, readonly, never None)

Type:

str

identifier

Unique name used in the code and scripting (default “”, readonly, never None)

Type:

str

is_registered

Function is registered as callback as part of type registration (default False, readonly)

Type:

bool

is_registered_optional

Function is optionally registered as callback part of type registration (default False, readonly)

Type:

bool

parameters

Parameters for the function (default None, readonly)

Type:

bpy_prop_collection[Property]

use_self

Function does not pass itself as an argument (becomes a static method in Python) (default False, readonly)

Type:

bool

use_self_type

Function passes itself type as an argument (becomes a class method in Python if use_self is false) (default False, readonly)

Type:

bool

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