screenshot: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - " \{\{GameCategory *\| *arma3 *\| *(New )?Scripting Commands\}\}" to "") |
Lou Montana (talk | contribs) m (Some wiki formatting) |
||
| Line 1: | Line 1: | ||
{{RV|type=command | {{RV|type=command | ||
| arma3 | |game1= arma3 | ||
|1.60 | |version1= 1.60 | ||
|gr1= System | |gr1= System | ||
| Captures a screenshot and stores it to given filename. <u>PNG is the only available format</u> and the file must have .png extension. | |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> | ||
<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> | ||
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: | To increase the limit, add the following line at the end of the profile file: | ||
< | <syntaxhighlight lang="cpp">maxScreenShotFolderSizeMB = 2000; // 2 GB</syntaxhighlight> | ||
|s1= | |s1= [[screenshot]] filename | ||
|p1= filename: [[String]] - desired path and name relative <tt> | |p1= filename: [[String]] - desired path and name relative <tt><USERDIR>\Screenshot\</tt>. | ||
If empty string "" used, the filename will be autogenerated in format: <tt>YYYY_MM_DD_hh_mm_ss.png</tt> | |||
|r1= [[Boolean]] - [[true]] if success | |r1= [[Boolean]] - [[true]] if success | ||
| Line 24: | Line 22: | ||
|x2= <code>[[screenshot]] "testFile.png";</code> | |x2= <code>[[screenshot]] "testFile.png";</code> | ||
|x3= The following code will result in the screenshot being placed in \Documents\Arma 3\Screenshots\any\where\you\want.png | |x3= The following code will result in the screenshot being placed in <tt>\Documents\Arma 3\Screenshots\'''any\where\you\want.png'''</tt> | ||
<code>[[screenshot]] "any\where\you\want.png";</code> | <code>[[screenshot]] "any\where\you\want.png";</code> | ||
| [[BIS_fnc_exportEditorPreview]], [[Eden_Editor:_Configuring_Asset_Previews|Configuring Asset Previews]] | |seealso= [[BIS_fnc_exportEditorPreview]], [[Eden_Editor:_Configuring_Asset_Previews|Configuring Asset Previews]] | ||
}} | }} | ||
| Line 57: | Line 54: | ||
For full reference on recommended settings consult [[Eden Editor: Configuring Asset Previews]] | For full reference on recommended settings consult [[Eden Editor: Configuring Asset Previews]] | ||
</dd> | </dd> | ||
</dl> | </dl> | ||
Revision as of 15:12, 13 June 2021
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 <USERDIR>\Screenshot\. 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
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
- Posted on July 18, 2016 - 18:31 (UTC)
- IT07
- This command only captures the rendered picture (including ppEffects). GUI nor the mouse are visible on the screenshot. (Arma 3 1.62.137494)
- Posted on December 3, 2017 - 08:42 (UTC)
- POLPOX
-
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. - Posted on March 20, 2018 - 15:29 (UTC)
- Komachi
- 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