FB1LoanProductTableRow

Overview

Structure that defines a loan product table row. Contains loan type, terms, interest rate, and all message/action IDs for each loan lifecycle event.

Metadata

Field	Value
Kind	`struct`
Environment	B1 - Presentation
Category	`structs`
Extends	`FB1TableRowBase`

Properties (23)

Name	Type	Description
`CompleteMessageId`	`string`	Message ID sent when the loan is fully repaid.
`DescTextId`	`string`	Text ID for the description of this loan product.
`FixedAmountRepayMessageId`	`string`	Message ID sent when a fixed-amount repayment is completed.
`ForcedCollectionMessageIds`	`string[]`	List of message IDs sent during forced collection (debt collection visits).
`ForcedCollectionScriptId`	`string`	Script ID executed during forced collection.
`ForcedCollectionSiteActionId`	`string`	Site action ID executed during forced collection.
`InheritFailMessageId`	`string`	Message ID sent when loan inheritance fails.
`InheritSuccessMessageId`	`string`	Message ID sent when loan inheritance succeeds.
`MaturityDay`	`integer`	Loan maturity period in game days from the loan start date.
`NameTextId`	`string`	Text ID for the display name of this loan product.
`OverdueMessageId`	`string`	Message ID sent when a payment is overdue.
`PayFailMessageId`	`string`	Message ID sent when a payment fails.
`PaySuccessMessageId`	`string`	Message ID sent when an interest payment succeeds.
`ProvideMessageId`	`string`	Message ID sent when the loan is approved and disbursed.
`Rate`	`number`	Interest rate applied to this loan product.
`RepaymentInterval`	`integer`	Repayment interval in game days between required payments.
`RepaymentMessageId`	`string`	Message ID sent as a repayment reminder.
`RepossessionMessageId`	`string`	Message ID sent during forced auction (repossession).
`RepossessionReleasedSiteActionId`	`string`	Site action ID executed when a repossession is released.
`RepossessionScriptId`	`string`	Script ID executed during forced auction.
`RepossessionSiteActionId`	`string`	Site action ID executed during forced auction.
`TransactionType`	`FB1LoanTransactionType`	Transaction type mapping for loan entries in the household ledger.
`Type`	`EB1LoanType`	The type of loan this row defines (e.g., Mortgage, Usury).