Saltychat Remove and PMA install

This commit is contained in:
Miho931 2025-06-30 19:26:56 +02:00
parent 0bff8ae174
commit 2fd3c1fe70
94 changed files with 8799 additions and 5199 deletions

View file

@ -0,0 +1,12 @@
## removePlayerFromCall
## Description
Removes the player from the call
## NOTE: This is just syntactic sugar for `setCallChannel(0)`
```lua
-- Removes the player from the call channel
exports['pma-voice']:removePlayerFromCall()
```

View file

@ -0,0 +1,12 @@
## removePlayerFromRadio
## Description
Removes the player from the radio
## NOTE: This is just syntactic sugar for `setRadioChannel(0)`
```lua
-- Removes the player from the radio channel
exports['pma-voice']:removePlayerFromRadio()
```

View file

@ -0,0 +1,25 @@
## setCallChannel | addPlayerToCall | SetCallChannel
## Description
Sets the local players call channel.
## Parameters
* **callChannel**: the call channel to join
```lua
-- Joins call channel 1
exports['pma-voice']:setCallChannel(1)
-- This will remove them from the call channel
exports['pma-voice']:setCallChannel(0)
```
addPlayerToCall is provided as a 'easier to read' version of setCallChannel.
```lua
-- Joins call channel 1
exports['pma-voice']:addPlayerToCall(1)
```

View file

@ -0,0 +1,14 @@
## setCallVolume
## Description
Sets the local players call channel volume
## Parameters
* **callVolume**: the call volume to set to between 0 - 100 percent
```lua
-- set the call volume to 50 percent
exports['pma-voice']:setCallVolume(50)
```

View file

@ -0,0 +1,26 @@
## 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
expots ['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)
```

View file

@ -0,0 +1,14 @@
## setRadioVolume
## Description
Sets the local players radio channel volume
## Parameters
* **radioVolume**: the radio volume to set to between 0 - 100 percent
```lua
-- sets the radio volume to 50 percent
exports['pma-voice']:setRadioVolume(50)
```

View file

@ -0,0 +1,17 @@
## setVoiceProperty | SetMumbleProperty | SetTokoProperty
## Description
Sets the voice property, currently the only use is to enable/disable radios and radio clicks.
## Parameters
* **property**: The property to set
* **value**: The value to set the property to
```lua
-- Enable the radio
exports['pma-voice']:setVoiceProperty('radioEnabled', true)
-- Disable radio clicks
exports['pma-voice']:setVoiceProperty('micClicks', false)
```