Top

Secret Chronicles of the Scripting API documentation

Module TSC

Module encapsulating stuff related to the game itself.

Module Methods

average_framerate

average_framerate() → integer

The average frames per second (FPS).

best_framerate

best_framerate() → integer

The best frames per second (FPS).

current_framerate

current_framerate() → integer

The current frames per second (FPS).

debug_mode?

debug_mode?() → true or false

Checks if this TSC has been compiled in debug mode, and if so, returns true, false otherwise.

exit

exit( exitcode )

Immediately and forcibly terminates TSC without any cleanup.

0 <= exitcode < 255 is the range for exitcode.

platform

platform() → a_string

Information about the platform TSC was compiled for.

Return value

One of :win32, :linux, :apple, or :other. Please notify us if you get :other from this method.

quit

quit()

Instructs TSC to terminate the main loop, exiting the game as if regularily closed.

version

version() → a_string

TSC’s version number in the form major.minor.patch.

worst_framerate

worst_framerate() → integer

The worst frames per second (FPS).