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

Compare commits

base: emilecok:57d2088a3a30c259cbf9ae835c873b7ec07a66cb
Branches Tags
emilecok:master
...
compare: emilecok:51dbf116c1c0979bd2c77f6386a8bf0a157dc16d
Branches Tags
emilecok:master

2 Commits
57d2088a3a ... 51dbf116c1

Author SHA1 Message Date
Alexander Popov 51dbf116c1
draft docs 2023-04-30 16:53:20 +03:00
Alexander Popov a087fce335
update icon link 2023-04-30 16:40:40 +03:00
2 changed files with 115 additions and 7 deletions
Show Stats Expand all files Collapse all files

2
README.md
View File

@ -1,6 +1,6 @@
# ⚠️ STATUS: DEVELOPMENT
![engine_icon](/src/icons/apple-touch-icon.png)
![engine_icon](/test/icons/apple-touch-icon.png)
# Documentation

120
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
@ -40,3 +42,109 @@ window.addEventListener('DOMContentLoaded', () => {
document.body.appendChild(app.view);
});
```
# Scene
Класс сцены.
## 🎛️ Параметры
...
## 🩻 Методы
...
## 🎮 Пример использования
```text
...
```
# SceneLayer
Класс слоя сцены.
## 🎛️ Параметры
...
## 🩻 Методы
...
## 🎮 Пример использования
```text
...
```
# Object
Класс объекта.
## 🎛️ Параметры
...
## 🎮 Пример использования
```text
...
```
# Rect
...
## 🎛️ Параметры
...
## 🎮 Пример использования
```text
...
```
# StrokeRect
...
## 🎛️ Параметры
...
## 🎮 Пример использования
```text
...
```
# Sprite
...
## 🎛️ Параметры
...
## 🎮 Пример использования
```text
...
```
# TiledSprite
...
## 🎛️ Параметры
...
## 🎮 Пример использования
```text
...
```