Scripts/resources/[voice]/pma-voice/docs/client-setters/setRadioChannel.md

27 lines
609 B
Markdown
Raw Normal View History

2024-12-29 20:02:57 +00:00
## setRadioChannel | addPlayerToRadio | SetCallChannel
## Description
Sets the local players radio channel.
## Parameters
* **radioChannel**: the radio channel to join
## NOTE: If the player fails the server side radio channel check they will be reset to no channel.
```lua
-- Joins radio channel 1
exports['pma-voice']:setRadioChannel(1)
-- This will remove the player from all radio channels
exports ['pma-voice']:setRadioChannel(0)
```
addPlayerToRadio is provided as a 'easier to read' alternative to setRadioChannel.
```lua
-- Joins radio channel 1
exports['pma-voice']:addPlayerToRadio(1)
```