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

# Factorio Prototype Docs Version 2.0.77

# ParticlePrototype - Prototype Docs

## ParticlePrototype 'optimized-particle'

An entity with a limited lifetime that can use trigger effects.

Inherits from Prototype « PrototypeBase

## Properties

- default
- sorted

pictures optional | :: AnimationVariations | Picture variation count and individual frame count must be equal to shadow variation count.
Picture variation count and individual frame count must be equal to shadow variation count.
life_time | :: uint16 | Can't be 1.
Can't be 1.
shadows optional | :: AnimationVariations | Shadow variation variation count and individual frame count must be equal to picture variation count.
Shadow variation variation count and individual frame count must be equal to picture variation count.
draw_shadow_when_on_ground optional | :: boolean |
regular_trigger_effect optional | :: TriggerEffect |
ended_in_water_trigger_effect optional | :: TriggerEffect |
ended_on_ground_trigger_effect optional | :: TriggerEffect |
render_layer optional | :: RenderLayer |
render_layer_when_on_ground optional | :: RenderLayer |
regular_trigger_effect_frequency optional | :: uint32 | Can't be 1.
Can't be 1.
movement_modifier_when_on_ground optional | :: float |
movement_modifier optional | :: float |
vertical_acceleration optional | :: float | Has to be >= -0.01 and <= 0.01.
Has to be >= -0.01 and <= 0.01.
mining_particle_frame_speed optional | :: float |
fade_away_duration optional | :: uint16 | Defaults to `life_time` / 5, but at most 60. [...]
Defaults to `life_time` / 5, but at most 60. [...]

Inherited from Prototype

factoriopedia_alternative optional | :: string | The ID type corresponding to the prototype that inherits from this. [...]
The ID type corresponding to the prototype that inherits from this. [...]
custom_tooltip_fields optional | :: array[CustomTooltipField] | Allows to add extra description items to the tooltip and Factoriopedia.
Allows to add extra description items to the tooltip and Factoriopedia.

Inherited from PrototypeBase

type | :: string | Specifies the kind of prototype this is. [...]
Specifies the kind of prototype this is. [...]
name | :: string | Unique textual identification of the prototype. [...]
Unique textual identification of the prototype. [...]
order optional | :: Order | Used to order prototypes in inventory, recipes and GUIs. [...]
Used to order prototypes in inventory, recipes and GUIs. [...]
localised_name optional | :: LocalisedString | Overwrites the name set in the locale file. [...]
Overwrites the name set in the locale file. [...]
localised_description optional | :: LocalisedString | Overwrites the description set in the locale file. [...]
Overwrites the description set in the locale file. [...]
factoriopedia_description optional | :: LocalisedString | Provides additional description used in factoriopedia.
Provides additional description used in factoriopedia.
subgroup optional | :: ItemSubGroupID | The name of an ItemSubGroup.
The name of an ItemSubGroup.
hidden optional | :: boolean |
hidden_in_factoriopedia optional | :: boolean |
parameter optional | :: boolean | Whether the prototype is a special type which can be used to parametrize blueprints and doesn't have other function.
Whether the prototype is a special type which can be used to parametrize blueprints and doesn't have other function.
factoriopedia_simulation optional | :: SimulationDefinition | The simulation shown when looking at this prototype in the Factoriopedia GUI.
The simulation shown when looking at this prototype in the Factoriopedia GUI.

life_time | :: uint16 | Can't be 1.
Can't be 1.
draw_shadow_when_on_ground optional | :: boolean |
ended_in_water_trigger_effect optional | :: TriggerEffect |
ended_on_ground_trigger_effect optional | :: TriggerEffect |
fade_away_duration optional | :: uint16 | Defaults to `life_time` / 5, but at most 60. [...]
Defaults to `life_time` / 5, but at most 60. [...]
mining_particle_frame_speed optional | :: float |
movement_modifier optional | :: float |
movement_modifier_when_on_ground optional | :: float |
pictures optional | :: AnimationVariations | Picture variation count and individual frame count must be equal to shadow variation count.
Picture variation count and individual frame count must be equal to shadow variation count.
regular_trigger_effect optional | :: TriggerEffect |
regular_trigger_effect_frequency optional | :: uint32 | Can't be 1.
Can't be 1.
render_layer optional | :: RenderLayer |
render_layer_when_on_ground optional | :: RenderLayer |
shadows optional | :: AnimationVariations | Shadow variation variation count and individual frame count must be equal to picture variation count.
Shadow variation variation count and individual frame count must be equal to picture variation count.
vertical_acceleration optional | :: float | Has to be >= -0.01 and <= 0.01.
Has to be >= -0.01 and <= 0.01.

Inherited from Prototype

custom_tooltip_fields optional | :: array[CustomTooltipField] | Allows to add extra description items to the tooltip and Factoriopedia.
Allows to add extra description items to the tooltip and Factoriopedia.
factoriopedia_alternative optional | :: string | The ID type corresponding to the prototype that inherits from this. [...]
The ID type corresponding to the prototype that inherits from this. [...]

Inherited from PrototypeBase

name | :: string | Unique textual identification of the prototype. [...]
Unique textual identification of the prototype. [...]
type | :: string | Specifies the kind of prototype this is. [...]
Specifies the kind of prototype this is. [...]
factoriopedia_description optional | :: LocalisedString | Provides additional description used in factoriopedia.
Provides additional description used in factoriopedia.
factoriopedia_simulation optional | :: SimulationDefinition | The simulation shown when looking at this prototype in the Factoriopedia GUI.
The simulation shown when looking at this prototype in the Factoriopedia GUI.
hidden optional | :: boolean |
hidden_in_factoriopedia optional | :: boolean |
localised_description optional | :: LocalisedString | Overwrites the description set in the locale file. [...]
Overwrites the description set in the locale file. [...]
localised_name optional | :: LocalisedString | Overwrites the name set in the locale file. [...]
Overwrites the name set in the locale file. [...]
order optional | :: Order | Used to order prototypes in inventory, recipes and GUIs. [...]
Used to order prototypes in inventory, recipes and GUIs. [...]
parameter optional | :: boolean | Whether the prototype is a special type which can be used to parametrize blueprints and doesn't have other function.
Whether the prototype is a special type which can be used to parametrize blueprints and doesn't have other function.
subgroup optional | :: ItemSubGroupID | The name of an ItemSubGroup.
The name of an ItemSubGroup.

## Properties

### pictures :: AnimationVariations optional

Picture variation count and individual frame count must be equal to shadow variation count.

### life_time :: uint16

Can't be 1.

### shadows :: AnimationVariations optional

Shadow variation variation count and individual frame count must be equal to picture variation count.

### draw_shadow_when_on_ground :: boolean optional

Default: `true`

### regular_trigger_effect :: TriggerEffect optional

### ended_in_water_trigger_effect :: TriggerEffect optional

### ended_on_ground_trigger_effect :: TriggerEffect optional

### render_layer :: RenderLayer optional

Default: `"object"`

### render_layer_when_on_ground :: RenderLayer optional

Default: `"lower-object"`

### regular_trigger_effect_frequency :: uint32 optional

Default: `0`

Can't be 1.

### movement_modifier_when_on_ground :: float optional

Default: `0.8`

### movement_modifier :: float optional

Default: `1`

### vertical_acceleration :: float optional

Default: `-0.004`

Has to be >= -0.01 and <= 0.01.

### mining_particle_frame_speed :: float optional

Default: `0`

### fade_away_duration :: uint16 optional

Defaults to `life_time` / 5, but at most 60. If this is 0, it is silently changed to 1.