enableChannel: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(both syntaxes support custom)
m (Text replacement - "server.cfg" to "server config")
 
(37 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
______________________________________________________________________________________________


| arma3 |Game name=
|game1= arma3
|version1= 1.42


|1.42|Game version=
|eff= local


|eff= local |Multiplayer Effects=
|gr1= Radio and Chat


|gr1= Radio and Chat |GROUP1=
|descr= Enables/disables UI functionality which is responsible for sending text or voice chat to the given chat channel.
__________________________________________________________________________________________
{{Feature|informative|
 
| Enables/disables UI functionality which is responsible for sending text or voice chat to the given chat channel. If the channel was disabled in [[Description.ext]], it can be enabled with this command, however the UI functionality changes will be local to the PC executing this command.
{{Informative|
This command:
This command:
* cannot disable Global channel for the admin, because Global channel is always available for the admin
* can override [[Description.ext]] or [[Arma 3: Server Config File|server config]]'s channel setting
* cannot disable Global channel for the admin or server host, because Global channel is always available for the admin
* does not disable ''incoming'' text or voice
* does not disable ''incoming'' text or voice
* does not interrupt own client's transmission in progress (but will prevent any further ones)
* actively interrupts (since {{arma3}} v2.02) the current communication in progress
* does not affect chat related scripting commands such as [[vehicleChat]], [[globalRadio]] etc.
* does not affect chat related scripting commands such as [[vehicleChat]], [[globalRadio]] etc.
}}
}}


Channel / Number correspondence:
{{{!}} class="wikitable align-center"
* 0 {{=}} Global
! colspan="16" {{!}} [[Channel IDs|Channel ID]] number correspondence
* 1 {{=}} Side
{{!}}-
* 2 {{=}} Command
{{!}} colspan="6" {{!}} Default Channels
* ''3 {{=}} Group'' (cannot be disabled with [[enableChannel]] nor [[Description.ext#disableChannels|Description.ext/disableChannels[]<nowiki/>]])
{{!}} colspan="10" {{!}} Custom Channels
* 4 {{=}} Vehicle
{{!}}- style="font-size: .9em"
* 5 {{=}} Direct
{{!}} Global
* 6-15 {{=}} Custom Radio
{{!}} Side
|DESCRIPTION=
{{!}} Command
____________________________________________________________________________________________
{{!}} Group
{{!}} Vehicle
{{!}} Direct
{{!}} CC&nbsp;1
{{!}} CC&nbsp;2
{{!}} CC&nbsp;3
{{!}} CC&nbsp;4
{{!}} CC&nbsp;5
{{!}} CC&nbsp;6
{{!}} CC&nbsp;7
{{!}} CC&nbsp;8
{{!}} CC&nbsp;9
{{!}} CC&nbsp;10
{{!}}-
{{!}} 0
{{!}} 1
{{!}} 2
{{!}} 3
{{!}} 4
{{!}} 5
{{!}} 6
{{!}} 7
{{!}} 8
{{!}} 9
{{!}} 10
{{!}} 11
{{!}} 12
{{!}} 13
{{!}} 14
{{!}} 15
{{!}}}


| channelID [[enableChannel]] enable |SYNTAX=
|s1= channelID [[enableChannel]] enable


|p1= channelID: [[Number]] |PARAMETER1=
|p1= channelID: [[Number]] - [[Channel IDs|channel ID]]


|p2= enable: [[Boolean]] - [[true]] to enable, [[false]] to disable (both VoN and chat) |PARAMETER2=
|p2= enable: [[Boolean]] - [[true]] to enable, [[false]] to disable (both VoN and chat)


| [[Nothing]] |RETURNVALUE=
|r1= [[Nothing]]


|s2= channelID [[enableChannel]] [chat, VoN] {{since|arma3|1.59.135661|y}} |SYNTAX2=
|s2= channelID [[enableChannel]] [chat, VoN]


|p21= channelID: [[Number]] |PARAMETER21=
|s2since= arma3 1.60


|p22= [chat, VoN]: [[Array]] |PARAMETER22=
|p21= channelID: [[Number]] - [[Channel IDs|channel ID]]


|p23= chat: [[Boolean]] - [[true]] to enable text chat |PARAMETER23=
|p22= chat: [[Boolean]] - [[true]] to enable text chat


|p24= VoN: [[Boolean]] - [[true]] to enable voice chat |PARAMETER4=
|p23= VoN: [[Boolean]] - [[true]] to enable voice chat


|r2= [[Nothing]] |RETURNVALUE2=
|r2= [[Nothing]]
____________________________________________________________________________________________


|x1= <code>0 [[enableChannel]] [[false]]; {{cc|Disable user ability to send voice and text on global channel}}</code> |EXAMPLE1=
|x1= <sqf>0 enableChannel false; // disable user ability to send voice and text on global channel</sqf>


|x2= <code>0 [[enableChannel]] [<nowiki/>[[true]], [[false]]]; {{cc|Enable user ability to send text but disable voice on global channel}}</code> |EXAMPLE2=
|x2= <sqf>0 enableChannel [true, false]; // enable user ability to send text but disable voice on global channel</sqf>
____________________________________________________________________________________________


|[[currentChannel]], [[setCurrentChannel]], [[getPlayerChannel]], [[channelEnabled]], [[radioChannelCreate]] |SEEALSO=
|seealso= [[currentChannel]] [[setCurrentChannel]] [[getPlayerChannel]] [[channelEnabled]] [[radioChannelCreate]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>

Latest revision as of 13:36, 17 May 2024

Arma 3 logo black.png1.42
LELocal
Hover & click on the images for description

Description

Description:
Enables/disables UI functionality which is responsible for sending text or voice chat to the given chat channel.
ⓘ
This command:
  • can override Description.ext or server config's channel setting
  • cannot disable Global channel for the admin or server host, because Global channel is always available for the admin
  • does not disable incoming text or voice
  • actively interrupts (since Arma 3 v2.02) the current communication in progress
  • does not affect chat related scripting commands such as vehicleChat, globalRadio etc.
Channel ID number correspondence
Default Channels Custom Channels
Global Side Command Group Vehicle Direct CC 1 CC 2 CC 3 CC 4 CC 5 CC 6 CC 7 CC 8 CC 9 CC 10
0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
Groups:
Radio and Chat

Syntax

Syntax:
channelID enableChannel enable
Parameters:
channelID: Number - channel ID
enable: Boolean - true to enable, false to disable (both VoN and chat)
Return Value:
Nothing

Alternative Syntax

Syntax:
channelID enableChannel [chat, VoN]
Parameters:
channelID: Number - channel ID
chat: Boolean - true to enable text chat
VoN: Boolean - true to enable voice chat
Return Value:
Nothing

Examples

Example 1:
0 enableChannel false; // disable user ability to send voice and text on global channel
Example 2:
0 enableChannel [true, false]; // enable user ability to send text but disable voice on global channel

Additional Information

See also:
currentChannel setCurrentChannel getPlayerChannel channelEnabled radioChannelCreate

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=enableChannel&oldid=364552"