Screenshot extension

This extension lets you save a screenshot of the running game in a specified folder.

Warning

Taking a screenshot writes a file directly to the computer's file system, so it only works in games exported for Windows, Linux and macOS (desktop). It has no effect in the web export or on mobile (Android/iOS).

To use it, just add an action and search for screenshot or go to Other Actions/Screenshot/Take screenshot.

Actions

Take screenshot

Use this action to save a screenshot of everything which is currently drawn on the game window into a png file.

Parameters:

Save path: The file path where the screenshot should be saved.

The save path needs to be an absolute path on the file system (like C:\MyFolder\MyScreenshot.png on Windows).

Relative paths are not supported.

If the path does not already end with .png, the extension is added automatically, so MyScreenshot is saved as MyScreenshot.png.

Note

In order to create a game that runs on all supported platforms you should use the special folders from the file system extension in combination with the path separator. These determine the path to common folders like Pictures, Documents or Desktop automatically. You can read more about it in this article.

Example

This path:

FileSystem::PicturesPath() + FileSystem::PathDelimiter() + "my_screenshot.png"

This will save the screenshot to the Pictures folder on Windows, Linux and MacOS.

Reference

All actions, conditions and expressions are listed in the screenshot extension reference page.