drawRectangle: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
 
m (template:command argument fix)
(25 intermediate revisions by 10 users not shown)
Line 1: Line 1:
[[Category:Scripting Commands|DRAWRECTANGLE]]
{{Command|= Comments
[[Category:Scripting Commands ArmA|DRAWRECTANGLE]]
____________________________________________________________________________________________
 
| arma |= Game name
 
|1.00|= Game version
____________________________________________________________________________________________
 
| Draws a rectangle on the map. |DESCRIPTION=
____________________________________________________________________________________________
 
| map '''drawRectangle''' [c, a, b, angle, color, fill] |SYNTAX=
 
|p1= map: [[Control]] |PARAMETER1=
 
|p2= [c, a, b, angle, color, fill]: [[Array]]
|p3= c: [[Array]] or [[Object]] - center of rectangle in format: [[Position2D]], [[Position3D]] or [[Object]] |=
 
|p4= a: [[Number]] - 1/2 width of rectangle (in meters)|=
 
|p5= b: [[Number]] - 1/2 height of rectangle (in meters) |=
 
|p6= angle: [[Number]] - angle of rotation |=


|p7= color: [[Array]] - line color in format: [r,g,b,a]|=


|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] |=


<h2 style="color:#000066">''map'' ''''' drawRectangle ''''' ''[center, a, b, angle, color, fill]''</h2>
| [[Nothing]]


<br><br>[[Image:drawRectangle.jpg|250px]]|RETURNVALUE=
____________________________________________________________________________________________


'''Operand types:'''
|x1= <code>_ctrl [[drawRectangle]] [
[[getPos]] [[player]],
20,
20,
[[getDir]] [[player]],
[0,0,1,1],
""
];</code>|EXAMPLE1=


'''map''': [[Control]]
|x2= <code>_ctrl [[drawRectangle]] [
[[player]],
10,
20,
[[getDir]] [[player]],
[1,1,1,1],
"#(rgb,8,8,3)color(1,0,0,1)"
];</code>|EXAMPLE1=


'''[center, a, b, angle, color, fill]''': [[Array]]
| [[drawArrow]], [[drawEllipse]], [[drawIcon]], [[drawLine]], [[drawPolygon]], [[drawTriangle]] |SEEALSO=


'''Type of returned value:'''
}}


[[Nothing]]
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->


'''Compatibility:'''
<dd class="notedate">Posted on March 22, 2014
<dt class="note">'''[[User:Waffle SS.|Waffle SS.]]'''
<dd class="note">Map example: <code>([[findDisplay]] 12 [[displayCtrl]] 51) [[ctrlAddEventHandler]] ["Draw",{
(_this [[select]] 0) [[drawRectangle]] [
[[getPos]] [[player]],
20,
20,
[[getDir]] [[player]],
[0,0,1,1],
""
];
}];</code><BR>
Be careful when using this command. Unlike map markers, the draw commands can decrease your framerate.


Version 2.35 required.
<!-- Note Section END -->
</dl>


'''Description:'''
<h3 style="display:none">Bottom Section</h3>


Draw a Rectangle on the map.
[[Category:Scripting Commands|DRAWRECTANGLE]]
[[Category:Scripting Commands ArmA|DRAWRECTANGLE]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_GUI_Control|{{uc:{{PAGENAME}}}}]]

Revision as of 15:38, 7 April 2019

-wrong parameter ("Arma") defined!-1.00
Hover & click on the images for description

Description

Description:
Draws a rectangle on the map.
Groups:
Uncategorised

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

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

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