Global Command: createScreenshot

Function History
Available since v3.7

Create a screenshot to be used for the next savegame or to save into an external folder as a .png file.

Syntax

createScreenshot(filename, {flags=1, clear})

Parameters

Parameter	Type/Structure		Description
filename	string		If specified the screenshot will be saved to the given path. If not specified the screenshot will be used for the next savegame(s), until a new screenshot is created or the current screenshot is cleared. If a screenshot for a savegame was created before it will be overwritten by the new screenshot.
flags	table	flags = 1	indicates flags table
		clear (bool)	If true the screenshot will be cleared. Default value is false. If the screenshot is cleared, savegame screenshots will be generated automatically by the engine again (everytime the scene is changed from a playable scene to a menu).

Return values

none

Examples

Example 1: Save a screenshot to a folder (if a file with the same name exists, it will be overwritten)

-- save to "screenshots" folder as "filename.png"
createScreenshot("screenshots/filename.png")

-- save to "screenshots" folder with current timestamp as "filename_(date)_(time).png"
local time = os.date("%Y-%m-%d_%Hh-%Mm-%Ss")
createScreenshot("screenshots/filename_" .. time .. ".png")

Example 2: Save a screenshot to use for the next savegame

createScreenshot()

Example 3: Clear the previously saved savegame screenshot

createScreenshot("", {flags=1, clear = true})