BIS fnc addCuratorIcon: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Text replacement - ">\[ +(.*) *\] +(call|spawn)" to ">[$1] $2")
 
(29 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma3
____________________________________________________________________________________________
|version1= 1.16


| arma3 |= Game name
|gr1= Curator


|1.00|= Game version
|descr= Add an icon displayed in curator interface.
____________________________________________________________________________________________


| <pre>/*
|s1= [object, iconParams, map, 3D] call [[BIS_fnc_addCuratorIcon]]


Description:
|p1= object: [[Object]] - curator module
Add an icon displayed in curator interface


Parameter(s):
|p2= iconParams: [[Array]] - icon params (see [[drawIcon3D]] scripting command for its format)
0: OBJECT - curator module
1: ARRAY - icon params (see drawIcon3D scripting command for its format)
2 (Optional) - true to show the icon in the map
2 (Optional) - true to show the icon in 3D scene


Returns:
|p3= map: [[Boolean]] - (Optional, default [[true]]) [[true]] to show icon on map
NUMBER - icon ID, used in BIS_fnc_removeCuratorIcon
*/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
|p4= 3D: [[Boolean]] - (Optional, default [[true]]) [[true]] to show icon in 3D scene
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_addCuratorIcon]]; --> |= Syntax
|r1= [[Number]] - icon ID, used in [[BIS_fnc_removeCuratorIcon]]


|p1= |= Parameter 1
|x1= <sqf>[curatorModule, ["targetIcon.paa", [1,1,1,1], position player, 1, 1, 45, "Target", 1, 0.05, "TahomaB"], false] call BIS_fnc_addCuratorIcon;</sqf>
 
| |= Return value
____________________________________________________________________________________________
 
|x1= <code></code> |=
____________________________________________________________________________________________
 
| |= See also


|seealso= [[Arma 3: Curator]] [[BIS_fnc_removeCuratorIcon]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Curator|{{uc:addCuratorIcon}}]]
[[Category:Functions|{{uc:addCuratorIcon}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:addCuratorIcon}}]]

Latest revision as of 17:27, 8 November 2023

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:
Arma 3: Curator BIS_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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_addCuratorIcon&oldid=349435"