BIS fnc exportEditorPreviews: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (template:command argument fix)
Line 14: Line 14:
| [duration, type, sides, mods, addons] spawn [[BIS_fnc_exportEditorPreviews]] |SYNTAX=
| [duration, type, sides, mods, addons] spawn [[BIS_fnc_exportEditorPreviews]] |SYNTAX=


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


|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 |= Parameter 2
* "all" - all objects will be used |PARAMETER2=


|p3= sides: [[Array]] of [[Side|Sides]] - (optional, default all sides) list of sides. Only objects of these sides will be used |= Parameter 3
|p3= sides: [[Array]] of [[Side|Sides]] - (optional, default all sides) list of sides. Only objects of these sides will be used |PARAMETER3=


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


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


|exec= spawn |= Execution
|exec= spawn |= Execution
Line 33: Line 33:


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


|x2= <code>{{codecomment|// 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}}
[0.5, "vehicles"] [[spawn]] [[BIS_fnc_exportEditorPreviews]];</code> |= Example 2
[0.5, "vehicles"] [[spawn]] [[BIS_fnc_exportEditorPreviews]];</code> |EXAMPLE2=


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


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


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


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



Revision as of 14:30, 7 April 2019


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