wiki/ScriptingCandle.md

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

Summary

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

Instances

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.

Inheritance

This class inherits functions and variables from the following base classes:

• MovingSprite
• MovingObject
• GameObject
• CollisionListener

Methods

Method	Explanation
void puff_smoke()	Spawns a puff of smoke.
bool get_burning()	Returns true if the candle is lit up.
void set_burning(bool burning)	Sets the burning state of the candle. burning - If true, the candle is lit up. If false, it's extinguished.

Variables

Variable	Explanation
bool burning	The burning state of the candle.true if candle is currently lighted

Constants

None.