Prototype/TrivialSmoke: Difference between revisions

Revision as of 18:41, 6 August 2019

Prototype definitions » PrototypeBase » Prototype/TrivialSmoke

Smoke, but it's not an entity for optimization purposes.

Prototype/TrivialSmoke — `trivial-smoke`
animation	::	Animation
duration	::	uint32
affected_by_wind	::	bool (optional)
color	::	Color (optional)
cyclic	::	bool (optional)
end_scale	::	double (optional)
fade_away_duration	::	uint32 (optional)
fade_in_duration	::	uint32 (optional)
glow_animation	::	Animation (optional)
glow_fade_away_duration	::	uint32 (optional)
movement_slow_down_factor	::	double (optional)
render_layer	::	RenderLayer (optional)
show_when_smoke_off	::	bool (optional)
spread_duration	::	uint32 (optional)
start_scale	::	double (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.

animation

Type: Animation

Optional properties

glow_animation

Type: Animation

color

Type: Color
Default: {r=0.375, g=0.375, b=0.375, a=0.375}

start_scale

Type: double
Default: 1.0

end_scale

Type: double
Default: 1.0

movement_slow_down_factor

Type: double
Default: 0.995
Value between 0 and 1, with 1 being no movement.

duration

Type: uint32
Default: 0
Smoke may not be cyclic = true if this is set to 0.

spread_duration

Type: uint32
Default: 0

fade_away_duration

Type: uint32
Default: 0
fade_in_duration + fade_away_duration must be <= duration.

fade_in_duration

Type: uint32
Default: 0
fade_in_duration + fade_away_duration must be <= duration.

glow_fade_away_duration

Type: uint32
Default: Value of fade_away_duration

cyclic

Type: bool
Default: false
Smoke must have a duration > 0 if this is set to true.

affected_by_wind

Type: bool
Default: true
Smoke always moves randomly unless movement_slow_down_factor is 1. If affected_by_wind is true, the smoke will also be moved by wind.

show_when_smoke_off

Type: bool
Default: false

render_layer

Type: RenderLayer
Default: "smoke"

@@ Line 1: / Line 1: @@
 {{Prototype parent|PrototypeBase}}
+Smoke, but it's not an entity for optimization purposes.
-== Basics ==
+{{Prototype TOC|trivial-smoke}}
-Prototype type: '''trivial-smoke'''
-Extends [[PrototypeBase]].
 == Mandatory properties ==
 This prototype inherits all the properties from [[PrototypeBase]].
-=== animation ===
+{{Prototype property|animation|[[Types/Animation|Animation]]}}
-'''Type''': [[Types/Animation]]
 == Optional properties ==
-=== glow_animation ===
+{{Prototype property|glow_animation|[[Types/Animation|Animation]]|optional=true}}
-'''Type''': [[Types/Animation]]
-=== color ===
-'''Type''': [[Types/Color]]
-'''Default''': {r=0.375, g=0.375, b=0.375, a=0.375}
-=== start_scale ===
-'''Type''': [[Types/double]]
-'''Default''': 1.0
-=== end_scale ===
-'''Type''': [[Types/double]]
-'''Default''': 1.0
+{{Prototype property|color|[[Types/Color|Color]]|<nowiki>{r=0.375, g=0.375, b=0.375, a=0.375}</nowiki>|optional=true}}
-=== movement_slow_down_factor ===
+{{Prototype property|start_scale|[[Types/double|double]]|1.0|optional=true}}
-'''Type''': [[Types/double]]
-'''Default''': 0.995
+{{Prototype property|end_scale|[[Types/double|double]]|1.0|optional=true}}
+{{Prototype property|movement_slow_down_factor|[[Types/double|double]]|0.995|optional=true}}
 Value between 0 and 1, with 1 being no movement.
-=== duration ===
+{{Prototype property|duration|[[Types/uint32|uint32]]|0|optional=true}}
-'''Type''': [[Types/uint32]]
-'''Default''': 0
 Smoke may not be <code>cyclic</code> = true if this is set to 0.
-=== spread_duration ===
+{{Prototype property|spread_duration|[[Types/uint32|uint32]]|0|optional=true}}
-'''Type''': [[Types/uint32]]
-'''Default''': 0
-=== fade_away_duration ===
-'''Type''': [[Types/uint32]]
-'''Default''': 0
+{{Prototype property|fade_away_duration|[[Types/uint32|uint32]]|0|optional=true}}
 <code>fade_in_duration</code> + <code>fade_away_duration</code> must be <= <code>duration</code>.
-=== fade_in_duration ===
+{{Prototype property|fade_in_duration|[[Types/uint32|uint32]]|0|optional=true}}
-'''Type''': [[Types/uint32]]
-'''Default''': 0
 <code>fade_in_duration</code> + <code>fade_away_duration</code> must be <= <code>duration</code>.
-=== glow_fade_away_duration ===
+{{Prototype property|glow_fade_away_duration|[[Types/uint32|uint32]]|Value of <code>fade_away_duration</code>|optional=true}}
-'''Type''': [[Types/uint32]]
-'''Default''': Value of <code>fade_away_duration</code>
-=== cyclic ===
-'''Type''': [[Types/bool]]
-'''Default''': false
+{{Prototype property|cyclic|[[Types/bool|bool]]|false|optional=true}}
 Smoke must have a <code>duration</code> > 0 if this is set to true.
-=== affected_by_wind ===
+{{Prototype property|affected_by_wind|[[Types/bool|bool]]|true|optional=true}}
-'''Type''': [[Types/bool]]
-'''Default''': true
 Smoke always moves randomly unless <code>movement_slow_down_factor</code> is 1. If <code>affected_by_wind</code> is true, the smoke will also be moved by wind.
-=== show_when_smoke_off ===
+{{Prototype property|show_when_smoke_off|[[Types/bool|bool]]|false|optional=true}}
-'''Type''': [[Types/bool]]
-'''Default''': false
-=== render_layer ===
-'''Type''': [[Types/RenderLayer]]
-'''Default''': "smoke"
+{{Prototype property|render_layer|[[Types/RenderLayer|RenderLayer]]|"smoke"|optional=true}}