BIS fnc moduleChat: 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


|1.00|Game version=
|1.00


|gr1= Modules |GROUP1=
|gr1= Modules


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


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


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


|p1= logic: [[Object]] the logic. Possible [[setVariable]] parameters:
|p1= logic: [[Object]] the logic. Possible [[setVariable]] parameters:
Line 20: Line 20:
** "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|Objects]] - 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=
| [[Boolean]] - [[true]] when done, even if ''isActivated'' equals [[false]]


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


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



Revision as of 00:12, 18 January 2021

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

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