PROPHESSOR/JsMB-Doc.md

## JsMB-Doc.md

      
    Raw
  

              JsMB-Doc.md
            
          
JsMB : object

Kind: global namespace
Внимание! Если вы используете стандартную реализацию - префикс JsMB. писать не обязательно.

JsMB : object

.sqrt
.sin ⇒ number
.cos ⇒ number
.tan ⇒ number
.asin ⇒ number
.acos ⇒ number
.atan ⇒ number
.abs ⇒ number
.pow ⇒ number
.ln ⇒ number
.exp ⇒ number
.min ⇒ number
.max ⇒ number
.chr ⇒ string
.setColor(color) ⇒ this
.setLineWidth(width) ⇒ this
.fillRect(x, y, w, h) ⇒ this
.fullScreen(mode) ⇒ this
.cls() ⇒ this
.fillScreen(color) ⇒ this
.drawRect(x, y, w, h) ⇒ this
.drawPlot(x, y) ⇒ this
.clearRect(x, y, w, h) ⇒ this
.drawLine(x1, y1, x2, y2) ⇒ this
.drawCube(x, y, w, h, q) ⇒ this
.drawArc(x, y, radius, startAngle, endAngle, counterClockwise) ⇒ this
.fillArc(x, y, radius, startAngle, endAngle, counterClockwise) ⇒ this
.fillRect4(x1, y1, x2, y2, x3, y3, x4, y4) ⇒ this
.drawRect4(x1, y1, x2, y2, x3, y3, x4, y4) ⇒ this
.fillTriangle(x1, y1, x2, y2, x3, y3) ⇒ this
.drawNangle(array) ⇒ this
.fillNangle(array) ⇒ this
.drawTriangle(x1, y1, x2, y2, x3, y3) ⇒ this
.drawString(text, x, y) ⇒ this
.repaint() ⇒ this
.setFontSize(size) ⇒ this
.setFont(family) ⇒ this
.makeLinearGradient(x, y, x1, y1) ⇒ this
.makeRadialGradient(x, y, r, x1, y1, r1) ⇒ this
.setGradientColor(g, pos, color) ⇒ this
.rgb(red, green, blue) ⇒ string
.rgba(red, green, blue, alpha) ⇒ string
.gelLoad(file, name) ⇒ this
.spriteGel(sprite, gel) ⇒ this
.drawGel(name, x, y) ⇒ this
.drawSprite(name, x, y) ⇒ this
.gelSize(name, w, h) ⇒ this
.drawGelFragment(name, fx, fy, fw, fh, x, y, w, h) ⇒ this
.makeTexture(gelname, repeat) ⇒ this
.input(text, [def]) ⇒ this
.println() ⇒ this
.playSound(file, loop, channel) ⇒ this
.pauseSound(channel) ⇒ this
.random(min, max) ⇒ number
.ctg(angle) ⇒ number
.mod(x, y) ⇒ number
.limit(variable, min, max) ⇒ number
.rad(deg) ⇒ number
.deg(rad) ⇒ number
.len(str) ⇒ number
.str(num) ⇒ string
.val(str) ⇒ number
.int(str, [system]) ⇒ number
.float(str) ⇒ number
.upper(str) ⇒ string
.lower(str) ⇒ string
.mid(str, pos, len) ⇒ string
.asc(str, [pos]) ⇒ number
.split(str, char) ⇒ array
.replace(str, reg, to, [all]) ⇒ string
.localSaveData(name, _data) ⇒ this
.localReadData(name) ⇒ this
.parseJSON(json) ⇒ object
.toJSON(object, [f], [s]) ⇒ string
.toPSON(object, [s]) ⇒ string
.include(file) ⇒ this
.screenWidth() ⇒ number
.screenHeight() ⇒ number
.getMouseX() ⇒ number
.getMouseY() ⇒ number
.getLeftClicksCount() ⇒ number
.getRightClicksCount() ⇒ number
.log() ⇒ this
.debug(text, [style]) ⇒ this
.exit() ⇒ this


JsMB.sqrt

