BIS fnc moduleChat: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision)
(Page filling)
Line 1: Line 1:
{{Function|Comments=
____________________________________________________________________________________________


{{Function|= Comments
| arma3 |Game name=
____________________________________________________________________________________________


| arma3 |= Game name
|1.00|Game version=


|1.00|= Game version
|eff= local |MP effects=
____________________________________________________________________________________________
____________________________________________________________________________________________


| ''N/A'' |= Description
| Make a list of units use any *chat command ([[groupChat]], [[vehicleChat]], [[sideChat]], [[commandChat]], [[globalChat]]) |Description=
____________________________________________________________________________________________
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_moduleChat]]; --> |= Syntax
| [logic, units, isActivated] call [[BIS_fnc_moduleChat]] |Syntax=
 
|p1= logic: [[Object]] the logic. It must have [[setVariable]] the following variables:
* "Text": [[String]] - the text to be sent
* "Channel": [[String]] - a number '''as a string''':
** "0": [[groupChat]]
** "1": [[vehicleChat]]
** "2": [[sideChat]]
** "3": [[commandChat]]
** "4": [[globalChat]] |Parameter 1=


|p1= |= Parameter 1
|p2= units: [[Array]] of [[Object|Objects]] - list of chatting units |Parameter 2=


| |= Return value
|p3= isActivated: [[Boolean]] - (Optional, default [[true]]) if [[true]], the chat is sent to all units |Parameter 3=
 
| [[Boolean]] - [[true]] when done, even if ''isActivated'' equals [[false]] |Return value=
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <code></code> |=  
|x1= <code>myLogic [[setVariable]] ["Channel", "2"];
myLogic [[setVariable]] ["Text", "Hello everyone, this is side chat!"];
[myLogic, <nowiki>[</nowiki>[[player]]], [[true]]] [[call]] [[BIS_fnc_moduleChat]];</code> |Example 1=
____________________________________________________________________________________________
____________________________________________________________________________________________


| |= See also
| [[groupChat]], [[vehicleChat]], [[sideChat]], [[commandChat]], [[globalChat]] |See also=
 
}}
}}


Line 33: Line 46:


<h3 style="display:none">Bottom Section</h3>
<h3 style="display:none">Bottom Section</h3>
[[Category:Functions|{{uc:moduleChat}}]]
[[Category:Function Group: Events|{{uc:moduleChat}}]]
[[Category:Function Group: Events|{{uc:moduleChat}}]]
[[Category:Functions|{{uc:moduleChat}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:moduleChat}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:moduleChat}}]]

Revision as of 19:35, 3 July 2018

Hover & click on the images for description

Description

Description:
Make a list of units use any *chat command (groupChat, vehicleChat, sideChat, commandChat, globalChat)
Execution:
call
Groups:
Uncategorised

Syntax

Syntax:
[logic, units, isActivated] call BIS_fnc_moduleChat
Parameters:
logic: Object the logic. It must have setVariable the following variables:
units: Array of Objects - list of chatting units
isActivated: Boolean - (Optional, default true) if true, the chat is sent to all units
Return Value:
Boolean - true when done, even if isActivated equals false

Examples

Example 1:
myLogic setVariable ["Channel", "2"]; myLogic setVariable ["Text", "Hello everyone, this is side chat!"]; [myLogic, [player], true] call BIS_fnc_moduleChat;

Additional Information

See also:
groupChatvehicleChatsideChatcommandChatglobalChat

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