# ParticleInstanceModifier(Modifier)

base classes — `bpy_struct`, `Modifier`

class `bpy.types.``ParticleInstanceModifier`(Modifier)

  Particle system instancing modifier

  `axis`

    Pole axis for rotation

    Type: | enum in [‘X’, ‘Y’, ‘Z’], default ‘X’

  `index_layer_name`

    Custom data layer name for the index

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

  `object`

    Object that has the particle system

    Type: | `Object`

  `particle_amount`

    Amount of particles to use for instancing

    Type: | float in [0, 1], default 1.0

  `particle_offset`

    Relative offset of particles to use for instancing, to avoid overlap of multiple instances

    Type: | float in [0, 1], default 0.0

  `particle_system`

    Type: | `ParticleSystem`

  `particle_system_index`

    Type: | int in [1, 32767], default 0

  `position`

    Position along path

    Type: | float in [0, 1], default 0.0

  `random_position`

    Randomize position along path

    Type: | float in [0, 1], default 0.0

  `random_rotation`

    Randomize rotation around path

    Type: | float in [0, 1], default 0.0

  `rotation`

    Rotation around path

    Type: | float in [0, 1], default 0.0

  `show_alive`

    Show instances when particles are alive

    Type: | boolean, default False

  `show_dead`

    Show instances when particles are dead

    Type: | boolean, default False

  `show_unborn`

    Show instances when particles are unborn

    Type: | boolean, default False

  `space`

    Space to use for copying mesh data

    - `LOCAL` Local, Use offset from the particle object in the instance object.
    - `WORLD` World, Use world space offset in the instance object.

    Type: | enum in [‘LOCAL’, ‘WORLD’], default ‘WORLD’

  `use_children`

    Create instances from child particles

    Type: | boolean, default False

  `use_normal`

    Create instances from normal particles

    Type: | boolean, default False

  `use_path`

    Create instances along particle paths

    Type: | boolean, default False

  `use_preserve_shape`

    Don’t stretch the object

    Type: | boolean, default False

  `use_size`

    Use particle size to scale the instances

    Type: | boolean, default False

  `value_layer_name`

    Custom data layer name for the randomized value

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

  classmethod `bl_rna_get_subclass`(id, default=None)

    Parameters: | id (string) – 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 (string) – The RNA type identifier.
    Returns: | The class or default when not found.
    Return type: | type

Inherited Properties

`bpy_struct.id_data` `Modifier.name` `Modifier.type` `Modifier.show_viewport` `Modifier.show_render` | `Modifier.show_in_editmode` `Modifier.show_on_cage` `Modifier.show_expanded` `Modifier.use_apply_on_spline`

Inherited Functions

`bpy_struct.as_pointer` `bpy_struct.driver_add` `bpy_struct.driver_remove` `bpy_struct.get` `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_resolve` `bpy_struct.pop` `bpy_struct.property_overridable_library_set` `bpy_struct.property_unset` `bpy_struct.type_recast` `bpy_struct.values`