BIS fnc exportCfgWeapons: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Add links to comment now that this is possible)
 
(42 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{RV|type=function


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


| arma3 |= Game name
|gr1= Diagnostic


|1.00|= Game version
|descr= Export list of weapons for Community Wiki [[:Category:Arma 3: Assets|Arma 3 Assets Category]].
____________________________________________________________________________________________


| <pre>/*
|s1= [mode, patches, types] spawn [[BIS_fnc_exportCfgWeapons]]


Description:
|p1= mode: [[String]] - can be one of:
Export list of weapons for Community Wiki
* "Equipment"
http://community.bistudio.com/wiki/Category:Arma_3:_Assets
* "Item"
* "VehicleWeapon"
* "Weapon" - specific item type, based on [[BIS_fnc_itemType]]
* internal use only: "screenshots" - create items one by one and take their screenshot. Works only on "Render" terrain.
* internal use only: "screenshotsTest" - create items one by one without taking screen (to verify everything is ok)


Parameter(s):
|p2= patches: [[Array]] of [[String]]s - (Optional, default <sqf inline>[]</sqf>) list of [[CfgPatches]] classes. Only weapons belonging to these addons will be used
0: STRING - mode
"Weapon", "VehicleWeapon", "Item" - specific item type, based on BIS_fnc_itemType
"screenshots" - create items one by one and take their screenshot. Works only on "Render" terrain.
"screenshotsTest" - create items one by one without taking screen (to verify everything is ok)


1: ARRAY of STRINGs - list of CfgPatches classes. Only weapons belonging to these addons will be used doesn't work, ToDo)
|p3= types: [[Array]] of [[String]]s - (Optional, default <sqf inline>[]</sqf>)


Returns:
|r1= [[Boolean]] - [[true]] when done
BOOL
*/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
|x1= <sqf>
____________________________________________________________________________________________
["Weapon"] spawn BIS_fnc_exportCfgWeapons; // exports [[Arma 3: CfgWeapons Weapons]]
["VehicleWeapon"] spawn BIS_fnc_exportCfgWeapons; // exports [[Arma 3: CfgWeapons Vehicle Weapons]]
["Item"] spawn BIS_fnc_exportCfgWeapons; // exports [[Arma 3: CfgWeapons Items]]
["Equipment"] spawn BIS_fnc_exportCfgWeapons; // exports [[Arma 3: CfgWeapons Equipment]]
["screenshots"] spawn BIS_fnc_exportCfgWeapons; // screenshots
["screenshotsTest"] spawn BIS_fnc_exportCfgWeapons; // screenshots test mode, does nothing
</sqf>


| <!-- [] call [[BIS_fnc_exportCfgWeapons]]; --> |= Syntax
|seealso= [[:Category:Function Group: Diagnostic|Diagnostic Function Group]]
 
|p1= |= Parameter 1
 
| |= Return value
____________________________________________________________________________________________
 
|x1= <code></code> |=
____________________________________________________________________________________________
 
| |= See also


|exec= spawn
}}
}}
<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:exportCfgWeapons}}]]
[[Category:Functions|{{uc:exportCfgWeapons}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:exportCfgWeapons}}]]

Latest revision as of 18:46, 15 March 2024

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

Description

Description:
Export list of weapons for Community Wiki Arma 3 Assets Category.
Execution:
spawn
Groups:
Diagnostic

Syntax

Syntax:
[mode, patches, types] spawn BIS_fnc_exportCfgWeapons
Parameters:
mode: String - can be one of:
  • "Equipment"
  • "Item"
  • "VehicleWeapon"
  • "Weapon" - specific item type, based on BIS_fnc_itemType
  • internal use only: "screenshots" - create items one by one and take their screenshot. Works only on "Render" terrain.
  • internal use only: "screenshotsTest" - create items one by one without taking screen (to verify everything is ok)
patches: Array of Strings - (Optional, default []) list of CfgPatches classes. Only weapons belonging to these addons will be used
types: Array of Strings - (Optional, default [])
Return Value:
Boolean - true when done

Examples

Example 1:
["Weapon"] spawn BIS_fnc_exportCfgWeapons; // exports Arma 3: CfgWeapons Weapons ["VehicleWeapon"] spawn BIS_fnc_exportCfgWeapons; // exports Arma 3: CfgWeapons Vehicle Weapons ["Item"] spawn BIS_fnc_exportCfgWeapons; // exports Arma 3: CfgWeapons Items ["Equipment"] spawn BIS_fnc_exportCfgWeapons; // exports Arma 3: CfgWeapons Equipment ["screenshots"] spawn BIS_fnc_exportCfgWeapons; // screenshots ["screenshotsTest"] spawn BIS_fnc_exportCfgWeapons; // screenshots test mode, does nothing

Additional Information

See also:
Diagnostic Function Group

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_exportCfgWeapons&oldid=353282"