Дополнение документации
This commit is contained in:
125
docs/methods.md
125
docs/methods.md
@@ -4,26 +4,125 @@
|
||||
|
||||
Перемещает игрока на указанное смещение.
|
||||
|
||||
### Входные данные
|
||||
### Параметры
|
||||
|
||||
| Параметр | Тип | Описание |
|
||||
|---|---|---|
|
||||
| dx | int | Смещение по X |
|
||||
| dy | int | Смещение по Y |
|
||||
| Имя | Тип | Описание |
|
||||
| --- | --- | ----------------- |
|
||||
| dx | int | Смещение по оси X |
|
||||
| dy | int | Смещение по оси Y |
|
||||
|
||||
### Возвращаемое значение
|
||||
|
||||
Метод ничего не возвращает.
|
||||
Отсутствует.
|
||||
|
||||
---
|
||||
|
||||
## Player::usePotion(int itemId, const vector<Item>& itemDatabase)
|
||||
## Game::solveRiddle(Location& location)
|
||||
|
||||
Использует зелье из инвентаря игрока.
|
||||
Отображает загадку игроку и проверяет введённый ответ.
|
||||
|
||||
### Входные данные
|
||||
### Параметры
|
||||
|
||||
| Параметр | Тип | Описание |
|
||||
|---|---|---|
|
||||
| itemId | int | ID предмета |
|
||||
| itemDatabase | vector<Item> | База всех предметов |
|
||||
| Имя | Тип |
|
||||
| -------- | --------- |
|
||||
| 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 |
|
||||
|
||||
Reference in New Issue
Block a user