Skip to main content

FB2TaxComponent

Overview

Tax component.

Metadata

Field	Value
Kind	`component`
Environment	B2 - Simulation
Category	`components`
Extends	`FB2Component`
Require	`require('Components.B2TaxComponent')`

Properties (8)

Name	Type	Description
`CurrentTax`	`integer`
`OverDue`	`integer`
`PreviousDay`	`EB1DayOfWeek`
`ServiceTaxesPerDay`	`table<EB1ServiceType, integer>`
`ServiceUsages`	`table<EB1ServiceType, integer>`
`TaxChargeState`	`EB1TaxChargeState`
`bElecticityCutoff`	`boolean`
`bWaterCutoff`	`boolean`

Functions (16)

Function	Parameters	Returns	Description
`CalculateTax`	InDataAsset: `UB1TaxDataAsset`	`FB1CalculatedTax`
`ForcedPayTax`	InAmount: `integer`	`-`
`GetOverDue`	`-`	`integer`	Returns Over Due.
`GetOwnerSite`	Self: `FB2TaxComponent`	`-`	Returns Owner Site.
`GetServiceUsages`	`-`	`table<EB1ServiceType, integer>`	Returns Service Usages.
`GetTax`	`-`	`integer`	Returns Tax.
`GetTaxChargeState`	`-`	`EB1TaxChargeState`	Returns Tax Charge State.
`GetUsages`	InType: `EB1ServiceType`	`integer`	Returns Usages.
`IsElectricityCutoff`	`-`	`boolean`	Returns whether Electricity Cutoff.
`IsTaxChargeState`	InState: `EB1TaxChargeState`	`boolean`	Returns whether Tax Charge State.
`IsWaterCutoff`	`-`	`boolean`	Returns whether Water Cutoff.
`MigrateTaxChargeData`	InSimulationTax: `FB1PseudoSimulationTax`	`-`
`MonitorTaxCharge`	`-`	`-`
`PaymentCompleted`	InCharEntityId: `FB1EntityId`	`-`
`RequestTaxCharge`	`-`	`-`	Requests Tax Charge.
`SendTaxMessageForCancel`	`-`	`-`	Sends Tax Message For Cancel.

Override points (7)

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

Function	Parameters	Returns	Description
`Override_CalculateTax`	InDataAsset: `UB1TaxDataAsset`	`FB1CalculatedTax`
`Override_ForcedPayTax`	InAmount: `integer`	`-`
`Override_MigrateTaxChargeData`	InSimulationTax: `FB1PseudoSimulationTax`	`-`
`Override_MonitorTaxCharge`	`-`	`-`
`Override_PaymentCompleted`	InCharEntityId: `FB1EntityId`	`-`
`Override_RequestTaxCharge`	`-`	`-`	Requests Tax Charge.
`Override_SendTaxMessageForCancel`	`-`	`-`	Sends Tax Message For Cancel.