A discovered archetype candidate, flattened to just the fields the pure discovery rules need. Produced at the Foundry boundary from a world document or a compendium index entry.

interface ArchetypeCandidate {
    name: string;
    priority: number;
    shortcode: string;
    subType?: string;
    tier: ARCHETYPE_TIER;
    type: string;
    uuid: string;
}

Properties

name: string

The display name (presentation only; may diverge across localizations).

priority: number

The flags.sohl.docArchetype priority; higher wins on a shortcode clash.

shortcode: string

The system.shortcode — the archetype's stable identity / dedup key.

subType?: string

The system.subType, or ""/undefined for types without subtypes.

The candidate's source tier (ARCHETYPE_TIER).

type: string

The document type (e.g. "being", "weapongear").

uuid: string

The candidate document's UUID — the picker option value and clone source.