BIS fnc moduleChat: Difference between revisions

Latest revision as of 18:00, 13 July 2022

1.00

LELocal

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:: Modules

Syntax

Syntax:

[logic, units, isActivated] call BIS_fnc_moduleChat

Parameters:

logic: Object the logic. Possible setVariable parameters:

"Text": String - the text to be sent
"Channel": String - (Optional, default "0") a number as a string:
- "0": groupChat
- "1": vehicleChat
- "2": sideChat
- "3": commandChat
- "4": globalChat

units: Array of Objects - list of chatting units

isActivated: Boolean - (Optional, default true) if true, the module is activated and chat is send. false disables the module

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:: groupChat vehicleChat sideChat commandChat globalChat systemChat

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

@@ Line 1: / Line 1: @@
+{{RV|type=function
-{{Function|= Comments
+|game1= arma3
-____________________________________________________________________________________________
+|version1= 1.00
-| arma3 |= Game name
+|gr1= Modules
-|1.00|= Game version
+|eff= local
-____________________________________________________________________________________________
-| ''N/A'' |= Description
+|descr= Make a list of units use any *chat command ([[groupChat]], [[vehicleChat]], [[sideChat]], [[commandChat]], [[globalChat]]).
-____________________________________________________________________________________________
-| <!-- [] call [[BIS_fnc_moduleChat]]; --> |= Syntax
+|s1= [logic, units, isActivated] call [[BIS_fnc_moduleChat]]
-|p1= |= Parameter 1
+|p1= logic: [[Object]] the logic. Possible [[setVariable]] parameters:
+* "Text": [[String]] - the text to be sent
+* "Channel": [[String]] - (Optional, default "0") a number '''as a string''':
+** "0": [[groupChat]]
+** "1": [[vehicleChat]]
+** "2": [[sideChat]]
+** "3": [[commandChat]]
+** "4": [[globalChat]]
-| |= Return value
+|p2= units: [[Array]] of [[Object]]s - list of chatting units
-____________________________________________________________________________________________
-|x1= <code></code> |=
+|p3= isActivated: [[Boolean]] - (Optional, default [[true]]) if [[true]], the module is activated and chat is send. [[false]] disables the module
-____________________________________________________________________________________________
-| |= See also
+|r1= [[Boolean]] - [[true]] when done, even if ''isActivated'' equals [[false]]
+|x1= <sqf>myLogic setVariable ["Channel", "2"];
+myLogic setVariable ["Text", "Hello everyone, this is side chat!"];
+[myLogic, [player], true] call BIS_fnc_moduleChat;</sqf>
+|seealso= [[groupChat]] [[vehicleChat]] [[sideChat]] [[commandChat]] [[globalChat]] [[systemChat]]
 }}
-<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: Events|{{uc:moduleChat}}]]
-[[Category:Functions|{{uc:moduleChat}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:moduleChat}}]]