Возвращает квадратный корень из числа
Kind: static property of JsMB


Param
Type
Description


number
number
Число


JsMB.sin ⇒ number

Возвращает синус угла
Kind: static property of JsMB


Param
Type
Description


angle
number
Угол в радианах


JsMB.cos ⇒ number

Возвращает косинус угла
Kind: static property of JsMB


Param
Type
Description


angle
number
Угол в радианах


JsMB.tan ⇒ number

Возвращает тангенс угла
Kind: static property of JsMB


Param
Type
Description


angle
number
Угол в радианах


JsMB.asin ⇒ number

Возвращает арксинус угла (в радианах)
Kind: static property of JsMB


Param
Type
Description


angle
number
Угол в радианах


JsMB.acos ⇒ number

Возвращает арккосинус угла (в радианах)
Kind: static property of JsMB


Param
Type
Description


angle
number
Угол в радианах


JsMB.atan ⇒ number

Возвращает арктангенс угла (в радианах)
Kind: static property of JsMB


Param
Type
Description


angle
number
Угол в радианах


JsMB.abs ⇒ number

Возвращает модуль числа
Kind: static property of JsMB


Param
Type
Description


number
number
Число


JsMB.pow ⇒ number

Возводит число в степень
Kind: static property of JsMB


Param
Type
Description


number
number
Число


power
number
Степень


JsMB.ln ⇒ number

Возвращает натуральный логарифм от числа
Kind: static property of JsMB


Param
Type
Description


number
number
Число


JsMB.exp ⇒ number

Возвращает число e в степени
Kind: static property of JsMB


Param
Type
Description


power
number
Степень


JsMB.min ⇒ number

Возвращает минимальное значение из аргументов
Kind: static property of JsMB


JsMB.max ⇒ number

Возвращает максимальное значение из аргументов
Kind: static property of JsMB


JsMB.chr ⇒ string

Возвращает символ по его коду. Можно передать несколько кодов
Kind: static property of JsMB


Param
Type
Description


code
number
Код(ы) символа


JsMB.setColor(color) ⇒ this

Задать текущий цвет
Kind: static method of JsMB


Param
Type
Description


color
string
Свет в CSS формате


JsMB.setLineWidth(width) ⇒ this

Задать толщину линий
Kind: static method of JsMB


Param
Type
Description


width
number
Толщина


JsMB.fillRect(x, y, w, h) ⇒ this

Рисует залитый прямоугольник
Kind: static method of JsMB


Param
Type
Description


x
number
Координата X левого верхнего угла


y
number
Координата Y левого верхнего угла


w
number
Ширина


h
number
Высота


JsMB.fullScreen(mode) ⇒ this

Переключить полноэкранный режим
Kind: static method of JsMB


Param
Type
Description


mode
bool
true - включить, false - отключить


JsMB.cls() ⇒ this

Очищает экран
Kind: static method of JsMB


JsMB.fillScreen(color) ⇒ this

Заливает экран выбранным цветом
Kind: static method of JsMB


Param
Type
Description


color
string
Цвет в CSS формате


JsMB.drawRect(x, y, w, h) ⇒ this

Рисует прямоугольник
Kind: static method of JsMB


Param
Type
Description


x
number
Координата X левого верхнего угла


y
number
Координата Y левого верхнего угла


w
number
Ширина


h
number
Высота


JsMB.drawPlot(x, y) ⇒ this

Рисует точку по координатам (заливает пиксель)
Kind: static method of JsMB


Param
Type
Description


x
number
X координата точки


y
number
Y координата точки


JsMB.clearRect(x, y, w, h) ⇒ this

Очищяет прямоугольную область
Kind: static method of JsMB


Param
Type
Description


x
number
Координата X левого верхнего угла


y
number
Координата Y левого верхнего угла


w
number
Ширина


h
number
Высота


JsMB.drawLine(x1, y1, x2, y2) ⇒ this

Рисует линию по 2 точкам
Kind: static method of JsMB


Param
Type
Description


x1
number
X 1 точки


