BIS fnc drawBoundingBox: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "^ {{Function\|Comments\=" to "{{Function|Comments=")
m (page filled)
Line 1: Line 1:
{{Function|Comments=
{{Function
____________________________________________________________________________________________


| arma3 |Game name=
|game1= arma3


| 1.98 |Game version=
|version1= 1.98
____________________________________________________________________________________________


| <pre>/*
<!--|serverExec= server-->
Description:
Draw bounding box around given objects


Parameter(s):
<!--|arg= local-->
_this select 0: ARRAY of objects
_this select 1: ARRAY in format of COLOR (R,G,B,A)
_this select 2: BOOL  whether the function should draw or not
Returns:
Bool status


Example:
<!--|eff= local-->
[[BIS_building],  [1,0,1,1], true] call bis_fnc_drawBoundingBox; to add
[[], [], false] call bis_fnc_drawBoundingBox; to remove
*/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |Description=
|descr= Draws bounding box around given objects.
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_drawBoundingBox]]; --> |Syntax=
|s1= [_objects, _color, _draw] call [[BIS_fnc_drawBoundingBox]]


|p1= |Parameter 1=
|p1= _objects: [[Array]] - (Optional, default [[objNull]]) [[Array]] of [[Object|Objects]]


| |Return value=
|p2= _color: [[Array]] - (Optional, default [1,0,1,1]) [[Array]] in format [R,G,B,A]
____________________________________________________________________________________________


|x1= <code></code> |Example 1=
|p3= _draw: [[Boolean]] - (Optional, default nil) [[True]] to draw, [[false]] to remove
____________________________________________________________________________________________


| |See also=
|r1= [[Boolean]] - [[True]] is successful, [[false]] if not
}}
 
|x1= <code>[<nowiki>[</nowiki>BIS_building],  [1,0,1,1], [[true]]<nowiki>]</nowiki> [[call]] [[BIS_fnc_drawBoundingBox]];</code>
 
|x2= <code>[<nowiki>[</nowiki>], [], [[false]]<nowiki>]</nowiki> [[call]] [[BIS_fnc_drawBoundingBox]];</code>


<h3 style="display:none">Notes</h3>
|exec= call
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|seealso= [[boundingBoxReal]] [[boundingBox]]
</dl>


<h3 style="display:none">Bottom Section</h3>
}}
[[Category:Function Group: Systems|{{uc:drawBoundingBox}}]]

Revision as of 11:50, 4 June 2020

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

Description

Description:
Draws bounding box around given objects.
Execution:
call
Groups:
Uncategorised

Syntax

Syntax:
[_objects, _color, _draw] call BIS_fnc_drawBoundingBox
Parameters:
_objects: Array - (Optional, default objNull) Array of Objects
_color: Array - (Optional, default [1,0,1,1]) Array in format [R,G,B,A]
_draw: Boolean - (Optional, default nil) True to draw, false to remove
Return Value:
Boolean - True is successful, false if not

Examples

Example 1:
[[BIS_building], [1,0,1,1], true] call BIS_fnc_drawBoundingBox;
Example 2:
[[], [], false] call BIS_fnc_drawBoundingBox;

Additional Information

See also:
boundingBoxReal boundingBox

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_drawBoundingBox&oldid=153845"