Modifier(bpy_struct)

base class — bpy_struct

subclasses — ArmatureModifier, ArrayModifier, BevelModifier, BooleanModifier, BuildModifier, CastModifier, ClothModifier, CollisionModifier, CorrectiveSmoothModifier, CurveModifier, DataTransferModifier, DecimateModifier, DisplaceModifier, DynamicPaintModifier, EdgeSplitModifier, ExplodeModifier, FluidModifier, GreasePencilArmatureModifier, GreasePencilArrayModifier, GreasePencilBuildModifier, GreasePencilColorModifier, GreasePencilDashModifierData, GreasePencilEnvelopeModifier, GreasePencilHookModifier, GreasePencilLatticeModifier, GreasePencilLengthModifier, GreasePencilLineartModifier, GreasePencilMirrorModifier, GreasePencilMultiplyModifier, GreasePencilNoiseModifier, GreasePencilOffsetModifier, GreasePencilOpacityModifier, GreasePencilOutlineModifier, GreasePencilShrinkwrapModifier, GreasePencilSimplifyModifier, GreasePencilSmoothModifier, GreasePencilSubdivModifier, GreasePencilTextureModifier, GreasePencilThickModifierData, GreasePencilTimeModifier, GreasePencilTintModifier, GreasePencilWeightAngleModifier, GreasePencilWeightProximityModifier, HookModifier, LaplacianDeformModifier, LaplacianSmoothModifier, LatticeModifier, MaskModifier, MeshCacheModifier, MeshDeformModifier, MeshSequenceCacheModifier, MeshToVolumeModifier, MirrorModifier, MultiresModifier, NodesModifier, NormalEditModifier, OceanModifier, ParticleInstanceModifier, ParticleSystemModifier, RemeshModifier, ScrewModifier, ShrinkwrapModifier, SimpleDeformModifier, SkinModifier, SmoothModifier, SoftBodyModifier, SolidifyModifier, SubsurfModifier, SurfaceDeformModifier, SurfaceModifier, TriangulateModifier, UVProjectModifier, UVWarpModifier, VertexWeightEditModifier, VertexWeightMixModifier, VertexWeightProximityModifier, VolumeDisplaceModifier, VolumeToMeshModifier, WarpModifier, WaveModifier, WeightedNormalModifier, WeldModifier, WireframeModifier

class bpy.types.Modifier(bpy_struct)

Modifier affecting the geometry data of an object

execution_time

Time in seconds that the modifier took to evaluate. This is only set on evaluated objects. If multiple modifiers run in parallel, execution time is not a reliable metric. (in [-inf, inf], default 0.0, readonly)

Type:

float

is_active

The active modifier in the list (default False)

Type:

bool

is_override_data

In a local override object, whether this modifier comes from the linked reference object, or is local to the override (default True, readonly)

Type:

bool

name

Modifier name (default “”, never None)

Type:

str

persistent_uid

Uniquely identifies the modifier within the modifier stack that it is part of (in [-inf, inf], default 0, readonly)

Type:

int

show_expanded

Set modifier expanded in the user interface (default False)

Type:

bool

show_in_editmode

Display modifier in Edit mode (default False)

Type:

bool

show_on_cage

Adjust edit cage to modifier result (default False)

Type:

bool

show_render

Use modifier during render (default False)

Type:

bool

show_viewport

Display modifier in viewport (default False)

Type:

bool

type

(default 'GREASE_PENCIL_VERTEX_WEIGHT_PROXIMITY', readonly)

Type:

Literal[Object Modifier Type Items]

use_apply_on_spline

Apply this and all preceding deformation modifiers on splines’ points rather than on filled curve/surface (default False)

Type:

bool

use_pin_to_last

Keep the modifier at the end of the list (default False)

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