Prototype/Particle: Difference between revisions

Revision as of 21:13, 5 August 2019

Prototype definitions » PrototypeBase » Prototype/Particle

An entity with a limited lifetime that can use trigger effects

Prototype/Particle — `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)

Extensions

Prototype/ArtilleryFlare artillery-flare
Prototype/LeafParticle leaf-particle

Mandatory properties

This prototype inherits all the properties from Prototype/Entity.

pictures

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

life_time

Type: uint16

Optional properties

shadows

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

regular_trigger_effect

Type: TriggerEffect

regular_trigger_effect_frequency

Type: uint32
Default: 0

ended_in_water_trigger_effect

Type: TriggerEffect

movement_modifier_when_on_ground

Type: double
Default: 0.8

movement_modifier

Type: double
Default: 1

mining_particle_frame_speed

Type: float
Default: 0

@@ Line 1: / Line 1: @@
 {{Prototype parent|Prototype/Entity}}
+An entity with a limited lifetime that can use trigger effects
-== Basics ==
+{{Prototype TOC|particle}}
-Prototype type: '''particle'''
-Extends [[Prototype/Entity]].
 == Extensions ==
@@ Line 13: / Line 11: @@
 This prototype inherits all the properties from [[Prototype/Entity]].
-=== pictures ===
+{{Prototype property|pictures|[[Types/AnimationVariations|AnimationVariations]]}}
-'''Type''': [[Types/AnimationVariations]]
 Picture variation count and individual frame count must be equal to shadow variation count.
-=== life_time ===
+{{Prototype property|life_time|[[Types/uint16|uint16]]}}
-'''Type''': [[Types/uint16]]
 == Optional properties ==
-=== shadows ===
+{{Prototype property|shadows|[[Types/AnimationVariations|AnimationVariations]]|optional=true}}
-'''Type''': [[Types/AnimationVariations]]
 Shadow variation variation count and individual frame count must be equal to picture variation count.
-=== regular_trigger_effect ===
+{{Prototype property|regular_trigger_effect|[[Types/TriggerEffect|TriggerEffect]]|optional=true}}
-'''Type''': [[Types/TriggerEffect]]
-=== regular_trigger_effect_frequency ===
-'''Type''': [[Types/uint32]]
-'''Default''': 0
-=== ended_in_water_trigger_effect ===
-'''Type''': [[Types/TriggerEffect]]
-=== movement_modifier_when_on_ground ===
-'''Type''': [[Types/double]]
-'''Default''': 0.8
+{{Prototype property|regular_trigger_effect_frequency|[[Types/uint32|uint32]]|0|optional=true}}
-=== movement_modifier ===
+{{Prototype property|ended_in_water_trigger_effect|[[Types/TriggerEffect|TriggerEffect]]|optional=true}}
-'''Type''': [[Types/double]]
-'''Default''': 1
+{{Prototype property|movement_modifier_when_on_ground|[[Types/double|double]]|0.8|optional=true}}
-=== mining_particle_frame_speed ===
+{{Prototype property|movement_modifier|[[Types/double|double]]|1|optional=true}}
-'''Type''': [[Types/float]]
-'''Default''': 0
+{{Prototype property|mining_particle_frame_speed|[[Types/float|float]]|0|optional=true}}