wiki/ScriptingRain.md

Note: This file is auto-generated from the SuperTux scripting interface source code, using the template ScriptingPage.md.

Summary

A RainParticleSystem that was given a name can be controlled by scripts.

Instance

A RainParticleSystem is instantiated by placing a definition inside a level. It can then be accessed by its name from a script or via sector.name from the console.

Methods

Method	Explanation
set_enabled(bool enable)	Enables/disables the system.
get_enabled()	Returns true if the system is enabled.
fade_speed(float speed, float time)	Smoothly changes the rain speed to the given value in time seconds.
fade_amount(float amount, float time)	Smoothly changes the amount of particles to the given value in time seconds.
fade_angle(float angle, float time, string ease)	Smoothly changes the angle of the rain the given value in time seconds, according to the provided easing function.

Constants

None.