y1
number
Y 1 точки


x2
number
X 2 точки


y2
number
Y 2 точки


JsMB.drawCube(x, y, w, h, q) ⇒ this

Рисует проекцию паралелепипеда (через 2 соединенных прямоугольника)
Kind: static method of JsMB


Param
Type
Description


x
number
X левого верхнего угла


y
number
Y левого верхнего угла


w
number
ширина


h
number
высота


q
number
глубина


JsMB.drawArc(x, y, radius, startAngle, endAngle, counterClockwise) ⇒ this

Рисует залитую окружность
Kind: static method of JsMB


Param
Type
Default
Description


x
number

X центра


y
number

Y центра


radius
number

радиус


startAngle
number
(15*PI/7)
Угол начала


endAngle
number
(13*PI/2)
Угол конца


counterClockwise
bool
false
По часовой стрелке?


JsMB.fillArc(x, y, radius, startAngle, endAngle, counterClockwise) ⇒ this

Рисует залитую окружность
Kind: static method of JsMB


Param
Type
Default
Description


x
number

X центра


y
number

Y центра


radius
number

радиус


startAngle
number
(15*PI/7)
Угол начала


endAngle
number
(13*PI/2)
Угол конца


counterClockwise
bool
false
По часовой стрелке?


JsMB.fillRect4(x1, y1, x2, y2, x3, y3, x4, y4) ⇒ this

Рисует залитый четырехугольник по четырем точкам
Kind: static method of JsMB


Param
Type
Description


x1
number
X 1 точки


y1
number
Y 1 точки


x2
number
X 2 точки


y2
number
Y 2 точки


x3
number
X 3 точки


y3
number
Y 3 точки


x4
number
X 4 точки


y4
number
Y 4 точки


JsMB.drawRect4(x1, y1, x2, y2, x3, y3, x4, y4) ⇒ this

Рисует четырехугольник по четырем точкам
Kind: static method of JsMB


Param
Type
Description


x1
number
X 1 точки


y1
number
Y 1 точки


x2
number
X 2 точки


y2
number
Y 2 точки


x3
number
X 3 точки


y3
number
Y 3 точки


x4
number
X 4 точки


y4
number
Y 4 точки


JsMB.fillTriangle(x1, y1, x2, y2, x3, y3) ⇒ this

Рисует залитый триугольник по трем точкам
Kind: static method of JsMB


Param
Type
Description


x1
number
X 1 точки


y1
number
Y 1 точки


x2
number
X 2 точки


y2
number
Y 2 точки


x3
number
X 3 точки


y3
number
Y 3 точки


JsMB.drawNangle(array) ⇒ this

Рисует n-угольник по точкам
Kind: static method of JsMB


Param
Type
Description


array
array
Двумерный массив точек ([[x,y],[x1,y1],...])


JsMB.fillNangle(array) ⇒ this

Рисует залитый n-угольник по точкам
Kind: static method of JsMB


Param
Type
Description


array
array
Двумерный массив точек ([[x,y],[x1,y1],...])


JsMB.drawTriangle(x1, y1, x2, y2, x3, y3) ⇒ this

Рисует триугольник по трем точкам
Kind: static method of JsMB


Param
Type
Description


x1
number
X 1 точки


y1
number
Y 1 точки


x2
number
X 2 точки


y2
number
Y 2 точки


x3
number
X 3 точки


y3
number
Y 3 точки


JsMB.drawString(text, x, y) ⇒ this

Kind: static method of JsMB


Param
Type
Description


text
string
Текст для отображения


x
number
X


y
number
Y


JsMB.repaint() ⇒ this

В некоторых реализациях JsMB используется двойная буфферизация
repaint производит отрисовку на экран ранее произведенных действий
В стандартной реализации ничего не делает
Kind: static method of JsMB


JsMB.setFontSize(size) ⇒ this

Задать размер шрифта
Kind: static method of JsMB


Param
Type
Description


size
number
Размер


JsMB.setFont(family) ⇒ this

Задать шрифт
Kind: static method of JsMB


Param
Type
Description


