wiki/ScriptingCandle.md

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

Summary

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

Instance

A Candle 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
get_burning()	Returns true if the candle is lit up.
set_burning(bool burning)	Sets the burning state of the candle. burning - If true, the candle is lit up. If false, it's extinguished.

Constants

None.