v0.12.0

Usage

local System = require("tofu.core.system")

Functions

System.args() : table

Returns a table with the command-line arguments passed to the engine executable at launch-time. This mimics the argv array for a C/C++ program, with the exception the first entry (the one indicating the executable itself) is not present.

System.version() : integer, integer, integer

Return a tuple of three values stating the run-time version of the game engine (major, minor, and revision).

System.information() : table

Return a table holding information about the current machine, with four string fields: system, release, version and architecture. An example table is the following:

{
  system = "Linux",
  release = "5.11.0-34-generic",
  version = "#36-Ubuntu SMP Thu Aug 26 19:22:09 UTC 2021",
  architecture = "x86_64"
}

System.clock() : number

Returns the current internal clock in seconds. This is totally unrelated to System.time() as it advances autonomously by means of the system real-time clock. A typical usage is to profile some piece of Lua code (like the standard os.clock() function).

System.time() : number

Returns the elapsed amount of seconds since the launch of the game-engine.

The timer advances on constant steps, according to the configured engine frequency. Also, it is kept constant during the engine callbacks functions.

System.date(format = “%Y-%m-%dT%H:%M:%S” : string, timezone = “local” : string) : string

Returns the current date as string, according to the format specification. According to the timezone argument, the date can be either interpreted according to the local timezone or gmt.

System.fps() : integer

Returns the current frame-per-seconds counter, as moving average of the last 128 samples.

System.stats() : number, number, number, number ¹

Returns a tuple of four value, each indicating the time (in seconds) spent in a different part of the frame time: process, update, render, and (total) frame time. Like for the FPS, each value is filtered using a moving average of 128 samples.

System.heap(type = “b” : string) : number ¹

Returns the current heap usage amount. This is the grand-total of the memory used by the application. The optional argument type can be used to specify if the amount should be expressed in bytes, kilobytes, or megabytes.

System.is_active() : boolean

Tells whether the game-engine is the current active (i.e. focused) window. Can be used to automatically “pause” the game when the user switch to another application.

System.quit()

Signals and halts the game-engine execution.