drawIcon: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "_{10,} " to "")
No edit summary
 
(55 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command


| arma1 |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 an icon on the map. The command needs to be called every frame, preferably with "Draw" control event handler [[ctrlAddEventHandler]].|DESCRIPTION=
|gr1= GUI Control - Map


| map '''drawIcon''' [texture, color, position, width, height, angle, text, shadow, textSize, font, align] |SYNTAX=
|eff= local


|p1= map: [[Control]] |PARAMETER1=
|descr= Draws an icon on the map.
|p2 = [texture, color, position, width, height, angle, text, shadow, textSize, font, align] : [[Array]]|PARAMETER2=
As this command needs to be called every frame, it is preferable using the [[User Interface Event Handlers#onDraw|onDraw]] UI Event Handler.
|p3= texture: [[String]] - icon texture |PARAMETER3=
{{Feature|informative|Some useful icons can be found in <sqf inline>configFile >> "CfgVehicleIcons"</sqf>.}}
|p4= color: [[Array]] - text and icon color in format [r,g,b,a] |PARAMETER4=


|p5= position: [[Position2D]] or [[Position3D]] or [[Object]] |PARAMETER5=
|s1= map [[drawIcon]] [texture, color, position, width, height, angle, text, shadow, textSize, font, align<!--, drawSideArrows, offsetX, offsetY-->]


|p6= width: [[Number]] - width of the icon but not text|PARAMETER6=
|p1= map: [[Control]]


|p7= height: [[Number]] - height of the icon but not text|PARAMETER7=
|p2= texture: [[String]] - icon texture


|p8= angle: [[Number]] - rotation angle of the icon but not text|PARAMETER8=
|p3= color: [[Array]] - text and icon color in format [[Color|Color(RGBA)]]


|p9= text (Optional): [[String]] |PARAMETER9=
|p4= position: [[Object]], [[Array]] format [[Position#Introduction|Position2D]] or [[Position#Introduction|Position3D]]
|p10= shadow (Optional): [[Number]] or [[Boolean]] - 0/false: no shadow, 1: shadow (for text), 2/true: outline (works for text and for icon only if icon angle is 0)|PARAMETER10=
|p11= textSize (Optional): [[Number]] - size of the text in UI units (since Arma 3 v0.72)|PARAMETER11=


|p12= font (Optional): [[String]] - (since Arma 3 v0.72) |PARAMETER12=
|p5= width: [[Number]] - width of the icon (but not the text)
|p13= align (Optional): [[String]] - (since Arma 3 v0.72) "left", "right", "center". Default is "right" |PARAMETER13=


| [[Nothing]] |RETURNVALUE=
|p6= height: [[Number]] - height of the icon (but not the text)


|x1= Red icon with text: <code>[[findDisplay]] 12 [[displayCtrl]] 51 [[ctrlAddEventHandler]] ["Draw",  
|p7= angle: [[Number]] - rotation angle of the icon not the text (add to it [[ctrlMapDir]] to show correctly on rotating minimap)
{
 
_this [[select]] 0 [[drawIcon]]  
|p8= text: [[String]] - (Optional, default "")
[
 
"iconStaticMG",
|p9= shadow: [[Number]] or [[Boolean]] - (Optional, default [[false]]) can be one of:
* 0 ([[false]]): no shadow
* 1: shadow (for text)
* 2 ([[true]]): outline (works for text and for icon only if icon angle is 0)
 
|p10= textSize: [[Number]] - (Optional, default -1) size of the text in UI units
|p10since= arma3 0.72
 
|p11= font: [[String]] - (Optional, default "") text's font
|p11since= arma3 0.72
 
|p12= align: [[String]] - (Optional, default "right") text alignment. Can be:
* "left"
* "right"
* "center"
|p12since= arma3 0.72
 
<!--
 
|p13= drawSideArrows: [[Boolean]] - (Optional, default [[false]]) unused
|p13since= arma3 2.04
 
|p14= offsetX: [[Number]] - (Optional, default 0) unused
|p14since= arma3 2.04
 
|p15= offsetY: [[Number]] - (Optional, default 0) unused
|p15since= arma3 2.04
 
-->
 
|r1= [[Nothing]]
 
|x1= Red icon with text:
<sqf>
findDisplay 12 displayCtrl 51 ctrlAddEventHandler ["Draw", {
_this select 0 drawIcon [
"iconStaticMG", // custom images can also be used: getMissionPath "\myFolder\myIcon.paa"
[1,0,0,1],
[1,0,0,1],
[[getPos]] [[player]],
getPosASLVisual player,
24,
24,
24,
24,
[[getDir]] [[player]],
getDirVisual player,
"Player Vehicle",
"Player Vehicle",
1,
1,
Line 51: Line 90:
"right"
"right"
]
]
}];</code>|EXAMPLE1=
}];
</sqf>


|x2= Green text only: <code>[[findDisplay]] 12 [[displayCtrl]] 51 [[ctrlAddEventHandler]] ["Draw",  
|x2= Green text only:
{
<sqf>
_this [[select]] 0 [[drawIcon]]
findDisplay 12 displayCtrl 51 ctrlAddEventHandler ["Draw", {
[
_this select 0 drawIcon [
"#(rgb,1,1,1)color(1,1,1,1)",
"#(rgb,1,1,1)color(1,1,1,1)",
[0,1,0,1],
[0,1,0,1],
[[player]],
player,
0,
0,
0,
0,
0,
0,
[[name]] [[player]]
name player
]
]
}];</code>|EXAMPLE2=
}];
 
</sqf>
| [[drawArrow]], [[drawEllipse]], [[drawLine]], [[drawRectangle]], [[drawPolygon]], [[drawTriangle]] |SEEALSO=


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


<h3 style="display:none">Notes</h3>
{{Note
<dl class="command_description">
|user= Benargee
<!-- Note Section BEGIN -->
|timestamp= 20160104054100
 
|text= {{arma3}} 1.54<br>
<dd class="notedate">Posted on July 03, 2013 - 15:35
This command does not seem to play nice with [[onEachFrame]]. It seems to draw on the main screen while maintaing position relative to the map position<br>
<dt class="note">[[User:Druid|Druid]]<dd class="note">Support of paremeters <i>textSize</i>, <i>font</i> and <i>align</i> is in the game since Arma 3 version 0.72.<br>
 
<dd class="notedate">Posted on March 22, 2014
<dt class="note">[[User:Waffle SS.|Waffle SS.]]
<dd class="note">icon will always remain the same width and height, if you want an icon scaled to the map, use:<code>('''sizeInMeters''' * 0.15) * 10^(abs log (ctrlMapScale _ctrl))</code> for width and height (guessimated).
<BR><BR>
 
<!-- Note Section END -->
</dl>
 
<h3 style="display:none">Bottom Section</h3>
 
[[Category:Scripting Commands|DRAWICON]]
{{GameCategory|arma1|Scripting Commands}}
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}
 
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on July 20, 2014 - 16:59 (UTC)</dd>
<dt class="note">[[User:AgentRevolution|AgentRevolution]]</dt>
<dd class="note">
If you want only text with no icon, you can use "#(argb,8,8,3)color(0,0,0,0)" as texture.
</dd>
</dl>
<!-- DISCONTINUE Notes -->
 
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on July 7, 2015 - 21:27 (UTC)</dd>
<dt class="note">[[User:Waffle SS.|Waffle SS.]]</dt>
<dd class="note">
Be careful when using this command. Unlike map markers, the draw commands can decrease your framerate.
</dd>
</dl>
<!-- DISCONTINUE Notes -->
 
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on January 4, 2016 - 05:41 (UTC)</dd>
<dt class="note">[[User:Benargee|Benargee]]</dt>
<dd class="note">
Arma 3 1.54<br>
This command doesn't seem to play nice with [[onEachFrame]]. It seems to draw on the main screen while maintaing position relative to the map position<br>
Example:
Example:
<code>[[onEachFrame]] {
<sqf>
[[findDisplay]] 12 [[displayCtrl]] 51 [[drawIcon]] ['iconStaticMG',[1,0,0,1],[[getPos]] [[player]],24,24,[[getDir]] [[player]],'Player Vehicle',1,0.03,'TahomaB','right'];
onEachFrame {
};</code>
findDisplay 12 displayCtrl 51 drawIcon ['iconStaticMG', [1,0,0,1], getPosASL player, 24, 24, getDir player, 'Player Vehicle', 1, 0.03, 'TahomaB', 'right'];
</dd>
};
</dl>
</sqf>
<!-- DISCONTINUE Notes -->
}}


<!-- CONTINUE Notes -->
{{Note
<dl class="command_description">
|user= Leopard20
<dd class="notedate">Posted on October 13, 2016 - 21:12 (UTC)</dd>
|timestamp= 20220509193407
<dt class="note">[[User:Icaruk|Icaruk]]</dt>
|text= The icon size always stays the same, even after zooming in/out. To make the icon get bigger with map zoom, use this for width and height size:
<dd class="note">
<sqf>
If you unPBO the following addon:<br>
private _scale = 6.4 * worldSize / 8192 * ctrlMapScale _map;
<code>@ui_f_data.pbo<br></code>
private _size = _sizeInMeters / _scale;
You can find the possible icons inside this folder:<br>
</sqf>
<code>ui_f\data\map\vehicleicons</code><br>
For example, the following icon has an exact size of 50 meters on the map, even after zooming in/out:
For example:<br>
<sqf>
If you want to use "iconman_ca.paa" you will write "iconman" on the texture string.
private _scale = 6.4 * worldSize / 8192 * ctrlMapScale _map;
</dd>
private _size = 50 / _scale;
</dl>
_map drawIcon ["iconStaticMG", [1,0,0,1], getPosASLVisual player, _size, _size, 0]
<!-- DISCONTINUE Notes -->
</sqf>
}}

Latest revision as of 22:35, 1 November 2024

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

Description

Description:
Draws an icon on the map. As this command needs to be called every frame, it is preferable using the onDraw UI Event Handler.
ⓘ
Some useful icons can be found in configFile >> "CfgVehicleIcons".
Groups:
GUI Control - Map

Syntax

Syntax:
map drawIcon [texture, color, position, width, height, angle, text, shadow, textSize, font, align]
Parameters:
map: Control
texture: String - icon texture
color: Array - text and icon color in format Color(RGBA)
position: Object, Array format Position2D or Position3D
width: Number - width of the icon (but not the text)
height: Number - height of the icon (but not the text)
angle: Number - rotation angle of the icon not the text (add to it ctrlMapDir to show correctly on rotating minimap)
text: String - (Optional, default "")
shadow: Number or Boolean - (Optional, default false) can be one of:
  • 0 (false): no shadow
  • 1: shadow (for text)
  • 2 (true): outline (works for text and for icon only if icon angle is 0)
since Arma 3 logo black.png0.72
textSize: Number - (Optional, default -1) size of the text in UI units
since Arma 3 logo black.png0.72
font: String - (Optional, default "") text's font
since Arma 3 logo black.png0.72
align: String - (Optional, default "right") text alignment. Can be:
  • "left"
  • "right"
  • "center"
Return Value:
Nothing

Examples

Example 1:
Red icon with text:
findDisplay 12 displayCtrl 51 ctrlAddEventHandler ["Draw", { _this select 0 drawIcon [ "iconStaticMG", // custom images can also be used: getMissionPath "\myFolder\myIcon.paa" [1,0,0,1], getPosASLVisual player, 24, 24, getDirVisual player, "Player Vehicle", 1, 0.03, "TahomaB", "right" ] }];
Example 2:
Green text only:
findDisplay 12 displayCtrl 51 ctrlAddEventHandler ["Draw", { _this select 0 drawIcon [ "#(rgb,1,1,1)color(1,1,1,1)", [0,1,0,1], player, 0, 0, 0, name player ] }];

Additional Information

See also:
drawArrow drawEllipse drawLine drawRectangle 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
Benargee - c
Posted on Jan 04, 2016 - 05:41 (UTC)
Arma 3 1.54
This command does not seem to play nice with onEachFrame. It seems to draw on the main screen while maintaing position relative to the map position
Example:
onEachFrame { findDisplay 12 displayCtrl 51 drawIcon ['iconStaticMG', [1,0,0,1], getPosASL player, 24, 24, getDir player, 'Player Vehicle', 1, 0.03, 'TahomaB', 'right']; };
Leopard20 - c
Posted on May 09, 2022 - 19:34 (UTC)
The icon size always stays the same, even after zooming in/out. To make the icon get bigger with map zoom, use this for width and height size:
private _scale = 6.4 * worldSize / 8192 * ctrlMapScale _map; private _size = _sizeInMeters / _scale;
For example, the following icon has an exact size of 50 meters on the map, even after zooming in/out:
private _scale = 6.4 * worldSize / 8192 * ctrlMapScale _map; private _size = 50 / _scale; _map drawIcon ["iconStaticMG", [1,0,0,1], getPosASLVisual player, _size, _size, 0]
Retrieved from "https://community.bistudio.com/wiki?title=drawIcon&oldid=370133"