screenshot: Difference between revisions

Latest revision as of 15:38, 29 June 2024

Hover & click on the images for description

Description

Description:

Captures a screenshot and stores it to given filename. PNG is the only available format and the file must have .png extension.

The file is saved into 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

Groups:

System

Syntax

Syntax:: screenshot filename
Parameters:: filename: String - 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
Return Value:: 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";

Additional Information

See also:: BIS_fnc_exportEditorPreviews Configuring Asset Previews

Notes

: Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note

Nelis75733126 - c: Posted on Jul 18, 2016 - 18:31 (UTC)
: This command only captures the rendered picture (including ppEffects). GUI nor the mouse are visible on the screenshot. (Arma 3 1.62.137494)

POLPOX - c: Posted on Dec 03, 2017 - 08:42 (UTC)
: Change Sampling on Video Options to make bigger picture than your screen.
For example, 200% sampling on 1920x1080 screen and take screenshot via this command, it will generate a 3840x2160 picture.

Komachi - c: Posted on Mar 20, 2018 - 15:29 (UTC)
: The command will silently fail if your profiles folder is configured to be somewhere else (-profiles parameter), or if your HDR setting is below 16 (configurable in arma3.cfg or medium and above in in-game settings) For full reference on recommended settings consult Eden Editor: Configuring Asset Previews

@@ Line 1: / Line 1: @@
-{{Command|= Comments
+{{RV|type=command
-|arma3 dev|= Game name
-|1.59|= Game version
-| Captures a screenshot and stores it to file filename.<br>The file is saved into the '''Arma 3 directory'''. Image format is PNG.
-{{warning|This command is not final and might be changed in a near future.}}|=
-| [[screenshot]] filename|= Syntax
-|p1= filename: [[String]] |= Parameter 1
-| [[Nothing]] |= RETURNVALUE
-|x1= <code>[[screenshot]] "testFile.png";</code>|= EXAMPLE1
-||= SEEALSO
+|game1= arma3
-|  |= MPBEHAVIOUR
+|version1= 1.60
+|gr1= System
+|descr= Captures a screenshot and stores it to given filename. <u>PNG is the only available format</u> and the file must have .png extension.<br><br>
+The file is saved into ''Screenshots'' folder in the [[Profile]] directory. The folder is by default limited to 250 MB to prevent abuse.<br>
+To increase the limit, add the following line at the end of the profile file:
+<syntaxhighlight lang="cpp">maxScreenShotFolderSizeMB = 2000; // 2 GB</syntaxhighlight>
+|s1= [[screenshot]] filename
+|p1= filename: [[String]] - desired path and name relative to {{hl|&lt;PROFILEDIR&gt;\Screenshots\}} (see [[Profile]]).<br>
+If empty string "" used, the filename will be autogenerated in format: {{hl|YYYY_MM_DD_hh_mm_ss.png}}
+|r1= [[Boolean]] - [[true]] if success
+|x1= <sqf>screenshot "";</sqf>
+|x2= <sqf>screenshot "testFile.png";</sqf>
+|x3= The following code will result in the screenshot being placed in {{hl|\Documents\Arma 3\Screenshots\'''any\where\you\want.png'''}}
+<sqf>screenshot "any\where\you\want.png";</sqf>
+|seealso= [[BIS_fnc_exportEditorPreviews]] [[Eden_Editor:_Configuring_Asset_Previews|Configuring Asset Previews]]
+}}
+{{Note
+|user= Nelis75733126
+|timestamp= 20160718183100
+|text= This command only captures the rendered picture (including ppEffects). GUI nor the mouse are visible on the screenshot. '''(Arma 3 1.62.137494)'''
 }}
-<h3 style='display:none'>Bottom Section</h3>
+{{Note
-[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
+|user= POLPOX
-[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
+|timestamp= 20171203084200
-[[Category:Arma_3:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]
+|text= Change Sampling on Video Options to make bigger picture than your screen.<br>
+For example, 200% sampling on 1920x1080 screen and take screenshot via this command, it will generate a 3840x2160 picture.
+}}
-<h3 style='display:none'>Notes</h3>
+{{Note
-<dl class="command_description">
+|user= Komachi
-<!-- BEGIN Note Section -->
+|timestamp= 20180320152900
-<!-- END Note Section -->
+|text=  The command will silently fail if your profiles folder is configured to be somewhere else (-profiles parameter), or if your HDR setting is below 16 (configurable in arma3.cfg or medium and above in in-game settings)
-</dl>
-<h3 style="display:none">Bottom Section</h3>
+For full reference on recommended settings consult [[Eden Editor: Configuring Asset Previews]]
+}}