FB2LoanManager

Overview

Manages loans.

Metadata

Field	Value
Kind	`system`
Environment	B2 - Simulation
Category	`systems`
Extends	`FB2ManagerBase`
Require	`require('Systems.B2LoanManager')`

Properties (2)

Name	Type	Description
`ExecutedLoans`	`table<FB1EntityId, FB2ExecutedLoanArray>`
`RepaidLoans`	`table<FB1EntityId, FB2ExecutedLoanArray>`

Functions (20)

Function	Parameters	Returns	Description
`ExecuteForcedSale`	InEntityId: `FB1EntityId`, InLoanProductId: `string`, InGameObjectPrice: `integer`	`boolean`
`ForcedCollection`	InEntityId: `FB1EntityId`, InExecutedLoan: `FB1ExecutedLoan`	`-`
`GetExecutedLoanByEntityId`	InEntityId: `FB1EntityId`, InLoanProductId: `string`, OutExecutedLoan: `FB1ExecutedLoan`	`boolean`	Returns Executed Loan By Entity Id.
`GetExecutedLoans`	`-`	`table<FB1EntityId, FB2ExecutedLoanArray>`	Returns Executed Loans.
`GetRemainingOverdueDebtAmount`	InEntityId: `FB1EntityId`, InLoanProductId: `string`, OutDebtAmount: `integer`	`boolean`	Returns Remaining Overdue Debt Amount.
`HasLoanType`	InEntityId: `FB1EntityId`, InLoanType: `EB1LoanType`	`boolean`	Returns whether it has Loan Type.
`InheritLoan`	InBeforeEntityid: `FB1EntityId`, InAfterEntityid: `FB1EntityId`	`-`
`IsEnableMortgage`	InEntityId: `FB1EntityId`	`boolean`	Returns whether Enable Mortgage.
`IsHouseHoldEnableMortgage`	InHouseHoldEntityId: `FB1EntityId`	`boolean`	Returns whether House Hold Enable Mortgage.
`IsRemainingOverdueDebt`	InEntityId: `FB1EntityId`, InLoanProductId: `string`	`boolean`	Returns whether Remaining Overdue Debt.
`OnDayChanged`	InPrevTime: `FDateTime`, InCurrentTime: `FDateTime`	`-`	Callback invoked on Day Changed.
`OnDeathCharacter`	InMemberId: `FB1EntityId`	`-`	Callback invoked on Death Character.
`OnHourChanged`	PrevTime: `FDateTime`, InCurrentTime: `FDateTime`	`-`	Callback invoked on Hour Changed.
`Provide`	Param: `FB2LoanQueryParameter`	`-`	Provides (issues) a loan.
`RemoveLoan`	InEntityId: `FB1EntityId`, InLoanProductId: `string`	`-`	Removes Loan.
`Repayment`	Param: `FB2RepaymentQueryParameter`	`-`	Processes loan repayment.
`Repossession`	InEntityId: `FB1EntityId`, InExecutedLoan: `FB1ExecutedLoan`	`-`
`RepossessionReleased`	InEntityId: `FB1EntityId`, InExecutedLoan: `FB1ExecutedLoan`	`-`
`SendLoanMessage`	InReceiver: `FB1EntityId`, InCustomMobileMessageId: `string`, InExecutedLoan: `FB1ExecutedLoan`, InPayAmount: `integer`	`-`	Sends Loan Message.
`UpdateLoanDataCache`	InEntityId: `FB1EntityId`	`-`	Updates Loan Data Cache.

Override points (9)

Implement these in Lua as FB2LoanManager.Override_Name = function(...) end.

Function	Parameters	Returns	Description
`Override_ExecuteForcedSale`	InEntityId: `FB1EntityId`, InLoanProductId: `string`, InGameObjectPrice: `integer`	`boolean`
`Override_HasLoanType`	InEntityId: `FB1EntityId`, InLoanType: `EB1LoanType`	`boolean`	Returns whether it has Loan Type.
`Override_InheritLoan`	InBeforeEntityid: `FB1EntityId`, InAfterEntityid: `FB1EntityId`	`-`
`Override_OnDayChanged`	InPrevTime: `FDateTime`, InCurrentTime: `FDateTime`	`-`	Callback invoked on Day Changed.
`Override_OnDeathCharacter`	InMemberId: `FB1EntityId`	`-`	Callback invoked on Death Character.
`Override_OnHourChanged`	PrevTime: `FDateTime`, InCurrentTime: `FDateTime`	`-`	Callback invoked on Hour Changed.
`Override_RemoveLoan`	InEntityId: `FB1EntityId`, InLoanProductId: `string`	`-`	Removes Loan.
`Override_SendLoanMessage`	InReceiver: `FB1EntityId`, InCustomMobileMessageId: `string`, InExecutedLoan: `FB1ExecutedLoan`, InPayAmount: `integer`	`-`	Sends Loan Message.
`Override_UpdateLoanDataCache`	InEntityId: `FB1EntityId`	`-`	Updates Loan Data Cache.