screenshot: Difference between revisions

From Bohemia Interactive Community
(autogenerated format)
(Add ppEffects info)
 
(46 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma3 |= Game name
|game1= arma3
|1.60|= Game version
|version1= 1.60
____________________________________________________________________________________________


| Captures a screenshot and stores it to given filename. <u>PNG is the only available format</u> and the file must have .png extension.
|gr1= System
<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.
|descr=
<br />
 
{{{!}} class="wikitable align-center-col-2 float-right"
! [[Post Process Effects|Post-Process Effect]]
! Active in<br>screenshot
{{!}}-
{{!}} ColorInversion
{{!}} {{Icon|unchecked}}
{{!}}-
{{!}} FilmGrain
{{!}} {{Icon|unchecked}}
{{!}}-
{{!}} ColorCorrections
{{!}} {{Icon|unchecked}}
{{!}}-
{{!}} DynamicBlur
{{!}} {{Icon|checked}}
{{!}}-
{{!}} WetDistortion
{{!}} {{Icon|checked}}
{{!}}-
{{!}} ChromaticAberration
{{!}} {{Icon|checked}}
{{!}}-
{{!}} RadialBlur
{{!}} {{Icon|checked}}
{{!}}-
{{!}} SSAO
{{!}} {{Icon|unknown}}
{{!}}-
{{!}} Resolution
{{!}} {{Icon|checked}}
{{!}}}
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
<br>
The file is saved in the ''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:
<code>maxScreenShotFolderSizeMB <nowiki>=</nowiki> 2000;</code>
<syntaxhighlight lang="cpp">maxScreenShotFolderSizeMB = 2000; // 2 GB</syntaxhighlight>
2000 can be replaced by any value in MB.
 
|=
|s1= [[screenshot]] filename
____________________________________________________________________________________________


| [[screenshot]] filename|= Syntax
|p1= filename: [[String]] - '''must''' have {{hl|.png}} extension; desired path and name relative to {{hl|&lt;PROFILEDIR&gt;\Screenshots\}} (see [[Profile]]).<br>
If empty string <sqf inline>""</sqf> used, the filename will be autogenerated in format: {{hl|YYYY_MM_DD_hh_mm_ss.png}}


|p1= filename: [[String]] - desired path and name relative <tt>%USERPROFILE%\Screenshot\</tt>. If empty string "" used, the filename will be autogenerated in format: <tt>YYYY_MM_DD_hh_mm_ss.png</tt> |= Parameter 1
|r1= [[Boolean]] - [[true]] if success


| [[Nothing]] |= RETURNVALUE
|x1= <sqf>screenshot "";</sqf>
____________________________________________________________________________________________
|x1= <code>[[screenshot]] "";</code>|= EXAMPLE1


|x2= <code>[[screenshot]] "testFile.png";</code>|= EXAMPLE2
|x2= <sqf>screenshot "testFile.png";</sqf>


|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 {{hl|\Documents\Arma 3\Screenshots\'''any\where\you\want.png'''}}:
<code>[[screenshot]] "any\where\you\want.png";</code>|= EXAMPLE3
<sqf>screenshot "any\where\you\want.png";</sqf>


| [[BIS_fnc_exportEditorPreview]], [[Eden_Editor:_Configuring_Asset_Previews|Configuring Asset Previews]] |= SEEALSO
|seealso= [[BIS_fnc_exportEditorPreviews]] [[Eden_Editor:_Configuring_Asset_Previews|Configuring Asset Previews]]
|  |= MPBEHAVIOUR
}}
}}


<h3 style='display:none'>Bottom Section</h3>
{{Note
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
|user= Komachi
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
|timestamp= 20180320152900
[[Category:Arma_3:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]
|text= The command will silently fail if your profiles folder is configured to be somewhere else ({{hl|-profiles}} parameter), or if your HDR setting is below 16 (configurable in arma3.cfg or medium and above in in-game settings)


<h3 style='display:none'>Notes</h3>
For full reference on recommended settings consult [[Eden Editor: Configuring Asset Previews]].
<dl class="command_description">
}}
<!-- BEGIN Note Section -->
<!-- END Note Section -->
</dl>
 
<h3 style="display:none">Bottom Section</h3>
 
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on July 18, 2016 - 18:31 (UTC)</dd>
<dt class="note">[[User:IT07|IT07]]</dt>
<dd class="note">
This command only captures the rendered picture (including ppEffects). GUI nor the mouse are visible on the screenshot. '''(ArmA 3 1.62.137494)'''
</dd>
</dl>
<!-- DISCONTINUE Notes -->

Latest revision as of 11:26, 11 April 2025

Arma 3 logo black.png1.60
Hover & click on the images for description

Description

Description:
Post-Process Effect Active in
screenshot
ColorInversion Unchecked
FilmGrain Unchecked
ColorCorrections Unchecked
DynamicBlur Checked
WetDistortion Checked
ChromaticAberration Checked
RadialBlur Checked
SSAO Unknown
Resolution Checked

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
Groups:
System

Syntax

Syntax:
screenshot filename
Parameters:
filename: String - must have .png extension; desired path and name relative to <PROFILEDIR>\Screenshots\ (see Profile).
If empty string c"" used, the filename will be autogenerated in format: YYYY_MM_DD_hh_mm_ss.png
Return Value:
Boolean - true if success

Examples

Example 1:
Copy
screenshot "";
Example 2:
Copy
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:
Copy
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
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.
Retrieved from "https://community.bistudio.com/wiki?title=screenshot&oldid=373186"