Skip to content

Profectus / game/modifiers / ModifierSectionOptions

Interface: ModifierSectionOptions ​

An object that configures a modifier section via createModifierSection.

Properties ​

base? ​

optional base: DecimalSource

The base value that'll be passed into the modifier. Defaults to 1.

Defined in ​

profectus/src/game/modifiers.tsx:303


baseText? ​

optional baseText: MaybeGetter<Renderable>

The label to use for the base value. Defaults to "Base".

Defined in ​

profectus/src/game/modifiers.tsx:307


modifier ​

modifier: WithRequired<Modifier, "description">

The modifier to render.

Defined in ​

profectus/src/game/modifiers.tsx:301


smallerIsBetter? ​

optional smallerIsBetter: boolean

Determines if numbers larger or smaller than the base should be displayed as red.

Defined in ​

profectus/src/game/modifiers.tsx:309


subtitle? ​

optional subtitle: string

Smaller text that appears in the header after the title.

Defined in ​

profectus/src/game/modifiers.tsx:299


title ​

title: string

The header for the section.

Defined in ​

profectus/src/game/modifiers.tsx:297


unit? ​

optional unit: string

The unit of the value being modified, if any.

Defined in ​

profectus/src/game/modifiers.tsx:305