Files
ASCII-G/docs/methods.md

129 lines
2.6 KiB
Markdown

# Описание методов
## Game::movePlayer(int dx, int dy)
Перемещает игрока на указанное смещение.
### Параметры
| Имя | Тип | Описание |
| --- | --- | ----------------- |
| dx | int | Смещение по оси X |
| dy | int | Смещение по оси Y |
### Возвращаемое значение
Отсутствует.
---
## Game::solveRiddle(Location& location)
Отображает загадку игроку и проверяет введённый ответ.
### Параметры
| Имя | Тип |
| -------- | --------- |
| location | Location& |
### Возвращаемое значение
| Тип | Описание |
| ---- | -------------------------- |
| bool | true при правильном ответе |
---
## Player::usePotion(int itemId, const std::vector<Item>& itemDatabase)
Использует выбранное зелье из инвентаря.
### Параметры
| Имя | Тип |
| ------------ | ----------------- |
| itemId | int |
| itemDatabase | std::vector<Item> |
---
## Player::equipWeapon(int itemId, const std::vector<Item>& itemDatabase)
Экипирует выбранное оружие.
### Параметры
| Имя | Тип |
| ------------ | ----------------- |
| itemId | int |
| itemDatabase | std::vector<Item> |
---
## Inventory::addItem(int itemId, int count)
Добавляет предмет в инвентарь.
### Параметры
| Имя | Тип |
| ------ | --- |
| itemId | int |
| count | int |
---
## Inventory::removeItem(int itemId, int count)
Удаляет предмет из инвентаря.
### Параметры
| Имя | Тип |
| ------ | --- |
| itemId | int |
| count | int |
### Возвращаемое значение
| Тип | Описание |
| ---- | ------------------- |
| bool | Успешность операции |
---
## Location::loadFromFile(const std::string& path)
Загружает данные локации из файла.
### Параметры
| Имя | Тип |
| ---- | ----------- |
| path | std::string |
### Возвращаемое значение
| Тип |
| ---- |
| bool |
---
## NPC::loadFromFile(const std::string& path)
Загружает параметры NPC из текстового файла.
### Параметры
| Имя | Тип |
| ---- | ----------- |
| path | std::string |
### Возвращаемое значение
| Тип |
| ---- |
| bool |