radioChannelInfo: Difference between revisions

From Bohemia Interactive Community
No edit summary
No edit summary
 
(4 intermediate revisions by the same user not shown)
Line 8: Line 8:
|gr2= Custom Radio and Chat
|gr2= Custom Radio and Chat


|descr= Obtains custom radio channel's details, set by [[radioChannelCreate]]. if 'customChannelID' is invalid, the return is either the first custom radio channel (customChannelID < firstCCChannel) or the last (customChannelID > lastCCChannel). 'inUse' [[true]] indicates if the channel was made available using [[radioChannelCreate]], [[false]] means it can be created.
|descr= Obtains custom radio channel's details. if 'customChannelID' is invalid, the return is either the first custom radio channel (customChannelID < firstCCChannel) or the last (customChannelID > lastCCChannel). 'inUse' [[true]] indicates if the channel was made available using [[radioChannelCreate]], [[false]] means it can be created.


|s1= [[radioChannelInfo]] customChannelID
|s1= [[radioChannelInfo]] customChannelID
Line 14: Line 14:
|p1= customChannelID: [[Number]] - [[Channel IDs|custom channel ID]] returned by [[radioChannelCreate]]
|p1= customChannelID: [[Number]] - [[Channel IDs|custom channel ID]] returned by [[radioChannelCreate]]


|r1= [[Array]] in format [colour, label, callSign, units, sentenceType, inUse] (see [[radioChannelCreate]])
|r1= [[Array]] in format [colour, label, callSign, units, sentenceType, inUse, {{GVI|arma3|2.22|size= 0.75}} callSignVoN] (see [[radioChannelCreate]])
 
|s2= [[radioChannelInfo]] option
|s2since= arma3 2.22
|p21= option: [[Boolean]] - [[true]] to return only channels in use, [[false]] to return all available channels
 
|r2= [[Array]] of [[Array]]s in format [ [colour, label, callSign, units, sentenceType, inUse, callSignVoN],....] (see [[radioChannelCreate]])


|x1= <sqf>
|x1= <sqf>

Latest revision as of 12:41, 23 November 2025

Hover & click on the images for description

Description

Description:
Obtains custom radio channel's details. if 'customChannelID' is invalid, the return is either the first custom radio channel (customChannelID < firstCCChannel) or the last (customChannelID > lastCCChannel). 'inUse' true indicates if the channel was made available using radioChannelCreate, false means it can be created.
Groups:
Radio and ChatCustom Radio and Chat

Syntax

Syntax:
radioChannelInfo customChannelID
Parameters:
customChannelID: Number - custom channel ID returned by radioChannelCreate
Return Value:
Array in format [colour, label, callSign, units, sentenceType, inUse, Arma 3 logo black.png 2.22 callSignVoN] (see radioChannelCreate)

Alternative Syntax

Syntax:
radioChannelInfo option
Parameters:
option: Boolean - true to return only channels in use, false to return all available channels
Return Value:
Array of Arrays in format [ [colour, label, callSign, units, sentenceType, inUse, callSignVoN],....] (see radioChannelCreate)

Examples

Example 1:
private _channelID = radioChannelCreate [[1, 0, 0.5, 0.8], "Q-dance Radio", "%UNIT_NAME", [u1, u2], false]; radioChannelInfo _channelID; // returns [[1,0,0.5,0.8], "Q-dance Radio", "%UNIT_NAME", [u1, u2], false, true]

Additional Information

See also:
radioChannelCreate getPlayerChannel

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