BIS fnc limitSupport: 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 - "<code> *(\^+\]) +\[\[call\]\] +\[\[(BIS_fnc_[a-zA-Z0-9_]+)\]\];? *<\/code>" to "<sqf>$1 call $2;</sqf>")
 
(12 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|Comments=
{{RV|type=function


| arma3 |Game name=
|game1= arma3
|version1= 1.00


|1.00|Game version=
|gr1= Supports


|gr1 = Supports |GROUP1=
|descr= Limits support runs during a mission.


| Limits support runs during a mission. |DESCRIPTION=
|s1= [module, supportType, quantity] call [[BIS_fnc_limitSupport]]


Parameter(s):
|p1= module: [[Object]] - the requester module
_this select 0: OBJECT - Requester module
_this select 1: STRING - Support type:
"Artillery"
"Transport"
"CAS_Heli"
"CAS_Bombing"
"Drop"
_this select 2: NUMBER - Support run limit
-1: Unlimited
 
| [caller, supportType, quantity] call [[BIS_fnc_limitSupport]] |SYNTAX=
 
|p1= caller: [[Object]] - the unit able to request support |PARAMETER1=


|p2= supportType: [[String]] - can be one of:
|p2= supportType: [[String]] - can be one of:
Line 29: Line 17:
* "CAS_Heli"
* "CAS_Heli"
* "CAS_Bombing"
* "CAS_Bombing"
* "Drop" |PARAMETER2=
* "Drop"
 
|p3= quantity: [[Number]] - support run limit. -1 for unlimited support |PARAMETER3=


| [[Nothing]] |RETURNVALUE=
|p3= quantity: [[Number]] - support run limit. -1 for unlimited support


|x1= <code><nowiki>[</nowiki>[[player]], "Transport", -1] [[call]] [[BIS_fnc_limitSupport]];</code> |EXAMPLE1=
|r1= [[Boolean]] - [[true]] when done


| |SEEALSO=
|x1= <sqf>[reqModule, "Transport", -1] call BIS_fnc_limitSupport;</sqf>


|seealso= [[BIS_fnc_addSupportLink]]
}}
}}
<h3 style="display:none">Bottom Section</h3>
[[Category:Functions|{{uc:limitSupport}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:limitSupport}}]]

Latest revision as of 19:03, 5 May 2022

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

Description

Description:
Limits support runs during a mission.
Execution:
call
Groups:
Supports

Syntax

Syntax:
[module, supportType, quantity] call BIS_fnc_limitSupport
Parameters:
module: Object - the requester module
supportType: String - can be one of:
  • "Artillery"
  • "Transport"
  • "CAS_Heli"
  • "CAS_Bombing"
  • "Drop"
quantity: Number - support run limit. -1 for unlimited support
Return Value:
Boolean - true when done

Examples

Example 1:
[reqModule, "Transport", -1] call BIS_fnc_limitSupport;

Additional Information

See also:
BIS_fnc_addSupportLink

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_limitSupport&oldid=310412"