BIS fnc setVehicleMass: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " *\| *(Effects?|Arguments?) *=" to "")
m (Some wiki formatting)
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{RV|type=function
{{RV|type=function


| arma3
|game1= arma3
|version1= 1.00


|1.00
|gr1= Object Manipulation
 
|gr1 = Object Manipulation


|arg= local
|arg= local
Line 11: Line 10:
|eff= global
|eff= global


| Set mass relative to the default vehicle mass (default mass being vehicle mass on first execution of this function).
|descr= Set mass relative to the default vehicle mass (default mass being vehicle mass on first execution of this function).


| [vehicle, animationInformation, massDifference] call [[BIS_fnc_setVehicleMass]]
|s1= [vehicle, animationInformation, massDifference] call [[BIS_fnc_setVehicleMass]]


|p1= vehicle: [[Object]]
|p1= vehicle: [[Object]]


|p2= animationInformation: [[Boolean]] or [[Array]] - (Optional, default {{Inline code|[]}})
|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 23: Line 22:
|p3= massDifference: [[Number]] - (Optional, default 0) value to add to the mass (can be negative)
|p3= massDifference: [[Number]] - (Optional, default 0) value to add to the mass (can be negative)


| [[Boolean]] - success state
|r1= [[Boolean]] - success state
 
2) Doesn't care about the current phase of animations, it will change the mass for the given sources
 
3) Will do the same as the first example, then, subtract 150 to the mass


|x1= <code>{{cc| default behaviour, change the mass according to the current phase of the animation sources}}result = [<nowiki/>[[this]]]        [[call]] [[BIS__fnc_setVehicleMass]];
|x1= <sqf>
result = [<nowiki/>[[this]], [], 0] [[call]] [[BIS_fnc_setVehicleMass]];</code>
// 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;
</sqf>


|x2= <code>{{cc| doesn't care about the current phase of animations, it will change the mass for the given sources}}result = [<nowiki/>[[this]], ["source1", 1, "source2", 0]] [[call]] [[BIS_fnc_initVehicle]];</code>
|x2= <sqf>
// 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}}result = [<nowiki/>[[this]], [], -150] [[call]] [[BIS_fnc_initVehicle]];</code>
|x3= <sqf>
// will do the same as the first example, then subtract 150 to the mass
result = [this, [], -150] call BIS_fnc_initVehicle;
</sqf>


| [[setMass]], [[setCenterOfMass]]
|seealso= [[setMass]] [[setCenterOfMass]]
}}
}}
[[Category:Functions|{{uc:setVehicleMass}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:setVehicleMass}}]]

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"