Property(bpy_struct)

base class — bpy_struct

subclasses — BoolProperty, CollectionProperty, EnumProperty, FloatProperty, IntProperty, PointerProperty, StringProperty

class bpy.types.Property(bpy_struct)

RNA property definition

deprecated_note

A note regarding deprecation (default “”, readonly, never None)

Type:

str

deprecated_removal_version

The Blender version this is expected to be removed (array of 3 items, in [-inf, inf], default (0, 0, 0), readonly)

Type:

bpy_prop_array[int]

deprecated_version

The Blender version this was deprecated (array of 3 items, in [-inf, inf], default (0, 0, 0), readonly)

Type:

bpy_prop_array[int]

description

Description of the property for tooltips (default “”, readonly, never None)

Type:

str

icon

Icon of the item (default 'NONE', readonly)

Type:

Literal[Icon Items]

identifier

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

Type:

str

is_animatable

Property is animatable through RNA (default False, readonly)

Type:

bool

is_argument_optional

True when the property is optional in a Python function implementing an RNA function (default False, readonly)

Type:

bool

is_deprecated

The property is deprecated (default False, readonly)

Type:

bool

is_enum_flag

True when multiple enums (default False, readonly)

Type:

bool

is_hidden

True when the property is hidden (default False, readonly)

Type:

bool

is_library_editable

Property is editable from linked instances (changes not saved) (default False, readonly)

Type:

bool

is_never_none

True when this value cannot be set to None (default False, readonly)

Type:

bool

is_output

True when this property is an output value from an RNA function (default False, readonly)

Type:

bool

is_overridable

Property is overridable through RNA (default False, readonly)

Type:

bool

is_path_output

Property is a filename, filepath or directory output (default False, readonly)

Type:

bool

is_path_supports_blend_relative

Property is a path which supports the “//” prefix, signifying the location as relative to the “.blend” file’s directory (default False, readonly)

Type:

bool

is_path_supports_templates

Property is a path which supports the “{variable_name}” variable expression syntax, which substitutes the value of the referenced variable in place of the expression (default False, readonly)

Type:

bool

is_readonly

Property is editable through RNA (default False, readonly)

Type:

bool

is_registered

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

Type:

bool

is_registered_optional

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

Type:

bool

is_required

False when this property is an optional argument in an RNA function (default False, readonly)

Type:

bool

is_runtime

Property has been dynamically created at runtime (default False, readonly)

Type:

bool

is_skip_preset

True when the property is not saved in presets (default False, readonly)

Type:

bool

is_skip_save

True when the property uses ghost values (default False, readonly)

Type:

bool

name

Human readable name (default “”, readonly, never None)

Type:

str

srna

Struct definition used for properties assigned to this item (readonly)

Type:

Struct

subtype

Semantic interpretation of the property (default 'NONE', readonly)

Type:

Literal[Property Subtype Items]

tags

Subset of tags (defined in parent struct) that are set for this property (default set(), readonly)

Type:

set[str]

translation_context

Translation context of the property’s name (default “”, readonly, never None)

Type:

str

type

Data type of the property (default 'BOOLEAN', readonly)

Type:

Literal[Property Type Items]

unit

Type of units for this property (default 'NONE', readonly)

Type:

Literal[Property Unit Items]

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