quizEngine/docs/DOCS.md

143 lines
4.2 KiB
Markdown
Raw Permalink Normal View History

2021-07-08 01:38:10 +03:00
<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
## setAreas
Устанавливает размеры и положение зон для отрисовки
### Parameters
* `canvas` **[Object][1]**
* `landscape_orientation` **Bool** текущая ориентация игры
* `logoImage` **[Image][2]** логотип
Returns **[Object][1]** список зон
## getMousePos
2021-07-11 16:26:27 +03:00
Возвращает координаты позичии курсора
2021-07-08 01:38:10 +03:00
### Parameters
* `canvas` **[Object][1]** canvas с которого считывается позиция курсора
* `event` **[Event][3]**
Returns **[Object][1]** координаты X, Y положения курсора на canvas
## isInside
Проверяет положение курсора в области объекта
### Parameters
* `mousePos` **[Object][1]** { x:, y: } курсора мыши
* `rect` **[Object][1]** квадратная область
Returns **Bool**
## clearContext
### Parameters
* `canvas` **[Object][1]** canvas object
* `color` **[String][4]** строка с цветом (HEX, либо имя, либо rgba, etc)
## getCenterH
Возвращает X координату для центрировки объекта
### Parameters
* `canvasWidth` **Integer**
* `objectWidth` **Integer**
Returns **Integer** X координата
## getCenterV
Возвращает Y координату для центрировки объекта
### Parameters
* `canvasHeight` **Integer**
* `objectHeight` **Integer**
Returns **Integer** Y координата
## drawProgressBar
Рисует полосу прогресса с визуализацией правильных и неправильных ответов
### Parameters
* `context`
* `area` **[Object][1]** зона в которой будет отрисовываться объект
* `colors` **[Object][1]** объект цветов
* `questions` **[Object][1]** объект вопросов
## imagePreloader
Функция, которая загружает изображения в документ
и по завершению выполнятся callback() функция
### Parameters
* `images` **[Array][5]** массив с именами файлов
* `callback` **[Function][6]** callback() функция
## shuffle
Функция случайным образом перемешивает массив
### Parameters
* `array` **[Array][5]** массив, элементы которого будут перемешаны
## setOrientation
Функция возвращает ориентацию игры в зависимости от размера canvas
### Parameters
* `canvas` **[Object][1]** canvas object
Returns **Bool** значение, которое присвается landscape_orientation в index.js
## checkAnswer
Проверяет правильность ответа на вопрос и устанавливает статус ответа в верно/неверно
### Parameters
* `quest` **[Object][1]** объект вопроса с вариантами ответа и правильным вариантом
* `answer` **[String][4]**
## restartGame
При выполнении перемешивает вопросы и варианты ответов и запускает игру сначала
### Parameters
* `game` **[Object][1]** объект игрового процесса
* `quests` **[Object][1]** объект с вопросами
## playMusic
Воспроизводит фоновую музыку
### Parameters
* `config` **[Object][1]** объект с параметрами движка
* `music` **AudioContext**
[1]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
[2]: https://developer.mozilla.org/docs/Web/API/HTMLImageElement/Image
[3]: https://developer.mozilla.org/docs/Web/API/Event
[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function