BIS fnc limitSupport: Difference between revisions

Latest revision as of 19:03, 5 May 2022

1.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

@@ Line 1: / Line 1: @@
+{{RV|type=function
-{{Function|Comments=
+|game1= arma3
-____________________________________________________________________________________________
+|version1= 1.00
-| arma3 |Game name=
+|gr1= Supports
-|1.00|Game version=
+|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:
@@ Line 31: / Line 17: @@
 * "CAS_Heli"
 * "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">Notes</h3>
-<dl class="command_description">
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
-</dl>
-<h3 style="display:none">Bottom Section</h3>
-[[Category:Function Group: Supports|{{uc:limitSupport}}]]
-[[Category:Functions|{{uc:limitSupport}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:limitSupport}}]]