From 51dbf116c1c0979bd2c77f6386a8bf0a157dc16d Mon Sep 17 00:00:00 2001 From: Alexander Popov Date: Sun, 30 Apr 2023 16:53:20 +0300 Subject: [PATCH] draft docs --- docs/ru.md | 118 +++++++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 111 insertions(+), 7 deletions(-) diff --git a/docs/ru.md b/docs/ru.md index a06c8c8..06d44a1 100644 --- a/docs/ru.md +++ b/docs/ru.md @@ -1,19 +1,17 @@ -# Документация - -## App +# App Основной класс движка. При инициализации самостоятельно добавляет HTML элемент `` в тег ``. -### Параметры +## 🎛️ Параметры - `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 +... +```