ProfectusInterface: Requirement
game/requirements.Requirement
An object that can be used to describe a requirement to perform some purchase or other action.
See
Properties
canMaximize
• Optional canMaximize: ProcessedComputable<boolean>
Whether or not this requirement can have multiple levels of requirements that can be met at once. Requirement is assumed to not have multiple levels if this property not present.
Defined in
profectus/src/game/requirements.tsx:53
display
• Optional display: (amount?: DecimalSource) => Element
Type declaration
▸ (amount?): Element
The display for this specific requirement. Required if visibility can be Visibility.Visible.
Parameters
| Name | Type |
|---|---|
amount? | DecimalSource |
Returns
Element
Defined in
profectus/src/game/requirements.tsx:37
partialDisplay
• Optional partialDisplay: (amount?: DecimalSource) => Element
Type declaration
▸ (amount?): Element
The display for this specific requirement. This is used for displays multiple requirements condensed. Required if visibility can be Visibility.Visible.
Parameters
| Name | Type |
|---|---|
amount? | DecimalSource |
Returns
Element
Defined in
profectus/src/game/requirements.tsx:33
pay
• Optional pay: (amount?: DecimalSource) => void
Type declaration
▸ (amount?): void
Perform any effects to the game state that should happen when the requirement gets triggered.
Parameters
| Name | Type | Description |
|---|---|---|
amount? | DecimalSource | The amount of levels of requirements to pay for. |
Returns
void
Defined in
profectus/src/game/requirements.tsx:58
requirementMet
• requirementMet: ProcessedComputable<boolean | DecimalSource>
Whether or not this requirement has been met.
Defined in
profectus/src/game/requirements.tsx:45
requiresPay
• requiresPay: ProcessedComputable<boolean>
Whether or not this requirement will need to affect the game state when whatever is using this requirement gets triggered.
Defined in
profectus/src/game/requirements.tsx:49
visibility
• visibility: ProcessedComputable<boolean | Visible | None>
Whether or not this requirement should be displayed in Vue Features. displayRequirements will respect this property.