commonMain.com.bselzer.gw2.v2.model.character.equipment.CharacterEquipment.kt Maven / Gradle / Ivy

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

Guild Wars 2 API models for v2-client.

The newest version!

package com.bselzer.gw2.v2.model.character.equipment

import com.bselzer.gw2.v2.model.character.CharacterName
import com.bselzer.gw2.v2.model.color.DyeColorId
import com.bselzer.gw2.v2.model.enumeration.wrapper.Binding
import com.bselzer.gw2.v2.model.enumeration.wrapper.EquipmentSlot
import com.bselzer.gw2.v2.model.item.ItemId
import com.bselzer.gw2.v2.model.skin.SkinId
import com.bselzer.ktx.value.identifier.Identifiable
import kotlinx.serialization.SerialName
import kotlinx.serialization.Serializable

@Serializable
data class CharacterEquipment(
    /**
     * The id of the item.
     * @see the wiki
     */
    @SerialName("id")
    override val id: ItemId = ItemId(),

    /**
     * The type of slot.
     */
    @SerialName("slot")
    val slot: EquipmentSlot = EquipmentSlot(),

    /**
     * The ids of the equipped infusions.
     * @see the wiki
     */
    @SerialName("infusions")
    val infusions: List = emptyList(),

    /**
     * The ids of the equipped upgrade components.
     * @see the wiki
     */
    @SerialName("upgrades")
    val upgrades: List = emptyList(),

    /**
     * The id of the equipped skin.
     * @see the wiki
     */
    @SerialName("skin")
    val skin: SkinId = SkinId(),

    /**
     * The stats of the item.
     * @see the wiki
     */
    @SerialName("stats")
    val stats: List = emptyList(),

    /**
     * What owns this item. Null if there is no binding.
     */
    @SerialName("binding")
    val binding: Binding? = null,

    /**
     * The number of charges left.
     */
    @SerialName("charges")
    val charges: Int = 0,

    /**
     * Who owns this item. Null if the binding is NOT for a character.
     */
    @SerialName("bound_to")
    val boundTo: CharacterName? = null,

    /**
     * The ids of the dyes. An id will be null if there is no selection.
     * @see the wiki
     */
    @SerialName("dyes")
    val dyes: List = emptyList()
) : Identifiable