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 (Text replacement - "\|game([0-9])=([^ ]+) * \|version([0-9])=([^ ]+) * " to "|game$1=$2 |version$3=$4 ")
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|Comments=
{{RV|type=function
____________________________________________________________________________________________


| arma3 |Game name=
|game1= arma3
|version1= 1.98


| 1.98 |Game version=
|gr1= Object Manipulation
____________________________________________________________________________________________


| <pre>/*
|descr= Draws bounding box around given objects.
Description:
Draw bounding box around given objects


Parameter(s):
|s1= [objects, color, draw] call [[BIS_fnc_drawBoundingBox]]
_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:  
|p1= objects: [[Array]] - (Optional, default [[objNull]]) [[Array]] of [[Object|Objects]]
[[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=
|p2= color: [[Array]] - (Optional, default [1,0,1,1]) [[Array]] in format [R,G,B,A]
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_drawBoundingBox]]; --> |Syntax=
|p3= draw: [[Boolean]] - (Optional, default nil) [[true]] to draw, [[false]] to remove


|p1= |Parameter 1=
|r1= [[Boolean]] - [[true]] is successful, [[false]] if not


| |Return value=
|x1= <code>[<nowiki>[</nowiki>BIS_building],  [1,0,1,1], [[true]]<nowiki>]</nowiki> [[call]] [[BIS_fnc_drawBoundingBox]];</code>
____________________________________________________________________________________________


|x1= <code></code> |Example 1=
|x2= <code>[<nowiki>[</nowiki>], [], [[false]]<nowiki>]</nowiki> [[call]] [[BIS_fnc_drawBoundingBox]];</code>
____________________________________________________________________________________________


| |See also=
|seealso= [[boundingBoxReal]] [[boundingBox]]
}}
}}
<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: Systems|{{uc:drawBoundingBox}}]]

Revision as of 11:07, 14 June 2021

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

Description

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

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=281292"