Skip to main content

B1LoanProductTableRow

  • Structure that defines a loan product table row.
    * Contains loan type, terms, interest rate, and all message/action IDs for each loan lifecycle event.
PropertyTypeDescriptionMetadata
TypeEB1LoanTypeThe type of loan this row defines (e.g., Mortgage, Usury).Category: B1LoanProductTableRow
NameTextIdFStringText ID for the display name of this loan product.Category: B1LoanProductTableRow
DescTextIdFStringText ID for the description of this loan product.Category: B1LoanProductTableRow
RepaymentIntervalint32Repayment interval in game days between required payments.Category: B1LoanProductTableRow
RatefloatInterest rate applied to this loan product.Category: B1LoanProductTableRow
MaturityDayint32Loan maturity period in game days from the loan start date.Category: B1LoanProductTableRow
ProvideMessageIdFNameMessage ID sent when the loan is approved and disbursed.Category: B1LoanProductTableRow
RepaymentMessageIdFNameMessage ID sent as a repayment reminder.Category: B1LoanProductTableRow
OverdueMessageIdFNameMessage ID sent when a payment is overdue.Category: B1LoanProductTableRow
CompleteMessageIdFNameMessage ID sent when the loan is fully repaid.Category: B1LoanProductTableRow
FixedAmountRepayMessageIdFNameMessage ID sent when a fixed-amount repayment is completed.Category: B1LoanProductTableRow
PaySuccessMessageIdFNameMessage ID sent when an interest payment succeeds.Category: B1LoanProductTableRow
PayFailMessageIdFNameMessage ID sent when a payment fails.Category: B1LoanProductTableRow
InheritSuccessMessageIdFNameMessage ID sent when loan inheritance succeeds.Category: B1LoanProductTableRow
InheritFailMessageIdFNameMessage ID sent when loan inheritance fails.Category: B1LoanProductTableRow
ForcedCollectionMessageIdsTArrayList of message IDs sent during forced collection (debt collection visits).Category: B1LoanProductTableRow
ForcedCollectionSiteActionIdFNameSite action ID executed during forced collection.Category: B1LoanProductTableRow
ForcedCollectionScriptIdFNameScript ID executed during forced collection.Category: B1LoanProductTableRow
RepossessionReleasedSiteActionIdFNameSite action ID executed when a repossession is released.Category: B1LoanProductTableRow
RepossessionMessageIdFNameMessage ID sent during forced auction (repossession).Category: B1LoanProductTableRow
RepossessionSiteActionIdFNameSite action ID executed during forced auction.Category: B1LoanProductTableRow
RepossessionScriptIdFNameScript ID executed during forced auction.Category: B1LoanProductTableRow
TransactionTypeFB1LoanTransactionTypeTransaction type mapping for loan entries in the household ledger.Category: B1LoanProductTableRow
IdFNameUnique IdCategory: B1TableRowBase
CommentFStringDev CommentCategory: B1TableRowBase