Difference between revisions of "drawRectangle"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "[[Category:Scripting Commands ArmA|" to "[[Category:Scripting Commands Armed Assault|")
 
(19 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Command|= Comments
+
{{Command|Comments=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| arma |= Game name
+
| arma |Game name=
  
|1.00|= Game version
+
|1.00|Game version=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| Draw a Rectangle on the map. |= Description
+
| Draws a rectangle on the map. |DESCRIPTION=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| map '''drawRectangle''' [center, a, b, angle, color, fill] |= Syntax
+
| map '''drawRectangle''' [c, a, b, angle, color, fill] |SYNTAX=
  
|p1= map: [[Control]] |= Parameter 1
+
|p1= map: [[Control]] |PARAMETER1=
  
|p2= center: [[Array]] |= Parameter 2
+
|p2= [c, a, b, angle, color, fill]: [[Array]]
 +
|p3= c: [[Array]] or [[Object]] - center of rectangle in format: [[Position2D]], [[Position3D]] or [[Object]] |=
  
|p3= a: [[Number]] |= Parameter 3
+
|p4= a: [[Number]] - 1/2 width of rectangle (in meters)|=
  
|p4= b: [[Number]] |= Parameter 4
+
|p5= b: [[Number]] - 1/2 height of rectangle (in meters) |=  
  
|p5= angle: [[Number]] |= Parameter 5
+
|p6= angle: [[Number]] - angle of rotation |=
  
|p6= color: [[Array]] |= Parameter 6
+
|p7= color: [[Array]] - line color in format: [r,g,b,a]|=  
  
|p7= fill: [[String]] |= Parameter 7
+
|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] |=  
  
| [[Nothing]] |= Return value
+
| [[Nothing]]
 +
 
 +
<br><br>[[Image:drawRectangle.jpg|250px]]|RETURNVALUE=  
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
|x1= <code>_ctrl '''drawRectangle''' [
+
|x1= <code>_ctrl [[drawRectangle]] [
getPos player,
+
[[getPos]] [[player]],
 
20,
 
20,
 
20,
 
20,
getDir player,
+
[[getDir]] [[player]],
 
[0,0,1,1],
 
[0,0,1,1],
""//"\A3\ui_f\data\IGUI\Cfg\imagecornerelement_ca.paa"
+
""
]</code>|= Example 1
+
];</code>|EXAMPLE1=
 +
 
 +
|x2= <code>_ctrl [[drawRectangle]] [
 +
[[player]],
 +
10,
 +
20,
 +
[[getDir]] [[player]],
 +
[1,1,1,1],
 +
"#(rgb,8,8,3)color(1,0,0,1)"
 +
];</code>|EXAMPLE1=
  
| [[drawArrow]], [[drawEllipse]], [[drawIcon]], [[drawLine]] |= See also
+
| [[drawArrow]], [[drawEllipse]], [[drawIcon]], [[drawLine]], [[drawPolygon]], [[drawTriangle]] |SEEALSO=
  
 
}}
 
}}
Line 46: Line 58:
 
<!-- Note Section BEGIN -->
 
<!-- Note Section BEGIN -->
  
<dd class="notedate">Posted on March 17, 2014
+
<dd class="notedate">Posted on March 22, 2014
<dt class="note">'''[[User:Waffle SS.|Waffle SS.]]'''
+
<dt class="note">[[User:Waffle SS.|Waffle SS.]]
<dd class="note">Map example: <code>(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>
+
}];</code><BR>
<BR><BR>
+
Be careful when using this command. Unlike map markers, the draw commands can decrease your framerate.
  
 
<!-- Note Section END -->
 
<!-- Note Section END -->
Line 66: Line 78:
  
 
[[Category:Scripting Commands|DRAWRECTANGLE]]
 
[[Category:Scripting Commands|DRAWRECTANGLE]]
[[Category:Scripting Commands ArmA|DRAWRECTANGLE]]
+
[[Category:Scripting Commands Armed Assault|DRAWRECTANGLE]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
+
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
+
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]
 
[[Category:Command_Group:_GUI_Control|{{uc:{{PAGENAME}}}}]]
 
[[Category:Command_Group:_GUI_Control|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Editor_Control|{{uc:{{PAGENAME}}}}]]
 

Latest revision as of 20:24, 3 June 2020

Introduced with Armed Assault version 1.001.00
Hover & click on the images for descriptions

Description

Description:
Draws a rectangle on the map.

Syntax

Syntax:
map drawRectangle [c, a, b, angle, color, fill]
Parameters:
map: Control
[c, a, b, angle, color, fill]: Array
c: Array or Object - center of rectangle in format: Position2D, Position3D or Object
a: Number - 1/2 width of rectangle (in meters)
b: Number - 1/2 height of rectangle (in meters)
angle: Number - angle of rotation
color: Array - line color in format: [r,g,b,a]
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]
Return Value:
Nothing

drawRectangle.jpg

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:
drawArrowdrawEllipsedrawIcondrawLinedrawPolygondrawTriangle

Notes

i
Only post proven facts here. Report bugs on the feedback tracker and discuss on the Arma Discord or on the Forums.

Notes

Posted on March 22, 2014
Waffle SS.
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.

Bottom Section