BIS fnc setVehicleMass: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - " *\| *(Effects?|Arguments?) *=" to "") |
Lou Montana (talk | contribs) m (revert + fix) |
||
| Line 1: | Line 1: | ||
{{RV|type=function | {{RV|type=function | ||
| arma3 | |game1= arma3 | ||
|1.00 | |version1= 1.00 | ||
|gr1 = Object Manipulation | |gr1= Object Manipulation | ||
|arg= local | |arg= local | ||
| Line 11: | Line 11: | ||
|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]] | ||
| Line 23: | Line 23: | ||
|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 | ||
|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= <code>{{cc| default behaviour, change the mass according to the current phase of the animation sources}}result = [<nowiki/>[[this]]] [[call]] [[ | |||
result = [<nowiki/>[[this]], [], 0] [[call]] [[BIS_fnc_setVehicleMass]];</code> | result = [<nowiki/>[[this]], [], 0] [[call]] [[BIS_fnc_setVehicleMass]];</code> | ||
|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= <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> | |||
|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= <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> | |||
| [[setMass]], [[setCenterOfMass]] | |seealso= [[setMass]], [[setCenterOfMass]] | ||
}} | }} | ||
Revision as of 20:12, 29 January 2021
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
[]) - 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