BIS fnc isInsideArea: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Text replacement - " +\] +" to "] ")
 
(39 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma3
____________________________________________________________________________________________
|version1= 1.00


| arma3 |= Game name
|gr1= Geometry


|1.00|= Game version
|descr= Detects whether a position is within a square area of given size about center.
____________________________________________________________________________________________


| Detects whether a position is within a square area of given size about center. |DESCRIPTION=
|s1= [center, size, position] call [[BIS_fnc_isInsideArea]]
____________________________________________________________________________________________


| [center, size, position ] call [[BIS_fnc_isInsideArea]] |SYNTAX=
|p1= center: [[Array]] - center [[Position]] of area to check
|p2= size: [[Array]] - [x,y] offsets from center


|p1= center: [[Array]] - Center [[Position]] of area to check |=
|p3= position: [[Array]] - [[Position]] to check
|p2= size: [[Array]] - [x,y] offsets from center |=
|p3= position: [[Array]] - [[Position]] to check |=
| [[Boolean]] - true when position is in area, false otherwise<br />
____________________________________________________________________________________________


|x1= <code>_center = getPos player;
|r1= [[Boolean]] - true when position is in area, false otherwise
_size = [ 5, 5 ];
 
|x1= <sqf>// Check an area, centered on the player that is 10m wide and 10m tall
_size = [5, 5];
_checkPos = getPos player;
_checkPos = getPos player;
//Check an area, centered on the player that is 10m wide and 10m tall
_inArea = [_checkPos, _size, _checkPos] call BIS_fnc_isInsideArea;</sqf>
_inArea = [ _center, _size, _checkPos ] call BIS_fnc_isInsideArea;</code> |=
____________________________________________________________________________________________


| [[createTrigger]] [[createMarker]] [[setTriggerArea]] [[setMarkerSize]] [[triggerArea]] [[markerSize]] |SEEALSO=
|seealso= [[createTrigger]] [[createMarker]] [[setTriggerArea]] [[setMarkerSize]] [[triggerArea]] [[markerSize]] [[BIS_fnc_inAngleSector]]
}}
}}
<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: Geometry|{{uc:isInsideArea}}]]
[[Category:Functions|{{uc:isInsideArea}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:isInsideArea}}]]

Latest revision as of 18:49, 8 November 2023

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

Description

Description:
Detects whether a position is within a square area of given size about center.
Execution:
call
Groups:
Geometry

Syntax

Syntax:
[center, size, position] call BIS_fnc_isInsideArea
Parameters:
center: Array - center Position of area to check
size: Array - [x,y] offsets from center
position: Array - Position to check
Return Value:
Boolean - true when position is in area, false otherwise

Examples

Example 1:
// Check an area, centered on the player that is 10m wide and 10m tall _size = [5, 5]; _checkPos = getPos player; _inArea = [_checkPos, _size, _checkPos] call BIS_fnc_isInsideArea;

Additional Information

See also:
createTrigger createMarker setTriggerArea setMarkerSize triggerArea markerSize BIS_fnc_inAngleSector

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_isInsideArea&oldid=349465"