family
string
Шрифт


JsMB.makeLinearGradient(x, y, x1, y1) ⇒ this

Создает линейный градиент
Kind: static method of JsMB


Param
Type
Description


x
number
X координата левого верхнего угла


y
number
Y координата левого верхнего угла


x1
number
X координата правого нижнего угла


y1
number
Y координата правого нижнего угла


JsMB.makeRadialGradient(x, y, r, x1, y1, r1) ⇒ this

Создает радиальный (круговой) градиент
Kind: static method of JsMB


Param
Type
Description


x
number
X координата левого верхнего угла


y
number
Y координата левого верхнего угла


r
number
Радиус внутреннего круга


x1
number
X координата правого нижнего угла


y1
number
Y координата правого нижнего угла


r1
number
Радиус внешнего круга


JsMB.setGradientColor(g, pos, color) ⇒ this

Задать цвет градиенту
Kind: static method of JsMB


Param
Type
Description


g
gradient
Градиент


pos
number
Позиция (0 - 1)


color
string
Цвет в CSS формате


JsMB.rgb(red, green, blue) ⇒ string

Цвет в rgb
Kind: static method of JsMB

Returns: string - "rgb(red, green, blue)"


Param
Type
Default
Description


red
number
0
Значение красного цвета (0 - 255)


green
number
0
Значение зеленого цвета (0 - 255)


blue
number
0
Значение синего цвета (0 - 255)


JsMB.rgba(red, green, blue, alpha) ⇒ string

Цвет в rgb
Kind: static method of JsMB

Returns: string - "rgba(red, green, blue, alpha)"


Param
Type
Default
Description


red
number
0
Значение красного цвета (0 - 255)


green
number
0
Значение зеленого цвета (0 - 255)


blue
number
0
Значение синего цвета (0 - 255)


alpha
number
0
Прозрачность (0 - 1)


JsMB.gelLoad(file, name) ⇒ this

Загрузить гель в память
Kind: static method of JsMB


Param
Type
Description


file
string
Файл (./,http,...)


name
string
Имя геля


JsMB.spriteGel(sprite, gel) ⇒ this

[НЕ РЕАЛИЗОВАНО]
Переводит гель в спрайт
Kind: static method of JsMB


Param
Type
Description


sprite
string
Имя спрайта


gel
string
Имя геля


JsMB.drawGel(name, x, y) ⇒ this

Рисует гель по указанным координатам
Kind: static method of JsMB


Param
Type
Description


name
string
Имя геля


x
number
X координата левого верхнего угла


y
number
Y координата левого верхнего угла


JsMB.drawSprite(name, x, y) ⇒ this

[НЕ РЕАЛИЗОВАНО]
Рисует спрайт по указанным координатам
Kind: static method of JsMB


Param
Type
Description


name
string
Имя спрайта


x
number
X координата левого верхнего угла


y
number
Y координата левого верхнего угла


JsMB.gelSize(name, w, h) ⇒ this

Задать размеры гелю (деформация)
Kind: static method of JsMB


Param
Type
Description


name
string
Название геля


w
number
Ширина


h
number
Высота


JsMB.drawGelFragment(name, fx, fy, fw, fh, x, y, w, h) ⇒ this

Рисует фрагмент геля
Kind: static method of JsMB


Param
Type
Default
Description


name
string

Имя геля


fx
number

Координаты левого верхнего угла области


fy
number

Координаты левого верхнего угла области


fw
number

Ширина области


fh
number

Высота области


x
number

Координаты левого верхнего угла для рисования


y
number

Координаты левого верхнего угла для рисования


w
number
fw
ширина для рисования


h
number
fh
высота для рисования


JsMB.makeTexture(gelname, repeat) ⇒ this

Создает текстуру из геля
Kind: static method of JsMB


Param
Type
Default
Description


gelname
string

Имя геля


repeat
string
"'repeat'"
Повторение (repeat/no-repeat)


JsMB.input(text, [def]) ⇒ this

Окно ввода данных
Kind: static method of JsMB


Param
Type
Description


