ParticleSystem(bpy_struct)

base class — bpy_struct

class bpy.types.ParticleSystem(bpy_struct)

Particle system in an object

active_particle_target

(readonly)

Type:

ParticleTarget

active_particle_target_index

(in [0, inf], default 0)

Type:

int

child_particles

Child particles generated by the particle system (default None, readonly)

Type:

bpy_prop_collection[ChildParticle]

child_seed

Offset in the random number table for child particles, to get a different randomized result (in [0, inf], default 0)

Type:

int

cloth

Cloth dynamics for hair (readonly, never None)

Type:

ClothModifier

dt_frac

The current simulation time step size, as a fraction of a frame (in [0.00990099, 1], default 0.0, readonly)

Type:

float

has_multiple_caches

Particle system has multiple point caches (default False, readonly)

Type:

bool

invert_vertex_group_clump

Negate the effect of the clump vertex group (default False)

Type:

bool

invert_vertex_group_density

Negate the effect of the density vertex group (default False)

Type:

bool

invert_vertex_group_field

Negate the effect of the field vertex group (default False)

Type:

bool

invert_vertex_group_kink

Negate the effect of the kink vertex group (default False)

Type:

bool

invert_vertex_group_length

Negate the effect of the length vertex group (default False)

Type:

bool

invert_vertex_group_rotation

Negate the effect of the rotation vertex group (default False)

Type:

bool

invert_vertex_group_roughness_1

Negate the effect of the roughness 1 vertex group (default False)

Type:

bool

invert_vertex_group_roughness_2

Negate the effect of the roughness 2 vertex group (default False)

Type:

bool

invert_vertex_group_roughness_end

Negate the effect of the roughness end vertex group (default False)

Type:

bool

invert_vertex_group_size

Negate the effect of the size vertex group (default False)

Type:

bool

invert_vertex_group_tangent

Negate the effect of the tangent vertex group (default False)

Type:

bool

invert_vertex_group_twist

Negate the effect of the twist vertex group (default False)

Type:

bool

invert_vertex_group_velocity

Negate the effect of the velocity vertex group (default False)

Type:

bool

is_editable

Particle system can be edited in particle mode (default False, readonly)

Type:

bool

is_edited

Particle system has been edited in particle mode (default False, readonly)

Type:

bool

is_global_hair

Hair keys are in global coordinate space (default False, readonly)

Type:

bool

name

Particle system name (default “”, never None)

Type:

str

parent

Use this object’s coordinate system instead of global coordinate system

Type:

Object

particles

Particles generated by the particle system (default None, readonly)

Type:

bpy_prop_collection[Particle]

point_cache

(readonly, never None)

Type:

PointCache

reactor_target_object

For reactor systems, the object that has the target particle system (empty if same object)

Type:

Object

reactor_target_particle_system

For reactor systems, index of particle system on the target object (in [1, 32767], default 0)

Type:

int

seed

Offset in the random number table, to get a different randomized result (in [0, inf], default 0)

Type:

int

settings

Particle system settings (never None)

Type:

ParticleSettings

targets

Target particle systems (default None, readonly)

Type:

bpy_prop_collection[ParticleTarget]

use_hair_dynamics

Enable hair dynamics using cloth simulation (default False)

Type:

bool

use_keyed_timing

Use key times (default False)

Type:

bool

vertex_group_clump

Vertex group to control clump (default “”, never None)

Type:

str

vertex_group_density

Vertex group to control density (default “”, never None)

Type:

str

vertex_group_field

Vertex group to control field (default “”, never None)

Type:

str

vertex_group_kink

Vertex group to control kink (default “”, never None)

Type:

str

vertex_group_length

Vertex group to control length (default “”, never None)

Type:

str

vertex_group_rotation

Vertex group to control rotation (default “”, never None)

Type:

str

vertex_group_roughness_1

Vertex group to control roughness 1 (default “”, never None)

Type:

str

vertex_group_roughness_2

Vertex group to control roughness 2 (default “”, never None)

Type:

str

vertex_group_roughness_end

Vertex group to control roughness end (default “”, never None)

Type:

str

vertex_group_size

Vertex group to control size (default “”, never None)

Type:

str

vertex_group_tangent

Vertex group to control tangent (default “”, never None)

Type:

str

vertex_group_twist

Vertex group to control twist (default “”, never None)

Type:

str

vertex_group_velocity

Vertex group to control velocity (default “”, never None)

Type:

str

co_hair(object, *, particle_no=0, step=0)

Obtain cache hair data

Parameters:

• object (Object) – Object (never None)

• particle_no (int) – Particle no, (in [-inf, inf], optional)

• step (int) – step no, (in [-inf, inf], optional)

Returns:

Co, Exported hairkey location (array of 3 items, in [-inf, inf])

Return type:

mathutils.Vector

uv_on_emitter(modifier, particle, *, particle_no=0, uv_no=0)

Obtain uv for all particles

Parameters:

• modifier (ParticleSystemModifier) – Particle modifier (never None)

• particle (Particle) – Particle (never None)

• particle_no (int) – Particle no, (in [-inf, inf], optional)

• uv_no (int) – UV no, (in [-inf, inf], optional)

Returns:

uv, (array of 2 items, in [-inf, inf])

Return type:

mathutils.Vector

mcol_on_emitter(modifier, particle, *, particle_no=0, vcol_no=0)

Obtain mcol for all particles

Parameters:

• modifier (ParticleSystemModifier) – Particle modifier (never None)

• particle (Particle) – Particle (never None)

• particle_no (int) – Particle no, (in [-inf, inf], optional)

• vcol_no (int) – vcol no, (in [-inf, inf], optional)

Returns:

mcol, (array of 3 items, in [0, inf])

Return type:

mathutils.Color

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

bpy_struct.id_data

Inherited Functions

bpy_struct.as_pointer bpy_struct.driver_add bpy_struct.driver_remove bpy_struct.get bpy_struct.id_properties_clear bpy_struct.id_properties_ensure bpy_struct.id_properties_ui bpy_struct.is_property_hidden bpy_struct.is_property_overridable_library bpy_struct.is_property_readonly 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_from_module bpy_struct.path_resolve bpy_struct.pop bpy_struct.property_overridable_library_set bpy_struct.property_unset bpy_struct.rna_ancestors bpy_struct.type_recast bpy_struct.values

References

bpy.context.particle_system bpy.context.particle_system_editable DepsgraphObjectInstance.particle_system DynamicPaintBrushSettings.particle_system FluidFlowSettings.particle_system

Object.particle_systems ParticleInstanceModifier.particle_system ParticleSystemModifier.particle_system ParticleSystems.active