drawRectangle: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(correction)
m (template:command argument fix)
(7 intermediate revisions by 3 users not shown)
Line 7: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


| Draw a Rectangle on the map. |= Description
| Draws a rectangle on the map. |DESCRIPTION=
____________________________________________________________________________________________
____________________________________________________________________________________________


| map '''drawRectangle''' [c, a, b, angle, colour, fill] |= Syntax
| map '''drawRectangle''' [c, a, b, angle, color, fill] |SYNTAX=


|p1= map: [[Control]] |= Parameter 1
|p1= map: [[Control]] |PARAMETER1=


|p2= c: [[Array]] - centre of rectangle [[Position2D]], [[Position3D]], [[Object]] |= 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]] - 1/2 width of rectangle (in metres)|= Parameter 3
|p4= a: [[Number]] - 1/2 width of rectangle (in meters)|=


|p4= b: [[Number]] - 1/2 height of rectangle (in metres) |= Parameter 4
|p5= b: [[Number]] - 1/2 height of rectangle (in meters) |=  


|p5= angle: [[Number]] - angle of rotation |= Parameter 5
|p6= angle: [[Number]] - angle of rotation |=


|p6= colour: [[Array]] - border colour [r,g,b,a]. If you are planning on using texture, set colour to white [1,1,1,1]|= Parameter 6
|p7= color: [[Array]] - line color in format: [r,g,b,a]|=  


|p7= fill: [[String]] - fill texture file or [[Procedural_Textures]]. Note that the file texture will not rotate with rectangle, use [[drawIcon]] for that. |= 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]]
| [[Nothing]]


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


Line 38: Line 39:
[0,0,1,1],
[0,0,1,1],
""
""
];</code>|= Example 1
];</code>|EXAMPLE1=


|x2= <code>_ctrl [[drawRectangle]] [
|x2= <code>_ctrl [[drawRectangle]] [
Line 47: Line 48:
[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>|= Example 1
];</code>|EXAMPLE1=


| [[drawArrow]], [[drawEllipse]], [[drawIcon]], [[drawLine]] |= See also
| [[drawArrow]], [[drawEllipse]], [[drawIcon]], [[drawLine]], [[drawPolygon]], [[drawTriangle]] |SEEALSO=


}}
}}
Line 68: Line 69:
""
""
];
];
}];</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 82: Line 83:
[[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}}}}]]

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