BIS fnc controlPoint isArrive: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Created page with "{{Function|= Comments | arma3 |Game name= |1.78|Game version= <!---|arg= local |Multiplayer Arguments=---> <!---|eff= local |Multiplayer Effects=---> | <pre>/* Author: N...")
 
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *T([a-z ])" to "$1 - t$2")
 
(20 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Function|= Comments
{{RV|type=function


| arma3 |Game name=
|game1= arma3
|version1= 1.78


|1.78|Game version=
|gr1= ControlPoint


<!---|arg= local |Multiplayer Arguments=--->
|descr= Whether given control point is arrive, not leave.


<!---|eff= local |Multiplayer Effects=--->
|s1= [controlPoint] call [[BIS_fnc_controlPoint_isArrive]]


| <pre>/*
|p1= controlPoint: [[Object]] - the control point
Author: Nelson Duarte <@Nelson_G_Duarte>


Description:
|r1= [[Boolean]] - returns [[true]] if control point is arrive, [[false]] if leave
Whether given control point is arrive, not leave


Parameter(s):
|x1= <sqf>private _isArrive = [controlPoint] call BIS_fnc_controlPoint_isArrive;</sqf>
_this select 0: Object - The control point


Returns:
|seealso= [[BIS_fnc_controlPoint_compute]] [[BIS_fnc_controlPoint_computeOwnerKey]] [[BIS_fnc_controlPoint_getOwnerKey]] [[BIS_fnc_controlPoint_setIsArrive]]
Bool - True if control point is Arrive, not Leave
*/</pre>{{Informative|Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]]}} |Description=
 
|[] call [[BIS_fnc_controlPoint_isArrive]]|Syntax=
 
|p1= parameter: Datatype - (Optional, default defValue) description |Parameter 1=
 
|Datatype - description|Return value=
 
|x1= <code></code>|Example 1=
 
|exec= call |Execution=
 
| |See also=
}}
}}
[[Category:Function Group: ControlPoint|{{uc:controlPoint_isArrive}}]]
[[Category:Functions|{{uc:controlPoint_isArrive}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:controlPoint_isArrive}}]]

Latest revision as of 16:51, 8 November 2023

Hover & click on the images for description

Description

Description:
Whether given control point is arrive, not leave.
Execution:
call
Groups:
ControlPoint

Syntax

Syntax:
[controlPoint] call BIS_fnc_controlPoint_isArrive
Parameters:
controlPoint: Object - the control point
Return Value:
Boolean - returns true if control point is arrive, false if leave

Examples

Example 1:
private _isArrive = [controlPoint] call BIS_fnc_controlPoint_isArrive;

Additional Information

See also:
BIS_fnc_controlPoint_compute BIS_fnc_controlPoint_computeOwnerKey BIS_fnc_controlPoint_getOwnerKey BIS_fnc_controlPoint_setIsArrive

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