BIS fnc addCuratorIcon: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (GVI 1.00 --> 1.16 http://dev.arma3.com/post/spotrep-00023 (It's Zeus update, obvious))
m (pf)
Line 1: Line 1:
 
{{Function|Comments=
{{Function|= Comments
____________________________________________________________________________________________
____________________________________________________________________________________________


| arma3 |= Game name
| arma3 |Game name=


|1.16|= Game version
|1.16|Game version=
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>/*
| Add an icon displayed in curator interface. |Description=
____________________________________________________________________________________________


Description:
| [object, iconParams, map, 3D] call [[BIS_fnc_addCuratorIcon]] |Syntax=
Add an icon displayed in curator interface


Parameter(s):
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:
|p1= object: [[Object]] - Curator module |Parameter 1=
NUMBER - icon ID, used in BIS_fnc_removeCuratorIcon
*/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
|p2= iconParams: [[Array]] - Icon params (see [[drawIcon3D]] scripting command for its format) |Parameter 2=
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_addCuratorIcon]]; --> |= Syntax
|p3= map: [[Boolean]] - (Optional, default [[true]]) [[True]] to show icon on map |Parameter 3=


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


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


|x1= <code></code> |=  
|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=
____________________________________________________________________________________________
____________________________________________________________________________________________


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


}}


<h3 style="display:none">Notes</h3>
<h3 style="display:none">Notes</h3>

Revision as of 22:53, 7 June 2018

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:
Uncategorised

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


Notes

Bottom Section

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