emilecok
/
ujs
1
0
Fork 0
Code Issues Pull Requests Projects 1 Releases Wiki Activity

draft docs

This commit is contained in:
Alexander Popov 2023-04-30 16:53:20 +03:00
parent a087fce335
commit 51dbf116c1
Signed by: iiiypuk
GPG Key ID: E47FE0AB36CD5ED6
1 changed files with 111 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

118
docs/ru.md
View File

@ -1,19 +1,17 @@
# Документация
## App
# App
Основной класс движка.
При инициализации самостоятельно добавляет HTML элемент `<canvas>`
в тег `<body>`.
### Параметры
## 🎛️ Параметры
- `w` — ширина холста в пикселях.
- `h` — высота холста в пикселях.
- `options` — объект опций.
**Имеет следующую структуру:**
### options
```text
{
@ -29,7 +27,11 @@
Отображает информацию о движке в **Console**.
По умолчанию `true`.
### Пример использования
## 🩻 Методы
...
## 🎮 Пример использования
```javascript
// init app
@ -41,6 +43,108 @@ window.addEventListener('DOMContentLoaded', () => {
});
```
## Scene
# Scene
Класс сцены.
## 🎛️ Параметры
...
## 🩻 Методы
...
## 🎮 Пример использования
```text
...
```
# SceneLayer
Класс слоя сцены.
## 🎛️ Параметры
...
## 🩻 Методы
...
## 🎮 Пример использования
```text
...
```
# Object
Класс объекта.
## 🎛️ Параметры
...
## 🎮 Пример использования
```text
...
```
# Rect
...
## 🎛️ Параметры
...
## 🎮 Пример использования
```text
...
```
# StrokeRect
...
## 🎛️ Параметры
...
## 🎮 Пример использования
```text
...
```
# Sprite
...
## 🎛️ Параметры
...
## 🎮 Пример использования
```text
...
```
# TiledSprite
...
## 🎛️ Параметры
...
## 🎮 Пример использования
```text
...
```