Class Requirement

Index

Constructors

Accessors

maximizeOptions maximizeParameters

Methods

maximize merge maximize merge

Constructors

constructor

new Requirement(maximizeParameters, maximizeOptions): Requirement
A convenient way of combining maximization parameters and options
Parameters
- maximizeParameters: string[]
  Parameters you're attempting to maximize
- maximizeOptions: Partial<MaximizeOptions>
  Object potentially containing forceEquips, bonusEquips, preventEquips, and preventSlots
Returns Requirement
- Defined in src/maximize.ts:652

Accessors

maximizeOptions

get maximizeOptions(): Partial<MaximizeOptions>
Returns Partial<MaximizeOptions>
- Defined in src/maximize.ts:664

maximizeParameters

get maximizeParameters(): string[]
Returns string[]
- Defined in src/maximize.ts:660

Methods

maximize

maximize(): boolean
Runs maximizeCached, using the maximizeParameters and maximizeOptions contained by this requirement.

Returns boolean
Whether the maximize call succeeded.
- Defined in src/maximize.ts:729

merge

merge(other): Requirement
Merges two requirements, concanating relevant arrays. Typically used in static form.
Parameters
- other: Requirement
  Requirement to merge with.
Returns Requirement
A new merged Requirement
- Defined in src/maximize.ts:673

`Static`maximize

maximize(...requirements): void
Merges requirements, and then runs maximizeCached on the combined requirement.
Parameters
- Rest...requirements: Requirement[]
  Requirements to maximize on
Returns void
- Defined in src/maximize.ts:738

`Static`merge

merge(allRequirements): Requirement
Merges a set of requirements together, starting with an empty requirement.
Parameters
- allRequirements: Requirement[]
  Requirements to merge
Returns Requirement
Merged requirements
- Defined in src/maximize.ts:717