drawRectangle: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[[cC]ategory:[sS]cripting [cC]ommands\|[a-z A-Z 0-9_]+\]\]" to "")
No edit summary
 
(39 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| arma1
|game1= arma1
|version1= 1.00


|1.00
|game2= arma2
|version2= 1.00
 
|game3= arma2oa
|version3= 1.50
 
|game4= tkoh
|version4= 1.00
 
|game5= arma3
|version5= 0.50


|gr1= GUI Control - Map
|gr1= GUI Control - Map


| Draws a rectangle on the map.
|descr= Draws a rectangle on the map.<br> [[File:drawRectangle.jpg|250px]]


| map '''drawRectangle''' [c, a, b, angle, color, fill]
|s1= map [[drawRectangle]] [centre, halfWidth, halfHeight, angle, color, fill, alignWithMap]


|p1= map: [[Control]]
|p1= map: [[Control]]


|p2= [c, a, b, angle, color, fill]: [[Array]]
|p2= centre: [[Object]] or [[Array]] in format [[Position#Introduction|Position2D]] or [[Position#Introduction|Position3D]] - rectangle's centre
|p3= c: [[Array]] or [[Object]] - center of rectangle in format: [[Position2D]], [[Position3D]] or [[Object]]


|p4= a: [[Number]] - 1/2 width of rectangle (in meters)
|p3= halfWidth: [[Number]] - 1/2 width of rectangle in meters


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


|p6= angle: [[Number]] - angle of rotation
|p5= angle: [[Number]] - angle of rotation in degrees


|p7= color: [[Array]] - line color in format: [r,g,b,a]
|p6= color: [[Array]] format [[Color|Color (RGBA)]] - line color


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


| [[Nothing]]
|p8= alignWithMap: [[Boolean]] - (Optional, default [[true]]) - when [[false]] the shape will not follow map rotation.
|p8since= Arma3 2.18


<br><br>[[Image:drawRectangle.jpg|250px]]
|r1= [[Nothing]]


|x1= <code>_ctrl [[drawRectangle]] [
|x1= <sqf>
[[getPos]] [[player]],
_ctrl drawRectangle [
getPos player,
20,
20,
20,
20,
[[getDir]] [[player]],
getDir player,
[0,0,1,1],
[0,0,1,1],
""
""
];</code>
];
</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>
];
</sqf>


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


<dl class="command_description">
{{Note
<!-- Note Section BEGIN -->
|user= Waffle SS.
 
|timestamp= 20140323002100
<dd class="notedate">Posted on March 22, 2014</dd>
|text= Map example:
<dt class="note">[[User:Waffle SS.|Waffle SS.]]</dt>
<sqf>
<dd class="note">Map example: <code>([[findDisplay]] 12 [[displayCtrl]] 51) [[ctrlAddEventHandler]] ["Draw",{
(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>
 
 
 
{{GameCategory|arma1|Scripting Commands}}
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}

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"