Compare commits
2 Commits
57d2088a3a
...
51dbf116c1
Author | SHA1 | Date |
---|---|---|
Alexander Popov | 51dbf116c1 | |
Alexander Popov | a087fce335 |
|
@ -1,6 +1,6 @@
|
||||||
# ⚠️ STATUS: DEVELOPMENT
|
# ⚠️ STATUS: DEVELOPMENT
|
||||||
|
|
||||||
![engine_icon](/src/icons/apple-touch-icon.png)
|
![engine_icon](/test/icons/apple-touch-icon.png)
|
||||||
|
|
||||||
# Documentation
|
# Documentation
|
||||||
|
|
||||||
|
|
120
docs/ru.md
120
docs/ru.md
|
@ -1,19 +1,17 @@
|
||||||
# Документация
|
# App
|
||||||
|
|
||||||
## App
|
|
||||||
|
|
||||||
Основной класс движка.
|
Основной класс движка.
|
||||||
|
|
||||||
При инициализации самостоятельно добавляет HTML элемент `<canvas>`
|
При инициализации самостоятельно добавляет HTML элемент `<canvas>`
|
||||||
в тег `<body>`.
|
в тег `<body>`.
|
||||||
|
|
||||||
### Параметры
|
## 🎛️ Параметры
|
||||||
|
|
||||||
- `w` — ширина холста в пикселях.
|
- `w` — ширина холста в пикселях.
|
||||||
- `h` — высота холста в пикселях.
|
- `h` — высота холста в пикселях.
|
||||||
- `options` — объект опций.
|
- `options` — объект опций.
|
||||||
|
|
||||||
**Имеет следующую структуру:**
|
### options
|
||||||
|
|
||||||
```text
|
```text
|
||||||
{
|
{
|
||||||
|
@ -29,7 +27,11 @@
|
||||||
Отображает информацию о движке в **Console**.
|
Отображает информацию о движке в **Console**.
|
||||||
По умолчанию `true`.
|
По умолчанию `true`.
|
||||||
|
|
||||||
### Пример использования
|
## 🩻 Методы
|
||||||
|
|
||||||
|
...
|
||||||
|
|
||||||
|
## 🎮 Пример использования
|
||||||
|
|
||||||
```javascript
|
```javascript
|
||||||
// init app
|
// init app
|
||||||
|
@ -40,3 +42,109 @@ window.addEventListener('DOMContentLoaded', () => {
|
||||||
document.body.appendChild(app.view);
|
document.body.appendChild(app.view);
|
||||||
});
|
});
|
||||||
```
|
```
|
||||||
|
|
||||||
|
# Scene
|
||||||
|
|
||||||
|
Класс сцены.
|
||||||
|
|
||||||
|
## 🎛️ Параметры
|
||||||
|
|
||||||
|
...
|
||||||
|
|
||||||
|
## 🩻 Методы
|
||||||
|
|
||||||
|
...
|
||||||
|
|
||||||
|
## 🎮 Пример использования
|
||||||
|
|
||||||
|
```text
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
# SceneLayer
|
||||||
|
|
||||||
|
Класс слоя сцены.
|
||||||
|
|
||||||
|
## 🎛️ Параметры
|
||||||
|
|
||||||
|
...
|
||||||
|
|
||||||
|
## 🩻 Методы
|
||||||
|
|
||||||
|
...
|
||||||
|
|
||||||
|
## 🎮 Пример использования
|
||||||
|
|
||||||
|
```text
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
# Object
|
||||||
|
|
||||||
|
Класс объекта.
|
||||||
|
|
||||||
|
## 🎛️ Параметры
|
||||||
|
|
||||||
|
...
|
||||||
|
|
||||||
|
## 🎮 Пример использования
|
||||||
|
|
||||||
|
```text
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
# Rect
|
||||||
|
|
||||||
|
...
|
||||||
|
|
||||||
|
## 🎛️ Параметры
|
||||||
|
|
||||||
|
...
|
||||||
|
|
||||||
|
## 🎮 Пример использования
|
||||||
|
|
||||||
|
```text
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
# StrokeRect
|
||||||
|
|
||||||
|
...
|
||||||
|
|
||||||
|
## 🎛️ Параметры
|
||||||
|
|
||||||
|
...
|
||||||
|
|
||||||
|
## 🎮 Пример использования
|
||||||
|
|
||||||
|
```text
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
# Sprite
|
||||||
|
|
||||||
|
...
|
||||||
|
|
||||||
|
## 🎛️ Параметры
|
||||||
|
|
||||||
|
...
|
||||||
|
|
||||||
|
## 🎮 Пример использования
|
||||||
|
|
||||||
|
```text
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
# TiledSprite
|
||||||
|
|
||||||
|
...
|
||||||
|
|
||||||
|
## 🎛️ Параметры
|
||||||
|
|
||||||
|
...
|
||||||
|
|
||||||
|
## 🎮 Пример использования
|
||||||
|
|
||||||
|
```text
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
Loading…
Reference in New Issue