Prototype/TrivialSmoke

Prototype definitions » PrototypeBase » Prototype/TrivialSmoke

Smoke, but it's not an entity for optimization purposes. Only 255 instances of this prototype may be defined.

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

duration

Type: uint32
Can't be 0 - the smoke will never render.

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 slowdown and 0 being no movement.

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

affected_by_wind

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

show_when_smoke_off