drawIcon: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <dd class="notedate">" to " <dt><dt> <dd class="notedate">")
m (Text replacement - " <!-- (DIS)?CONTINUE Notes -->" to "")
Line 63: Line 63:
{{GameCategory|tkoh|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}


<!-- CONTINUE Notes -->
<dl class="command_description">
<dl class="command_description">
<dt></dt>
<dt></dt>
Line 98: Line 97:
</dd>
</dd>
</dl>
</dl>
<!-- DISCONTINUE Notes -->

Revision as of 00:50, 6 April 2021

Hover & click on the images for description

Description

Description:
Draws an icon on the map. This command needs to be called every frame, preferably using the onDraw UI Event Handler.
Problems:
Since command has to be drawn on each frame, performance can be decreased!
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 [r,g,b,a]
position: Position2D, Position3D or Object
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 (but not the 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, default: "right"): String - "left", "right" or "center" (since Arma 3 v0.72)
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], 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:
drawArrow drawEllipse drawLine drawRectangle drawPolygon drawTriangle

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
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).
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 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.