BIS_fnc_setVehicleMass

From Bohemia Interactive Community
Jump to navigation Jump to search
Introduced with Arma 3 version 1.00
  Arguments of this scripting function have to be local to the client the function is executed onEffects of this scripting function are broadcasted over the network and happen on every computer in the network

Click on the images for descriptions

Introduced in

Game:
Arma 3
Version:
1.00

Description

Description:
Set mass relative to the default vehicle mass (default mass being vehicle mass on first execution of this function).

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

Execution:
call
Multiplayer:
-
See also:
setMasssetCenterOfMass

Notes

Only post proven facts here. Report bugs on the feedback tracker. Use the talk page or the forums for discussions.
Add New Note | How To

Notes

Bottom Section