@hatsuboshi/types
    Preparing search index...

    Class Character

    An in-game character.

    Includes both playable characters (e.g. "花海咲季" / "Hanami Saki", "月村手毬" / "Tsukimura Temari", "藤田ことね" / "Fujita Kotone", etc.), and non-playable characters (e.g. "根緒亜紗里" / "Neo Asari", "十王邦夫" / "Juo Kunio", "藍井撫子" / "Aoi Nadeshiko", etc.).

    For the playable produce idol units of each character, see PIdol.

    Tip

    See CharacterFilter for the list of filtering options.

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

    Hierarchy (View Summary)

    Implements

    Index
    • Constructs a Character instance from an optional ICharacter object.

      If obj, or any of its required fields are undefined, the default value of each property's type will be used to construct the object.

      Parameters

      • Optionalobj: Partial<ICharacter>

        Data to construct the object from.

      Returns Character

      // Default instance
      new Character()

      // From partial data
      new Character({ name: { ja: "Hello" } })

      // From JSON data returned by an API
      const res = await fetch(...)
      const data = new Character(await res.json())
    • 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 DBCharacter

    • 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 character.

    The set of colors associated with the character.

    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"
    

    The extended details of the character.

    firstName: LocaleString

    The first / given name of a character, or otherwise the second part of a character's name.

    id: string

    An ID associated with the object.

    index: number = 0

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

    isPlayable: boolean

    Whether the character is playable in-game.

    lastName: LocaleString

    The last / family name of a character, or otherwise the first part of a character's name.

    sortableFields: readonly [
        "id",
        "createdAt",
        "updatedAt",
        "firstName",
        "lastName",
        "isPlayable",
    ] = ...
    trueEndBonuses: CharacterTrueEndBonus[]

    The bonuses gained from reaching any available True End's in gameplay scenarios for the character.

    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"