BIS fnc addCuratorIcon: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|Game version=" to "|Game version= |gr1 = Curator |GROUP1=")
m (Text replacement - ">\[ +(.*) *\] +(call|spawn)" to ">[$1] $2")
 
(25 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|Comments=
{{RV|type=function
____________________________________________________________________________________________


| arma3 |Game name=
|game1= arma3
|version1= 1.16


|1.16|Game version=
|gr1= Curator


|gr1 = Curator |GROUP1=
|descr= Add an icon displayed in curator interface.
____________________________________________________________________________________________


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


| [object, iconParams, map, 3D] call [[BIS_fnc_addCuratorIcon]] |Syntax=
|p1= object: [[Object]] - curator module


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


|p1= object: [[Object]] - Curator module |Parameter 1=
|p3= map: [[Boolean]] - (Optional, default [[true]]) [[true]] to show icon on map


|p2= iconParams: [[Array]] - Icon params (see [[drawIcon3D]] scripting command for its format) |Parameter 2=
|p4= 3D: [[Boolean]] - (Optional, default [[true]]) [[true]] to show icon in 3D scene


|p3= map: [[Boolean]] - (Optional, default [[true]]) [[True]] to show icon on map |Parameter 3=
|r1= [[Number]] - icon ID, used in [[BIS_fnc_removeCuratorIcon]]


|p4= 3D: [[Boolean]] - (Optional, default [[true]]) [[true]] to show icon in 3D scene |Parameter 4=
|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>


| [[Number]] - Icon ID, used in [[BIS_fnc_removeCuratorIcon]] |Return value=
|seealso= [[Arma 3: Curator]] [[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=
____________________________________________________________________________________________
 
| [[Curator]], [[BIS_fnc_removeCuratorIcon]] |See also=
}}
}}
<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"