Skip to content
On this page

Interface: ModifierSectionOptions

game/modifiers.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:305


baseText

Optional baseText: CoercableComponent

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

Defined in

profectus/src/game/modifiers.tsx:309


modifier

modifier: WithRequired<Modifier, "description">

The modifier to render.

Defined in

profectus/src/game/modifiers.tsx:303


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:311


subtitle

Optional subtitle: string

Smaller text that appears in the header after the title.

Defined in

profectus/src/game/modifiers.tsx:301


title

title: string

The header for the section.

Defined in

profectus/src/game/modifiers.tsx:299


unit

Optional unit: string

The unit of the value being modified, if any.

Defined in

profectus/src/game/modifiers.tsx:307