drawIcon: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) (Add missing parameters… and hide them) |
Killzone Kid (talk | contribs) No edit summary |
||
(3 intermediate revisions by 3 users not shown) | |||
Line 18: | Line 18: | ||
|gr1= GUI Control - Map | |gr1= GUI Control - Map | ||
|descr= Draws an icon on the map. | |eff= local | ||
|descr= Draws an icon on the map. | |||
As this command needs to be called every frame, it is preferable using the [[User Interface Event Handlers#onDraw|onDraw]] UI Event Handler. | |||
{{Feature|informative|Some useful icons can be found in <sqf inline>configFile >> "CfgVehicleIcons"</sqf>.}} | |||
|s1= map [[drawIcon]] [texture, color, position, width, height, angle, text, shadow, textSize, font, align<!--, drawSideArrows, offsetX, offsetY-->] | |s1= map [[drawIcon]] [texture, color, position, width, height, angle, text, shadow, textSize, font, align<!--, drawSideArrows, offsetX, offsetY-->] | ||
Line 34: | Line 38: | ||
|p6= height: [[Number]] - height of the icon (but not the text) | |p6= height: [[Number]] - height of the icon (but not the text) | ||
|p7= angle: [[Number]] - rotation angle of the icon | |p7= angle: [[Number]] - rotation angle of the icon not the text (add to it [[ctrlMapDir]] to show correctly on rotating minimap) | ||
|p8= text: [[String]] - (Optional, default "") | |p8= text: [[String]] - (Optional, default "") | ||
Line 104: | Line 108: | ||
</sqf> | </sqf> | ||
|seealso= [[drawArrow]] [[drawEllipse]] [[drawLine]] [[drawRectangle]] [[drawPolygon]] [[drawTriangle]] | |seealso= [[drawArrow]] [[drawEllipse]] [[drawLine]] [[drawRectangle]] [[drawPolygon]] [[drawTriangle]] [[drawXPolygon]] | ||
}} | }} | ||
Latest revision as of 22:35, 1 November 2024
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.
- 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:
- since 0.72
- textSize: Number - (Optional, default -1) size of the text in UI units
- since 0.72
- font: String - (Optional, default "") text's font
- since 0.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
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 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']; };
- 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:
For example, the following icon has an exact size of 50 meters on the map, even after zooming in/out:
Categories:
- Scripting Commands
- Introduced with Armed Assault version 1.00
- ArmA: Armed Assault: New Scripting Commands
- ArmA: Armed Assault: Scripting Commands
- Arma 2: Scripting Commands
- Arma 2: Operation Arrowhead: Scripting Commands
- Take On Helicopters: Scripting Commands
- Arma 3: Scripting Commands
- Command Group: GUI Control - Map
- Scripting Commands: Local Effect