commonMain.com.bselzer.gw2.v2.model.pvp.game.PvpGame.kt Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of v2-model-jvm Show documentation

Guild Wars 2 API models for v2-client.

The newest version!

package com.bselzer.gw2.v2.model.pvp.game

import com.bselzer.gw2.v2.model.enumeration.wrapper.PvpRatingType
import com.bselzer.gw2.v2.model.enumeration.wrapper.PvpResult
import com.bselzer.gw2.v2.model.enumeration.wrapper.PvpTeam
import com.bselzer.gw2.v2.model.map.MapId
import com.bselzer.gw2.v2.model.profession.ProfessionId
import com.bselzer.gw2.v2.model.pvp.season.PvpSeasonId
import com.bselzer.ktx.value.identifier.Identifiable
import kotlinx.datetime.Instant
import kotlinx.serialization.SerialName
import kotlinx.serialization.Serializable

@Serializable
data class PvpGame(
    /**
     * The id in the form of a UUID.
     */
    @SerialName("id")
    override val id: PvpGameId = PvpGameId(),

    /**
     * The id of the map the match was played on.
     * @see the wiki
     */
    @SerialName("map_id")
    val mapId: MapId = MapId(),

    /**
     * The start date.
     */
    @SerialName("started")
    val startedAt: Instant = Instant.DISTANT_PAST,

    /**
     * The end date.
     */
    @SerialName("ended")
    val endedAt: Instant = Instant.DISTANT_PAST,

    /**
     * The result of the match.
     */
    @SerialName("result")
    val result: PvpResult = PvpResult(),

    /**
     * The name of the team the player was on.
     */
    @SerialName("team")
    val team: PvpTeam = PvpTeam(),

    /**
     * The name of the profession the player used.
     */
    @SerialName("profession")
    val profession: ProfessionId = ProfessionId(),

    /**
     * The scores for each team.
     */
    @SerialName("scores")
    val scores: Map = emptyMap(),

    /**
     * The type of game mode.
     */
    @SerialName("rating_type")
    val ratingType: PvpRatingType = PvpRatingType(),

    /**
     * The change in rating. Positive for a win and negative for a loss.
     */
    @SerialName("rating_change")
    val ratingChange: Int = 0,

    /**
     * The id of the season.
     * @see the wiki
     */
    @SerialName("season")
    val season: PvpSeasonId = PvpSeasonId()
) : Identifiable