quizEngine/docs/DOCS.md

4.2 KiB
Raw Blame History

setAreas

Устанавливает размеры и положение зон для отрисовки

Parameters

  • canvas Object
  • landscape_orientation Bool текущая ориентация игры
  • logoImage Image логотип

Returns Object список зон

getMousePos

Возвращает координаты позичии курсора

Parameters

  • canvas Object canvas с которого считывается позиция курсора
  • event Event

Returns Object координаты X, Y положения курсора на canvas

isInside

Проверяет положение курсора в области объекта

Parameters

  • mousePos Object { x:, y: } курсора мыши
  • rect Object квадратная область

Returns Bool

clearContext

Parameters

  • canvas Object canvas object
  • color String строка с цветом (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 зона в которой будет отрисовываться объект
  • colors Object объект цветов
  • questions Object объект вопросов

imagePreloader

Функция, которая загружает изображения в документ и по завершению выполнятся callback() функция

Parameters

  • images Array массив с именами файлов
  • callback Function callback() функция

shuffle

Функция случайным образом перемешивает массив

Parameters

  • array Array массив, элементы которого будут перемешаны

setOrientation

Функция возвращает ориентацию игры в зависимости от размера canvas

Parameters

Returns Bool значение, которое присвается landscape_orientation в index.js

checkAnswer

Проверяет правильность ответа на вопрос и устанавливает статус ответа в верно/неверно

Parameters

  • quest Object объект вопроса с вариантами ответа и правильным вариантом
  • answer String

restartGame

При выполнении перемешивает вопросы и варианты ответов и запускает игру сначала

Parameters

  • game Object объект игрового процесса
  • quests Object объект с вопросами

playMusic

Воспроизводит фоновую музыку

Parameters

  • config Object объект с параметрами движка
  • music AudioContext