screenshot

Description

Takes a screenshot of the 3D scene and saves it to the provided filename.

• Only the 3D scene is captured, no GUI/cursor
• Sampling is taken in consideration: a 200% sampling value on a 1920x1080 resolution takes a 3840x2160 screenshot
• PNG is the only available format

The file is saved in the Screenshots folder in the Profile directory. The folder is by default limited to 250 MB to prevent abuse.

To increase the limit, add the following line at the end of the profile file:

maxScreenShotFolderSizeMB = 2000; // 2 GB

Syntax

screenshot filename

Parameters:

• filename: String - must have .png extension; desired path and name relative to <PROFILEDIR>\Screenshots\ (see Profile).

  If empty string "" used, the filename will be autogenerated in format: YYYY_MM_DD_hh_mm_ss.png

Returns: Boolean - true if success

Examples

Example 1

screenshot "";

Example 2

screenshot "testFile.png";

Example 3

The following code will result in the screenshot being placed in \Documents\Arma 3\Screenshots\**any\where\you\want.png**:

screenshot "any\where\you\want.png";

See also

BIS_fnc_exportEditorPreviews · Eden Editor: Configuring Asset Previews