BIS fnc addCuratorIcon: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl>" to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...)
Line 1: Line 1:
{{Function|Comments=
{{Function


| arma3 |Game name=
| arma3


|1.16|Game version=
|1.16


|gr1 = Curator |GROUP1=
|gr1 = Curator


| Add an icon displayed in curator interface. |Description=
| Add an icon displayed in curator interface.


| [object, iconParams, map, 3D] call [[BIS_fnc_addCuratorIcon]] |Syntax=
| [object, iconParams, map, 3D] call [[BIS_fnc_addCuratorIcon]]




|p1= object: [[Object]] - Curator module |Parameter 1=
|p1= object: [[Object]] - Curator module


|p2= iconParams: [[Array]] - Icon params (see [[drawIcon3D]] scripting command for its format) |Parameter 2=
|p2= iconParams: [[Array]] - Icon params (see [[drawIcon3D]] scripting command for its format)


|p3= map: [[Boolean]] - (Optional, default [[true]]) [[true]] to show icon on map |Parameter 3=
|p3= map: [[Boolean]] - (Optional, default [[true]]) [[true]] to show icon on map


|p4= 3D: [[Boolean]] - (Optional, default [[true]]) [[true]] to show icon in 3D scene |Parameter 4=
|p4= 3D: [[Boolean]] - (Optional, default [[true]]) [[true]] to show icon in 3D scene


| [[Number]] - Icon ID, used in [[BIS_fnc_removeCuratorIcon]] |Return value=
| [[Number]] - Icon ID, used in [[BIS_fnc_removeCuratorIcon]]


|x1= <code>[ curatorModule, ["targetIcon.paa", [1,1,1,1], position [[player]], 1, 1, 45, "Target", 1, 0.05, "TahomaB"], [[false]] ] [[call]] [[BIS_fnc_addCuratorIcon]];</code> |Example 1=
|x1= <code>[ curatorModule, ["targetIcon.paa", [1,1,1,1], position [[player]], 1, 1, 45, "Target", 1, 0.05, "TahomaB"], [[false]] ] [[call]] [[BIS_fnc_addCuratorIcon]];</code>


| [[Curator]], [[BIS_fnc_removeCuratorIcon]] |See also=
| [[Curator]], [[BIS_fnc_removeCuratorIcon]]
}}
}}


Revision as of 22:40, 17 January 2021

Arma 3 logo black.png1.16
Hover & click on the images for description

Description

Description:
Add an icon displayed in curator interface.
Execution:
call
Groups:
Curator

Syntax

Syntax:
[object, iconParams, map, 3D] call BIS_fnc_addCuratorIcon
Parameters:
object: Object - Curator module
iconParams: Array - Icon params (see drawIcon3D scripting command for its format)
map: Boolean - (Optional, default true) true to show icon on map
3D: Boolean - (Optional, default true) true to show icon in 3D scene
Return Value:
Number - Icon ID, used in BIS_fnc_removeCuratorIcon

Examples

Example 1:
[ curatorModule, ["targetIcon.paa", [1,1,1,1], position player, 1, 1, 45, "Target", 1, 0.05, "TahomaB"], false ] call BIS_fnc_addCuratorIcon;

Additional Information

See also:
CuratorBIS_fnc_removeCuratorIcon

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


Bottom Section

Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_addCuratorIcon&oldid=202730"