BIS fnc moduleChat: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (fixed parameter 3 description)
m (Text replacement - "= <code>([^<{]+)<\/code>" to "= <sqf>$1</sqf>")
 
(31 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|Comments=
{{RV|type=function
____________________________________________________________________________________________


| arma3 |Game name=
|game1= arma3
|version1= 1.00


|1.00|Game version=
|gr1= Modules


|eff= local |MP effects=
|eff= local
____________________________________________________________________________________________


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


| [logic, units, isActivated] call [[BIS_fnc_moduleChat]] |Syntax=
|s1= [logic, units, isActivated] call [[BIS_fnc_moduleChat]]


|p1= logic: [[Object]] the logic. Possible [[setVariable]] parameters:
|p1= logic: [[Object]] the logic. Possible [[setVariable]] parameters:
Line 21: Line 19:
** "2": [[sideChat]]
** "2": [[sideChat]]
** "3": [[commandChat]]
** "3": [[commandChat]]
** "4": [[globalChat]] |Parameter 1=
** "4": [[globalChat]]


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


|p3= isActivated: [[Boolean]] - (Optional, default [[true]]) if [[true]], the module is activated and chat is send. [[False]] disables the module |Parameter 3=
|p3= isActivated: [[Boolean]] - (Optional, default [[true]]) if [[true]], the module is activated and chat is send. [[false]] disables the module


| [[Boolean]] - [[true]] when done, even if ''isActivated'' equals [[false]] |Return value=
|r1= [[Boolean]] - [[true]] when done, even if ''isActivated'' equals [[false]]
____________________________________________________________________________________________


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


| [[groupChat]], [[vehicleChat]], [[sideChat]], [[commandChat]], [[globalChat]], [[systemChat]] |See also=
|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:Functions|{{uc:moduleChat}}]]
[[Category:Function Group: Events|{{uc:moduleChat}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:moduleChat}}]]

Latest revision as of 17:00, 13 July 2022

Arma 3 logo black.png1.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:
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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_moduleChat&oldid=328357"