radioChannelSetCallSign: Difference between revisions

From Bohemia Interactive Community
(First draft documentation for new TKOH command)
 
(Add parameters table)
 
(46 intermediate revisions by 8 users not shown)
Line 1: Line 1:
[[Category:Scripting Commands]]
{{RV|type=command


{{Command|= Comments
|game1= tkoh
____________________________________________________________________________________________
|version1= 1.00


| TKOH |= Game name
|game2= arma3
|version2= 0.50


|1.00|= Game version
|arg= global
____________________________________________________________________________________________
|eff= global


| Set the custom radio channel's call sign. |= Description
|gr1= Radio and Chat
____________________________________________________________________________________________


| index '''radioChannelSetCallSign''' callSign|= Syntax
|gr2= Custom Radio and Chat


|p1= index : [[Number]] - custom radio channel index |= Parameter 1
|descr= Set the custom radio chat channel's callsign / VoN callsign.
|p2= callSign : [[String]] - custom call sign |= Parameter 2


| [[Nothing]] |= Return value
|s1= customChannelID [[radioChannelSetCallSign]] callSign
____________________________________________________________________________________________


|x1= <code>4 radioChannelSetCallSign "%UNIT_NAME";</code> |=
|p1= customChannelID: [[Number]] - [[Channel IDs|custom channel ID]] returned by [[radioChannelCreate]] command


| - |= See also
|p2= callSign: [[String]] or {{GVI|arma3|2.22|size= 0.75}} [[Array]] - custom chat callsign or [callSign, callSignVoN]. Available parameters: <spoiler>
{| class="wikitable"
! Parameter !! Description !! Example
|-
| {{hl|%$KEY}} || Reference a localised text || "%$STR_Q_North" &rarr; "North"
|-
| {{hl|%CHANNEL_LABEL}} || The channel's label - see [[radioChannelSetLabel]] || "Q-dance Radio"
|-
| {{hl|%UNIT_SIDE}} || Side's name, similar to [[sideRadio]] || "BLUFOR"
|-
| {{hl|%UNIT_NAME}} || The '''''player'''''<nowiki/>'s or AI's name - see [[name]] || "John Doe"
|-
| {{hl|%UNIT_RANK}} || A shorthand version of the unit's rank || "Sgt"
|-
| {{hl|%UNIT_ID}} || The unit's id in the group || "1"
|-
| {{hl|%UNIT_REF}} || The unit's log reference || "Unit123456"
|-
| {{hl|%UNIT_GRP_NAME}} || The group's name - see [[setGroupId]] || "Alpha 1-1"
|-
| {{hl|%UNIT_GRP_LEADER}} || Group leader mention (if the unit is its group's leader) || ", group leader"
|-
| {{hl|%UNIT_VEH_NAME}} || Display name of the unit's vehicle || "Hunter"
|-
| {{hl|%UNIT_VEH_POSITION}} || Unit's vehicle position, similar to [[vehicleRadio]] || "Gunner"
|-
| {{hl|%%}} || To display a normal percentage sign || {{n/a}}
|}
</spoiler>


}}
|r1= [[Nothing]]


<h3 style="display:none">Notes</h3>
|x1= <sqf>4 radioChannelSetCallSign "(%UNIT_ID) %UNIT_RANK %UNIT_NAME%UNIT_GRP_LEADER"; // (1) Sgt Ben Kelly, group leader</sqf>
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|x2= <sqf>4 radioChannelSetCallSign ["%UNIT_VEH_POSITION, %UNIT_VEH_NAME", "%UNIT_NAME%UNIT_GRP_LEADER"];</sqf>
</dl>


<h3 style="display:none">Bottom Section</h3>
|seealso= [[radioChannelAdd]] [[radioChannelCreate]] [[radioChannelRemove]] [[radioChannelSetLabel]]
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]
}}
[[Category:Take On Helicopters: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]

Latest revision as of 00:46, 2 April 2026

tkoh logo small.png 1.00Arma 3 logo black.png 0.50
GAGlobalGEGlobal
Hover & click on the images for description

Description

Description:
Set the custom radio chat channel's callsign / VoN callsign.
Groups:
Radio and ChatCustom Radio and Chat

Syntax

Syntax:
customChannelID radioChannelSetCallSign callSign
Parameters:
customChannelID: Number - custom channel ID returned by radioChannelCreate command
callSign: String or Arma 3 logo black.png 2.22 Array - custom chat callsign or [callSign, callSignVoN]. Available parameters:
Parameter Description Example
%$KEY Reference a localised text "%$STR_Q_North" → "North"
%CHANNEL_LABEL The channel's label - see radioChannelSetLabel "Q-dance Radio"
%UNIT_SIDE Side's name, similar to sideRadio "BLUFOR"
%UNIT_NAME The player's or AI's name - see name "John Doe"
%UNIT_RANK A shorthand version of the unit's rank "Sgt"
%UNIT_ID The unit's id in the group "1"
%UNIT_REF The unit's log reference "Unit123456"
%UNIT_GRP_NAME The group's name - see setGroupId "Alpha 1-1"
%UNIT_GRP_LEADER Group leader mention (if the unit is its group's leader) ", group leader"
%UNIT_VEH_NAME Display name of the unit's vehicle "Hunter"
%UNIT_VEH_POSITION Unit's vehicle position, similar to vehicleRadio "Gunner"
%% To display a normal percentage sign N/A
↑ Back to spoiler's top
Return Value:
Nothing

Examples

Example 1:
4 radioChannelSetCallSign "(%UNIT_ID) %UNIT_RANK %UNIT_NAME%UNIT_GRP_LEADER"; // (1) Sgt Ben Kelly, group leader
Example 2:
4 radioChannelSetCallSign ["%UNIT_VEH_POSITION, %UNIT_VEH_NAME", "%UNIT_NAME%UNIT_GRP_LEADER"];

Additional Information

See also:
radioChannelAdd radioChannelCreate radioChannelRemove radioChannelSetLabel

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord.
Only post proven facts here! Add Note
Retrieved from "https://community.bistudio.com/wiki?title=radioChannelSetCallSign&oldid=378308"