BIS fnc setVehicleMass: Difference between revisions
Jump to navigation
Jump to search
m (1 revision imported: BIS Functions update 7/7) |
Lou Montana (talk | contribs) (Page filling) |
||
| Line 1: | Line 1: | ||
{{Function|Comments= | |||
____________________________________________________________________________________________ | |||
| arma3 |Game name= | |||
|1.00|Game version= | |||
| | |arg= local |Arguments= | ||
| | |eff= global |Effect= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| | | Set mass relative to the default vehicle mass (default mass being vehicle mass on first execution of this function). |Description= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| | | [vehicle, animationInformation, massDifference] call [[BIS_fnc_setVehicleMass]] |Syntax= | ||
| |= Return value | |p1= vehicle: [[Object]] |Parameter 1= | ||
|p2= animationInformation: [[Boolean]] or [[Array]] - (Optional, default {{Inline code|[]}}) | |||
* [[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, ...] |Parameter 2= | |||
|p3= massDifference: [[Number]] - (Optional, default 0) value to add to the mass (can be negative) |Parameter 3= | |||
| [[Boolean]] - success state |Return value= | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
|x1= <code></code> |= | 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>{{codecomment|// default behaviour, change the mass according to the current phase of the animation sources}} | |||
result = <nowiki>[</nowiki>[[this]]] [[call]] [[BIS__fnc_setVehicleMass]]; | |||
result = <nowiki>[</nowiki>[[this]], [], 0] [[call]] [[BIS_fnc_setVehicleMass]];</code> |Example 1= | |||
|x2= <code>{{codecomment|// doesn't care about the current phase of animations, it will change the mass for the given sources}} | |||
result = <nowiki>[</nowiki>[[this]], ["source1", 1, "source2", 0]] [[call]] [[BIS_fnc_initVehicle]];</code> |Example 2= | |||
|x3= <code>{{codecomment|// will do the same as the first example, then subtract 150 to the mass}} | |||
result = <nowiki>[</nowiki>[[this]], [], -150] [[call]] [[BIS_fnc_initVehicle]];</code> |Example 3= | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| | | | [[setMass]], [[setCenterOfMass]] |See also= | ||
}} | }} | ||
| Line 32: | Line 53: | ||
<h3 style="display:none">Bottom Section</h3> | <h3 style="display:none">Bottom Section</h3> | ||
[[Category:Functions|{{uc:setVehicleMass}}]] | |||
[[Category:Function Group: Vehicles|{{uc:setVehicleMass}}]] | [[Category:Function Group: Vehicles|{{uc:setVehicleMass}}]] | ||
[[Category:{{Name|arma3}}: Functions|{{uc:setVehicleMass}}]] | [[Category:{{Name|arma3}}: Functions|{{uc:setVehicleMass}}]] | ||
Revision as of 13:50, 10 July 2018
Description
- Description:
- Set mass relative to the default vehicle mass (default mass being vehicle mass on first execution of this function).
- Execution:
- call
- Groups:
- Uncategorised
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