ScriptingCamera

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

Summary

A Camera that was given a name can be manipulated by scripts.

Instance

An instance named Camera (sector.Camera in the console) is available.

The mode of the camera is either normal (the camera is following the player) or autoscroll. In the latter mode the camera is forced along a specified Path.

Methods

Method	Explanation
shake(float duration, float x, float y)	Shakes the camera in a certain direction only 1 time.
start_earthquake(float strength, float delay)	Starts "earthquake" mode, which shakes the camera vertically with a specified average strength, at a certain minimal delay, until stopped.
stop_earthquake()	Stops "earthquake" mode.
set_pos(float x, float y)	Moves the camera to the specified absolute position. The origin is at the top left.
move(float x, float y)	Moves the camera x to the left and y down.
set_mode(string mode)	Sets the camera mode. mode - The mode can be "normal" or "manual".
scroll_to(float x, float y, float scrolltime)	Scrolls the camera to specific coordinates in scrolltime seconds.
get_current_scale()	Returns the current scale factor of the camera.
get_target_scale()	Returns the scale factor the camera is fading towards.
set_scale(float scale)	Sets the scale factor.
set_scale_anchor(float scale, int anchor)	Sets the scale factor and the target position anchor. NOTE: Target position anchor is only applied, if the camera is in "manual" mode. anchor - Anchor point as represented by the ANCHOR_* constants (see AnchorPoints).
scale(float scale, float time)	Fades to a specified scale factor in time seconds.
scale_anchor(float scale, float time, int anchor)	Fades to a specified scale factor and target position anchor in time seconds. NOTE: Target position anchor is only applied, if the camera is in "manual" mode. anchor - Anchor point as represented by the ANCHOR_* constants (see AnchorPoints).
ease_scale(float scale, float time, string ease)	Fades to a specified scale factor in time seconds with easing (smooth movement).
ease_scale_anchor(float scale, float time, int anchor, string ease)	Fades to a specified scale factor and target position anchor in time seconds with easing (smooth movement). NOTE: Target position anchor is only applied, if the camera is in "manual" mode. anchor - Anchor point as represented by the ANCHOR_* constants (see AnchorPoints).
get_screen_width()	Gets the current width of the screen.
get_screen_height()	Gets the current height of the screen.
get_x()	Gets the X coordinate of the top-left corner of the screen.
get_y()	Gets the Y coordinate of the top-left corner of the screen.

Constants

None.