drawIcon: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Text replacement - "|= Game version" to "|Game version=")
(15 intermediate revisions by 6 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 an icon on the map. The command needs to be called every frame, preferably with "Draw" control event handler [[ctrlAddEventHandler]].
| Draws an icon on the map. The command needs to be called every frame, preferably with "Draw" control event handler [[ctrlAddEventHandler]].


|= Description
|DESCRIPTION=
____________________________________________________________________________________________
____________________________________________________________________________________________


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


|p1= map: [[Control]] |= Parameter 1
|p1= map: [[Control]] |PARAMETER1=
|p2 = [texture, color, position, width, height, angle, text, shadow, textSize, font, align] : [[Array]]
|p3= texture: [[String]] - icon texture |=
|p4= color: [[Array]] - text and icon color in format [r,g,b,a] |=
|p5= position: [[Position2D]] or [[Position3D]] or [[Object]] |=
|p6= width: [[Number]] - width of the icon but not text|=
|p7= height: [[Number]] - height of the icon but not text|=
|p8= angle: [[Number]] - rotation angle of the icon but not text|=
|p9= text (Optional): [[String]] |=
|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)|=
|p11= textSize (Optional): [[Number]] - size of the text in UI units (since Arma 3 v0.72)|=
|p12= font (Optional): [[String]] - (since Arma 3 v0.72) |=
|p13= align (Optional): [[String]] - (since Arma 3 v0.72) "left", "right", "center". Default is "right" |=


|p2= texture: [[String]] |=
| [[Nothing]] |RETURNVALUE=
|p3= color: [[Array]] - [r,g,b,a] |=
|p4= position: [[Position2D]] or [[Position3D]] or [[Object]] |=
|p5= width: [[Number]]|=
|p6= height: [[Number]]|=
|p7= angle: [[Number]]|=
|p8= text: [[String]] |=
|p9= shadow: [[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)|=
|p10= textSize: [[Number]] - (since Arma 3 v0.72)|=
|p11= font: [[String]] - (since Arma 3 v0.72) |=
|p12= align: [[String]] - (since Arma 3 v0.72) "left", "right", "center". Default is "right" |=


| [[Nothing]] |= Return value
|x1= Red icon with text: <code>[[findDisplay]] 12 [[displayCtrl]] 51 [[ctrlAddEventHandler]] ["Draw",  
 
{
|x1= <code>[[findDisplay]] 12 [[displayCtrl]] 51 [[ctrlAddEventHandler]] ["Draw", "
_this [[select]] 0 [[drawIcon]]  
_this [[select]] 0 [[drawIcon]] [
[
'iconStaticMG',
"iconStaticMG",
[1,0,0,1],
[1,0,0,1],
[[getPos]] [[player]],
[[getPos]] [[player]],
Line 38: Line 40:
24,
24,
[[getDir]] [[player]],
[[getDir]] [[player]],
'Player Vehicle',
"Player Vehicle",
1,
1,
0.03,
0.03,
'TahomaB',
"TahomaB",
'right'
"right"
]
]
"];</code>|= EXAMPLE1
}];</code>|EXAMPLE1=
 
|x2= Green text only: <code>[[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]]
]
}];</code>|EXAMPLE2=
____________________________________________________________________________________________
____________________________________________________________________________________________


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


}}
}}
Line 92: Line 108:
<dd class="note">
<dd class="note">
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.
</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:
<code>[[onEachFrame]] {
[[findDisplay]] 12 [[displayCtrl]] 51 [[drawIcon]] ['iconStaticMG',[1,0,0,1],[[getPos]] [[player]],24,24,[[getDir]] [[player]],'Player Vehicle',1,0.03,'TahomaB','right'];
};</code>
</dd>
</dl>
<!-- DISCONTINUE Notes -->
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on October 13, 2016 - 21:12 (UTC)</dd>
<dt class="note">[[User:Icaruk|Icaruk]]</dt>
<dd class="note">
If you unPBO the following addon:<br>
<code>@ui_f_data.pbo<br></code>
You can find the possible icons inside this folder:<br>
<code>ui_f\data\map\vehicleicons</code><br>
For example:<br>
If you want to use "iconman_ca.paa"  you will write "iconman" on the texture string.
</dd>
</dd>
</dl>
</dl>
<!-- DISCONTINUE Notes -->
<!-- DISCONTINUE Notes -->

Revision as of 13:19, 31 August 2019

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

Description

Description:
Draws an icon on the map. The command needs to be called every frame, preferably with "Draw" control event handler ctrlAddEventHandler.
Groups:
Uncategorised

Syntax

Syntax:
map drawIcon [texture, color, position, width, height, angle, text, shadow, textSize, font, align]
Parameters:
map: Control
[texture, color, position, width, height, angle, text, shadow, textSize, font, align] : Array
texture: String - icon texture
color: Array - text and icon color in format [r,g,b,a]
position: Position2D or Position3D or Object
width: Number - width of the icon but not text
height: Number - height of the icon but not text
angle: Number - rotation angle of the icon but not text
text (Optional): String
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)
textSize (Optional): Number - size of the text in UI units (since Arma 3 v0.72)
font (Optional): String - (since Arma 3 v0.72)
align (Optional): String - (since Arma 3 v0.72) "left", "right", "center". Default is "right"
Return Value:
Nothing

Examples

Example 1:
Red icon with text: findDisplay 12 displayCtrl 51 ctrlAddEventHandler ["Draw", { _this select 0 drawIcon [ "iconStaticMG", [1,0,0,1], getPos player, 24, 24, getDir 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:
drawArrowdrawEllipsedrawLinedrawRectangledrawPolygondrawTriangle

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 July 03, 2013 - 15:35
Druid
Support of paremeters textSize, font and align is in the game since Arma 3 version 0.72.
Posted on March 22, 2014
Waffle SS.
icon will always remain the same width and height, if you want an icon scaled to the map, use:(sizeInMeters * 0.15) * 10^(abs log (ctrlMapScale _ctrl)) for width and height (guessimated).

Bottom Section

Posted on July 20, 2014 - 16:59 (UTC)
AgentRevolution
If you want only text with no icon, you can use "#(argb,8,8,3)color(0,0,0,0)" as texture.
Posted on July 7, 2015 - 21:27 (UTC)
Waffle SS.
Be careful when using this command. Unlike map markers, the draw commands can decrease your framerate.
Posted on January 4, 2016 - 05:41 (UTC)
Benargee
Arma 3 1.54
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
Example: onEachFrame { findDisplay 12 displayCtrl 51 drawIcon ['iconStaticMG',[1,0,0,1],getPos player,24,24,getDir player,'Player Vehicle',1,0.03,'TahomaB','right']; };
Posted on October 13, 2016 - 21:12 (UTC)
Icaruk
If you unPBO the following addon:
@ui_f_data.pbo
 You can find the possible icons inside this folder:
ui_f\data\map\vehicleicons
For example:
If you want to use "iconman_ca.paa" you will write "iconman" on the texture string.
Retrieved from "https://community.bistudio.com/wiki?title=drawIcon&oldid=131257"