api:taxation_function
Table of Contents
TAXATION_FUNCTION
Properties
MinimalTimeBetweenVisits
Texture
NameKey
TaxedNameKey
DescriptionKey
CategoryKey
IsActiveByDefault
IsVisitBuilding
If true
, will visit building. If false
, will visit buildable (part or building). If fails, will visit owner of taxable component.
- Type:
boolean
- Expected:
boolean value
- Default value:
false
IsOtherTax
- Type:
boolean
- Expected:
boolean value
- Default value:
true
Functions
init
finalize
void finalize(instTaxationFunction)
Function called when taxation function is removed. You can cleanup components added during init (except TaxCollectables, those will be managed by the system).
Name | Type | Description |
---|---|---|
instTaxationFunction | INST_TAXATION_FUNCTION |
collect
INST_TAXATION_COLLECT_INFO collect(compTaxCollectable)
Function called every frame to compute how much to cumulate.
Name | Type | Description |
---|---|---|
compTaxCollectable | COMP_TAX_COLLECTABLE |
getMaximumAmountToCollect
integer_and_unsigned_integer getMaximumAmountToCollect(compTaxCollectable)
Name | Type | Description |
---|---|---|
compTaxCollectable | COMP_TAX_COLLECTABLE |
getMinimalTimeBetweenVisits
getTaxedCount
integer_and_unsigned_integer getTaxedCount(instTaxationFunction)
Name | Type | Description |
---|---|---|
instTaxationFunction | INST_TAXATION_FUNCTION |
registerAmountAvailableToCollect
void registerAmountAvailableToCollect(compTaxCollectable)
Name | Type | Description |
---|---|---|
compTaxCollectable | COMP_TAX_COLLECTABLE |
api/taxation_function.txt · Last modified: 2025/04/30 14:22 by 127.0.0.1