ujs/docs/ru/api.md

151 lines
1.9 KiB
Markdown
Raw Normal View History

2023-04-30 17:39:03 +03:00
# 🔵 App
2023-04-30 15:55:44 +03:00
Основной класс движка.
При инициализации самостоятельно добавляет HTML элемент `<canvas>`
в тег `<body>`.
2023-04-30 16:53:20 +03:00
## 🎛️ Параметры
2023-04-30 15:55:44 +03:00
- `w` — ширина холста в пикселях.
- `h` — высота холста в пикселях.
- `options` — объект опций.
2023-04-30 16:53:20 +03:00
### options
2023-04-30 15:55:44 +03:00
```text
{
backgroundColor: '#ffcc68',
welcome: true,
}
```
2023-04-30 17:39:03 +03:00
- `backgroundColor` — фон холста.
2023-04-30 15:55:44 +03:00
По умолчанию `#ffcc68`.
2023-04-30 17:39:03 +03:00
- `welcome``bool` тип.
2023-04-30 15:55:44 +03:00
Отображает информацию о движке в **Console**.
По умолчанию `true`.
2023-04-30 16:53:20 +03:00
## 🩻 Методы
...
## 🎮 Пример использования
2023-04-30 15:55:44 +03:00
```javascript
// init app
let app = new App(400, 400);
// add app view in document
window.addEventListener('DOMContentLoaded', () => {
document.body.appendChild(app.view);
});
```
2023-04-30 16:40:40 +03:00
2023-04-30 17:39:03 +03:00
# 🔵 Scene
2023-04-30 16:40:40 +03:00
Класс сцены.
2023-04-30 16:53:20 +03:00
## 🎛️ Параметры
...
## 🩻 Методы
...
## 🎮 Пример использования
```text
...
```
2023-04-30 17:39:03 +03:00
# 🔵 SceneLayer
2023-04-30 16:53:20 +03:00
Класс слоя сцены.
## 🎛️ Параметры
...
## 🩻 Методы
...
## 🎮 Пример использования
```text
...
```
2023-04-30 17:39:03 +03:00
# 🔵 Object
2023-04-30 16:53:20 +03:00
Класс объекта.
## 🎛️ Параметры
...
## 🎮 Пример использования
```text
...
```
2023-04-30 17:39:03 +03:00
# 🔵 Rect
2023-04-30 16:53:20 +03:00
...
## 🎛️ Параметры
...
## 🎮 Пример использования
```text
...
```
2023-04-30 17:39:03 +03:00
# 🔵 StrokeRect
2023-04-30 16:53:20 +03:00
...
## 🎛️ Параметры
...
## 🎮 Пример использования
```text
...
```
2023-04-30 17:39:03 +03:00
# 🔵 Sprite
2023-04-30 16:53:20 +03:00
...
## 🎛️ Параметры
...
## 🎮 Пример использования
```text
...
```
2023-04-30 17:39:03 +03:00
# 🔵 TiledSprite
2023-04-30 16:53:20 +03:00
...
## 🎛️ Параметры
...
## 🎮 Пример использования
```text
...
```