Commit 764149bd authored by Ryan Grupp's avatar Ryan Grupp
Browse files

Readme interim update

parent 1c097580
......@@ -31,18 +31,18 @@ You're now free to make edits to this file however you wish. __Note: Do not edit
## Module Documenation
| Module | Has Global Configuration |
| ---------------------------------------- | ------------------------ |
| [\_core\_](#module-core) | |
| [Ambient Sounds](#module-ambient-sounds) | ✓ |
| [Car Radio](#module-car-radio) | |
| [Components](#module-components) | |
| [LZ Select](#module-lz-select) | |
| [Static Radio](#module-static-radio) | |
| __Module__ | __Has Global Configuration__ |
| ---------------------------------------- | ---------------------------- |
| [\_core\_](#module-core) | |
| [Ambient Sounds](#module-ambient-sounds) | ✓ |
| [Car Radio](#module-car-radio) | |
| [Components](#module-components) | |
| [LZ Select](#module-lz-select) | |
| [Static Radio](#module-static-radio) | |
---
### Module - \_core\_
### 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.
......@@ -51,10 +51,43 @@ The \_core\_ module is the heart of TSM, there is no configuration involved, nor
_This module requires the use of [TSM Configuraiton](#using-tsm-configuration)._
| Config Setting | Description |
| -------------- | ------------------------ |
| sounds | An array of sound definition data, each item is an array made up of:<br><ul><li>__Sound class__</li></ul> |
| initialDelay | ✓ |
| gapTime | |
| mode | |
\ No newline at end of file
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._
| __Config Setting__ | __Type__ | __Description__ |
| ------------------ | -------- | --------------- |
| sounds | Array | An array of sound definition data, each item is an array made up of:<ul><li>__Sound class__ _<sub>(string)</sub>_<ul><li>A classname from `CfgSounds`, can be from an addon, or from mission config.</li></ul></li><li>__Sound length__ _<sub>(integer)</sub>_<ul><li>The number of seconds the sound plays for.</li></ul></li></ul> |
| initialDelay | Integer | Amount of time in seconds before the initial sound plays. |
| gapTime | Array | The time between a sound stopping, and a new on playing _(in seconds)_. An array of 1 or 2 elements, both integers.<ul><li>If only one element is provided, that value will be used.</li><li>If two elements are provided, a random number will be generated between the two values.</li></ul> |
| mode | Integer | Defines the mode of selecting the next sound file:<ul><li>__0__ - Random</li><li>__1__ - Sequential</li></ul> |
### 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._
> #### __tsm_car_radio_fnc_init__
> Initialises a vehicle to have a radio.
>
> Arguments:
> * __Vehicle__ <sub>_(object)_</sub>
> * The vehicle to add a radio to.
> * __Songs__ <sub>_(array)_</sub>
> * A list of classnames from CfgMusic _(config or mission config)_ of songs to play.
>
> Ex.
> ```sqf
> [
> this,
> [
> "cbb_music_2_minutes_to_midnight_im",
> "cbb_music_bad_company_bc",
> "cbb_music_dont_fear_the_reaper_boc"
> ]
> ] call tsm_car_radio_fnc_init;
> ```
### Module - Components
### Module - LZ Select
### Module - Static Radio
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment