Channel IDs: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Some wiki formatting) |
Lou Montana (talk | contribs) m (Some wiki formatting) |
||
(2 intermediate revisions by the same user not shown) | |||
Line 3: | Line 3: | ||
== | == Description == | ||
{{Feature|informative|"Content" designates anything channel-related: markers, messages, voice.}} | {{Feature|informative|"Content" designates anything channel-related: markers, messages, voice.}} | ||
Line 10: | Line 10: | ||
! Channel ID !! Channel Name !! Visible To !! Additional Information | ! Channel ID !! Channel Name !! Visible To !! Additional Information | ||
|- | |- | ||
| -1 || None || All players. | | | -1 || None || All players. || Is used when a marker is created with [[createMarker]] and the '''channelID''' parameter was not defined. Markers in "none" channel are visible in all other channels as well. | ||
| Is used when a marker is created with [[createMarker]] and the '''channelID''' parameter was not defined. Markers in "none" channel are visible in all other channels as well. | |||
|- | |- | ||
| 0 || Global || All players. || | | 0 || Global || All players. || | ||
Line 23: | Line 22: | ||
| 4 || Vehicle || Content is only visible to the vehicle's crew. || | | 4 || Vehicle || Content is only visible to the vehicle's crew. || | ||
|- | |- | ||
| 5 || Direct || | | 5 || Direct || Players in close proximity. || | ||
|- | |- | ||
| 6 | | 6..15 || Custom Channels || Content will only be available for players which have been assigned to this channel. See [[radioChannelAdd]]. || Custom channels can be created on the fly. See [[radioChannelCreate]]. | ||
{{Feature| | {{Feature|warning|The '''custom channel ID''' returned by [[radioChannelCreate]] is going to be in a range from 1 - 10 (0 if failed). Internally, these numbers are converted to the '''channel IDs''' 6 - 15 which are reserved for custom channels. | ||
{{{!}} class{{=}}"wikitable" | : {{{!}} class{{=}}"wikitable align-center" | ||
{{!}}- | {{!}}- | ||
! Channel ID | ! Channel ID | ||
{{!}} 6 | {{!}} style{{=}}"width: 1.5em" {{!}} '''6''' | ||
{{!}} 7 | {{!}} style{{=}}"width: 1.5em" {{!}} 7 | ||
{{!}} 8 | {{!}} style{{=}}"width: 1.5em" {{!}} 8 | ||
{{!}} 9 | {{!}} style{{=}}"width: 1.5em" {{!}} 9 | ||
{{!}} 10 | {{!}} style{{=}}"width: 1.5em" {{!}} 10 | ||
{{!}} 11 | {{!}} style{{=}}"width: 1.5em" {{!}} 11 | ||
{{!}} 12 | {{!}} style{{=}}"width: 1.5em" {{!}} 12 | ||
{{!}} 13 | {{!}} style{{=}}"width: 1.5em" {{!}} 13 | ||
{{!}} 14 | {{!}} style{{=}}"width: 1.5em" {{!}} 14 | ||
{{!}} 15 | {{!}} style{{=}}"width: 1.5em" {{!}} '''15''' | ||
{{!}}- | {{!}}- | ||
! Custom Channel ID | ! Custom Channel ID | ||
{{!}} 1 | {{!}} '''1''' | ||
{{!}} 2 | {{!}} 2 | ||
{{!}} 3 | {{!}} 3 | ||
Line 51: | Line 50: | ||
{{!}} 8 | {{!}} 8 | ||
{{!}} 9 | {{!}} 9 | ||
{{!}} 10 | {{!}} '''10''' | ||
{{!}}} <!--- close inner table ---> | {{!}}} <!--- close inner table ---> | ||
}} <!--- close warning template ---> | }} <!--- close warning template ---> | ||
Line 57: | Line 56: | ||
== | == Colours == | ||
[[File:xChat.jpg|right]] | [[File:xChat.jpg|right]] | ||
Line 85: | Line 84: | ||
// Create custom channel | // Create custom channel | ||
_customChannelID = radioChannelCreate [[0.96, 0.34, 0.13, 0.8], "Q-dance Radio", "%UNIT_NAME", [player]]; // _customChannelID is 1 | _customChannelID = radioChannelCreate [[0.96, 0.34, 0.13, 0.8], "Q-dance Radio", "%UNIT_NAME", [player]]; // _customChannelID is 1 | ||
// Switch current channel of the player to the newly created channel. | // Switch current channel of the player to the newly created channel. | ||
setCurrentChannel (_customChannelID + 5); // Note the channel ID used here. Even though the ID returned by radioChannelCreate is 1, we have to use 6 as channel ID - see table above. | setCurrentChannel (_customChannelID + 5); // Note the channel ID used here. Even though the ID returned by radioChannelCreate is 1, we have to use 6 as channel ID - see table above. | ||
// Let us use this channel for a message | // Let us use this channel for a message | ||
player customChat [_customChannelID, "Hi, I am a custom chat message"]; // Since this command uses the customChannelID we have to use 1 (_customChannelID) here | player customChat [_customChannelID, "Hi, I am a custom chat message"]; // Since this command uses the customChannelID we have to use 1 (_customChannelID) here | ||
</sqf> | </sqf> | ||
{{Feature|important|Always be aware of what kind of channel ID you are currently working with and what channel ID is expected by the command you are using. See [[:Category:Command Group: Custom Radio and Chat|Command Group: Custom Radio and Chat]] for commands which expect a customChannelID | {{Feature|important| | ||
Always be aware of what kind of channel ID you are currently working with and what channel ID is expected by the command you are using. | |||
See [[:Category:Command Group: Custom Radio and Chat|Command Group: Custom Radio and Chat]] for commands which expect a customChannelID. | |||
}} | |||
Latest revision as of 13:16, 1 October 2024
In Arma 3, chat, radio, VON and markers all use the same channel ID system. However, channel IDs for custom channels behave a bit differently. This is explained in the table below.
Description
Channel ID | Channel Name | Visible To | Additional Information |
---|---|---|---|
-1 | None | All players. | Is used when a marker is created with createMarker and the channelID parameter was not defined. Markers in "none" channel are visible in all other channels as well. |
0 | Global | All players. | |
1 | Side | Content is only visible to the side of the player who created it. | |
2 | Command | ||
3 | Group | Content is only visible for the players in the group of the player who created it. | This channel cannot be disabled. It's the default fallback channel if all other channels are disabled. |
4 | Vehicle | Content is only visible to the vehicle's crew. | |
5 | Direct | Players in close proximity. | |
6..15 | Custom Channels | Content will only be available for players which have been assigned to this channel. See radioChannelAdd. | Custom channels can be created on the fly. See radioChannelCreate. |
Colours
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";
Changing Channels
- Ingame Controls
- , and . cycle through the channels
- Scripting
- setCurrentChannel
Custom Channel Example
// Create custom channel
_customChannelID = radioChannelCreate [[0.96, 0.34, 0.13, 0.8], "Q-dance Radio", "%UNIT_NAME", [player]]; // _customChannelID is 1
// Switch current channel of the player to the newly created channel.
setCurrentChannel (_customChannelID + 5); // Note the channel ID used here. Even though the ID returned by radioChannelCreate is 1, we have to use 6 as channel ID - see table above.
// Let us use this channel for a message
player customChat [_customChannelID, "Hi, I am a custom chat message"]; // Since this command uses the customChannelID we have to use 1 (_customChannelID) here