Документация
This commit is contained in:
26
docs/classes.md
Normal file
26
docs/classes.md
Normal file
@@ -0,0 +1,26 @@
|
||||
# Документация классов
|
||||
|
||||
## Game
|
||||
|
||||
Основной класс игры. Управляет игровым циклом, загрузкой данных, обработкой команд игрока, перемещением, взаимодействием с сундуками, NPC и боевой системой.
|
||||
|
||||
### Поля
|
||||
|
||||
| Поле | Тип | Описание |
|
||||
|---|---|---|
|
||||
| player | Player | Игрок |
|
||||
| locations | vector<Location> | Список игровых локаций |
|
||||
| itemDatabase | vector<Item> | База предметов |
|
||||
| isRunning | bool | Флаг работы игры |
|
||||
|
||||
### Методы
|
||||
|
||||
| Метод | Описание |
|
||||
|---|---|
|
||||
| run() | Запускает игру |
|
||||
| loadLocations() | Загружает локации из файлов |
|
||||
| loadItems() | Загружает предметы |
|
||||
| processCommand() | Обрабатывает команды игрока |
|
||||
| movePlayer() | Перемещает игрока |
|
||||
| openChest() | Открывает сундук |
|
||||
| startCombat() | Запускает бой |
|
||||
Reference in New Issue
Block a user