add setMasterGain and getMasterGain

Author: ntsh-oni

source/scripting/api/index.rst

@@ -370,6 +370,10 @@ Functions related to audio.
 	  - Sets the pitch of a sound source.
 	* - :doc:`/types/Script/getSoundSourcePitch/index`
 	  - Returns the pitch of a sound source.
+	* - :doc:`/types/Script/setMasterGain/index`
+	  - Sets the master gain.
+	* - :doc:`/types/Script/getMasterGain/index`
+	  - Returns the master gain.
 
 Animation
 ---------

source/types/AudioModuleInterface/getMasterGain/index.rst

@@ -0,0 +1,28 @@
+getMasterGain
+=============
+
+:doc:`/types/AudioModuleInterface/index`::getMasterGain
+
+Returns the master gain.
+
+Declaration
+-----------
+
+.. code-block:: cpp
+
+	virtual float getMasterGain() = 0;
+
+Parameters
+----------
+
+None.
+
+Returns
+-------
+
+The master gain.
+
+Notes
+-----
+
+The master gain is the overall volume of all sounds.

source/types/AudioModuleInterface/index.rst

@@ -46,6 +46,10 @@ Functions
 	  - Enables or disables looping on a sound source.
 	* - :doc:`/types/AudioModuleInterface/isSoundSourceLooping/index`
 	  - Checks if a sound source is looping.
+	* - :doc:`/types/AudioModuleInterface/setMasterGain/index`
+	  - Sets the master gain.
+	* - :doc:`/types/AudioModuleInterface/getMasterGain/index`
+	  - Returns the master gain.
 
 .. toctree::
 	:hidden:
@@ -65,4 +69,6 @@ Functions
 	./setSoundSourcePitch/index.rst
 	./getSoundSourcePitch/index.rst
 	./setSoundSourceLooping/index.rst
-	./isSoundSourceLooping/index.rst
+	./isSoundSourceLooping/index.rst
+	./setMasterGain/index.rst
+	./getMasterGain/index.rst

source/types/AudioModuleInterface/setMasterGain/index.rst

@@ -0,0 +1,38 @@
+setMasterGain
+=============
+
+:doc:`/types/AudioModuleInterface/index`::setMasterGain
+
+Sets the master gain.
+
+Declaration
+-----------
+
+.. code-block:: cpp
+
+	virtual void setMasterGain(float newGain) = 0;
+
+Parameters
+----------
+
+.. list-table::
+	:width: 100%
+	:header-rows: 1
+	:class: code-table
+
+	* - Name
+	  - Type
+	  - Description
+	* - newGain
+	  - float
+	  - The new master gain.
+
+Returns
+-------
+
+None.
+
+Notes
+-----
+
+The master gain is the overall volume of all sounds.

source/types/Script/getMasterGain/index.rst

@@ -0,0 +1,28 @@
+getMasterGain
+=============
+
+:doc:`/types/Script/index`::getMasterGain
+
+Returns the master gain.
+
+Declaration
+-----------
+
+.. code-block:: cpp
+
+	float getMasterGain();
+
+Parameters
+----------
+
+None.
+
+Returns
+-------
+
+The master gain.
+
+Notes
+-----
+
+The master gain is the overall volume of all sounds.

source/types/Script/index.rst

@@ -316,6 +316,10 @@ Functions
 	  - Enables or disables looping on a sound source.
 	* - :doc:`/types/Script/isSoundSourceLooping/index`
 	  - Checks if a sound source is looping.
+	* - :doc:`/types/Script/setMasterGain/index`
+	  - Sets the master gain.
+	* - :doc:`/types/Script/getMasterGain/index`
+	  - Returns the master gain.
 	* - :doc:`/types/Script/playAnimation/index`
 	  - Plays an :doc:`/types/Animation/index` on an :doc:`/entity_component_system/entity/index`.
 	* - :doc:`/types/Script/pauseAnimation/index`
@@ -515,6 +519,8 @@ Functions
 	./getSoundSourcePitch/index.rst
 	./setSoundSourceLooping/index.rst
 	./isSoundSourceLooping/index.rst
+	./setMasterGain/index.rst
+	./getMasterGain/index.rst
 
 	./intersect/index.rst
 	./raycast/index.rst

source/types/Script/setMasterGain/index.rst

@@ -0,0 +1,38 @@
+setMasterGain
+=============
+
+:doc:`/types/Script/index`::setMasterGain
+
+Sets the master gain.
+
+Declaration
+-----------
+
+.. code-block:: cpp
+
+	void setMasterGain(float newGain);
+
+Parameters
+----------
+
+.. list-table::
+	:width: 100%
+	:header-rows: 1
+	:class: code-table
+
+	* - Name
+	  - Type
+	  - Description
+	* - newGain
+	  - float
+	  - The new master gain.
+
+Returns
+-------
+
+None.
+
+Notes
+-----
+
+The master gain is the overall volume of all sounds.