BIS fnc addCommMenuItem: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Some wiki formatting)
 
(46 intermediate revisions by 8 users not shown)
Line 1: Line 1:
{{RV|type=function


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


| arma3 |= Game name
|eff= local
|arg= local


|1.00|= Game version
|gr1= Communication Menu
____________________________________________________________________________________________


| <pre>/*
|descr= Add [[Arma 3: Communication Menu|communication menu]] to the given unit.


Description:
The item will be available in the Communication menu and visualized in comm menu icon area.
Add communication menu item to the given unit.
The item will be available in the Communication menu and visualized in comm menu icon area.


Parameter(s):
|s1= [owner, itemClass, textArguments, expressionArguments, notification] call [[BIS_fnc_addCommMenuItem]]
0: OBJECT - object to which the item belongs to
1: STRING - CfgCommunicationMenu class
2 (Optional): ANY - text arguments
3 (Optional): ANY - expression arguments
4 (Optional): STRING - notification class from CfgNotifications. Empty string will disabled the notification.


Returns:
|p1= '''owner''': [[Object]] - object to which the item belongs to
NUMBER - item ID, used in BIS_fnc_removeCommMenuItem
*/
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_addCommMenuItem]]; --> |= Syntax
|p2= '''itemClass''': [[String]] - {{hl|CfgCommunicationMenu}} class


|p1= |= Parameter 1
|p3= '''textArguments''': [[Anything]] - (Optional) additional info to display in the {{hl|text}} attribute. {{hl|%1}} will be replaced by the first array element, {{hl|%2}} with the second and so on.


| |= Return value
|p4= '''expressionArguments''': [[Anything]] - (Optional) similar to '''textArguments''', just this time in the {{hl|expression}} attribute.
____________________________________________________________________________________________


|x1= <code></code> |=
|p5= '''notification''': [[String]] - (Optional) notification class from {{hl|CfgNotifications}}. Empty string will disabled the notification.
____________________________________________________________________________________________


| |= See also
|r1= [[Number]] - item ID, used in [[BIS_fnc_removeCommMenuItem]]


|x1= <sqf>
private _supportHeli = [player,"Support_Request_CAS_Heli"] call BIS_fnc_addCommMenuItem;
_supportHeli = [player,"Support_Request_CAS_Heli",nil,nil,""] call BIS_fnc_addCommMenuItem; // don't show notification
</sqf>
|seealso= [[BIS_fnc_removeCommMenuItem]] [[Arma 3: Communication Menu]]
}}
}}
<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: Misc|{{uc:addCommMenuItem}}]]
[[Category:Functions|{{uc:addCommMenuItem}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:addCommMenuItem}}]]

Latest revision as of 13:26, 27 July 2022

Arma 3 logo black.png0.50
LALocalLELocal
Hover & click on the images for description

Description

Description:
Add communication menu to the given unit. The item will be available in the Communication menu and visualized in comm menu icon area.
Execution:
call
Groups:
Communication Menu

Syntax

Syntax:
[owner, itemClass, textArguments, expressionArguments, notification] call BIS_fnc_addCommMenuItem
Parameters:
owner: Object - object to which the item belongs to
itemClass: String - CfgCommunicationMenu class
textArguments: Anything - (Optional) additional info to display in the text attribute. %1 will be replaced by the first array element, %2 with the second and so on.
expressionArguments: Anything - (Optional) similar to textArguments, just this time in the expression attribute.
notification: String - (Optional) notification class from CfgNotifications. Empty string will disabled the notification.
Return Value:
Number - item ID, used in BIS_fnc_removeCommMenuItem

Examples

Example 1:
private _supportHeli = [player,"Support_Request_CAS_Heli"] call BIS_fnc_addCommMenuItem; _supportHeli = [player,"Support_Request_CAS_Heli",nil,nil,""] call BIS_fnc_addCommMenuItem; // don't show notification

Additional Information

See also:
BIS_fnc_removeCommMenuItem Arma 3: Communication Menu

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_addCommMenuItem&oldid=329363"