BIS fnc initVehicle: Difference between revisions
Jump to navigation
Jump to search
m (some minor fixes) |
(merged note into examples and various other formatting tweaks) |
||
| Line 11: | Line 11: | ||
|gr1 = Vehicles | |gr1 = Vehicles | ||
| This function changes the textures, animation sources and/or mass of a given vehicle. | | This function changes the textures, animation sources and/or mass of a given vehicle. | ||
The use of '''BIS_fnc_initVehicle_customization''' variable in a vehicle's init field is possible ( | * The use of '''BIS_fnc_initVehicle_customization''' variable in a vehicle's init field is possible ('''Example 4'''). | ||
* Unless explicitly mentioned , the function will restore the initial state of every animation sources of the given object ('''Example 3'''). | |||
''' | |||
| [vehicle, variant, animations, mass] call [[BIS_fnc_initVehicle]] | | [vehicle, variant, animations, mass] call [[BIS_fnc_initVehicle]] | ||
| Line 31: | Line 27: | ||
|p3= animations: (Optional, default [[false]]) | |p3= animations: (Optional, default [[false]]) | ||
* [[Boolean]] - [[true]] to restore init phase of every animation sources | * [[Boolean]] - [[true]] to restore init phase of every animation sources | ||
* [[Array]] - Array of animation sources with their probability, to format {{Inline code|["animationSource1", 0.5, "animationSource2", 0.5]}} | * [[Array]] - Array of animation sources with their probability, to format {{Inline code|["animationSource1", 0.5, "animationSource2", 0.5]}} | ||
{{Important|If the first element is wrong, it will skip the rest of the animation sources!}} | |||
* [[String]] - variant class name - from the <tt>[[configFile]] >> [[CfgVehicles]]</tt> or from the <tt>[[missionConfigFile]] >> [[Description.ext#CfgVehicleTemplates|CfgVehicleTemplates]]</tt> | * [[String]] - variant class name - from the <tt>[[configFile]] >> [[CfgVehicles]]</tt> or from the <tt>[[missionConfigFile]] >> [[Description.ext#CfgVehicleTemplates|CfgVehicleTemplates]]</tt> | ||
| Line 48: | Line 45: | ||
|x4= <code>[[this]] [[setVariable]] ["'''BIS_fnc_initVehicle_customization'''", [[false]], [[false]]]; {{codecomment|// set in an init field}}</code> | |x4= <code>[[this]] [[setVariable]] ["'''BIS_fnc_initVehicle_customization'''", [[false]], [[false]]]; {{codecomment|// set in an init field}}</code> | ||
| [[Vehicle Customization | |x5= <code>{{cc|Randomise camo net options with 50% probability}} | ||
<nowiki>[</nowiki>[[vehicle]] [[player]], [[false]], ["showcamonethull", 0.5, "showcamonetturret", 0.5, "showcamonetcannon", 0.5, "showslathull", 0.5]] [[call]] [[BIS_fnc_initVehicle]];</code> | |||
| [[Arma 3 Vehicle Customization]] [[Description.ext#CfgVehicleTemplates|CfgVehicleTemplates]] [[Description.ext#disableRandomization|disableRandomization]] [http://dev.arma3.com/post/oprep-vehicle-customization OPREP] | |||
|x6= <code>{{cc|Force show all camo net options. Use [[animationNames]] to get all available animation sources. Vehicles that don't support certain animations are simply ignored.}} | |||
<nowiki>[</nowiki>[[vehicle]] [[player]], [[false]], ["showcamonethull", 1, "showcamonetturret", 1, "showcamonetcannon", 1, "showslathull", 1]] [[call]] [[BIS_fnc_initVehicle]]; | |||
</code> | |||
}} | |||
[[Category:Functions|{{uc:initVehicle}}]] | [[Category:Functions|{{uc:initVehicle}}]] | ||
[[Category:{{Name|arma3}}: Functions|{{uc:initVehicle}}]] | [[Category:{{Name|arma3}}: Functions|{{uc:initVehicle}}]] | ||
Revision as of 17:17, 29 January 2021
Description
- Description:
- Description needed
- Execution:
- call
- Groups:
- Vehicles
Syntax
- Syntax:
- Syntax needed
- Parameters:
- vehicle: Object - vehicle to customize
- variant: (Optional, default false)
- Boolean - true to restore default texture source, false to skip texture source change
- Array - Array of texture sources with their probability, to format
["textureSource1", 0.5, "textureSource2", 0.5] - String - Variant class name - from the configFile >> CfgVehicles or from the missionConfigFile >> CfgVehicleTemplates
- Number - index of the texture source (same as the old system)
- animations: (Optional, default false)
- Boolean - true to restore init phase of every animation sources
- Array - Array of animation sources with their probability, to format
["animationSource1", 0.5, "animationSource2", 0.5]
- String - variant class name - from the configFile >> CfgVehicles or from the missionConfigFile >> CfgVehicleTemplates
- mass: (Optional, default false)
- Return Value:
- Return value needed
Examples
- Example 1:
result = [this, "", []] call BIS_fnc_initVehicle;- Example 2:
result = [this, ["MyTextureSource1", 0.5, "MyTextureSource2", 0.6], []] call BIS_fnc_initVehicle;- Example 3:
result = [this, nil, ["MyAnimationSource1", 0.5, "MyAnimationSource2", 0.7]] call BIS_fnc_initVehicle;- Example 4:
this setVariable ["BIS_fnc_initVehicle_customization", false, false]; // set in an init field- Example 5:
// Randomise camo net options with 50% probability [vehicle player, false, ["showcamonethull", 0.5, "showcamonetturret", 0.5, "showcamonetcannon", 0.5, "showslathull", 0.5]] call BIS_fnc_initVehicle;- Example 6:
// Force show all camo net options. Use animationNames to get all available animation sources. Vehicles that don't support certain animations are simply ignored. [vehicle player, false, ["showcamonethull", 1, "showcamonetturret", 1, "showcamonetcannon", 1, "showslathull", 1]] call BIS_fnc_initVehicle;
Additional Information
- See also:
- See also needed
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