Class BaseMultiCycleSim<ResultType, InternalSettingsType, CycleProcessorType, FullResultType>`Abstract`

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

Constructors

`Protected`constructor

new BaseMultiCycleSim<
    ResultType extends CycleSimResult<EmptyGauge>,
    InternalSettingsType extends SimSettings,
    CycleProcessorType extends
        CycleProcessor<GaugeManager<unknown>> = CycleProcessor<
        NoopGaugeManager,
    >,
    FullResultType extends
        CycleSimResultFull<ResultType> = CycleSimResultFull<ResultType>,
>(
    job:
        | "NIN"
        | "PLD"
        | "WAR"
        | "DRK"
        | "GNB"
        | "WHM"
        | "SCH"
        | "AST"
        | "SGE"
        | "MNK"
        | "DRG"
        | "SAM"
        | "RPR"
        | "VPR"
        | "BRD"
        | "MCH"
        | "DNC"
        | "BLM"
        | "SMN"
        | "RDM"
        | "PCT"
        | "BLU",
    settings?: ExternalCycleSettings<InternalSettingsType>,
): BaseMultiCycleSim<
    ResultType,
    InternalSettingsType,
    CycleProcessorType,
    FullResultType,
>
Type Parameters
- ResultType extends CycleSimResult<EmptyGauge>
- InternalSettingsType extends SimSettings
- CycleProcessorType extends CycleProcessor<GaugeManager<unknown>> = CycleProcessor<NoopGaugeManager>
- FullResultType extends CycleSimResultFull<ResultType> = CycleSimResultFull<ResultType>
Parameters
- job:
      | "NIN"
      | "PLD"
      | "WAR"
      | "DRK"
      | "GNB"
      | "WHM"
      | "SCH"
      | "AST"
      | "SGE"
      | "MNK"
      | "DRG"
      | "SAM"
      | "RPR"
      | "VPR"
      | "BRD"
      | "MCH"
      | "DNC"
      | "BLM"
      | "SMN"
      | "RDM"
      | "PCT"
      | "BLU"
- Optionalsettings: ExternalCycleSettings<InternalSettingsType>
Returns BaseMultiCycleSim<
    ResultType,
    InternalSettingsType,
    CycleProcessorType,
    FullResultType,
>
- Defined in sims/src/processors/sim_processors.ts:82

Properties

`Readonly`buffManager

buffManager: BuffSettingsManager

Manages party buff settings

`Readonly`cycleSettings

cycleSettings: CycleSettings

Manages generic cycle settings

`Abstract`displayName

displayName: string

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

`Readonly`job

job:
    | "NIN"
    | "PLD"
    | "WAR"
    | "DRK"
    | "GNB"
    | "WHM"
    | "SCH"
    | "AST"
    | "SGE"
    | "MNK"
    | "DRG"
    | "SAM"
    | "RPR"
    | "VPR"
    | "BRD"
    | "MCH"
    | "DNC"
    | "BLM"
    | "SMN"
    | "RDM"
    | "PCT"
    | "BLU"

`Optional` `Readonly`manuallyActivatedBuffs

manuallyActivatedBuffs?: PartyBuff[]

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

`Readonly`manualRun

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.

`Readonly`resultSettings

resultSettings: ResultSettings

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

settings

settings: InternalSettingsType

The internalized settings of the object.

`Abstract`shortName

shortName: string

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.

`Abstract`spec

spec: SimSpec<
    Simulation<
        FullResultType,
        InternalSettingsType,
        ExternalCycleSettings<InternalSettingsType>,
    >,
    ExternalCycleSettings<InternalSettingsType>,
>

The original sim spec.

Accessors

defaultCutoffMode

get defaultCutoffMode(): CutoffMode
Returns CutoffMode
- Defined in sims/src/processors/sim_processors.ts:118

useAutosByDefault

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
- Defined in sims/src/processors/sim_processors.ts:113

Methods

calcDamage

calcDamage(set: CharacterGearSet): FullResultType
Parameters
- set: CharacterGearSet
Returns FullResultType
- Defined in sims/src/processors/sim_processors.ts:201

calcDamageSimple

calcDamageSimple(set: CharacterGearSet): number
Parameters
- set: CharacterGearSet
Returns number
- Defined in sims/src/processors/sim_processors.ts:183

`Protected`computeCacheKey

computeCacheKey(set: CharacterGearSet): RotationCacheKey
Parameters
- set: CharacterGearSet
Returns RotationCacheKey
- Defined in sims/src/processors/sim_processors.ts:238

`Protected`createCycleProcessor

createCycleProcessor(settings: MultiCycleSettings): CycleProcessorType
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
- settings: MultiCycleSettings
  The settings
Returns CycleProcessorType
The CycleProcessor instance.
- Defined in sims/src/processors/sim_processors.ts:157

defaultCycleSettings

defaultCycleSettings(): CycleSettings
Return the default settings for this sim. You can override this to provide your own custom settings. It should respect useAutosByDefault

