@hatsuboshi/types
    Preparing search index...

    Class Skill

    A skill card (スキルカード).

    These are cards that can be played during a lesson/audition gameplay segment for various effects (e.g. "ファンサ" / "Fansa", "シュプレヒコール" / "Sprechchor", "星屑センセーション" / "Stardust Sensation", etc.).

    Tip

    See SkillFilter for the list of filtering options.

    See ISkill for the list of fields that can be used for sorting.

    Hierarchy (View Summary)

    Implements

    Index
    • TODO

      Parameters

      • Optionalpos: number
      • Optionallevel: number

      Returns this

    • Returns the document-store representation of this object.

      Caution

      Unlike toJSON(), the resulting document-store representation may be in a significantly different shape to that of its implementing class, and it cannot be passed back into the constructor to reconstruct an equivalent instance.

      Use fromDB() instead, which reconstructs the instance and rehydrates any fields truncated by the conversion.

      Returns DBSkill

    • Returns the JSON-serializable representation of this object.

      Tip

      The result can be passed back into the constructor to reconstruct an equivalent instance.

      Returns ISkill

      // t1 and t2 are deeply equal
      const t1: T = new T({ ... })
      const t2: T = new T(t1.toJSON())
    • get dbRef(): string

      The unique reference to this object in persistent storage.

      Returns string

    assetUrl: string

    The URL to the main visual asset (image) of the skill card.

    category: SkillCategory

    The category of the skill card (i.e. Active, Mental, Trouble).

    createdAt: string

    The time the object was created, as an ISO 8601 (RFC 3339) timestamp.

    ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(.\d+)?(Z|[+-]\d{2}:\d{2})$

    "2026-07-08T07:35:46.741Z"
    
    currentCustomizeLevels: [number, number][]

    The current set of customization options applied to this Skill instance.

    currentCustomizeLimit: number

    The customize limit of this Skill instance (including any level upgrades / customizations).

    currentEffect: SkillEffect

    The effects of this Skill instance (including any level upgrades / customizations).

    currentFlags: SkillFlags

    The boolean flags of this Skill instance (including any level upgrades / customizations).

    currentStaminaCost: number

    The stamina cost of this Skill instance (including any level upgrades / customizations).

    currentUpgradeLevel: number

    The current upgrade level of this Skill instance.

    customizeOptions: SkillCustomize[]

    A list of customization options for the skill card.

    id: string

    An ID associated with the object.

    index: number = 0

    An auto-incremented index to keep object IDs unique during runtime.

    initialCustomizeLimit: number

    The customize limit of the skill card, at upgrade level 0 (unupgraded) without customizations. Use Skill.currentCustomizeLimit for the customize limit including any level upgrades / customizations.

    initialEffect: SkillEffect

    The effects of the skill card, at upgrade level 0 (unupgraded) without customizations. Use Skill.currentEffect for the effects including any level upgrades / customizations.

    initialFlags: SkillFlags

    The boolean flags of the skill card, at upgrade level 0 (unupgraded) without customizations. Use Skill.currentFlags for the boolean flags including any level upgrades / customizations.

    initialStaminaCost: number

    The stamina cost of the skill card, at upgrade level 0 (unupgraded) without customizations. Use Skill.currentStaminaCost for the stamina cost including any level upgrades / customizations.

    The name of the skill card.

    plan: Plan

    The produce plan(s) the skill card can be used on.

    rarity: SkillRarity

    The rarity of the skill card.

    sortableFields: readonly [
        "id",
        "createdAt",
        "updatedAt",
        "name",
        "plan",
        "rarity",
        "unlockLevel",
        "source",
        "category",
        "initialStaminaCost",
        "initialCustomizeLimit",
    ] = ...
    source: SkillSource

    The source of the skill card.

    unlockLevel: number

    The produce level at which the skill card is unlocked at.

    updatedAt: string

    The time the object was last updated, as an ISO 8601 (RFC 3339) timestamp.

    ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(.\d+)?(Z|[+-]\d{2}:\d{2})$

    "2026-07-09T14:02:11.508Z"
    
    upgradeLevels: SkillUpgradeLevelEffect[]

    A list of upgrade level effects for the skill card. Use upgradeLevels.length for its maximum upgrade level.