Radio and Chat
41 scripting commands. Also as Markdown for agents.
- channelEnabledReturns Array of Booleans in format [enabledChat, enabledVoN] for the given channel. For more information about enabling/disabling of chat channels…
- clearRadioClean up the content of radio protocol history.
- commandChatTypes 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…
- commandRadioSends the audio message to the command radio channel. The message is defined in CfgRadio in the description.ext file or config radio protocol. The…
- conversationDisabledA getter for disableConversation.
- currentChannelReturns currently selected user chat channel on the UI (selected with <kbd><</kbd> and <kbd>></kbd> in multiplayer).
- customChatSends the chat message to the custom radio channel. The radio channel needs to be created on the server before hand, with radioChannelCreate command.…
- customRadioSends the message to the custom radio channel. The message is defined in the description.ext file or radio protocol.
- directSaySends given audio message to the direct channel. Command operates just like xxxxRadio commands, but the sound is played over direct channel and is…
- disableConversationIn theory disables the ability to talk to other people. In actuality, if true is given, the command increases unit's kbTell *IsSpeaking* status by 1,…
- enableChannelEnables/disables UI functionality which is responsible for sending text or voice chat to the given chat channel.
- enableRadioEnable and disable radio messages to be heard and shown in the left lower corner of the screen - the order-giving unit can still be heard…
- enableSentencesEnables radio transmissions to be heard and seen on screen. It does not affect KBTell conversations.
- getPlayerChannelReturns channel number for given player, provided that player is SPEAKING, otherwise -1. Having mic on is not enough, player has to make a sound.
- getPlayerVoNVolumeGets provided player's Voice over Network (VoN) volume.
- getSubtitleOptionsReturns subtitles settings.
- globalChatTypes text to the global radio channel. The text will be visible only on the PC where command was executed. If you need the message to show on all…
- globalRadioSends the audio message to the global radio channel. The message is defined in CfgRadio in the description.ext file or config radio protocol. The…
- groupChatTypes text to the group radio channel. The text will be visible only on the PC where command was executed. If you need the message to show on all…
- groupRadioSends the audio message to the group radio channel. The message is defined in CfgRadio in the description.ext file or config radio protocol.
- radioChannelAddAdd the units to the custom channel.
- radioChannelCreateCreate a custom radio channel with the given color, label, call sign and registered characters. The custom channel ID returned can be used to…
- radioChannelInfoObtains custom radio channel's details. if 'customChannelID' is invalid, the return is either the first custom radio channel (customChannelID <…
- radioChannelRemoveRemove the units from the custom radio channel.
- radioChannelSetCallSignSet the custom radio chat channel's callsign / VoN callsign.
- radioChannelSetLabelSet the custom radio channel's label.
- radioEnabledA getter for enableRadio.
- sentencesEnabledA getter for enableSentences.
- setCurrentChannelSets given channel as current chat channel. Scripted way of selecting desired channel on the UI.
- setPlayerVoNVolumeSets provided player's Voice over Network (VoN) volume.
- showChatShows/hides the whole chat window.
- shownChatReturns true if chat window is enabled. Chat window can be disabled with showChat command.
- shownRadioCheck if player has Radio enabled.
- shownSubtitlesA getter for showSubtitles.
- showRadioShows or hides the radio on the map screen, if enabled for the mission and you possess the item. (default true).
- showSubtitlesEnables / disables showing of subtitles in a chat. Only scripted/engine chatter is affected, player manual chat is unaffected. Returns the previous…
- sideChatTypes text to the side radio channel by the specified unit. Use clearRadio to clear chat history
- sideRadioSends the audio message to the side radio channel. The message is defined in CfgRadio in the description.ext file or config radio protocol. The…
- systemChatTypes text to the system radio channel. The text will be visible only on the PC where command was executed. If you need the message to show on all…
- vehicleChatTypes text to the vehicle radio channel. The text will be visible only on the PC where command was executed. If you need the message to show on all…
- vehicleRadioSends the audio message to the vehicle radio channel. The message is defined in CfgRadio in the description.ext file or config radio protocol. The…