screenshot: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\|seealso= *\[\[([^ ]+)\]\], \[\[([^ ]+)\]\]" to "|seealso= $1 $2")
m (Some wiki formatting)
(One intermediate revision by the same user not shown)
Line 13: Line 13:
|s1= [[screenshot]] filename
|s1= [[screenshot]] filename


|p1= filename: [[String]] - desired path and name relative {{hl|<USERDIR>\Screenshot\}}.
|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}}
If empty string "" used, the filename will be autogenerated in format: {{hl|YYYY_MM_DD_hh_mm_ss.png}}


|r1= [[Boolean]] - [[true]] if success
|r1= [[Boolean]] - [[true]] if success


|x1= <code>[[screenshot]] "";</code>
|x1= <sqf>screenshot "";</sqf>


|x2= <code>[[screenshot]] "testFile.png";</code>
|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'''}}
|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>
<sqf>screenshot "any\where\you\want.png";</sqf>


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


{{Note
|user= IT07
|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)'''
}}


<dl class="command_description">
{{Note
 
|user= POLPOX
<dt></dt>
|timestamp= 20171203084200
<dd class="notedate">Posted on July 18, 2016 - 18:31 (UTC)</dd>
|text= Change Sampling on Video Options to make bigger picture than your screen.<br>
<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>
 
<dt><dt>
<dd class="notedate">Posted on December 3, 2017 - 08:42 (UTC)</dd>
<dt class="note">[[User:POLPOX|POLPOX]]</dt>
<dd class="note">
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.
For example, 200% sampling on 1920x1080 screen and take screenshot via this command, it will generate a 3840x2160 picture.
</dd>
}}


<dt><dt>
{{Note
<dd class="notedate">Posted on March 20, 2018 - 15:29 (UTC)</dd>
|user= Komachi
<dt class="note">[[User:Komachi|Komachi]]</dt>
|timestamp= 20180320152900
<dd class="note">
|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)
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]]
For full reference on recommended settings consult [[Eden Editor: Configuring Asset Previews]]
</dd>
}}
 
</dl>

Revision as of 21:06, 18 April 2022

Arma 3 logo black.png1.60
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
IT07 - 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
Retrieved from "https://community.bistudio.com/wiki?title=screenshot&oldid=308927"