More WIP documentation

readme.md

@@ -48,6 +48,18 @@ You're now free to make edits to this file however you wish. __Note: Do not edit
 
 ---
 
+
+
+
+
+
+
+
+
+
+
+
+
 ### Module - Core
 
 The \_core\_ module is the heart of TSM, there is no configuration involved, nor should the user touch it. It must exist for TSM to work.
@@ -55,11 +67,19 @@ The \_core\_ module is the heart of TSM, there is no configuration involved, nor
 <br>
 <br>
 
+
+
+
+
+
+
+
+
 ### Module - Ambient Sounds
 
 _This module requires the use of [TSM Configuraiton](#using-tsm-configuration)._
 
-Ambient Sounds plays audio in the background to make your players more _immersed_. _It plays the audio in the sound (sfx) audio channel, ie. not music._
+Ambient Sounds plays audio in the background to make your players more _immersed_. _It plays the sound (sfx) audio channel, ie. not music._
 
 
 | __Config Setting__ | __Type__ | __Description__ |
@@ -72,12 +92,18 @@ Ambient Sounds plays audio in the background to make your players more _immersed
 <br>
 <br>
 
+
+
+
+
+
+
 ### Module - Car Radio
 
 Car Radio allows a player in a vehicle _(doesn't actually need to be a car)_ to use ACE interact to play a song on the radio (or stop a playing one). _Plays in the music audio channel._
 
 <dl>
-<dd><h3>Function Reference</h3></dd>
+<dd><h4>Function Reference</h4></dd>
 <dd>
 <details>
 <summary><strong>tsm_car_radio_fnc_init</strong></summary>
@@ -87,7 +113,7 @@ Initialises a vehicle to have a radio.
 Arguments:
 * __Vehicle__ <sub>_(object)_</sub>
     * The vehicle to add a radio to.
-* __Songs__ <sub>_(array)_</sub>
+* __Song List__ <sub>_(array)_</sub>
     * A list of classnames from CfgMusic _(config or mission config)_ of songs to play.
 
 ```sqf
@@ -106,6 +132,18 @@ Arguments:
 
 </details>
 </dd>
+</dl>
+<br>
+<br>
+
+
+
+
+
+
+
+
+
 
 
 ### Module - Components
@@ -113,9 +151,183 @@ Arguments:
 <br>
 <br>
 
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 ### Module - LZ Select
 
+LZ Select add actions to a vehicle that call a script, usually a unitPlay script.
+
+<dl>
+<dd><h4>Function Reference</h4></dd>
+
+
+<dd>
+<details>
+<summary><strong>tsm_lz_select_fnc_init</strong></summary>
+
+Initializes actions for a vehicle.
+
+Arguments:
+* __Vehicle__ <sub>_(object)_</sub>
+    * The vehicle to initialize.
+* __LZ List__ <sub>_(array)_</sub>
+    * A list of classnames from CfgSounds _(config or mission config)_ of songs to play.
+
+```sqf
+[ 
+    this, 
+    [ 
+        ["scripts\LB_11.sqf", "LZ Defiant"], 
+        ["scripts\LB_12.sqf", "LZ RazorCrest"], 
+        ["scripts\LB_13.sqf", "LZ Moya"], 
+        ["scripts\LB_14.sqf", "LZ RogerYoung"] 
+    ] 
+] call tsm_lz_select_fnc_init;
+```
+<br>
+<br>
+</details>
+</dd>
+
+
+<dd>
+<details>
+<summary><strong>tsm_static_radio_fnc_forceOut</strong></summary>
+
+Kicks units out of a vehicle, but only FFV and Cargo seats.
+
+Arguments:
+* __Vehicle__ <sub>_(object)_</sub>
+    * The object to eject units from.
+
+```sqf
+[my_aircraft] call tsm_static_radio_fnc_forceOut;
+```
+<br>
+<br>
+</details>
+</dd>
+
+
+
+<dd>
+<details>
+<summary><strong>tsm_static_radio_fnc_fastrope</strong></summary>
+
+Fast ropes units out of a vehicle.
+
+Arguments:
+* __Vehicle__ <sub>_(object)_</sub>
+    * The object to fastrope units from
+* __Deploy Special__ <sub>_(boolean) [optional]_</sub>
+    * Causes every unit that isn't the pilot to fastrope, including co-pilot and gunners. _(Default: false)_
+
+```sqf
+[my_aircraft] call tsm_static_radio_fnc_fastrope;
+```
+<br>
+<br>
+</details>
+</dd>
+</dl>
 <br>
 <br>
 
-### Module - Static Radio
+
\ No newline at end of file
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+### Module - Static Radio
+
+Static Radio creates Static Radios in the work to play music, or any other sound. _It plays the sound (sfx) audio channel, ie. not music._
+
+<dl>
+<dd><h4>Function Reference</h4></dd>
+
+
+<dd>
+<details>
+<summary><strong>tsm_static_radio_fnc_init</strong></summary>
+
+Initialises an object to be a radio.
+
+Arguments:
+* __Object__ <sub>_(object)_</sub>
+    * The object to add a radio to.
+* __Song List__ <sub>_(array)_</sub>
+    * A list of classnames from CfgSounds _(config or mission config)_ of songs to play.
+* __Max Distance__ <sub>_(integer) [optional]_</sub>
+    * Distance in meters of the sound should travel max. _(Default: 100)_
+
+```sqf
+[
+    this,
+    [
+        "cbb_music_2_minutes_to_midnight_im",
+        "cbb_music_bad_company_bc",
+        "cbb_music_dont_fear_the_reaper_boc"
+    ]
+] call tsm_static_radio_fnc_init;
+```
+<br>
+<br>
+</details>
+</dd>
+
+
+<dd>
+<details>
+<summary><strong>[BETA] tsm_static_radio_fnc_loopSoundGlobal</strong></summary>
+
+Loops a sound from an object, always, forever.
+
+Arguments:
+* __Object__ <sub>_(object|position)_</sub>
+    * The object to play a sound from. Can also be a position in ASL format.
+* __Sound__ <sub>_(string)_</sub>
+    * A classname from CfgSounds _(config or mission config)_ __OR__ a path to the sound file.
+* __Sound Length__ <sub>_(integer)_</sub>
+    * Duration of the sound, in seconds.
+* __Volume__ <sub>_(integer) [optional]_</sub>
+    * Volume of the sound, with 1 being normal volume. _(Default: 1)_
+
+```sqf
+[
+    this,
+    "cbb_music_2_minutes_to_midnight_im",
+    300
+] call tsm_static_radio_fnc_loopSoundGlobal;
+```
+<br>
+<br>
+</details>
+</dd>
+</dl>
+<br>
+<br>
\ No newline at end of file