radioChannelCreate: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (return value)
Line 23: Line 23:
|p4= units: [[Array]] - list of units in the channel |= Parameter 4
|p4= units: [[Array]] - list of units in the channel |= Parameter 4


| [[Number]] - created channel id (used in [[customChat]] command) |= Return value
| [[Number]] - created channel ID (used in [[customChat]] command), 0 if failed |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________


Line 32: Line 32:
|p24= characters: [[Array]] - list of units in the channel |= Parameter 4
|p24= characters: [[Array]] - list of units in the channel |= Parameter 4
|p25= sentenceType: [[Boolean]] - enable putting all chat messages in quotations (default: true) |= Parameter 5
|p25= sentenceType: [[Boolean]] - enable putting all chat messages in quotations (default: true) |= Parameter 5
| r2= [[Number]] - created channel id (used in [[customChat]] command)|= Return value
| r2= [[Number]] - created channel ID (used in [[customChat]] command), 0 if failed |= Return value


|x1= <code>_index = '''radioChannelCreate''' [[0.96, 0.34, 0.13, 0.8], "Q-dance Radio", "%UNIT_NAME", [player]];</code> |=
|x1= <code>_index = '''radioChannelCreate''' [[0.96, 0.34, 0.13, 0.8], "Q-dance Radio", "%UNIT_NAME", [player]];</code> |=

Revision as of 22:44, 2 June 2016


Hover & click on the images for description

Description

Description:
Create a custom radio channel with the given color, label, call sign and registered characters. The index returned can be used to manipulate the created channel later. There are 10 slots for custom radio channels which would correspond to channels 6-15 (see getPlayerChannel). The command will find an unused index in this range and create it when found.
Multiplayer:
Execute on the server
Groups:
Uncategorised

Syntax

Syntax:
radioChannelCreate [color, label, callSign, units]
Parameters:
color: Array - RGBA color values
label: String - label
callSign: String - call sign
units: Array - list of units in the channel
Return Value:
Number - created channel ID (used in customChat command), 0 if failed

Alternative Syntax

Syntax:
radioChannelCreate [color, label, callSign, characters, sentenceType]
Parameters:
color: Array - RGBA color values
label: String - label
callSign: String - call sign
characters: Array - list of units in the channel
sentenceType: Boolean - enable putting all chat messages in quotations (default: true)
Return Value:
Number - created channel ID (used in customChat command), 0 if failed

Examples

Example 1:
_index = radioChannelCreate [[0.96, 0.34, 0.13, 0.8], "Q-dance Radio", "%UNIT_NAME", [player]];
Example 2:
_index = radioChannelCreate [[0.96, 0.34, 0.13, 0.8], "Q-dance Radio", "%UNIT_NAME", [player], false]; // disable automatic quotes for chat in channel (ArmA 3)

Additional Information

See also:
radioChannelAddradioChannelRemoveradioChannelSetCallSignradioChannelSetLabelcustomChatcustomRadiosetCurrentChannelcurrentChannelenableChannelchannelEnabledgetPlayerChannel

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

Notes

Bottom Section

Posted on January 21, 2016 - 13:30 (UTC)
Killzone Kid
Make sure you add all units you intend to speak or receive messages on created custom channel to the channel.