BIS fnc moduleFuel: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl> " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...)
Line 1: Line 1:
{{Function|Comments=
{{Function


| arma3 |Game name=
| arma3


|1.00|Game version=
|1.00


|gr1= Modules |GROUP1=
|gr1= Modules


|arg= local |Arguments in MP=
|arg= local |Arguments in MP=
Line 12: Line 12:


| Set fuel of linked units' '''vehicles'''.
| Set fuel of linked units' '''vehicles'''.
{{Informative|Regarding locality: unit's '''vehicle''' must be local to the machine, the unit itself can be remote.}} |Description=
{{Informative|Regarding locality: unit's '''vehicle''' must be local to the machine, the unit itself can be remote.}}


| [logic, units, isActivated] call [[BIS_fnc_moduleFuel]] |Syntax=
| [logic, units, isActivated] call [[BIS_fnc_moduleFuel]]


|p1= logic: [[Object]] - the logic. Possible [[setVariable]] parameter:
|p1= logic: [[Object]] - the logic. Possible [[setVariable]] parameter:
* "value": [[Number]] - (Optional, default 0) wanted fuel level, in range 0..1 |Parameter 1=
* "value": [[Number]] - (Optional, default 0) wanted fuel level, in range 0..1


|p2= units: [[Array]] of [[Object|Objects]] - list of units |Parameter 2=
|p2= units: [[Array]] of [[Object|Objects]] - list of units


|p3= isActivated: [[Boolean]] - (Optional, default [[true]]) if [[true]], the fuel is set |Parameter 3=
|p3= isActivated: [[Boolean]] - (Optional, default [[true]]) if [[true]], the fuel is set


| [[Boolean]] - [[true]] when done, even if ''isActivated'' equals [[false]] |Return value=
| [[Boolean]] - [[true]] when done, even if ''isActivated'' equals [[false]]


|x1= <code>[myLogic, [unit1, unit2, vehicle1], [[true]]] [[call]] [[BIS_fnc_moduleFuel]];</code> |Example 1=
|x1= <code>[myLogic, [unit1, unit2, vehicle1], [[true]]] [[call]] [[BIS_fnc_moduleFuel]];</code>


| [[fuel]], [[setFuel]] |See also=
| [[fuel]], [[setFuel]]
}}
}}


Revision as of 00:09, 18 January 2021

Arma 3 logo black.png1.00
LALocalGEGlobal
Hover & click on the images for description

Description

Description:
Set fuel of linked units' vehicles.
ⓘ
Regarding locality: unit's vehicle must be local to the machine, the unit itself can be remote.
Execution:
call
Groups:
Modules

Syntax

Syntax:
[logic, units, isActivated] call BIS_fnc_moduleFuel
Parameters:
logic: Object - the logic. Possible setVariable parameter:
  • "value": Number - (Optional, default 0) wanted fuel level, in range 0..1
units: Array of Objects - list of units
isActivated: Boolean - (Optional, default true) if true, the fuel is set
Return Value:
Boolean - true when done, even if isActivated equals false

Examples

Example 1:
[myLogic, [unit1, unit2, vehicle1], true] call BIS_fnc_moduleFuel;

Additional Information

See also:
fuelsetFuel

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

Bottom Section

Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_moduleFuel&oldid=203089"