BIS fnc drawBoundingBox: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (remove _ from parameters)
m (Some wiki formatting)
 
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function
{{RV|type=function


|game1= arma3
|game1= arma3
|version1= 1.98
|version1= 1.98


<!--|serverExec= server-->
|gr1= Object Manipulation
 
<!--|arg= local-->
 
<!--|eff= local-->


|descr= Draws bounding box around given objects.
|descr= Draws bounding box around given objects.
Line 15: Line 10:
|s1= [objects, color, draw] call [[BIS_fnc_drawBoundingBox]]
|s1= [objects, color, draw] call [[BIS_fnc_drawBoundingBox]]


|p1= objects: [[Array]] - (Optional, default [[objNull]]) [[Array]] of [[Object|Objects]]
|p1= objects: [[Array]] - (Optional, default <sqf inline>[objNull]</sqf>) [[Array]] of [[Object]]s


|p2= color: [[Array]] - (Optional, default [1,0,1,1]) [[Array]] in format [R,G,B,A]
|p2= color: [[Array]] in format [[Color|Color (RGBA)]] - (Optional, default [1,0,1,1])


|p3= draw: [[Boolean]] - (Optional, default nil) [[True]] to draw, [[false]] to remove
|p3= draw: [[Boolean]] - (Optional, default nil) [[true]] to draw, [[false]] to remove


|r1= [[Boolean]] - [[True]] is successful, [[false]] if not
|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>
|x1= <sqf>[[BIS_building], [1,0,1,1], true] call BIS_fnc_drawBoundingBox;</sqf>


|x2= <code>[<nowiki>[</nowiki>], [], [[false]]<nowiki>]</nowiki> [[call]] [[BIS_fnc_drawBoundingBox]];</code>
|x2= <sqf>[[], [], false] call BIS_fnc_drawBoundingBox;</sqf>
 
|exec= call


|seealso= [[boundingBoxReal]] [[boundingBox]]
|seealso= [[boundingBoxReal]] [[boundingBox]]
}}
}}

Latest revision as of 16:01, 13 July 2022

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 in format Color (RGBA) - (Optional, default [1,0,1,1])
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=327977"