[PythonAPI] Методы для работы с боем (Battle)

[MedvedevTD]

PythonAPI - Battle 

Работа с методами "battle" возможна только после входа в бой (срабатывания события, см. методы "events"), в противном случае методы ничего не возвращают, т.к. информация которую они обрабатывают есть только в бою. Для обработки событий необходимо использовать "events.onSFMEvent" (см. описание ниже в методах "events"), возвращаемые параметры этого события: "eventName" - название события, "eventData" - dict с параметрами события.

 

Доступные методы:

battle

• getPlayersInfo()
• getPlayerInfo(playerId)
• getSelfPlayerInfo()
• getPlayerInfoByName(name)
• getPlayerShipInfo(playerId)
• getPlayerByVehicleId(shipID)
• getAmmoParams(ammoID)
• isVehicleBurning(shipID)
• isVehicleFlooding(shipID)
• isBattleStarted()

---

battle.getPlayersInfo()

Данная функция возвращает dict, где ключами являются "playerID", а значениями - dict "PlayerInfo" с различной информацией об игроке.

Для просмотра результата можно вывести через "print" в "Korabli\profile\python.log" файл, либо записать в отдельный файл "open('filename', 'w')".

 

---

battle.getPlayerInfo(playerID)

Данная функция возвращает объект с информацией об игроке.

Входной параметр: playerId - идентификатор игрока. Возвращаемое значение: PlayerInfo.

---

battle.getSelfPlayerInfo()

Данная функция возвращает объект с информацией о нашем игроке. Возвращаемое значение: PlayerInfo.

---

battle.getPlayerInfoByName(name)

Данная функция возвращает объект с информацией об игроке.

Входной параметр: name - никнэйм игрока. Возвращаемое значение: PlayerInfo.

---

battle.getPlayerShipInfo(playerID)

Данная функция возвращает объект с информацией о корабле игрока.

Входной параметр: playerId - идентификатор игрока. Возвращаемое значение: ShipInfo.

---

battle.getPlayerByVehicleId(shipID)

Данная функция возвращает объект с информацией об игроке.

Входной параметр: shipId - идентификатор корабля. Возвращаемое значение: PlayerInfo.

---

battle.getAmmoParams(ammoID)

Данная функция возвращает объект с информацией о снаряде.

Входной параметр: ammoId - идентификатор снаряда, этот параметр можно получить в функции-обработчике события "events.onReceiveShellInfo(func)" (см. описание в методах "events").

---

battle.isVehicleBurning(shipID)

Данная функция возвращает True если корабль горит, или False если нет, например можно использовать в функции-обработчике события "events.onReceiveShellInfo(func)" (см. описание в методах "events").

Входной параметр - ID идентификатор корабля.

---

battle.isVehicleFlooding(shipID)

Данная функция возвращает True если попадание снаряда в корабль вызвало затопление, или False если нет, рекомендация к использованию аналогично "isVehicleBurning".

Входной параметр - ID идентификатор корабля.

---

battle.isBattleStarted()

Данная функция возвращает True если бой начался.