BIS fnc addCuratorIcon: Difference between revisions

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


| arma3
|game1= arma3
|version1= 1.16


|1.16
|gr1= Curator


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


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


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


|p1= object: [[Object]] - Curator module
|p2= iconParams: [[Array]] - icon params (see [[drawIcon3D]] scripting command for its format)
 
|p2= iconParams: [[Array]] - Icon params (see [[drawIcon3D]] scripting command for its format)


|p3= map: [[Boolean]] - (Optional, default [[true]]) [[true]] to show icon on map
|p3= map: [[Boolean]] - (Optional, default [[true]]) [[true]] to show icon on map
Line 19: Line 18:
|p4= 3D: [[Boolean]] - (Optional, default [[true]]) [[true]] to show icon in 3D scene
|p4= 3D: [[Boolean]] - (Optional, default [[true]]) [[true]] to show icon in 3D scene


| [[Number]] - Icon ID, used in [[BIS_fnc_removeCuratorIcon]]
|r1= [[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>
|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>


| [[Curator]], [[BIS_fnc_removeCuratorIcon]]
|seealso= [[Arma 3: Curator]] [[BIS_fnc_removeCuratorIcon]]
}}
}}
[[Category:Functions|{{uc:addCuratorIcon}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:addCuratorIcon}}]]

Latest revision as of 17:27, 8 November 2023

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