Property(bpy_struct)

base class — bpy_struct

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

class bpy.types.Property(bpy_struct)

RNA property definition

description

Description of the property for tooltips

Type:

string, default “”, (readonly, never None)

icon

Icon of the item

Type:

enum in Icon Items, default ‘NONE’, (readonly)

identifier

Unique name used in the code and scripting

Type:

string, default “”, (readonly, never None)

is_animatable

Property is animatable through RNA

Type:

boolean, default False, (readonly)

is_argument_optional

True when the property is optional in a Python function implementing an RNA function

Type:

boolean, default False, (readonly)

is_enum_flag

True when multiple enums

Type:

boolean, default False, (readonly)

is_hidden

True when the property is hidden

Type:

boolean, default False, (readonly)

is_library_editable

Property is editable from linked instances (changes not saved)

Type:

boolean, default False, (readonly)

is_never_none

True when this value can’t be set to None

Type:

boolean, default False, (readonly)

is_output

True when this property is an output value from an RNA function

Type:

boolean, default False, (readonly)

is_overridable

Property is overridable through RNA

Type:

boolean, default False, (readonly)

is_path_output

Property is a filename, filepath or directory output

Type:

boolean, default False, (readonly)

is_readonly

Property is editable through RNA

Type:

boolean, default False, (readonly)

is_registered

Property is registered as part of type registration

Type:

boolean, default False, (readonly)

is_registered_optional

Property is optionally registered as part of type registration

Type:

boolean, default False, (readonly)

is_required

False when this property is an optional argument in an RNA function

Type:

boolean, default False, (readonly)

is_runtime

Property has been dynamically created at runtime

Type:

boolean, default False, (readonly)

is_skip_preset

True when the property is not saved in presets

Type:

boolean, default False, (readonly)

is_skip_save

True when the property uses ghost values

Type:

boolean, default False, (readonly)

name

Human readable name

Type:

string, default “”, (readonly, never None)

srna

Struct definition used for properties assigned to this item

Type:

Struct, (readonly)

subtype

Semantic interpretation of the property

Type:

enum in Property Subtype Items, default ‘NONE’, (readonly)

tags

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

Type:

enum set in {}, default {}, (readonly)

translation_context

Translation context of the property’s name

Type:

string, default “”, (readonly, never None)

type

Data type of the property

Type:

enum in Property Type Items, default ‘BOOLEAN’, (readonly)

unit

Type of units for this property

Type:

enum in Property Unit Items, default ‘NONE’, (readonly)

classmethod bl_rna_get_subclass(id, default=None)
Parameters:

id (str) – 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 (str) – The RNA type identifier.

Returns:

The class or default when not found.

Return type:

type

Inherited Properties

Inherited Functions

References