Xivgear Types Documentation
    Preparing search index...

    Type Alias MathFormula<AllArgType, FuncType>

    Represents a single, simple formula, e.g. crit stat to crit chance

    type MathFormula<AllArgType, FuncType extends Func> = {
        excludeFormula?: boolean;
        fn: FuncType;
        hideableColumn?: boolean;
        name: string;
        argExtractor(
            arg: AllArgType,
            gen: GeneralSettings,
        ): Promise<Parameters<FuncType>>;
    }

    Type Parameters

    • AllArgType
    • FuncType extends Func
    Index

    Properties

    excludeFormula? fn hideableColumn? name

    Methods

    argExtractor

    Properties

    excludeFormula?: boolean
    fn: FuncType
    hideableColumn?: boolean

    If true, the output column for this formula can be hidden by the user via the UI. If omitted or false, the column is always shown (unless excludeFormula is true).

    name: string

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods