commandChat: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Changed unitName to unit to avoid misunderstandings)
 
(53 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma2 |= Game name
|game1= arma2
|version1= 1.00


|1.00|= Game version
|game2= arma2oa
|version2= 1.50


|arg= global |= Arguments in MP
|game3= tkoh
|version3= 1.00


|eff= local |= Effects in MP
|game4= arma3
____________________________________________________________________________________________
|version4= 0.50


| Types text to the command radio channel. Must have assigned "ItemRadio" to see or transmit the messages. The text will be visible only on the PC where command was executed. If you need the message to show on all computers, you have to execute it globally (see [[remoteExec]]) |= Description
|arg= global
____________________________________________________________________________________________


|eff= local


| unitName '''commandChat''' chatText |= Syntax
|gr1= Radio and Chat


|p1= unitName: [[Object]] - unit transmitting message|= Parameter 1
|gr2= Sounds
|p2= chatText: [[String]] - message to transmit |= Parameter 2


| [[Nothing]] |= Return value
|descr= Types text to the command radio channel. The text will be visible only on the PC where command was executed. If you need the message to show on all computers, you have to execute it globally (see [[remoteExec]])


{{Feature|important|The unit must have an [[assignItem|assigned]] radio item (such as '''''"ItemRadio"''''') to see or transmit the messages. A radio item must have the property <syntaxhighlight lang="cpp" inline>simulation = "ItemRadio";</syntaxhighlight> in its [[CfgWeapons_Config_Reference#simulation.3D.22Weapon.22|CfgWeapons config]].}}


|s2= [side, identity] '''commandChat''' chatText |= Syntax
|s1= unit [[commandChat]] chatText


|p21= [side, identity]: [[Array]] |= Parameter 1
|p1= unit: [[Object]] - unit transmitting message
|p22= side: [[Side]] - side to which the message will be seen |= Parameter 2
 
|p23= identity: [[String]] - class name of one of the identities in CfgHQIdentities. Possible identities in Arma 3 are:
|p2= chatText: [[String]] - message to transmit
 
|r1= [[Nothing]]
 
|s2= [side, identity] [[commandChat]] chatText
 
|p21= side: [[Side]] - side to which the message will be seen
 
|p22= identity: [[String]] - class name of one of the identities in CfgHQIdentities. Possible identities in {{arma3}} are:
{{Columns|2|
* "Base"
* "Base"
* "HQ"
* "HQ"
Line 35: Line 46:
* "OPF"
* "OPF"
* "IND"
* "IND"
* "IND_G" |= Parameter 3
* "IND_G"
|p24= chatText: [[String]] - message to transmit |= Parameter 4
}}
|r2=  [[Nothing]] |= Return value


|p23= chatText: [[String]] - message to transmit


|x1= <code>_soldierOne [[commandChat]] "Show this text";</code>|EXAMPLE1=
|r2= [[Nothing]]


|x2= <code><nowiki>[</nowiki>[[playerSide]], "HQ"] [[commandChat]] "Do this! That's an order!";</code>|EXAMPLE2=
|x1= <sqf>_soldierOne commandChat "Show this text";</sqf>


|x3= <code>[[driver]] [[vehicle]] [[player]] [[sideChat]] "sideChat";
|x2= <sqf>[playerSide, "HQ"] commandChat "Do this! That's an order!";</sqf>
[[driver]] [[vehicle]] [[player]] [[globalChat]] "globalChat";
[[driver]] [[vehicle]] [[player]] [[groupChat]] "groupChat";
[[vehicle]] [[player]] [[vehicleChat]] "vehicleChat";
[[driver]] [[vehicle]] [[player]] [[commandChat]] "commandChat";
[[driver]] [[vehicle]] [[player]] [[customChat]] [1, "customChat"];
[[systemChat]] "systemChat";</code>
<br>[[Image:xChat.jpg]]|= Example 3


| [[globalChat]], [[groupChat]], [[vehicleChat]], [[sideChat]], [[customChat]], [[systemChat]], [[commandRadio]] |= See also
|x3= [[File:xChat.jpg|right]]
<sqf>
driver vehicle player sideChat "sideChat";
driver vehicle player globalChat "globalChat";
driver vehicle player groupChat "groupChat";
vehicle player vehicleChat "vehicleChat";
driver vehicle player commandChat "commandChat";
driver vehicle player customChat [1, "customChat"];
systemChat "systemChat";
</sqf>


| |MPBEHAVIOUR=  
|seealso= [[globalChat]] [[groupChat]] [[vehicleChat]] [[sideChat]] [[customChat]] [[systemChat]] [[commandRadio]]
____________________________________________________________________________________________
}}
}}
<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:ArmA 2: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 09:16, 2 February 2024

Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
GAGlobalLELocal
Hover & click on the images for description

Description

Description:
Types text to the command radio channel. The text will be visible only on the PC where command was executed. If you need the message to show on all computers, you have to execute it globally (see remoteExec)
⚠
The unit must have an assigned radio item (such as "ItemRadio") to see or transmit the messages. A radio item must have the property simulation = "ItemRadio"; in its CfgWeapons config.
Groups:
Radio and ChatSounds

Syntax

Syntax:
unit commandChat chatText
Parameters:
unit: Object - unit transmitting message
chatText: String - message to transmit
Return Value:
Nothing

Alternative Syntax

Syntax:
[side, identity] commandChat chatText
Parameters:
side: Side - side to which the message will be seen
identity: String - class name of one of the identities in CfgHQIdentities. Possible identities in Arma 3 are:
  • "Base"
  • "HQ"
  • "PAPA_BEAR"
  • "AirBase"
  • "BLU"
  • "OPF"
  • "IND"
  • "IND_G"
chatText: String - message to transmit
Return Value:
Nothing

Examples

Example 1:
_soldierOne commandChat "Show this text";
Example 2:
[playerSide, "HQ"] commandChat "Do this! That's an order!";
Example 3:
xChat.jpg
driver vehicle player sideChat "sideChat"; driver vehicle player globalChat "globalChat"; driver vehicle player groupChat "groupChat"; vehicle player vehicleChat "vehicleChat"; driver vehicle player commandChat "commandChat"; driver vehicle player customChat [1, "customChat"]; systemChat "systemChat";

Additional Information

See also:
globalChat groupChat vehicleChat sideChat customChat systemChat commandRadio

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=commandChat&oldid=352240"