Factorio.com|Forums|Wiki|Mod Portal|API Docs

# Factorio Prototype Docs Version 2.0.77

# CreateParticleTriggerEffectItem - Prototype Docs

## CreateParticleTriggerEffectItem :: struct

Inherits from TriggerEffectItem
Children FootstepTriggerEffectItem

## Properties

- default
- sorted

type | :: `"create-particle"` |
particle_name | :: ParticleID |
initial_height | :: float |
offset_deviation optional | :: SimpleBoundingBox |
tile_collision_mask optional | :: CollisionMaskConnector |
offsets optional | :: array[Vector] |
initial_height_deviation optional | :: float |
initial_vertical_speed optional | :: float |
initial_vertical_speed_deviation optional | :: float |
speed_from_center optional | :: float |
speed_from_center_deviation optional | :: float |
frame_speed optional | :: float |
frame_speed_deviation optional | :: float |
movement_multiplier optional | :: float |
tail_length optional | :: uint8 | Silently capped to a maximum of 100.
Silently capped to a maximum of 100.
tail_length_deviation optional | :: uint8 | Silently capped to a maximum of 100.
Silently capped to a maximum of 100.
tail_width optional | :: float |
rotate_offsets optional | :: boolean |
only_when_visible optional | :: boolean | Create the particle only when they are within a 200 tile range of any connected player.
Create the particle only when they are within a 200 tile range of any connected player.
apply_tile_tint optional | :: ApplyTileTint |
tint optional | :: Color | Only loaded if `apply_tile_tint` is not defined.
Only loaded if `apply_tile_tint` is not defined.

Inherited from TriggerEffectItem

repeat_count optional | :: uint16 |
repeat_count_deviation optional | :: uint16 |
probability optional | :: float | Must be greater than `0` and less than or equal to `1`.
Must be greater than `0` and less than or equal to `1`.
affects_target optional | :: boolean |
show_in_tooltip[overridden] optional | :: boolean |
damage_type_filters optional | :: DamageTypeFilters | Guaranteed to work with EntityWithHealthPrototype::damaged_trigger_effect and EntityWithHealthPrototype::dying_trigger_effect. [...]
Guaranteed to work with EntityWithHealthPrototype::damaged_trigger_effect and EntityWithHealthPrototype::dying_trigger_effect. [...]

initial_height | :: float |
particle_name | :: ParticleID |
type | :: `"create-particle"` |
apply_tile_tint optional | :: ApplyTileTint |
frame_speed optional | :: float |
frame_speed_deviation optional | :: float |
initial_height_deviation optional | :: float |
initial_vertical_speed optional | :: float |
initial_vertical_speed_deviation optional | :: float |
movement_multiplier optional | :: float |
offset_deviation optional | :: SimpleBoundingBox |
offsets optional | :: array[Vector] |
only_when_visible optional | :: boolean | Create the particle only when they are within a 200 tile range of any connected player.
Create the particle only when they are within a 200 tile range of any connected player.
rotate_offsets optional | :: boolean |
speed_from_center optional | :: float |
speed_from_center_deviation optional | :: float |
tail_length optional | :: uint8 | Silently capped to a maximum of 100.
Silently capped to a maximum of 100.
tail_length_deviation optional | :: uint8 | Silently capped to a maximum of 100.
Silently capped to a maximum of 100.
tail_width optional | :: float |
tile_collision_mask optional | :: CollisionMaskConnector |
tint optional | :: Color | Only loaded if `apply_tile_tint` is not defined.
Only loaded if `apply_tile_tint` is not defined.

Inherited from TriggerEffectItem

affects_target optional | :: boolean |
damage_type_filters optional | :: DamageTypeFilters | Guaranteed to work with EntityWithHealthPrototype::damaged_trigger_effect and EntityWithHealthPrototype::dying_trigger_effect. [...]
Guaranteed to work with EntityWithHealthPrototype::damaged_trigger_effect and EntityWithHealthPrototype::dying_trigger_effect. [...]
probability optional | :: float | Must be greater than `0` and less than or equal to `1`.
Must be greater than `0` and less than or equal to `1`.
repeat_count optional | :: uint16 |
repeat_count_deviation optional | :: uint16 |
show_in_tooltip[overridden] optional | :: boolean |

## Properties

### type :: `"create-particle"`

### particle_name :: ParticleID

### initial_height :: float

### offset_deviation :: SimpleBoundingBox optional

### tile_collision_mask :: CollisionMaskConnector optional

### offsets :: array[Vector] optional

### initial_height_deviation :: float optional

Default: `0`

### initial_vertical_speed :: float optional

Default: `0`

### initial_vertical_speed_deviation :: float optional

Default: `0`

### speed_from_center :: float optional

Default: `0`

### speed_from_center_deviation :: float optional

Default: `0`

### frame_speed :: float optional

Default: `1`

### frame_speed_deviation :: float optional

Default: `0`

### movement_multiplier :: float optional

Default: `0`

### tail_length :: uint8 optional

Default: `0`

Silently capped to a maximum of 100.

### tail_length_deviation :: uint8 optional

Default: `0`

Silently capped to a maximum of 100.

### tail_width :: float optional

Default: `1`

### rotate_offsets :: boolean optional

Default: `false`

### only_when_visible :: boolean optional

Default: `false`

Create the particle only when they are within a 200 tile range of any connected player.

### apply_tile_tint :: ApplyTileTint optional

### tint :: Color optional

Default: `{1, 1, 1, 1} (white)`

Only loaded if `apply_tile_tint` is not defined.

## Overridden Properties

### show_in_tooltip :: boolean optional

Default: `false`

Type used in

- CranePartDyingEffect::particle_effects
- FootstepTriggerEffectItem::actions
- TreeVariation::leaf_generation
- TreeVariation::branch_generation
- TriggerEffect