weyne/DCSOlympus
1
0
Fork 0
mirror of https://github.com/Pax1601/DCSOlympus.git synced 2025-10-29 16:56:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated documentation

Browse Source
This commit is contained in:
Pax1601
2023-09-03 16:45:48 +02:00
parent fe0e964a5a
commit 41e2e6fa59
221 changed files with 5816 additions and 2576 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
client/docs/classes/controls_switch.Switch.html
View File

@@ -23,7 +23,7 @@
<ul class="tsd-hierarchy">
<li><span class="target">Switch</span></li></ul></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fab7d26/client/src/controls/switch.ts#L3">src/controls/switch.ts:3</a></li></ul></aside>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fe0e964/client/src/controls/switch.ts#L3">src/controls/switch.ts:3</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -72,31 +72,31 @@
<h4 class="tsd-returns-title">Returns <a href="controls_switch.Switch.html" class="tsd-signature-type tsd-kind-class">Switch</a></h4><aside class="tsd-sources">
<p>Overrides <a href="controls_control.Control.html">Control</a>.<a href="controls_control.Control.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fab7d26/client/src/controls/switch.ts#L8">src/controls/switch.ts:8</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fe0e964/client/src/controls/switch.ts#L8">src/controls/switch.ts:8</a></li></ul></aside></li></ul></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-is-private"><a id="_callback" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#callback</span><a href="#_callback" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">#callback</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">CallableFunction</span><span class="tsd-signature-symbol"> = null</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fab7d26/client/src/controls/switch.ts#L5">src/controls/switch.ts:5</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fe0e964/client/src/controls/switch.ts#L5">src/controls/switch.ts:5</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-private tsd-is-inherited"><a id="_container" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#container</span><a href="#_container" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">#container</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">HTMLElement</span></div><aside class="tsd-sources">
<p>Inherited from <a href="controls_control.Control.html">Control</a>.<a href="controls_control.Control.html#_container">#container</a></p>
<ul>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fab7d26/client/src/controls/control.ts#L2">src/controls/control.ts:2</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fe0e964/client/src/controls/control.ts#L2">src/controls/control.ts:2</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="_value" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#value</span><a href="#_value" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">#value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fab7d26/client/src/controls/switch.ts#L4">src/controls/switch.ts:4</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fe0e964/client/src/controls/switch.ts#L4">src/controls/switch.ts:4</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="expectedValue" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>expected<wbr/>Value</span><a href="#expectedValue" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">expected<wbr/>Value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = null</span></div><aside class="tsd-sources">
<p>Inherited from <a href="controls_control.Control.html">Control</a>.<a href="controls_control.Control.html#expectedValue">expectedValue</a></p>
<ul>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fab7d26/client/src/controls/control.ts#L3">src/controls/control.ts:3</a></li></ul></aside></section></section>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fe0e964/client/src/controls/control.ts#L3">src/controls/control.ts:3</a></li></ul></aside></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-is-private"><a id="_onToggle" class="tsd-anchor"></a>
@@ -106,7 +106,7 @@
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fab7d26/client/src/controls/switch.ts#L39">src/controls/switch.ts:39</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fe0e964/client/src/controls/switch.ts#L39">src/controls/switch.ts:39</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="checkExpectedValue" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>check<wbr/>Expected<wbr/>Value</span><a href="#checkExpectedValue" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures tsd-is-inherited">
@@ -120,7 +120,7 @@
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="controls_control.Control.html">Control</a>.<a href="controls_control.Control.html#checkExpectedValue">checkExpectedValue</a></p>
<ul>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fab7d26/client/src/controls/control.ts#L34">src/controls/control.ts:34</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fe0e964/client/src/controls/control.ts#L34">src/controls/control.ts:34</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="createElement" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>create<wbr/>Element</span><a href="#createElement" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures tsd-is-inherited">
@@ -134,7 +134,7 @@
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">HTMLElement</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="controls_control.Control.html">Control</a>.<a href="controls_control.Control.html#createElement">createElement</a></p>
<ul>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fab7d26/client/src/controls/control.ts#L38">src/controls/control.ts:38</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fe0e964/client/src/controls/control.ts#L38">src/controls/control.ts:38</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="getContainer" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>get<wbr/>Container</span><a href="#getContainer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures tsd-is-inherited">
@@ -143,7 +143,7 @@
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">HTMLElement</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="controls_control.Control.html">Control</a>.<a href="controls_control.Control.html#getContainer">getContainer</a></p>
<ul>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fab7d26/client/src/controls/control.ts#L22">src/controls/control.ts:22</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fe0e964/client/src/controls/control.ts#L22">src/controls/control.ts:22</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="getValue" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>get<wbr/>Value</span><a href="#getValue" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
@@ -151,7 +151,7 @@
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fab7d26/client/src/controls/switch.ts#L35">src/controls/switch.ts:35</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fe0e964/client/src/controls/switch.ts#L35">src/controls/switch.ts:35</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="hide" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>hide</span><a href="#hide" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures tsd-is-inherited">
@@ -160,7 +160,7 @@
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="controls_control.Control.html">Control</a>.<a href="controls_control.Control.html#hide">hide</a></p>
<ul>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fab7d26/client/src/controls/control.ts#L17">src/controls/control.ts:17</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fe0e964/client/src/controls/control.ts#L17">src/controls/control.ts:17</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="resetExpectedValue" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>reset<wbr/>Expected<wbr/>Value</span><a href="#resetExpectedValue" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures tsd-is-inherited">
@@ -169,7 +169,7 @@
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="controls_control.Control.html">Control</a>.<a href="controls_control.Control.html#resetExpectedValue">resetExpectedValue</a></p>
<ul>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fab7d26/client/src/controls/control.ts#L30">src/controls/control.ts:30</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fe0e964/client/src/controls/control.ts#L30">src/controls/control.ts:30</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="setExpectedValue" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>set<wbr/>Expected<wbr/>Value</span><a href="#setExpectedValue" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures tsd-is-inherited">
@@ -183,7 +183,7 @@
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="controls_control.Control.html">Control</a>.<a href="controls_control.Control.html#setExpectedValue">setExpectedValue</a></p>
<ul>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fab7d26/client/src/controls/control.ts#L26">src/controls/control.ts:26</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fe0e964/client/src/controls/control.ts#L26">src/controls/control.ts:26</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="setValue" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>set<wbr/>Value</span><a href="#setValue" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
@@ -198,7 +198,7 @@
<h5><span class="tsd-kind-parameter">ignoreExpectedValue</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fab7d26/client/src/controls/switch.ts#L28">src/controls/switch.ts:28</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fe0e964/client/src/controls/switch.ts#L28">src/controls/switch.ts:28</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="show" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>show</span><a href="#show" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures tsd-is-inherited">
@@ -207,7 +207,7 @@
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="controls_control.Control.html">Control</a>.<a href="controls_control.Control.html#show">show</a></p>
<ul>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fab7d26/client/src/controls/control.ts#L12">src/controls/control.ts:12</a></li></ul></aside></li></ul></section></section></div>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fe0e964/client/src/controls/control.ts#L12">src/controls/control.ts:12</a></li></ul></aside></li></ul></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
@@ -270,6 +270,7 @@
<li><a href="../modules/map_destinationpreviewmarker.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>map/destinationpreviewmarker</span></a></li>
<li><a href="../modules/map_drawingcursor.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>map/drawingcursor</span></a></li>
<li><a href="../modules/map_map.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>map/map</span></a></li>
<li><a href="../modules/map_smokemarker.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>map/smokemarker</span></a></li>
<li><a href="../modules/map_targetmarker.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>map/targetmarker</span></a></li>
<li><a href="../modules/map_temporaryunitmarker.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>map/temporaryunitmarker</span></a></li>
<li><a href="../modules/mission_airbase.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>mission/airbase</span></a></li>