BIS fnc saveVehicle: Difference between revisions

Latest revision as of 23:57, 8 April 2024

1.00

Hover & click on the images for description

Description

Description:: Save vehicle's params (textures, animations, crew).
Execution:: call
Groups:: Vehicles

Syntax

Syntax:

[object,target,params,delete] call BIS_fnc_saveVehicle

Parameters:

object: Object - vehicle

target: Array - in format:

0: Namespace, Group or Object - Where the save will be saved
1: String - Name of the save

params: Array - (Optional, default []) additional parameters to be saved

delete: Boolean - (Optional, default false) true to delete the save

Return Value:

Array - saved value

Examples

Example 1:: [BIS_tank, [missionNamespace, "BIS_someTankSave"], ["SomeRandomParam"], false] call BIS_fnc_saveVehicle;

Additional Information

See also:: BIS_fnc_initVehicle BIS_fnc_loadVehicle Arma 3: Vehicle Customisation

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

@@ Line 1: / Line 1: @@
+{{RV|type=function
-{{Function|= Comments
+|game1= arma3
-____________________________________________________________________________________________
+|version1= 1.00
-| arma3 |= Game name
+|gr1= Vehicles
-|1.00|= Game version
+|descr= Save vehicle's params (textures, animations, crew).
-____________________________________________________________________________________________
-| <pre>/*
+|s1= [object,target,params,delete] call [[BIS_fnc_saveVehicle]]
-	Author: Karel Moricky
-	Description:
+|p1= object: [[Object]] - vehicle
-	Save vehicle's params (textures, animations, crew)
+|p2= target: [[Array]] - in format:
+*0: [[Namespace]], [[Group]] or [[Object]] - Where the save will be saved
+*1: [[String]] - Name of the save
+|p3= params: [[Array]] - (Optional, default <sqf inline>[]</sqf>) additional parameters to be saved
+|p4= delete: [[Boolean]] - (Optional, default [[false]]) [[true]] to delete the save
-	Parameter(s):
+|r1= [[Array]] - saved value
-: OBJECT - saved vehicle
-: ARRAY in format
-: NAMESPACE or GROUP or OBJECT - target in which namespace the loadout will be saved
-: STRING - name
-(Optional): ARRAY - custom params to be saved along the params (default: [])
-(Optional): BOOL - true to delete the save (default: false)
-	Returns:
+|x1= <sqf>[BIS_tank, [missionNamespace, "BIS_someTankSave"], ["SomeRandomParam"], false] call BIS_fnc_saveVehicle;</sqf>
-	ARRAY - saved value
-*/
-</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
-____________________________________________________________________________________________
-| <!-- [] call [[BIS_fnc_saveVehicle]]; --> |= Syntax
-|p1= |= Parameter 1
-| |= Return value
-____________________________________________________________________________________________
-|x1= <code></code> |=
-____________________________________________________________________________________________
-| |= See also
+|seealso= [[BIS_fnc_initVehicle]] [[BIS_fnc_loadVehicle]] [[Arma 3: Vehicle Customisation]]
 }}
-<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: Vehicles|{{uc:saveVehicle}}]]
-[[Category:Functions|{{uc:saveVehicle}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:saveVehicle}}]]