text
string
Текст заголовка окна


[def]
string
Текст по умолчанию


JsMB.println() ⇒ this

Вывести текст на экран
Kind: static method of JsMB


JsMB.playSound(file, loop, channel) ⇒ this

Играть звук
Kind: static method of JsMB


Param
Type
Default
Description


file
string

Файл звука


loop
bool

Зациклить?


channel
string
0
Канал


JsMB.pauseSound(channel) ⇒ this

Приостановить воспроизведение звука на канале
Kind: static method of JsMB


Param
Type
Default
Description


channel
number
-1
Канал (-1 для остановки на всех каналах)


JsMB.random(min, max) ⇒ number

Возвращает случайное число
Kind: static method of JsMB


Param
Type
Description


min
number
От


max
number
До


JsMB.ctg(angle) ⇒ number

Возвращает котангенс угла
Kind: static method of JsMB


Param
Type
Description


angle
number
Угол в радианах


JsMB.mod(x, y) ⇒ number

Возвращает остаток от деления 2-х чисел
Kind: static method of JsMB


Param
Type
Description


x
number
Делимое


y
number
Делитель


JsMB.limit(variable, min, max) ⇒ number

Возвращает ограниченное значение переменной
Kind: static method of JsMB


Param
Type
Description


variable
number
Начальное значение


min
number
Минимум (нижняя граница)


max
number
Максимум (верхняя граница)


JsMB.rad(deg) ⇒ number

Переводит градусы в радианы
Kind: static method of JsMB

Returns: number - Радианы


Param
Type
Description


deg
number
Значение в градусах


JsMB.deg(rad) ⇒ number

Переводит радианы в градусы
Kind: static method of JsMB

Returns: number - Градусы


Param
Type
Description


rad
number
Значение в радианах


JsMB.len(str) ⇒ number

Возвращает длину строки/массива
Kind: static method of JsMB


Param
Type
Description


str
string
Строка/массив


JsMB.str(num) ⇒ string

Переводит число/значение в строку
Kind: static method of JsMB


Param
Type
Description


num
*
Число или другое значение


JsMB.val(str) ⇒ number

Переводит строку в число (или возвращает NaN, если это невозможно)
Kind: static method of JsMB


Param
Type
Description


str
string
Строка с числом


JsMB.int(str, [system]) ⇒ number

Переводит строку в число (или возвращает NaN, если это невозможно)
Лучше использовать val
Kind: static method of JsMB

Returns: number - Int


Param
Type
Default
Description


str
string

Строка с числом


[system]
number
10
Система исчисления


JsMB.float(str) ⇒ number

Переводит строку в число с плавающей точкой (или возвращает NaN, если это невозможно)
Kind: static method of JsMB

Returns: number - Float


Param
Type
Description


str
string
Строка с числом


JsMB.upper(str) ⇒ string

Приводит все символы строки в ВЕРХНИЙ РЕГИСТР
Kind: static method of JsMB


Param
Type
Description


str
string
Строка


JsMB.lower(str) ⇒ string

Приводит все символы строки в нижний регистр
Kind: static method of JsMB


Param
Type
Description


str
string
Строка


JsMB.mid(str, pos, len) ⇒ string

Возвращает часть строки
Kind: static method of JsMB


Param
Type
Description


str
string
Строка


pos
number
Начало выделения


len
number
Длина выделения


JsMB.asc(str, [pos]) ⇒ number

Возвращает код символа
Kind: static method of JsMB


Param
Type
Default
Description


str
string

Строка


[pos]
number
0
Позиция символа в строке


JsMB.split(str, char) ⇒ array

Разбивает строку и возвращает массив частей
Kind: static method of JsMB


Param
Type
Description


str
string
Строка


char
string
Символ/регулярное выражение, по которому разбивать


JsMB.replace(str, reg, to, [all]) ⇒ string

Возвращает строку с замененной частью
Kind: static method of JsMB


Param
Type
Default
Description


str
string

Строка


reg
string

Строка/регулярное выражение для замены


to
string

На что менять


