Commit 827ab873 authored by Ryan Grupp's avatar Ryan Grupp
Browse files

Update documentation

parent 39b92313
......@@ -39,14 +39,15 @@ 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) | |
| [Spectrum Device](#module-spectrum-device) | ✓ |
| [Static Radio](#module-static-radio) | |
---
......@@ -428,6 +429,112 @@ Arguments:
### Module - Spectrum Device
Spectrum Device module manipulates the device of the same name, displaying signals based on their location.
<dl>
<dd><h4>Function Reference</h4></dd>
<dd>
<details>
<summary><strong>tsm_spectrum_device_fnc_signalAdd</strong></summary>
Adds a signal to an object which can be found by the device. _(Editor safe.)_ _(Should be run on server.)_
Arguments:
* __Source__ <sub>_(object|position)_</sub>
* The object or position that is emitting a signal.
* __Frequency__ <sub>_(float)_</sub>
* The frequency on which the signal appears.
```sqf
[this, 143.5] call tsm_spectrum_device_fnc_signalAdd;
```
<br>
<br>
</details>
</dd>
<dd>
<details>
<summary><strong>tsm_spectrum_device_fnc_signalRemove</strong></summary>
Removes the signal an object is transmitting. _(Editor safe.)_ _(Should be run on server.)_
Arguments:
* __Source__ <sub>_(object|position)_</sub>
* The object or position that is emitting a signal.
```sqf
[this] call tsm_spectrum_device_fnc_signalRemove;
```
<br>
<br>
</details>
</dd>
<dd>
<details>
<summary><strong>tsm_spectrum_device_fnc_noise</strong></summary>
Floods the device with noise. _(Should run local to the player.)_
Arguments:
* __None__
```sqf
call tsm_spectrum_device_fnc_noise;
```
<br>
<br>
</details>
</dd>
<dd>
<details>
<summary><strong>tsm_spectrum_device_fnc_noiseStop</strong></summary>
Stops device noise handler. _(Should run local to the player.)_
Arguments:
* __None__
```sqf
call tsm_spectrum_device_fnc_noiseStop;
```
<br>
<br>
</details>
</dd>
</dl>
<br>
<br>
### Module - Static Radio
......
......@@ -2,6 +2,8 @@ params [
['_source', [0,0,0], [objNull, []]]
];
if !(isServer) exitWith {};
private _signals = missionNamespace getVariable ['tsm_spectrum_device_signals', []];
private _index = _signals findIf {_x#0 isEqualTo _source};
......
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