BIS fnc setVehicleMass: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "this" to "this")
m (Text replacement - "{{Inline code|" to "{{ic|")
Line 17: Line 17:
|p1= vehicle: [[Object]]
|p1= vehicle: [[Object]]


|p2= animationInformation: [[Boolean]] or [[Array]] - (Optional, default {{Inline code|[]}})
|p2= animationInformation: [[Boolean]] or [[Array]] - (Optional, default {{ic|[]}})
* [[Boolean]] - [[true]] to take current animations mass in consideration, [[false]] to set "raw" mass
* [[Boolean]] - [[true]] to take current animations mass in consideration, [[false]] to set "raw" mass
* [[Array]] - animation sources and phases to format ["animationSource1", 1, "animationSource2", 0, ...]
* [[Array]] - animation sources and phases to format ["animationSource1", 1, "animationSource2", 0, ...]

Revision as of 19:09, 27 February 2021

Hover & click on the images for description

Description

Description:
Set mass relative to the default vehicle mass (default mass being vehicle mass on first execution of this function).
Execution:
call
Groups:
Object Manipulation

Syntax

Syntax:
[vehicle, animationInformation, massDifference] call BIS_fnc_setVehicleMass
Parameters:
vehicle: Object
animationInformation: Boolean or Array - (Optional, default [])
  • Boolean - true to take current animations mass in consideration, false to set "raw" mass
  • Array - animation sources and phases to format ["animationSource1", 1, "animationSource2", 0, ...]
massDifference: Number - (Optional, default 0) value to add to the mass (can be negative)
Return Value:
Boolean - success state

Examples

Example 1:
// default behaviour, change the mass according to the current phase of the animation sources result = [this] call BIS_fnc_setVehicleMass; result = [this, [], 0] call BIS_fnc_setVehicleMass;
Example 2:
// doesn't care about the current phase of animations, it will change the mass for the given sources result = [this, ["source1", 1, "source2", 0]] call BIS_fnc_initVehicle;
Example 3:
// will do the same as the first example, then subtract 150 to the mass result = [this, [], -150] call BIS_fnc_initVehicle;

Additional Information

See also:
setMasssetCenterOfMass

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