drawIcon: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|Game version=" to "|Game version= |gr1= GUI Control |GROUP1= ")
mNo edit summary
Line 11: Line 11:
____________________________________________________________________________________________
____________________________________________________________________________________________


| Draws 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=
____________________________________________________________________________________________
____________________________________________________________________________________________


Line 19: Line 17:


|p1= map: [[Control]] |PARAMETER1=
|p1= map: [[Control]] |PARAMETER1=
|p2 = [texture, color, position, width, height, angle, text, shadow, textSize, font, align] : [[Array]]
|p2 = [texture, color, position, width, height, angle, text, shadow, textSize, font, align] : [[Array]]|PARAMETER2=
|p3= texture: [[String]] - icon texture |=  
|p3= texture: [[String]] - icon texture |PARAMETER3=  
|p4= color: [[Array]] - text and icon color in format [r,g,b,a] |PARAMETER4=
|p4= color: [[Array]] - text and icon color in format [r,g,b,a] |PARAMETER4=


Line 31: Line 29:
|p8= angle: [[Number]] - rotation angle of the icon but not text|PARAMETER8=
|p8= angle: [[Number]] - rotation angle of the icon but not text|PARAMETER8=


|p9= text (Optional): [[String]] |=  
|p9= text (Optional): [[String]] |PARAMETER9=  
|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)|=  
|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=
|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) |=  
|p12= font (Optional): [[String]] - (since Arma 3 v0.72) |PARAMETER12=  
|p13= align (Optional): [[String]] - (since Arma 3 v0.72) "left", "right", "center". Default is "right" |=
|p13= align (Optional): [[String]] - (since Arma 3 v0.72) "left", "right", "center". Default is "right" |PARAMETER13=


| [[Nothing]] |RETURNVALUE=
| [[Nothing]] |RETURNVALUE=

Revision as of 18:52, 24 September 2020

-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:
GUI Control

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.