-
Notifications
You must be signed in to change notification settings - Fork 2
Resource RoundResource
Endpoints: • round.getById • round.getLastHits
Get a battle round by ID.
await client.round.get(round_id: 'str') -> 'Round'| Name | Type | Default |
|---|---|---|
round_id |
str |
*Required* |
A single equipped item returned by inventory.fetchCurrentEquipment.
The API returns one object keyed by slot (weapon, helmet, ...);
the resource flattens it into a list of Equipment with slot set.
| Field | Type | Required |
|---|---|---|
_id |
string |
Optional |
__v |
integer |
Optional |
slot |
string |
Optional |
itemId |
string |
Optional |
itemCode |
string |
Optional |
name |
string |
Optional |
rarity |
string |
Optional |
stats |
object |
Optional |
type |
string |
Optional |
code |
string |
Optional |
skills |
EquipmentSkills |
Optional |
state |
number |
Optional |
maxState |
number |
Optional |
quantity |
integer |
Optional |
lastAcquisitionAt |
string |
Optional |
Stat bonuses granted by an equipped item.
| Field | Type | Required |
|---|---|---|
_id |
string |
Optional |
__v |
integer |
Optional |
attack |
number |
Optional |
armor |
number |
Optional |
criticalChance |
number |
Optional |
criticalDamages |
number |
Optional |
dodge |
number |
Optional |
precision |
number |
Optional |
A single hit entry (round.getLastHits / round side lastHits).
| Field | Type | Required |
|---|---|---|
_id |
string |
Optional |
__v |
integer |
Optional |
user |
string |
Optional |
mu |
string |
Optional |
damages |
number |
Optional |
isCriticalHit |
boolean |
Optional |
isMissed |
boolean |
Optional |
hitAt |
string |
Optional |
ammo |
string |
Optional |
weapon |
Equipment |
Optional |
equipments |
array[Equipment] |
Optional |
| Field | Type | Required |
|---|---|---|
_id |
string |
Optional |
__v |
integer |
Optional |
battle |
string |
Optional |
number |
integer |
Optional |
isActive |
boolean |
Optional |
attacker |
RoundSide |
Optional |
defender |
RoundSide |
Optional |
live |
RoundLive |
Optional |
createdAt |
string |
Optional |
updatedAt |
string |
Optional |
| Field | Type | Required |
|---|---|---|
_id |
string |
Optional |
__v |
integer |
Optional |
ticksCount |
integer |
Optional |
actualTickPoints |
number |
Optional |
nextTickAt |
string |
Optional |
Combat stats of one side (attacker/defender) within a round.
| Field | Type | Required |
|---|---|---|
_id |
string |
Optional |
__v |
integer |
Optional |
country |
string |
Optional |
damages |
number |
Optional |
points |
number |
Optional |
hitCount |
integer |
Optional |
lastHits |
array[Hit] |
Optional |
Get the most recent hits in a battle round.
await client.round.get_last_hits(round_id: 'str') -> 'list[Hit]'| Name | Type | Default |
|---|---|---|
round_id |
str |
*Required* |
A single equipped item returned by inventory.fetchCurrentEquipment.
The API returns one object keyed by slot (weapon, helmet, ...);
the resource flattens it into a list of Equipment with slot set.
| Field | Type | Required |
|---|---|---|
_id |
string |
Optional |
__v |
integer |
Optional |
slot |
string |
Optional |
itemId |
string |
Optional |
itemCode |
string |
Optional |
name |
string |
Optional |
rarity |
string |
Optional |
stats |
object |
Optional |
type |
string |
Optional |
code |
string |
Optional |
skills |
EquipmentSkills |
Optional |
state |
number |
Optional |
maxState |
number |
Optional |
quantity |
integer |
Optional |
lastAcquisitionAt |
string |
Optional |
Stat bonuses granted by an equipped item.
| Field | Type | Required |
|---|---|---|
_id |
string |
Optional |
__v |
integer |
Optional |
attack |
number |
Optional |
armor |
number |
Optional |
criticalChance |
number |
Optional |
criticalDamages |
number |
Optional |
dodge |
number |
Optional |
precision |
number |
Optional |
A single hit entry (round.getLastHits / round side lastHits).
| Field | Type | Required |
|---|---|---|
_id |
string |
Optional |
__v |
integer |
Optional |
user |
string |
Optional |
mu |
string |
Optional |
damages |
number |
Optional |
isCriticalHit |
boolean |
Optional |
isMissed |
boolean |
Optional |
hitAt |
string |
Optional |
ammo |
string |
Optional |
weapon |
Equipment |
Optional |
equipments |
array[Equipment] |
Optional |
Fetch multiple rounds by ID concurrently using the auto-batcher.
await client.round.get_many(round_ids: 'list[str]') -> 'list[Round | None]'| Name | Type | Default |
|---|---|---|
round_ids |
list[str] |
*Required* |
A single equipped item returned by inventory.fetchCurrentEquipment.
The API returns one object keyed by slot (weapon, helmet, ...);
the resource flattens it into a list of Equipment with slot set.
| Field | Type | Required |
|---|---|---|
_id |
string |
Optional |
__v |
integer |
Optional |
slot |
string |
Optional |
itemId |
string |
Optional |
itemCode |
string |
Optional |
name |
string |
Optional |
rarity |
string |
Optional |
stats |
object |
Optional |
type |
string |
Optional |
code |
string |
Optional |
skills |
EquipmentSkills |
Optional |
state |
number |
Optional |
maxState |
number |
Optional |
quantity |
integer |
Optional |
lastAcquisitionAt |
string |
Optional |
Stat bonuses granted by an equipped item.
| Field | Type | Required |
|---|---|---|
_id |
string |
Optional |
__v |
integer |
Optional |
attack |
number |
Optional |
armor |
number |
Optional |
criticalChance |
number |
Optional |
criticalDamages |
number |
Optional |
dodge |
number |
Optional |
precision |
number |
Optional |
A single hit entry (round.getLastHits / round side lastHits).
| Field | Type | Required |
|---|---|---|
_id |
string |
Optional |
__v |
integer |
Optional |
user |
string |
Optional |
mu |
string |
Optional |
damages |
number |
Optional |
isCriticalHit |
boolean |
Optional |
isMissed |
boolean |
Optional |
hitAt |
string |
Optional |
ammo |
string |
Optional |
weapon |
Equipment |
Optional |
equipments |
array[Equipment] |
Optional |
| Field | Type | Required |
|---|---|---|
_id |
string |
Optional |
__v |
integer |
Optional |
battle |
string |
Optional |
number |
integer |
Optional |
isActive |
boolean |
Optional |
attacker |
RoundSide |
Optional |
defender |
RoundSide |
Optional |
live |
RoundLive |
Optional |
createdAt |
string |
Optional |
updatedAt |
string |
Optional |
| Field | Type | Required |
|---|---|---|
_id |
string |
Optional |
__v |
integer |
Optional |
ticksCount |
integer |
Optional |
actualTickPoints |
number |
Optional |
nextTickAt |
string |
Optional |
Combat stats of one side (attacker/defender) within a round.
| Field | Type | Required |
|---|---|---|
_id |
string |
Optional |
__v |
integer |
Optional |
country |
string |
Optional |
damages |
number |
Optional |
points |
number |
Optional |
hitCount |
integer |
Optional |
lastHits |
array[Hit] |
Optional |
Clear the SWR cache for all resources.
await client.round.invalidate_cache() -> 'None'- action_log
- alliance
- article
- battle
- battle_loot_summary
- battle_order
- battle_ranking
- company
- country
- donation
- election
- event
- game_config
- game_stat
- government
- inventory
- item_trading
- mercenary_contract_auction
- mu
- mu_member
- party
- ranking
- region
- round
- search
- tournament
- transaction
- upgrade
- user
- work
- work_offer
- worker