BIS fnc exportEditorPreviews: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Created page for BIS_fnc_exportEditorPreview with examples from https://community.bistudio.com/wiki/Eden_Editor:_Configuring_Asset_Previews)
 
m (Text replacement - "Category:Eden Editor" to "Eden Editor")
 
(44 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma3
____________________________________________________________________________________________
|version1= 1.60


| arma3 |= Game name
|gr1= Diagnostic


|1.60|= Game version
|descr= Export screenshots of objects for [[:Category:Eden Editor|Eden Editor]] and Community Wiki to {{hl|<Arma 3 Profile>\Screenshots\EditorPreviews}} directory. See [[:Category:Arma 3: Assets|Arma 3 assets]].
____________________________________________________________________________________________
{{Feature|informative|
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; // size in MB</syntaxhighlight>
}}


| <pre>/*
|s1= [duration, type, sides, mods, addons, classes] spawn [[BIS_fnc_exportEditorPreviews]]


Description:
|p1= duration: [[Number]] - (Optional, default 1) duration in seconds for which an objects remains on the screen before its screen is captured
Export list of objects for Community Wiki
http://community.bistudio.com/wiki/Category:Arma_3:_Assets


Parameter(s):
|p2= type: [[String]] - (Optional, default "all") can be one of:
0: NUMBER - duration in seconds for which an objects remains on the screen before its screen is captured (default: 1 s)
* "vehicles" - only characters and vehicles will be used
1: STRING:
* "props" - only props will be used
"vehicles" - only characters and vehicles will be used
* "all" - all objects will be used
"props" - only props will be used
"all" (default) - all objects will be used
2: ARRAY of SIDEs - list of sides. Only objects of these sides will be used  (default: all sides)
3: ARRAY of STRINGs - list of CfgMods classes. Only objects belonging to these mods will be used (default: all mods)
3: ARRAY of STRINGs - list of CfgPatches classes. Only objects belonging to these addons will be used (default: all addons)


Returns:
|p3= sides: [[Array]] of [[Side]]s - (Optional, default all sides) list of sides. Only objects of these sides will be used
Nothing
*/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
|p4= mods: [[Array]] of [[String]] - (Optional, default all mods) list of CfgMods classes. Only objects belonging to these mods will be used
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_exportEditorPreviews]]; --> |= Syntax
|p5= addons: [[Array]] of [[String]] - (Optional, default all addons) list of CfgPatches classes. Only objects belonging to these addons will be used


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


| |= Return value
|exec= spawn
____________________________________________________________________________________________


|x1= All objects:
|r1= [[Nothing]]
<code>0 = [] spawn BIS_fnc_exportEditorPreviews;</code> |= EXAMPLE1


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


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


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


|x5= All objects in specified addons:
|x4= <sqf>// Props in Karts DLC
<code>0 = [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= BLUFOR characters and vehicles in Marksmen DLC:
|x5= <sqf>// All objects in specified addons
<code>0 = [nil,"vehicles",[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>
____________________________________________________________________________________________


| [[screenshot]] |= See also
|x6= <sqf>// BLUFOR characters and vehicles in Marksmen DLC
[nil, "vehicles", [west], ["mark"]] spawn BIS_fnc_exportEditorPreviews;</sqf>


|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">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Diagnostic|{{uc:exportEditorPreviews}}]]
[[Category:Functions|{{uc:exportEditorPreviews}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:exportEditorPreviews}}]]

Latest revision as of 13:27, 9 July 2023

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