Update Functions-Ducker.md

JujuAdams · Jun 1, 2024 · 65d5da4 · 65d5da4
1 parent 2917956
commit 65d5da4
Showing 1 changed file with 27 additions and 10 deletions.
diff --git a/docs/6.0/Functions-Ducker.md b/docs/6.0/Functions-Ducker.md
@@ -10,12 +10,23 @@
 
 #### **Description**
 
-*Returns:* N/A (`undefined`)
+*Returns:* Number or `undefined`
 
 |Name        |Datatype|Purpose                                      |
 |------------|--------|---------------------------------------------|
-|`duckerName`|string  |                                             |
-|`priority`  |number  |                                             |
+|`duckerName`|string  |Ducker to target                             |
+|`priority`  |number  |Reference priority                           |
+
+Checks whether a new voice played with the given priority would either not play, would replace an existing voice, or would become the new maximum priority voice.
+
+This function returns one of the following values:
+
+|Value      |Meaning                                          |
+|-----------|-------------------------------------------------|
+|`0`        |Priority is below the current maximum priority   |
+|`1`        |Priority is equal to the current maximum priority|
+|`2`        |Priority is above the current maximum priority   |
+|`undefined`|Ducker name not recognised                       |
 
 #### **Example**
 
@@ -35,12 +46,14 @@ No example provided.
 
 #### **Description**
 
-*Returns:* N/A (`undefined`)
+*Returns:* Voice or `undefined`
 
 |Name        |Datatype|Purpose                                      |
 |------------|--------|---------------------------------------------|
-|`duckerName`|string  |                                             |
-|`priority`  |number  |                                             |
+|`duckerName`|string  |Ducker to target                             |
+|`priority`  |number  |Priority to target                           |
+
+Returns the voice currently playing on the ducker with the given priority. If either the ducker doesn't exist or no voice is playing with that priority then this function returns `undefined`.
 
 #### **Example**
 
@@ -60,11 +73,13 @@ No example provided.
 
 #### **Description**
 
-*Returns:* N/A (`undefined`)
+*Returns:* Number
 
 |Name        |Datatype|Purpose                                      |
 |------------|--------|---------------------------------------------|
-|`duckerName`|string  |                                             |
+|`duckerName`|string  |Ducker to target                             |
+
+Returns the maximum priority out of all sounds currently playing. If either the ducker doesn't exist or no audio is playing on the ducker then this function returns `-infinity`.
 
 #### **Example**
 
@@ -84,11 +99,13 @@ No example provided.
 
 #### **Description**
 
-*Returns:* N/A (`undefined`)
+*Returns:* Voice or `undefined`
 
 |Name        |Datatype|Purpose                                      |
 |------------|--------|---------------------------------------------|
-|`duckerName`|string  |                                             |
+|`duckerName`|string  |Ducker to target                             |
+
+Returns the voice with the maximum priority out of all sounds currently playing. If either the ducker doesn't exist or no audio is playing on the ducker then this function returns `undefined`.
 
 #### **Example**