BIS fnc setVehicleMass: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\|seealso= ([^ ]+)(\]\]|\}\}), *(\[\[|\{\{)" to "|seealso= $1$2 $3")
m (Some wiki formatting)
 
(One intermediate revision by the same user not shown)
Line 16: Line 16:
|p1= vehicle: [[Object]]
|p1= vehicle: [[Object]]


|p2= animationInformation: [[Boolean]] or [[Array]] - (Optional, default {{ic|[]}})
|p2= animationInformation: [[Boolean]] or [[Array]] - (Optional, default <sqf inline>[]</sqf>)
* [[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, ...]
Line 24: Line 24:
|r1= [[Boolean]] - success state
|r1= [[Boolean]] - success state


|x1= <code>{{cc|default behaviour, change the mass according to the current phase of the animation sources}}
|x1= <sqf>
result = [<nowiki/>[[Magic Variables#this_2|this]]]        [[call]] [[BIS_fnc_setVehicleMass]];
// default behaviour, change the mass according to the current phase of the animation sources
result = [<nowiki/>[[Magic Variables#this_2|this]], [], 0] [[call]] [[BIS_fnc_setVehicleMass]];</code>
result = [this] call BIS_fnc_setVehicleMass;
result = [this, [], 0] call BIS_fnc_setVehicleMass;
</sqf>


|x2= <code>{{cc|doesn't care about the current phase of animations, it will change the mass for the given sources}}
|x2= <sqf>
result = [<nowiki/>[[Magic Variables#this_2|this]], ["source1", 1, "source2", 0]] [[call]] [[BIS_fnc_initVehicle]];</code>
// 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;
</sqf>


|x3= <code>{{cc|will do the same as the first example, then subtract 150 to the mass}}
|x3= <sqf>
result = [<nowiki/>[[Magic Variables#this_2|this]], [], -150] [[call]] [[BIS_fnc_initVehicle]];</code>
// will do the same as the first example, then subtract 150 to the mass
result = [this, [], -150] call BIS_fnc_initVehicle;
</sqf>


|seealso= [[setMass]] [[setCenterOfMass]]
|seealso= [[setMass]] [[setCenterOfMass]]
}}
}}

Latest revision as of 14:59, 13 July 2022

Arma 3 logo black.png1.00
LALocalGEGlobal
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:
setMass setCenterOfMass

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_setVehicleMass&oldid=327965"