BIS fnc exportEditorPreviews: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl>" to "")
m (Some wiki formatting)
(22 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Function|Comments=
{{RV|type=function


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


|1.60|Game version=
|gr1= Diagnostic


|gr1= Diagnostic |GROUP1=
|descr= Export screenshots of objects for [[Eden Editor]] and Community Wiki to {{hl|<Arma 3 Profile>\Screenshots\EditorPreviews}} directory. See [[:Category:Arma 3: Assets|Arma 3 assets]].
 
{{Feature|informative|
| Export screeenshots of objects for [[Eden Editor]] and Community Wiki to {{Inline code|<Arma 3 Profile>\Screenshots\EditorPreviews}} directory.<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>
See [[:Category:Arma_3:_Assets|Arma 3 assets]].
<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:
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; // size in MB</syntaxhighlight>
2000 can be replaced by any value in MB. |DESCRIPTION=
}}


| [duration, type, sides, mods, addons] spawn [[BIS_fnc_exportEditorPreviews]] |SYNTAX=
|s1= [duration, type, sides, mods, addons, classes] spawn [[BIS_fnc_exportEditorPreviews]]


|p1= duration: [[Number]] - (optional, default 1) duration in seconds for which an objects remains on the screen before its screen is captured |PARAMETER1=
|p1= duration: [[Number]] - (Optional, default 1) duration in seconds for which an objects remains on the screen before its screen is captured


|p2= type: [[String]] - (Optional, default "all") can be one of:
|p2= type: [[String]] - (Optional, default "all") can be one of:
* "vehicles" - only characters and vehicles will be used
* "vehicles" - only characters and vehicles will be used
* "props" - only props will be used
* "props" - only props will be used
* "all" - all objects will be used |PARAMETER2=
* "all" - all objects will be used
 
|p3= sides: [[Array]] of [[Side|Sides]] - (optional, default all sides) list of sides. Only objects of these sides will be used |PARAMETER3=


|p4= mods: [[Array]] of [[String]] - (Optional, default all mods) list of CfgMods classes. Only objects belonging to these mods will be used |PARAMETER4=
|p3= sides: [[Array]] of [[Side]]s - (Optional, default all sides) list of sides. Only objects of these sides will be used


|p5= addons: [[Array]] of [[String]] - (Optional, default all addons) list of CfgPatches classes. Only objects belonging to these addons will be used|PARAMETER5=
|p4= mods: [[Array]] of [[String]] - (Optional, default all mods) list of CfgMods classes. Only objects belonging to these mods will be used


|p6= classes: [[Array]] of [[String]] - (Optional, default all classes) list of CfgVehicles classes. Only these objects will be used|PARAMETER6=
|p5= addons: [[Array]] of [[String]] - (Optional, default all addons) list of CfgPatches classes. Only objects belonging to these addons will be used


|exec= spawn |Execution=
|p6= classes: [[Array]] of [[String]] - (Optional, default all classes) list of CfgVehicles classes. Only these objects will be used


| [[Nothing]] |RETURNVALUE=
|exec= spawn


|x1= <code>{{codecomment|// All objects}}
|r1= [[Nothing]]
[] [[spawn]] [[BIS_fnc_exportEditorPreviews]];</code> |EXAMPLE1=


|x2= <code>{{codecomment|// All characters and vehicles. Capturing delay will be 0.5 seconds}}
|x1= <sqf>// All objects
[0.5, "vehicles"] [[spawn]] [[BIS_fnc_exportEditorPreviews]];</code> |EXAMPLE2=
[] spawn BIS_fnc_exportEditorPreviews;</sqf>


|x3= <code>{{codecomment|// BLUFOR characters and vehicles}}
|x2= <sqf>// All characters and vehicles. Capturing delay will be 0.5 seconds
<nowiki>[</nowiki>[[nil]], "vehicles", [<nowiki/>[[west]]]] [[spawn]] [[BIS_fnc_exportEditorPreviews]];</code> |EXAMPLE3=
[0.5, "vehicles"] spawn BIS_fnc_exportEditorPreviews;</sqf>


|x4= <code>{{codecomment|// Props in Karts DLC}}
|x3= <sqf>// BLUFOR characters and vehicles
<nowiki>[</nowiki>[[nil]], "props", [], ["kart"]] [[spawn]] [[BIS_fnc_exportEditorPreviews]];</code> |EXAMPLE4=
[nil, "vehicles", [west]] spawn BIS_fnc_exportEditorPreviews;</sqf>


|x5= <code>{{codecomment|// All objects in specified addons}}
|x4= <sqf>// Props in Karts DLC
<nowiki>[</nowiki>[[nil]], "all", [], [], ["A3_Armor_F_Slammer", "A3_Air_F_Heli_Heli_Transport_03"]] [[spawn]] [[BIS_fnc_exportEditorPreviews]];</code> |EXAMPLE5=
[nil, "props", [], ["kart"]] spawn BIS_fnc_exportEditorPreviews;</sqf>


|x6= <code>{{codecomment|// BLUFOR characters and vehicles in Marksmen DLC}}
|x5= <sqf>// All objects in specified addons
<nowiki>[</nowiki>[[nil]], "vehicles", [<nowiki/>[[west]]], ["mark"]] [[spawn]] [[BIS_fnc_exportEditorPreviews]];</code> |EXAMPLE6=
[nil, "all", [], [], ["A3_Armor_F_Slammer", "A3_Air_F_Heli_Heli_Transport_03"]] spawn BIS_fnc_exportEditorPreviews;</sqf>


|x7= <code>{{codecomment|// Only the B_Soldier_F}}
|x6= <sqf>// BLUFOR characters and vehicles in Marksmen DLC
<nowiki>[</nowiki>[[nil]], "all", [], [], [], ["B_Soldier_F"]] [[spawn]] [[BIS_fnc_exportEditorPreviews]];</code> |EXAMPLE7=
[nil, "vehicles", [west], ["mark"]] spawn BIS_fnc_exportEditorPreviews;</sqf>


| [[screenshot]], [[Eden_Editor:_Configuring_Asset_Previews|Configuring Asset Previews]] |SEEALSO=
|x7= <sqf>// Only the B_Soldier_F
[nil, "all", [], [], [], ["B_Soldier_F"]] spawn BIS_fnc_exportEditorPreviews;</sqf>


|seealso= [[screenshot]] [[Eden_Editor:_Configuring_Asset_Previews|Configuring Asset Previews]]
}}
}}
<h3 style="display:none">Bottom Section</h3>
[[Category:Functions|{{uc:exportEditorPreviews}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:exportEditorPreviews}}]]

Revision as of 12:51, 27 July 2022

Hover & click on the images for description

Description

Description:
Export screenshots of objects for Eden Editor and Community Wiki to <Arma 3 Profile>\Screenshots\EditorPreviews directory. See Arma 3 assets.
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; // size in MB
Execution:
spawn
Groups:
Diagnostic

Syntax

Syntax:
[duration, type, sides, mods, addons, classes] spawn BIS_fnc_exportEditorPreviews
Parameters:
duration: Number - (Optional, default 1) duration in seconds for which an objects remains on the screen before its screen is captured
type: String - (Optional, default "all") can be one of:
  • "vehicles" - only characters and vehicles will be used
  • "props" - only props will be used
  • "all" - all objects will be used
sides: Array of Sides - (Optional, default all sides) list of sides. Only objects of these sides will be used
mods: Array of String - (Optional, default all mods) list of CfgMods classes. Only objects belonging to these mods will be used
addons: Array of String - (Optional, default all addons) list of CfgPatches classes. Only objects belonging to these addons will be used
classes: Array of String - (Optional, default all classes) list of CfgVehicles classes. Only these objects will be used
Return Value:
Nothing

Examples

Example 1:
// All objects [] spawn BIS_fnc_exportEditorPreviews;
Example 2:
// All characters and vehicles. Capturing delay will be 0.5 seconds [0.5, "vehicles"] spawn BIS_fnc_exportEditorPreviews;
Example 3:
// BLUFOR characters and vehicles [nil, "vehicles", [west]] spawn BIS_fnc_exportEditorPreviews;
Example 4:
// Props in Karts DLC [nil, "props", [], ["kart"]] spawn BIS_fnc_exportEditorPreviews;
Example 5:
// All objects in specified addons [nil, "all", [], [], ["A3_Armor_F_Slammer", "A3_Air_F_Heli_Heli_Transport_03"]] spawn BIS_fnc_exportEditorPreviews;
Example 6:
// BLUFOR characters and vehicles in Marksmen DLC [nil, "vehicles", [west], ["mark"]] spawn BIS_fnc_exportEditorPreviews;
Example 7:
// Only the B_Soldier_F [nil, "all", [], [], [], ["B_Soldier_F"]] spawn BIS_fnc_exportEditorPreviews;

Additional Information

See also:
screenshot 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