Profectus / data/common / Section
Interface: Section ​
An option object for a modifier display as a single section. *
Properties ​
base? ​
optionalbase:MaybeRefOrGetter<DecimalSource>
The base value being modified. *
Defined in ​
profectus/src/data/common.tsx:241
baseText? ​
optionalbaseText:MaybeGetter<Renderable>
The label to call the base amount. Defaults to "Base". *
Defined in ​
profectus/src/data/common.tsx:245
modifier ​
modifier:
WithRequired<Modifier,"description">
The modifier to be displaying in this section. *
Defined in ​
profectus/src/data/common.tsx:239
smallerIsBetter? ​
optionalsmallerIsBetter:boolean
Determines if numbers larger or smaller than the base should be displayed as red.
Defined in ​
profectus/src/data/common.tsx:249
subtitle? ​
optionalsubtitle:MaybeRefOrGetter<string>
A subtitle for this modifier, e.g. to explain the context for the modifier. *
Defined in ​
profectus/src/data/common.tsx:237
title ​
title:
MaybeRefOrGetter<string>
The header for this modifier. *
Defined in ​
profectus/src/data/common.tsx:235
unit? ​
optionalunit:string
The unit of measurement for the base. *
Defined in ​
profectus/src/data/common.tsx:243
visible? ​
optionalvisible:MaybeRefOrGetter<boolean>
Whether or not this section should be currently visible to the player. *