BIS fnc addCommMenuItem: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl>" to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...)
Line 1: Line 1:
{{Function|Comments=
{{Function


| arma3 |Game name=
| arma3


|0.50|Game version=
|0.50


|eff= local |MPEFFECTS=
|eff= local |MPEFFECTS=
|arg= local |MPARGUMENTS=
|arg= local |MPARGUMENTS=


|gr1= Communication Menu|GROUP1=
|gr1= Communication Menu


| Add [[Arma_3_Communication_Menu|communication menu]] to the given unit.
| Add [[Arma_3_Communication_Menu|communication menu]] to the given unit.


The item will be available in the Communication menu and visualized in comm menu icon area.|DESCRIPTION=
The item will be available in the Communication menu and visualized in comm menu icon area.


| [owner,itemClass,textArguments,expressionArguments,notification] call [[BIS_fnc_addCommMenuItem]]; |SYNTAX=
| [owner,itemClass,textArguments,expressionArguments,notification] call [[BIS_fnc_addCommMenuItem]];


|p1= '''owner''': [[Object]] - object to which the item belongs to |Parameter1=
|p1= '''owner''': [[Object]] - object to which the item belongs to
|p2= '''itemClass''': [[String]] - CfgCommunicationMenu class |Parameter2=
|p2= '''itemClass''': [[String]] - CfgCommunicationMenu class


|p3= '''textArguments''' (Optional): [[Any]] |PARAMETER3=
|p3= '''textArguments''' (Optional): [[Any]]


|p4= '''expressionArguments''' (Optional): [[Any]] |PARAMETER4=
|p4= '''expressionArguments''' (Optional): [[Any]]


|p5= '''notification''' (Optional): [[String]] - notification class from CfgNotifications. Empty string will disabled the notification. |PARAMETER5=
|p5= '''notification''' (Optional): [[String]] - notification class from CfgNotifications. Empty string will disabled the notification.


| [[Number]] - item ID, used in [[BIS_fnc_removeCommMenuItem]] |RETURNVALUE=
| [[Number]] - item ID, used in [[BIS_fnc_removeCommMenuItem]]
   
   
|x1= <code>_supportHeli = [<nowiki/>[[player]],"Support_Request_CAS_Heli"] [[call]] [[BIS_fnc_addCommMenuItem]];
|x1= <code>_supportHeli = [<nowiki/>[[player]],"Support_Request_CAS_Heli"] [[call]] [[BIS_fnc_addCommMenuItem]];
_supportHeli = [<nowiki/>[[player]],"Support_Request_CAS_Heli",nil,nil,""] [[call]] [[BIS_fnc_addCommMenuItem]]; {{codecomment|// don't show notification}}</code> |EXAMPLE1=
_supportHeli = [<nowiki/>[[player]],"Support_Request_CAS_Heli",nil,nil,""] [[call]] [[BIS_fnc_addCommMenuItem]]; {{codecomment|// don't show notification}}</code>


| [[BIS_fnc_removeCommMenuItem]], [[Arma_3_Communication_Menu]] |SEEALSO=
| [[BIS_fnc_removeCommMenuItem]], [[Arma_3_Communication_Menu]]


}}
}}

Revision as of 23:38, 17 January 2021

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 (Optional): Any
expressionArguments (Optional): Any
notification (Optional): String - notification class from CfgNotifications. Empty string will disabled the notification.
Return Value:
Number - item ID, used in BIS_fnc_removeCommMenuItem

Examples

Example 1:
_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_removeCommMenuItemArma_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


Bottom Section