Returns CycleSettings
- Defined in sims/src/processors/sim_processors.ts:126

exportSettings

exportSettings(): ExternalCycleSettings<InternalSettingsType>
The settings, flatted into a form that is fully JSON-ifiable.

Returns ExternalCycleSettings<InternalSettingsType>
Implementation of Simulation.exportSettings
- Defined in sims/src/processors/sim_processors.ts:99

generateRotations

generateRotations(
set: CharacterGearSet,
simple?: boolean,
): [string, CycleProcessorType][]
Parameters
- set: CharacterGearSet
- simple: boolean = false
Returns [string, CycleProcessorType][]
- Defined in sims/src/processors/sim_processors.ts:162

`Abstract`getRotationsToSimulate

getRotationsToSimulate(set: CharacterGearSet): Rotation<CycleProcessorType>[]
This is the main abstract method of this simulation type. You can specify one or more rotations to simulate. The sim's result will be whichever rotation sims the highest.
Parameters
- set: CharacterGearSet
Returns Rotation<CycleProcessorType>[]
- Defined in sims/src/processors/sim_processors.ts:146

invalidateCaches

invalidateCaches(): void
Returns void
- Defined in sims/src/processors/sim_processors.ts:277

`Abstract`makeDefaultSettings

makeDefaultSettings(): InternalSettingsType
Returns InternalSettingsType
- Defined in sims/src/processors/sim_processors.ts:97

rehydrateCycleSettings

rehydrateCycleSettings(imported: Partial<CycleSettings>): CycleSettings
Parameters
- imported: Partial<CycleSettings>
Returns CycleSettings
- Defined in sims/src/processors/sim_processors.ts:136

settingsChanged

settingsChanged(): void
Notify the sim that settings have changed

Returns void
Implementation of Simulation.settingsChanged
- Defined in sims/src/processors/sim_processors.ts:273

simulate

simulate(set: CharacterGearSet): Promise<FullResultType>
Run a simulation. As mentioned in the class-level docs, all mutable state should be scoped to this method.
Parameters
- set: CharacterGearSet
Returns Promise<FullResultType>
Implementation of Simulation.simulate
- Defined in sims/src/processors/sim_processors.ts:249

simulateSimple

simulateSimple(set: CharacterGearSet): Promise<number>
Like simulate, but only needs to return a single number. This is used for meld solving and such, as the brute force sim does not need to display any additional data to the user. If the extra processing time and memory use from the normal simulation path is trivial for a particular sim implementation, then this can be implemented as simply "return (await this.simulate(set)).mainDpsResult".
Parameters
- set: CharacterGearSet
Returns Promise<number>
Implementation of Simulation.simulateSimple
- Defined in sims/src/processors/sim_processors.ts:259

Class BaseMultiCycleSim<ResultType, InternalSettingsType, CycleProcessorType, FullResultType>Abstract

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

Protectedconstructor

Type Parameters

Parameters

Returns BaseMultiCycleSim< ResultType, InternalSettingsType, CycleProcessorType, FullResultType,>

Properties

ReadonlybuffManager

ReadonlycycleSettings

AbstractdisplayName

Readonlyjob

Optional ReadonlymanuallyActivatedBuffs

ReadonlymanualRun

ReadonlyresultSettings

settings

AbstractshortName

Abstractspec

Accessors

defaultCutoffMode

Returns CutoffMode

useAutosByDefault

Returns boolean

Methods

calcDamage

Parameters

Returns FullResultType

calcDamageSimple

Parameters

Returns number

ProtectedcomputeCacheKey

Parameters

Returns RotationCacheKey

ProtectedcreateCycleProcessor

Parameters

Returns CycleProcessorType

defaultCycleSettings

Returns CycleSettings

exportSettings

Returns ExternalCycleSettings<InternalSettingsType>

generateRotations

Parameters

Returns [string, CycleProcessorType][]

AbstractgetRotationsToSimulate

Parameters

Returns Rotation<CycleProcessorType>[]

invalidateCaches

Returns void

AbstractmakeDefaultSettings

Returns InternalSettingsType

rehydrateCycleSettings

Parameters

Returns CycleSettings

settingsChanged

Returns void

simulate

Parameters

Returns Promise<FullResultType>

simulateSimple

Parameters

Returns Promise<number>

Settings

On This Page

Class BaseMultiCycleSim<ResultType, InternalSettingsType, CycleProcessorType, FullResultType>`Abstract`

`Protected`constructor

Returns BaseMultiCycleSim<
ResultType,
InternalSettingsType,
CycleProcessorType,
FullResultType,
>

`Readonly`buffManager

`Readonly`cycleSettings

`Abstract`displayName

`Readonly`job

`Optional` `Readonly`manuallyActivatedBuffs

`Readonly`manualRun

`Readonly`resultSettings

`Abstract`shortName

`Abstract`spec

`Protected`computeCacheKey

`Protected`createCycleProcessor

`Abstract`getRotationsToSimulate

`Abstract`makeDefaultSettings