BIS fnc getArea: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Text replacement - "= <code>([^<{]+)<\/code>" to "= <sqf>$1</sqf>")
 
(39 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{RV|type=function


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


| arma3 |= Game name
|gr1= Geometry


|1.00|= Game version
|gr2= Map and Markers
____________________________________________________________________________________________


| <pre>/*
|descr= Extracts area information from trigger, marker, location or array
Author:
Killzone_Kid


Description:
|s1= param call [[BIS_fnc_getArea]]
Extracts area information from trigger, marker, location or array


Parameter(s):
|p1= param:
_this:
* [[Object]] - trigger
OBJECT - trigger
* [[String]] - marker
STRING - marker
* [[Location]] - location
ARRAY - array in format [center, distance] or [center, [a, b, angle, rect]] or [center, [a, b, angle, rect, height]]
* [[Array]] - array in format [center, distance] or [center, [a, b, angle, rect]] or [center, [a, b, angle, rect, height]]
LOCATION - location


Returns:
|r1= [[Array]] - in format [center, a, b, angle, isRectangle, height]
ARRAY in format [center, a, b, angle, isRectangle, height]


*/
|x1= <sqf>private _area = [player, 100] call BIS_fnc_getArea;</sqf>
 
// is trigger
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________
 
| <!-- [] call [[BIS_fnc_getArea]]; --> |= Syntax
|p1= |= Parameter 1
 
| |= Return value
____________________________________________________________________________________________
 
|x1= <code></code> |=
____________________________________________________________________________________________
 
| |= See also


|seealso= [[createTrigger]] [[createMarker]] [[setTriggerArea]] [[setMarkerSize]] [[triggerArea]] [[markerSize]] [[inArea]] [[inAreaArray]] [[BIS_fnc_inTrigger]]
}}
}}
<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: Misc|{{uc:getArea}}]]
[[Category:Functions|{{uc:getArea}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:getArea}}]]

Latest revision as of 17:00, 13 July 2022

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

Description

Description:
Extracts area information from trigger, marker, location or array
Execution:
call
Groups:
GeometryMap and Markers

Syntax

Syntax:
param call BIS_fnc_getArea
Parameters:
param:
  • Object - trigger
  • String - marker
  • Location - location
  • Array - array in format [center, distance] or [center, [a, b, angle, rect]] or [center, [a, b, angle, rect, height]]
Return Value:
Array - in format [center, a, b, angle, isRectangle, height]

Examples

Example 1:
private _area = [player, 100] call BIS_fnc_getArea;

Additional Information

See also:
createTrigger createMarker setTriggerArea setMarkerSize triggerArea markerSize inArea inAreaArray BIS_fnc_inTrigger

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_getArea&oldid=328393"