BIS fnc exportEditorPreviews: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Cleaned up name of Configuring Asset Previews in see also)
(Page filling and comment cleanup)
Line 8: Line 8:
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>/*
| Export screeenshots of objects for [[Eden Editor]] and Community Wiki to {{Inline code|<Arma 3 Profile>\Screenshots\EditorPreviews}} directory.<br />
See [[:Category:Arma_3:_Assets|Arma 3 assets]]. |= Description
____________________________________________________________________________________________


Description:
| [duration, type, sides, mods, addons] spawn [[BIS_fnc_exportEditorPreviews]] |= Syntax
Export list of objects for Community Wiki
http://community.bistudio.com/wiki/Category:Arma_3:_Assets


Parameter(s):
|p1= duration: [[Number]] - (optional, default 1) duration in seconds for which an objects remains on the screen before its screen is captured |= Parameter 1
0: NUMBER - duration in seconds for which an objects remains on the screen before its screen is captured (default: 1 s)
1: STRING:
"vehicles" - only characters and vehicles 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:
|p2= type: [[String]] - (Optional, default "all") can be one of:
Nothing
* "vehicles" - only characters and vehicles will be used
*/
* "props" - only props will be used
* "all" - all objects will be used |= Parameter 2


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


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


|p1= |= Parameter 1
|exec= spawn |= Execution


| |= Return value
| [[Nothing]] |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= All objects:
|x1= <code>{{codecomment|// All objects}}
<code>0 = [] spawn BIS_fnc_exportEditorPreviews;</code> |= EXAMPLE1
[] [[spawn]] [[BIS_fnc_exportEditorPreviews]];</code> |= Example 1


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


|x3= BLUFOR characters and vehicles:
|x3= <code>{{codecomment|// BLUFOR characters and vehicles}}
<code>0 = [nil,"vehicles",[west]] spawn BIS_fnc_exportEditorPreviews;</code> |= EXAMPLE3
<nowiki>[</nowiki>[[nil]], "vehicles", <nowiki>[</nowiki>[[west]]]] [[spawn]] [[BIS_fnc_exportEditorPreviews]];</code> |= Example 3


|x4= Props in Karts DLC:
|x4= <code>{{codecomment|// Props in Karts DLC}}
<code>0 = [nil,"props",[],["kart"]] spawn BIS_fnc_exportEditorPreviews;</code> |= EXAMPLE4
<nowiki>[</nowiki>[[nil]], "props", [], ["kart"]] [[spawn]] [[BIS_fnc_exportEditorPreviews]];</code> |= Example 4


|x5= All objects in specified addons:
|x5= <code>{{codecomment|// All objects in specified addons}}
<code>0 = [nil,"all",[],[],["A3_Armor_F_Slammer","A3_Air_F_Heli_Heli_Transport_03"]] spawn BIS_fnc_exportEditorPreviews;</code> |= EXAMPLE5
<nowiki>[</nowiki>[[nil]], "all", [], [], ["A3_Armor_F_Slammer", "A3_Air_F_Heli_Heli_Transport_03"]] [[spawn]] [[BIS_fnc_exportEditorPreviews]];</code> |= Example 5


|x6= BLUFOR characters and vehicles in Marksmen DLC:
|x6= <code>{{codecomment|// BLUFOR characters and vehicles in Marksmen DLC}}
<code>0 = [nil,"vehicles",[west],["mark"]] spawn BIS_fnc_exportEditorPreviews;</code> |= EXAMPLE6
<nowiki>[</nowiki>[[nil]], "vehicles", <nowiki>[</nowiki>[[west]]], ["mark"]] [[spawn]] [[BIS_fnc_exportEditorPreviews]];</code> |= Example 6
____________________________________________________________________________________________
____________________________________________________________________________________________


Line 72: Line 66:
[[Category:Functions|{{uc:exportEditorPreviews}}]]
[[Category:Functions|{{uc:exportEditorPreviews}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:exportEditorPreviews}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:exportEditorPreviews}}]]
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on June 5, 2016 - 00:29 (UTC)</dd>
<dt class="note">[[User:Pennyworth|Pennyworth]]</dt>
<dd class="note">
The function will go through given objects and automatically create screenshots for them in the following folder:
<code><Arma 3 Profile>\Screenshots\EditorPreviews</code>
</dd>
</dl>
<!-- DISCONTINUE Notes -->

Revision as of 16:47, 25 April 2018


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

Description

Description:
Export screeenshots of objects for Eden Editor and Community Wiki to <Arma 3 Profile>\Screenshots\EditorPreviews directory.
See Arma 3 assets.
Execution:
spawn
Groups:
Uncategorised

Syntax

Syntax:
[duration, type, sides, mods, addons] 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: String - (Optional, default all mods) list of CfgMods classes. Only objects belonging to these mods will be used
addons: String - (Optional, default all addons) list of CfgPatches classes. Only objects belonging to these addons 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;

Additional Information

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

Notes

Bottom Section

Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_exportEditorPreviews&oldid=106780"