megaten/dist/types.d.ts

An unofficial collection of data from the Shin Megami Tensei and Persona games.

/** A utility type for shortening ternary typings */
export type If<Bool extends boolean, ValueIfTrue, ValueIfFalse> = Bool extends true ? ValueIfTrue : ValueIfFalse;
/** Criteria for AilBoostSkill instances taking effect */
export type AilBoostCriteria = 'Rain/Snow';
/** An ailment/status effect */
export interface Ailment {
    /** The ailment's name */
    name: AilmentName;
    /** The percent chance of inflicting the ailment */
    chance: number;
}
/** Ailments' names (adjusted for consistency with SMT5) */
export type AilmentName = 'Burn' | 'Charm' | 'Confuse' | 'Despair' | 'Enervate' | 'Exhaust' | 'Fear' | 'Freeze' | 'Hunger' | 'Mirage' | 'Mud' | 'Poison' | 'Rage' | 'Seal' | 'Shock' | 'Shroud' | 'Sleep';
/** An ailment's name or all ailments */
export type OneOrAllAilments = AilmentName | 'All';
/** Ailments that an AilDefensiveSkill instance protects against */
export type AilDefensiveAilment = OneOrAllAilments | 'Confuse/Fear/Rage/Despair';
/** Resistances to ailments */
export type AilResistance = 'Resist' | 'Null';
/** Resistances to damaging skills */
export type Resistance = AilResistance | 'Drain' | 'Repel';
/** Ranges for skills targeting allies */
export type AllyRange = 'Self' | 'Ally' | 'Party';
/** Ranges for skills targeting enemies */
export type EnemyRange = 'One' | 'All' | 'Random';
/** Ranges for skills */
export type AnyRange = AllyRange | EnemyRange;
/** Range for AilmentSkill instances */
export type AilmentRange = Exclude<EnemyRange, 'Random'>;
/** Range for AutoBuffSkill instances */
export type AutoBuffRange = Exclude<AllyRange, 'Ally'>;
/** Range for BarrierSkill instances */
export type BarrierRange = Exclude<AllyRange, 'Self'>;
/** Range for CritSkill instances */
export type CritRange = Exclude<AllyRange, 'Self'> | 'All';
/** Range for RecoverySkill instances */
export type RecoveryRange = Exclude<AllyRange, 'Self'>;
/** Range for SupportSkill instances */
export type SupportRange = Exclude<AnyRange, 'Random'>;
/** Range for SusceptibilitySkill instances */
export type SusceptibilityRange = 'Foe' | 'All';
/** Demons' Arcana */
export type Arcana = 'Fool' | 'Magician' | 'Councillor' | 'Priestess' | 'Empress' | 'Emperor' | 'Hierophant' | 'Apostle' | 'Lovers' | 'Chariot' | 'Justice' | 'Hermit' | 'Fortune' | 'Strength' | 'Hunger' | 'Hanged' | 'Death' | 'Temperance' | 'Devil' | 'Tower' | 'Star' | 'Moon' | 'Sun' | 'Judgement' | 'Aeon' | 'World' | 'Faith' | 'Hope';
/** An AttackSkill instance's cost */
export interface AttackCost {
    /** The amount of HP or MP that the skill uses */
    amount: number;
    /** The stat that the skill uses */
    stat: HPMP;
}
/** Flags for AttackSkill instances */
export type AttackFlag = '+20% Crit Rate' | '+200% Crit Rate' | '+30% Crit Rate' | 'Accuracy/Evasion Down' | 'Afflicted Boost' | 'Asleep Boost' | 'Attack Down' | 'Attack Reduced' | 'Baton Boost' | 'Charmed Boost' | 'Confused Boost' | 'Crit Damage Boost' | 'Defense Down' | 'Defense Greatly Down' | 'Down Boost' | 'Drain HP' | 'Drain HP/MP' | 'Drain MP' | 'HP Dependent' | 'Instakill' | 'Minimize Defense' | 'Negate Buffs' | 'Pierce' | 'Poisoned Boost' | 'Shroud Dependent' | 'Static Damage' | 'Surround Boost' | 'Weakness Instakill' | 'Weather Boost';
/** A base for skills with a specific amount of power */
export interface BasePower {
    /** The skill's base power (adjusted for consistency with SMT5) */
    amount: number;
    /** The skill's visible power relative to other skills */
    display: unknown;
}
/** An AttackSkill instance's power */
export interface AttackPower extends BasePower {
    display: AttackDisplay;
    /** The type of damage that the skill inflicts */
    type: DamageType;
}
/** An SMTCounterSkill instance's power */
export interface SMTCounterPower extends BasePower {
    display: CounterDisplay;
}
/** Barriers formed by a Skill instance */
export type Barrier = 'Painting' | 'Kannabi Veil' | 'Tetrakarn' | 'Makarakarn' | 'Shield of Justice' | 'Tetraja' | `${Exclude<DamagingAffinity, PersonaAffinity | 'Almighty'>} Block`;
/** The method for calculating how multiple BoostSkill instances stack */
export type BoostStack = '+' | 'x';
/** Buffs cast by a Skill instance */
export type Buff = 'Attack' | 'Defense' | 'Accuracy/Evasion';
/** A one- or two-stage buff */
export type SingleOrDoubleBuff = Buff | `Double ${Buff}`;
/** Charges cast by a Skill instance */
export type Charge = 'Recovery' | 'Charge' | 'Concentrate' | 'Critical' | 'Pierce';
/** Displayed damage values for SMTCounterSkill instances */
export type CounterDisplay = 'Weak' | 'Medium';
/** Displayed damage values for AttackSkill instances */
export type AttackDisplay = CounterDisplay | 'Minuscule' | 'Heavy' | 'Severe' | 'Colossal';
/** Criteria for CritBoostSkill instances taking effect */
export type CritBoostCriteria = 'Ambush' | 'Surround';
/** Types of damage dealt */
export type DamageType = 'Physical' | 'Magic';
/** Debuffs cast by AilmentSkill flags */
export type Debuff = `${Buff} Down` | `${Buff} Greatly Down`;
/** A demon's skill potential and inherit affinity */
export interface DemonAffinities<PersonaBased extends boolean = boolean> {
    /** The demon's skill potential */
    skillPotential: If<PersonaBased, null, SkillPotential | null>;
    /** The affinity that the demon can learn skills of */
    inherit: InheritAffinity | null;
}
/** A demon's mythological origin */
export type DemonOrigin = 'Aboriginal' | 'Abrahamic' | 'Arabian' | 'ATLUS Original' | 'Balinese' | 'Buddhist' | 'Buryat' | 'Canaanite' | 'Celtic' | 'Chinese' | 'Egyptian' | 'European' | 'Filipino' | 'Greco-Roman' | 'Haitian' | 'Hindu' | 'Japanese' | 'Lithuanian' | 'Lovecraftian' | 'Historical' | 'Mesopotamian' | 'Modern Fiction' | 'Norse' | 'North American' | 'Slavic' | 'South American' | 'Universal' | 'Zoroastrian';
/** A demon's ailment and affinity resistances */
export interface DemonResistances<PersonaBased extends boolean = boolean> {
    /** Ailments that the demon is weak to, resists, or nullifies */
    ailments: If<PersonaBased, null, Partial<Record<AilmentName, AilResistance | 'Weak'>> | null>;
    /** Affinities that the demon is weak to */
    weak: DamagingAffinity[];
    /** Affinities that the demon resists */
    resist: DamagingAffinity[];
    /** Affinities that the demon nullifies */
    null: DamagingAffinity[];
    /** Affinities that the demon drains */
    drain: DamagingAffinity[];
    /** Affinities that the demon repels */
    repel: DamagingAffinity[];
}
/** A skill that a demon learns via leveling up */
export interface DemonSkill {
    /** The skill's name */
    name: string;
    /** The level that the skill is learned, or 0 if innate */
    level: number;
}
/** A demon's stats */
export interface DemonStats {
    /** The demon's strength stat */
    st: number;
    /** The demon's vitality/endurance stat */
    vi: number;
    /** The demon's magic stat */
    ma: number;
    /** The demon's agility stat */
    ag: number;
    /** The demon's luck stat */
    lu: number;
}
/** Criteria for EndureSkill instances taking effect */
export type EndureCriteria = LightDark | 'Light/Dark';
/** Criteria for EvasionSkill instances taking effect */
export type EvasionBoostCriteria = 'Surrounded' | 'Rain/Snow';
/** The HP or MP stats */
export type HPMP = 'HP' | 'MP';
/** The cost stat that a MasterSkill instance decreases */
export type MasterStat = HPMP | 'HPMP';
/** The stat that a RegenSkill instance regenerates */
export type RegenStat = MasterStat | 'AIL';
/**
 * The stat that a RegenSkill instance regenerates
 *
 * @deprecated Use RegenStat instead.
 */
