Основная структура

2023-03-27 15:04:48 +04:00
parent d2ed8eaf58
commit f90f0c542b
13 changed files with 12384 additions and 0 deletions
@@ -0,0 +1,174 @@
+## Classes
+
+<dl>
+<dt><a href="#AprilFoolsJokeClass">AprilFoolsJokeClass</a></dt>
+<dd><p>Блок обработки перво-апрельских шуток</p></dd>
+<dt><a href="#Joke">Joke</a></dt>
+<dd><p>Объект, описывающий шутку</p></dd>
+<dt><a href="#ShakeJoke">ShakeJoke</a></dt>
+<dd><p>Форумо-трясение</p>
+<p>Страница форума начинает трястись</p></dd>
+</dl>
+
+## Members
+
+<dl>
+<dt><a href="#AprilFoolsJokeClass">AprilFoolsJokeClass</a></dt>
+<dd><p>Объект хранения шуток</p></dd>
+<dt><a href="#Joke">Joke</a></dt>
+<dd><p>Объект, описывающий шутку, которая может быть остановлена</p></dd>
+</dl>
+
+<a name="AprilFoolsJokeClass"></a>
+
+## AprilFoolsJokeClass
+<p>Блок обработки перво-апрельских шуток</p>
+
+**Kind**: global class  
+**Author**: Kozhilya  
+
+* [AprilFoolsJokeClass](#AprilFoolsJokeClass)
+    * [.add(joke)](#AprilFoolsJokeClass+add)
+    * [.setSettings(settings)](#AprilFoolsJokeClass+setSettings)
+    * [.check(chance)](#AprilFoolsJokeClass+check) ⇒ <code>boolean</code>
+    * [.start(id, forced)](#AprilFoolsJokeClass+start)
+    * [.startAll()](#AprilFoolsJokeClass+startAll)
+
+<a name="AprilFoolsJokeClass+add"></a>
+
+### aprilFoolsJokeClass.add(joke)
+<p>Добавление шутки</p>
+
+**Kind**: instance method of [<code>AprilFoolsJokeClass</code>](#AprilFoolsJokeClass)  
+
+| Param |
+| --- |
+| joke | 
+
+<a name="AprilFoolsJokeClass+setSettings"></a>
+
+### aprilFoolsJokeClass.setSettings(settings)
+<p>Запись новых настроек</p>
+
+**Kind**: instance method of [<code>AprilFoolsJokeClass</code>](#AprilFoolsJokeClass)  
+
+| Param |
+| --- |
+| settings | 
+
+<a name="AprilFoolsJokeClass+check"></a>
+
+### aprilFoolsJokeClass.check(chance) ⇒ <code>boolean</code>
+<p>Проверка вероятности</p>
+
+**Kind**: instance method of [<code>AprilFoolsJokeClass</code>](#AprilFoolsJokeClass)  
+**Returns**: <code>boolean</code> - <p>Флаг срабатывания (true - сработало)</p>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| chance | <code>number</code> | <p>Вероятность срабатывания</p> |
+
+<a name="AprilFoolsJokeClass+start"></a>
+
+### aprilFoolsJokeClass.start(id, forced)
+<p>Запуск шутки</p>
+
+**Kind**: instance method of [<code>AprilFoolsJokeClass</code>](#AprilFoolsJokeClass)  
+
+| Param | Type | Default |
+| --- | --- | --- |
+| id |  |  | 
+| forced | <code>boolean</code> | <code>false</code> | 
+
+<a name="AprilFoolsJokeClass+startAll"></a>
+
+### aprilFoolsJokeClass.startAll()
+<p>Запуск всех шуток</p>
+
+**Kind**: instance method of [<code>AprilFoolsJokeClass</code>](#AprilFoolsJokeClass)  
+<a name="Joke"></a>
+
+## Joke
+<p>Объект, описывающий шутку</p>
+
+**Kind**: global class  
+<a name="ShakeJoke"></a>
+
+## ShakeJoke
+<p>Форумо-трясение</p>
+<p>Страница форума начинает трястись</p>
+
+**Kind**: global class  
+**Author**: Kozhilya  
+<a name="AprilFoolsJokeClass"></a>
+
+## AprilFoolsJokeClass
+<p>Объект хранения шуток</p>
+
+**Kind**: global variable  
+
+* [AprilFoolsJokeClass](#AprilFoolsJokeClass)
+    * [.add(joke)](#AprilFoolsJokeClass+add)
+    * [.setSettings(settings)](#AprilFoolsJokeClass+setSettings)
+    * [.check(chance)](#AprilFoolsJokeClass+check) ⇒ <code>boolean</code>
+    * [.start(id, forced)](#AprilFoolsJokeClass+start)
+    * [.startAll()](#AprilFoolsJokeClass+startAll)
+
+<a name="AprilFoolsJokeClass+add"></a>
+
+### aprilFoolsJokeClass.add(joke)
+<p>Добавление шутки</p>
+
+**Kind**: instance method of [<code>AprilFoolsJokeClass</code>](#AprilFoolsJokeClass)  
+
+| Param |
+| --- |
+| joke | 
+
+<a name="AprilFoolsJokeClass+setSettings"></a>
+
+### aprilFoolsJokeClass.setSettings(settings)
+<p>Запись новых настроек</p>
+
+**Kind**: instance method of [<code>AprilFoolsJokeClass</code>](#AprilFoolsJokeClass)  
+
+| Param |
+| --- |
+| settings | 
+
+<a name="AprilFoolsJokeClass+check"></a>
+
+### aprilFoolsJokeClass.check(chance) ⇒ <code>boolean</code>
+<p>Проверка вероятности</p>
+
+**Kind**: instance method of [<code>AprilFoolsJokeClass</code>](#AprilFoolsJokeClass)  
+**Returns**: <code>boolean</code> - <p>Флаг срабатывания (true - сработало)</p>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| chance | <code>number</code> | <p>Вероятность срабатывания</p> |
+
+<a name="AprilFoolsJokeClass+start"></a>
+
+### aprilFoolsJokeClass.start(id, forced)
+<p>Запуск шутки</p>
+
+**Kind**: instance method of [<code>AprilFoolsJokeClass</code>](#AprilFoolsJokeClass)  
+
+| Param | Type | Default |
+| --- | --- | --- |
+| id |  |  | 
+| forced | <code>boolean</code> | <code>false</code> | 
+
+<a name="AprilFoolsJokeClass+startAll"></a>
+
+### aprilFoolsJokeClass.startAll()
+<p>Запуск всех шуток</p>
+
+**Kind**: instance method of [<code>AprilFoolsJokeClass</code>](#AprilFoolsJokeClass)  
+<a name="Joke"></a>
+
+## Joke
+<p>Объект, описывающий шутку, которая может быть остановлена</p>
+
+**Kind**: global variable