Xivgear Types Documentation
    Preparing search index...

    Base class for a CycleProcessor based simulation. You should extend this class, and provide your own generic types.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    buffManager: BuffSettingsManager

    Manages party buff settings

    cycleSettings: CycleSettings

    Manages generic cycle settings

    displayName: string = mnkSpec.displayName

    The user-facing display name of the sim. This needs to be writable, as users can change the display name of sims.

    job:
        | "NIN"
        | "PLD"
        | "WAR"
        | "DRK"
        | "GNB"
        | "WHM"
        | "SCH"
        | "AST"
        | "SGE"
        | "MNK"
        | "DRG"
        | "SAM"
        | "RPR"
        | "VPR"
        | "BRD"
        | "MCH"
        | "DNC"
        | "BLM"
        | "SMN"
        | "RDM"
        | "PCT"
        | "BLU"
    manuallyActivatedBuffs: {
        cooldown: 120;
        duration: 20;
        effects: { dmgIncrease: 0.05 };
        job: "MNK";
        name: "Brotherhood";
        saveKey: "Brotherhood";
        selfOnly: false;
        startTime: 7.5;
        statusId: 1185;
    }[] = ...

    Party buffs which would be activated automatically, but should be treated as manual due to being associated with the class being simulated.

    manualRun: false

    If true, do not automatically re-run the sim. Currently, this is only implemented for the configuration - changing settings will not cause the sim to auto-re-run. Eventually, it may also be implemented for changes to gear sets.

    resultSettings: ResultSettings

    Represents result settings, such as what std deviation to use as the main result

    settings: MnkSettings

    The internalized settings of the object.

    shortName: string = 'mnk-sim'

    A short name for the sim, used for internal naming. Should be usable as a CSS class name or other HTML-ish applications, i.e. start with a letter, then keep to alphanumeric and hyphen.

    A good choice is to simply use the spec's stub name.

    The original sim spec.

    Accessors

    • get useAutosByDefault(): boolean

      Whether or not autoattacks should be enabled by default for ths sim.

      The default implementation returns false for healers and casters, true for everyone else.

      Returns boolean

    Methods

    • Protected

      If you are using a custom CycleProcessorType, you MUST override this method and have it return an instance of your custom type. It is only implemented on the base class for the convenience of simulations that are using the default CycleProcessor implementation.

      Parameters

      Returns MNKCycleProcessor

      The CycleProcessor instance.

    • It is rotationally important for monk abilities to be recorded with all of their buffs, and simulateSimple doesn't store those for other sims as an optimization. We don't get that optimization. This is because chakra gain is important to our DPS, and at the time of writing this is only recorded based on the Buffs that are snapshotted in addAbilityUse.

      Parameters

      Returns Promise<number>