Prototype/Particle
Prototype definitions » PrototypeBase » Prototype/Particle
An entity with a limited lifetime that can use trigger effects
Prototype/Particle — optimized-particle | ||
| life_time | :: | uint16 |
| pictures | :: | AnimationVariations |
| render_layer | :: | RenderLayer |
| render_layer_when_on_ground | :: | RenderLayer |
| draw_shadow_when_on_ground | :: | bool (optional) |
| ended_in_water_trigger_effect | :: | TriggerEffect (optional) |
| ended_on_ground_trigger_effect | :: | TriggerEffect (optional) |
| fade_away_duration | :: | uint16 (optional) |
| mining_particle_frame_speed | :: | float (optional) |
| movement_modifier | :: | double (optional) |
| movement_modifier_when_on_ground | :: | double (optional) |
| regular_trigger_effect | :: | TriggerEffect (optional) |
| regular_trigger_effect_frequency | :: | uint32 (optional) |
| shadows | :: | AnimationVariations (optional) |
| vertical_acceleration | :: | float (optional) |
| Inherited from PrototypeBase | ||
| name | :: | string |
| type | :: | string |
| localised_description | :: | LocalisedString (optional) |
| localised_name | :: | LocalisedString (optional) |
| order | :: | Order (optional) |
Mandatory properties
This prototype inherits all the properties from PrototypeBase.
pictures
Type: AnimationVariations
Picture variation count and individual frame count must be equal to shadow variation count.
life_time
Type: uint16
Can't be 1.
Optional properties
shadows
Type: AnimationVariations
Shadow variation variation count and individual frame count must be equal to picture variation count.
draw_shadow_when_on_ground
Type: bool
Default: true
regular_trigger_effect
Type: TriggerEffect
ended_in_water_trigger_effect
Type: TriggerEffect
ended_on_ground_trigger_effect
Type: TriggerEffect
render_layer
Type: RenderLayer
Default: "object"
render_layer_when_on_ground
Type: RenderLayer
Default: "lower-object"
regular_trigger_effect_frequency
Type: uint32
Default: 0
Can't be 1.
movement_modifier_when_on_ground
Type: double
Default: 0.8
movement_modifier
Type: double
Default: 1
vertical_acceleration
Type: float
Default: -0.004
Has to be >= -0.01 and <= 0.01.
mining_particle_frame_speed
Type: float
Default: 0
fade_away_duration
Type: uint16
Defaults to life_time / 5, but at most 60. If this is 0, it is silently changed to 1.