Xivgear Types Documentation
    Preparing search index...

    Type Alias MathFormulaSet<AllArgType>

    Represents a set of related formulae, e.g. crit => crit chance, crit damage

    type MathFormulaSet<AllArgType extends object> = {
        functions: MathFormula<AllArgType, Func>[];
        makeDefaultInputs: (generalSettings: GeneralSettings) => AllArgType;
        name: string;
        primaryVariable: PropertyOfType<AllArgType, number> | "level" | "job";
        stub: string;
        variables: (Variable<AllArgType> & { type: "number" })[];
    }

    Type Parameters

    • AllArgType extends object
    Index

    Properties

    functions: MathFormula<AllArgType, Func>[]
    makeDefaultInputs: (generalSettings: GeneralSettings) => AllArgType
    name: string
    primaryVariable: PropertyOfType<AllArgType, number> | "level" | "job"

    The "primary" variable. If the user enters 100 for this, then the table should show values between 100-x and 100+x for this.

    stub: string
    variables: (Variable<AllArgType> & { type: "number" })[]