ParticleInstanceModifier(Modifier)

base classes — bpy_struct, Modifier

class bpy.types.ParticleInstanceModifier(Modifier)

Particle system instancing modifier

axis

Pole axis for rotation (default 'Z')

Type:

Literal[Axis Xyz Items]

index_layer_name

Custom data layer name for the index (default “”, never None)

Type:

str

object

Object that has the particle system

Type:

Object

particle_amount

Amount of particles to use for instancing (in [0, 1], default 1.0)

Type:

float

particle_offset

Relative offset of particles to use for instancing, to avoid overlap of multiple instances (in [0, 1], default 0.0)

Type:

float

particle_system
Type:

ParticleSystem

particle_system_index

(in [1, 32767], default 1)

Type:

int

position

Position along path (in [0, 1], default 1.0)

Type:

float

random_position

Randomize position along path (in [0, 1], default 0.0)

Type:

float

random_rotation

Randomize rotation around path (in [0, 1], default 0.0)

Type:

float

rotation

Rotation around path (in [0, 1], default 0.0)

Type:

float

show_alive

Show instances when particles are alive (default True)

Type:

bool

show_dead

Show instances when particles are dead (default True)

Type:

bool

show_unborn

Show instances when particles are unborn (default True)

Type:

bool

space

Space to use for copying mesh data (default 'WORLD')

  • LOCAL Local – Use offset from the particle object in the instance object.

  • WORLD World – Use world space offset in the instance object.

Type:

Literal[‘LOCAL’, ‘WORLD’]

use_children

Create instances from child particles (default False)

Type:

bool

use_normal

Create instances from normal particles (default True)

Type:

bool

use_path

Create instances along particle paths (default False)

Type:

bool

use_preserve_shape

Don’t stretch the object (default False)

Type:

bool

use_size

Use particle size to scale the instances (default False)

Type:

bool

value_layer_name

Custom data layer name for the randomized value (default “”, never None)

Type:

str

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