[all]
bool
false
Заменять все включения


JsMB.localSaveData(name, _data) ⇒ this

Сохранить данные в хранилище
Kind: static method of JsMB


Param
Type
Description


name
string
Название ячейки


_data
*
Данные


JsMB.localReadData(name) ⇒ this

Получить данные из хранилища
Kind: static method of JsMB


Param
Type
Description


name
string
Название ячейки


JsMB.parseJSON(json) ⇒ object

Возвращает объект из JSON строки
Kind: static method of JsMB


Param
Type
Description


json
string
JSON строка


JsMB.toJSON(object, [f], [s]) ⇒ string

Возвращает JSON строку из объекта
Kind: static method of JsMB


Param
Type
Default
Description


object
object

Объект


[f]
function

Дополнительный обработчик


[s]
number
4
Отступ


JsMB.toPSON(object, [s]) ⇒ string

Возвращает PSON строку из объекта (с функциями)
Kind: static method of JsMB


Param
Type
Default
Description


object
object

Объект


[s]
number
4
Отступ


JsMB.include(file) ⇒ this

Подключает модуль/файл
Kind: static method of JsMB


Param
Type
Description


file
string
Имя/адрес файла


JsMB.screenWidth() ⇒ number

Возвращает ширину экрана
Kind: static method of JsMB


JsMB.screenHeight() ⇒ number

Возвращает высоту экрана
Kind: static method of JsMB


JsMB.getMouseX() ⇒ number

Возвращает X координату мыши в данный момент
Kind: static method of JsMB


JsMB.getMouseY() ⇒ number

Возвращает Y координату мыши в данный момент
Kind: static method of JsMB


JsMB.getLeftClicksCount() ⇒ number

Возвращает количество кликов с момента запуска программы
Kind: static method of JsMB


JsMB.getRightClicksCount() ⇒ number

Возвращает количество правых кликов с момента запуска программы
Kind: static method of JsMB


JsMB.log() ⇒ this

Логирование
Kind: static method of JsMB


Type
Description


*
Данные


JsMB.debug(text, [style]) ⇒ this

Вывести сообщение для отладки
Kind: static method of JsMB


Param
Type
Description


text
string
Сообщение


[style]
string
Оформление сообщения (CSS)


JsMB.exit() ⇒ this

Закрыть программу
Kind: static method of JsMB
Param	Type	Description
x	`number`	Координата X левого верхнего угла
y	`number`	Координата Y левого верхнего угла
w	`number`	Ширина
h	`number`	Высота
Param	Type	Description
x	`number`	X координата точки
y	`number`	Y координата точки
Param	Type	Description
x1	`number`	X 1 точки
y1	`number`	Y 1 точки
x2	`number`	X 2 точки
y2	`number`	Y 2 точки
Param	Type	Description
x	`number`	X левого верхнего угла
y	`number`	Y левого верхнего угла
w	`number`	ширина
h	`number`	высота
q	`number`	глубина
Param	Type	Default	Description
x	`number`		X центра
y	`number`		Y центра
radius	`number`		радиус
startAngle	`number`	`(15*PI/7)`	Угол начала
endAngle	`number`	`(13*PI/2)`	Угол конца
counterClockwise	`bool`	`false`	По часовой стрелке?
Param	Type	Description
text	`string`	Текст для отображения
x	`number`	X
y	`number`	Y
Param	Type	Description
x	`number`	X координата левого верхнего угла
y	`number`	Y координата левого верхнего угла
x1	`number`	X координата правого нижнего угла
y1	`number`	Y координата правого нижнего угла
Param	Type	Description
g	`gradient`	Градиент
pos	`number`	Позиция (0 - 1)
color	`string`	Цвет в CSS формате
Param	Type	Default	Description
red	`number`	`0`	Значение красного цвета (0 - 255)
green	`number`	`0`	Значение зеленого цвета (0 - 255)
blue	`number`	`0`	Значение синего цвета (0 - 255)
Param	Type	Description
file	`string`	Файл (./,http,...)
name	`string`	Имя геля