export type HPMPAil = RegenStat;
/** The stat that a PostBattleSkill instance increases */
export type PostBattleStat = MasterStat | 'EXP' | 'Money';
/** Demons' moral alignments */
export type MoralAlignment = 'Light' | 'Neutral' | 'Dark' | 'Unknown';
/** Demons' ethical alignments */
export type EthicalAlignment = 'Law' | 'Neutral' | 'Chaos' | 'Unknown';
/** A demon's moral and ethical alignment */
export interface DemonAlignment {
    /** The demon's moral alignment (Light v. Dark) */
    moral: MoralAlignment;
    /** The demon's ethical alignment (Law v. Chaos) */
    ethical: EthicalAlignment;
}
/** A static number or a percent */
export type NumberOrPercent = number | `${number}%`;
/** Affinities exclusive to the Persona series */
export type PersonaAffinity = 'Gun' | 'Wind' | 'Psy' | 'Nuke';
/** Affinities exclusive to the mainline Shin Megami Tensei series */
export type SMTAffinity = 'Force';
/** Affinities used by demons and skills */
export type AnyAffinity = 'Phys' | 'Fire' | 'Ice' | 'Elec' | 'Light' | 'Dark' | 'Almighty' | 'Recovery' | 'Ailment' | 'Support' | 'Passive' | 'Misc' | SMTAffinity | PersonaAffinity;
/** Affinities used by damage-dealing skills */
export type DamagingAffinity = Exclude<AnyAffinity, 'Recovery' | 'Ailment' | 'Support' | 'Passive' | 'Misc'>;
/** A damaging affinity or all damaging affinities */
export type OneOrAllDamagingAffinities = DamagingAffinity | 'All';
/** Affinities that can be a demon's inherit affinity */
export type InheritAffinity = Exclude<AnyAffinity, 'Gun' | 'Passive' | 'Misc' | SMTAffinity>;
/** The Light and Dark affinities */
export type LightDark = 'Light' | 'Dark';
/** Affinities used by BoostSkill instances */
export type BoostAffinity = OneOrAllDamagingAffinities | 'Magic' | 'Recovery';
/** Affinities used by BreakSkill instances */
export type BreakAffinity = Exclude<DamagingAffinity, SMTAffinity | 'Almighty'>;
/** Affinities used by DefensiveSkill instances */
export type DefensiveAffinity = Exclude<DamagingAffinity, 'Almighty'> | 'Light/Dark';
/** Affinities used by EvasionSkill instances */
export type EvasionAffinity = OneOrAllDamagingAffinities | 'Crit/Magic' | 'Magic';
/** Affinities used by SetSkill instances */
export type SetAffinity = LightDark | 'Almighty';
/** Affinities used by SMTCounterSkill instances */
export type SMTCounterAffinity = 'Phys' | 'Elec' | 'Dark' | 'Almighty';
/** Affinities used by WallSkill instances */
export type WallAffinity = Exclude<DamagingAffinity, SMTAffinity | 'Phys' | 'Gun' | LightDark | 'Almighty'>;
/** Mainline Persona games */
export type PersonaGame = 'p3' | 'p4' | 'p5';
/** Mainline Shin Megami Tensei games */
export type SMTGame = 'smt5';
/** Games that demon data can originate from */
export type AnyGame = PersonaGame | SMTGame;
/** Custom races for demons that originate in Persona games */
export type PersonaRace = 'Persona' | 'Picaro' | 'Treasure';
/** Demons' official races */
export type SMTRace = 'Amatsu' | 'Avatar' | 'Avian' | 'Beast' | 'Brute' | 'Deity' | 'Devil' | 'Divine' | 'Dragon' | 'Drake' | 'Element' | 'Fairy' | 'Fallen' | 'Femme' | 'Fiend' | 'Foul' | 'Fury' | 'Genma' | 'Godly' | 'Haunt' | 'Herald' | 'Holy' | 'Jaki' | 'Jirae' | 'King' | 'Kishin' | 'Kunitsu' | 'Lady' | 'Matter' | 'Megami' | 'Meta' | 'Mitama' | 'Nahobino' | 'Night' | 'Nymph' | 'Panagia' | 'Raptor' | 'Snake' | 'Tenma' | 'Tyrant' | 'Vile' | 'Wargod' | 'Wilder' | 'Wood' | 'Yoma';
/** Demons' races */
export type AnyRace = PersonaRace | SMTRace;
/** The displayed amount that RecoverySkill instances can recover  */
export type RecoveryAmount = 'Slight' | 'Moderate' | 'Half' | 'Full' | '130%';
/** Flags for RecoverySkill instances */
export type RecoveryFlag = 'Negate' | 'Revert Debuffs' | 'Revive' | 'Summon';
/** Criteria for RegenSkill instances taking effect */
export type RegenCriteria = 'Ambush' | 'Baton Pass' | 'Turn Start';
/** Game series that skill data can originate from */
export type Series = 'persona' | 'smt';
/** Criteria for SiphonSkill instances taking effect */
export type SiphonCriteria = 'Ailment' | 'Weakness/Critical' | 'Drain';
/** The effectiveness of a demon's skills based on the skills' affinities */
export type SkillPotential = Record<Exclude<AnyAffinity, PersonaAffinity | 'Passive' | 'Misc'>, number>;
/** Skill instances' types */
export type SkillType = 'AILBOOST' | 'AILDEFENSIVE' | 'AILMENT' | 'ATTACK' | 'AUTOBUFF' | 'BARRIER' | 'BARRIERBREAK' | 'BOOST' | 'BREAK' | 'CHARGE' | 'CRIT' | 'CRITBOOST' | 'DEFENSIVE' | 'ENDURE' | 'EVASION' | 'INSTAKILLBOOST' | 'MASTER' | 'MISC' | 'NAVI' | 'PERSONACOUNTER' | 'POSTBATTLE' | 'RECOVERY' | 'REGEN' | 'SET' | 'SIPHON' | 'SMTCOUNTER' | 'SPRING' | 'SUMMON' | 'SUPPORT' | 'SUSCEPTIBILITY' | 'TAUNT' | 'WALL';
/** Stages for a Persona and its evolutions */
export type Stage = 1 | 2 | 3;
/** Effects automatically applied by having a SupportSkill instance */
export type SupportAutoEffect = Barrier | Buff | Charge;
/** Flags for SupportSkill instances */
export type SupportFlag = 'Cure Non-Special Ailments' | 'Maximize Buff' | 'Minimize Debuffs' | 'Surrounded Only';