drawRectangle: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|gr1= GUI Control |GROUP1=" to "|gr1= GUI Control - Map |GROUP1=")
No edit summary
 
(54 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma |Game name=
|game1= arma1
|version1= 1.00


|1.00|Game version=
|game2= arma2
|version2= 1.00


|gr1= GUI Control - Map |GROUP1=
|game3= arma2oa
|version3= 1.50


|game4= tkoh
|version4= 1.00


____________________________________________________________________________________________
|game5= arma3
|version5= 0.50


| Draws a rectangle on the map. |DESCRIPTION=
|gr1= GUI Control - Map
____________________________________________________________________________________________


| map '''drawRectangle''' [c, a, b, angle, color, fill] |SYNTAX=
|descr= Draws a rectangle on the map.<br> [[File:drawRectangle.jpg|250px]]


|p1= map: [[Control]] |PARAMETER1=
|s1= map [[drawRectangle]] [centre, halfWidth, halfHeight, angle, color, fill, alignWithMap]


|p2= [c, a, b, angle, color, fill]: [[Array]] |PARAMETER2=
|p1= map: [[Control]]
|p3= c: [[Array]] or [[Object]] - center of rectangle in format: [[Position2D]], [[Position3D]] or [[Object]] |Parameter3=


|p4= a: [[Number]] - 1/2 width of rectangle (in meters)|PARAMETER4=
|p2= centre: [[Object]] or [[Array]] in format [[Position#Introduction|Position2D]] or [[Position#Introduction|Position3D]] - rectangle's centre


|p5= b: [[Number]] - 1/2 height of rectangle (in meters) |PARAMETER5=
|p3= halfWidth: [[Number]] - 1/2 width of rectangle in meters


|p6= angle: [[Number]] - angle of rotation |PARAMETER6=
|p4= halfHeight: [[Number]] - 1/2 height of rectangle in meters


|p7= color: [[Array]] - line color in format: [r,g,b,a]|PARAMETER7=
|p5= angle: [[Number]] - angle of rotation in degrees


|p8= fill: [[String]] - fill texture file or [[Procedural_Textures]]. Note that the file texture will not rotate with rectangle, use [[drawIcon]] for that. If fill texture is not empty, set line color to white [1,1,1,1] |PARAMETER8=
|p6= color: [[Array]] format [[Color|Color (RGBA)]] - line color


| [[Nothing]]
|p7= fill: [[String]] - fill texture file or [[Procedural Textures]]. Note that the file texture will not rotate with rectangle, use [[drawIcon]] for that. If fill texture is not empty, set line color to white <sqf inline>[1,1,1,1]</sqf>


<br><br>[[Image:drawRectangle.jpg|250px]]|RETURNVALUE=  
|p8= alignWithMap: [[Boolean]] - (Optional, default [[true]]) - when [[false]] the shape will not follow map rotation.
____________________________________________________________________________________________
|p8since= Arma3 2.18


|x1= <code>_ctrl [[drawRectangle]] [
|r1= [[Nothing]]
[[getPos]] [[player]],
 
|x1= <sqf>
_ctrl drawRectangle [
getPos player,
20,
20,
20,
20,
[[getDir]] [[player]],
getDir player,
[0,0,1,1],
[0,0,1,1],
""
""
];</code>|EXAMPLE1=
];
</sqf>


|x2= <code>_ctrl [[drawRectangle]] [
|x2= <sqf>
[[player]],
_ctrl drawRectangle [
player,
10,
10,
20,
20,
[[getDir]] [[player]],
getDir player,
[1,1,1,1],
[1,1,1,1],
"#(rgb,8,8,3)color(1,0,0,1)"
"#(rgb,8,8,3)color(1,0,0,1)"
];</code>|EXAMPLE2=
];
 
</sqf>
| [[drawArrow]], [[drawEllipse]], [[drawIcon]], [[drawLine]], [[drawPolygon]], [[drawTriangle]] |SEEALSO=


|seealso= [[drawArrow]] [[drawEllipse]] [[drawIcon]] [[drawLine]] [[drawPolygon]] [[drawTriangle]] [[drawXPolygon]]
}}
}}


<h3 style="display:none">Notes</h3>
{{Note
<dl class="command_description">
|user= Waffle SS.
<!-- Note Section BEGIN -->
|timestamp= 20140323002100
 
|text= Map example:
<dd class="notedate">Posted on March 22, 2014
<sqf>
<dt class="note">[[User:Waffle SS.|Waffle SS.]]
(findDisplay 12 displayCtrl 51) ctrlAddEventHandler ["Draw",{
<dd class="note">Map example: <code>([[findDisplay]] 12 [[displayCtrl]] 51) [[ctrlAddEventHandler]] ["Draw",{
(_this select 0) drawRectangle [
(_this [[select]] 0) [[drawRectangle]] [
getPos player,
[[getPos]] [[player]],
20,
20,
20,
20,
[[getDir]] [[player]],
getDir player,
[0,0,1,1],
[0,0,1,1],
""
""
];
];
}];</code><BR>
}];
</sqf>
Be careful when using this command. Unlike map markers, the draw commands can decrease your framerate.
Be careful when using this command. Unlike map markers, the draw commands can decrease your framerate.
 
}}
<!-- Note Section END -->
</dl>
 
<h3 style="display:none">Bottom Section</h3>
 
[[Category:Scripting Commands|DRAWRECTANGLE]]
[[Category:Scripting Commands Armed Assault|DRAWRECTANGLE]]
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_GUI_Control|{{uc:{{PAGENAME}}}}]]

Latest revision as of 22:36, 1 November 2024

Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
Hover & click on the images for description

Description

Description:
Draws a rectangle on the map.
drawRectangle.jpg
Groups:
GUI Control - Map

Syntax

Syntax:
map drawRectangle [centre, halfWidth, halfHeight, angle, color, fill, alignWithMap]
Parameters:
map: Control
centre: Object or Array in format Position2D or Position3D - rectangle's centre
halfWidth: Number - 1/2 width of rectangle in meters
halfHeight: Number - 1/2 height of rectangle in meters
angle: Number - angle of rotation in degrees
color: Array format Color (RGBA) - line color
fill: String - fill texture file or Procedural Textures. Note that the file texture will not rotate with rectangle, use drawIcon for that. If fill texture is not empty, set line color to white [1,1,1,1]
since Arma 3 logo black.png2.18
alignWithMap: Boolean - (Optional, default true) - when false the shape will not follow map rotation.
Return Value:
Nothing

Examples

Example 1:
_ctrl drawRectangle [ getPos player, 20, 20, getDir player, [0,0,1,1], "" ];
Example 2:
_ctrl drawRectangle [ player, 10, 20, getDir player, [1,1,1,1], "#(rgb,8,8,3)color(1,0,0,1)" ];

Additional Information

See also:
drawArrow drawEllipse drawIcon drawLine drawPolygon drawTriangle drawXPolygon

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
Waffle SS. - c
Posted on Mar 23, 2014 - 00:21 (UTC)
Map example:
(findDisplay 12 displayCtrl 51) ctrlAddEventHandler ["Draw",{ (_this select 0) drawRectangle [ getPos player, 20, 20, getDir player, [0,0,1,1], "" ]; }];
Be careful when using this command. Unlike map markers, the draw commands can decrease your framerate.
Retrieved from "https://community.bistudio.com/wiki?title=drawRectangle&oldid=370137"