commonMain.com.bselzer.gw2.v2.model.item.detail.ConsumableDetails.kt Maven / Gradle / Ivy

Go to download

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.item.detail

import com.bselzer.gw2.v2.model.color.DyeColorId
import com.bselzer.gw2.v2.model.enumeration.wrapper.ConsumableDetailType
import com.bselzer.gw2.v2.model.enumeration.wrapper.ConsumableUnlockType
import com.bselzer.gw2.v2.model.guild.upgrade.GuildUpgradeId
import com.bselzer.gw2.v2.model.recipe.RecipeId
import com.bselzer.gw2.v2.model.skin.SkinId
import com.bselzer.gw2.v2.model.wrapper.ImageLink
import com.bselzer.ktx.serialization.serializer.MillisecondDurationSerializer
import kotlinx.serialization.SerialName
import kotlinx.serialization.Serializable
import kotlin.time.Duration

@Serializable
data class ConsumableDetails(
    @SerialName("type")
    val type: ConsumableDetailType = ConsumableDetailType(),

    @SerialName("description")
    val description: String = "",

    @Serializable(with = MillisecondDurationSerializer::class)
    @SerialName("duration_ms")
    val duration: Duration = Duration.ZERO,

    /**
     * The unlock type for unlockable consumables.
     *
     * Null if this consumable is not unlockable.
     */
    @SerialName("unlock_type")
    val unlockType: ConsumableUnlockType? = null,

    /**
     * The id of the dye color when the [unlockType] is for a dye.
     * @see the wiki
     */
    @SerialName("color_id")
    val colorId: DyeColorId = DyeColorId(),

    /**
     * The id of the recipe when the [unlockType] is for a recipe.
     * @see the wiki
     */
    @SerialName("recipe_id")
    val recipeId: RecipeId = RecipeId(),

    /**
     * The ids of the additional recipe unlocks.
     * @see the wiki
     */
    @SerialName("extra_recipe_ids")
    val extraRecipeIds: List = emptyList(),

    /**
     * The id of the guild upgrade.
     * @see the wiki
     */
    @SerialName("guild_upgrade_id")
    val guildUpgradeId: GuildUpgradeId = GuildUpgradeId(),

    /**
     * The number of stacks of the effect applied by this item.
     */
    @SerialName("apply_count")
    val applyCount: Int = 0,

    /**
     * The effect type name.
     */
    @SerialName("name")
    val name: String = "",

    /**
     * The link to the effect icon.
     */
    @SerialName("icon")
    val iconLink: ImageLink = ImageLink(),

    /**
     * The ids of the skins this item unlocks.
     * @see the wiki
     */
    @SerialName("skins")
    val skinIds: List = emptyList()
)