Property(bpy_struct)

base class — bpy_struct

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

class bpy.types.Property(bpy_struct)

RNA property definition

description

Description of the property for tooltips

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

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_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_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_save

True when the property is not saved in presets

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 [‘NONE’, ‘FILE_PATH’, ‘DIRECTORY_PATH’, ‘UNSIGNED’, ‘PERCENTAGE’, ‘FACTOR’, ‘ANGLE’, ‘TIME’, ‘DISTANCE’, ‘COLOR’, ‘TRANSLATION’, ‘DIRECTION’, ‘MATRIX’, ‘EULER’, ‘QUATERNION’, ‘XYZ’, ‘COLOR_GAMMA’, ‘COORDINATES’, ‘LAYER’, ‘LAYER_MEMBERSHIP’], default ‘NONE’, (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 [‘BOOLEAN’, ‘INT’, ‘FLOAT’, ‘STRING’, ‘ENUM’, ‘POINTER’, ‘COLLECTION’], default ‘BOOLEAN’, (readonly)

unit

Type of units for this property

Type :enum in [‘NONE’, ‘LENGTH’, ‘AREA’, ‘VOLUME’, ‘ROTATION’, ‘TIME’, ‘VELOCITY’, ‘ACCELERATION’], default ‘NONE’, (readonly)

Inherited Properties

bpy_struct.id_data

Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add bpy_struct.driver_remove bpy_struct.get bpy_struct.is_property_hidden bpy_struct.is_property_set

bpy_struct.items bpy_struct.keyframe_delete bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

References

Function.parameters

Struct.properties