0.0.1

resources/[standalone]/pma-voice/docs/client-setters/removePlayerFromCall.md

@@ -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()
+```

resources/[standalone]/pma-voice/docs/client-setters/removePlayerFromRadio.md

@@ -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()
+```

resources/[standalone]/pma-voice/docs/client-setters/setCallChannel.md

@@ -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)
+```

resources/[standalone]/pma-voice/docs/client-setters/setCallVolume.md

@@ -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)
+```

resources/[standalone]/pma-voice/docs/client-setters/setMicClickOffVolume.md

@@ -0,0 +1,14 @@
+## setMicClickOffVolume
+
+## Description
+
+Sets the local players radio turn off mic click volume
+
+## Parameters
+
+* **volume**: the volume to change to between 0 - 100 percent
+
+```lua
+-- sets the radio turn off mic click volume to 20 percent
+exports['pma-voice']:setMicClickOffVolume(20)
+```

resources/[standalone]/pma-voice/docs/client-setters/setMicClickOnVolume.md

@@ -0,0 +1,14 @@
+## setMicClickOnVolume
+
+## Description
+
+Sets the local players radio turn on mic click volume
+
+## Parameters
+
+* **volume**: the volume to change to between 0 - 100 percent
+
+```lua
+-- sets the radio turn on mic click volume to 20 percent
+exports['pma-voice']:setMicClickOnVolume(20)
+```

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

@@ -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
+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)
+```

resources/[standalone]/pma-voice/docs/client-setters/setRadioVolume.md

@@ -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)
+```

resources/[standalone]/pma-voice/docs/client-setters/setVoiceProperty.md

@@ -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)
+```