@hatsuboshi/types
    Preparing search index...

    Class AuditionTerminology

    A gameplay terminology.

    This may refer to any commonly used word within the game, e.g. パラメータ, チェンジ, 強化, 相談の全項目を割増, etc.

    Tip

    See AuditionTerminologyFilter for the list of filtering options.

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

    Note

    AuditionTerminologies can sometimes look similar to AuditionEffects, but they are subtly different. AuditionTerminologies usually refer to effects that persist across an entire produce run, while AuditionEffects usually refer to effects that are ephemeral to only a specific lesson/audition gameplay sector.

    For example, 強化 (an AuditionTerminology) upgrades a skill card for the whole produce run, while レッスン中強化 (an AuditionEffect) only upgrades a skill card for the duration of a lesson/audition.

    Hierarchy (View Summary)

    Implements

    Index
    • 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 DBAuditionTerminology

    • get dbRef(): string

      The unique reference to this object in persistent storage.

      Returns string

    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"
    
    description: Effect

    The description of the terminology.

    The icon associated with the terminology.

    id: string

    An ID associated with the object.

    index: number = 0

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

    isHighlighted: boolean

    Whether the terminology should be highlighted when the effect text it appears in is rendered.

    The name of the terminology.

    sortableFields: readonly [
        "id",
        "createdAt",
        "updatedAt",
        "name",
        "isHighlighted",
    ] = ...
    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"