====== TAXATION_FUNCTION ======

//Abstract class//\\
**Category**: Asset

Parent class:  [[:api:asset|ASSET]]\\
Inherited by:
  * [[:api:taxation_function_bracket|TAXATION_FUNCTION_BRACKET]]
  * [[:api:taxation_function_housing|TAXATION_FUNCTION_HOUSING]]



[[:assets:taxation_function| List of TAXATION_FUNCTION assets]]

===== Properties =====

----

==== MinimalTimeBetweenVisits ====
//[[:annotations#serialized|Serialized]]//

  * **Type**: ''[[:api:time_system|TIME_SYSTEM]]''
  * **Expected**: ''TIME_SYSTEM value''

----

==== Texture ====
//[[:annotations#serialized|Serialized]]//

  * **Type**: ''[[:api:texture|TEXTURE]]''
  * **Expected**: ''asset ID''
  * **Default value**: ''nil''

----

==== NameKey ====
//[[:annotations#serialized|Serialized]]//

  * **Type**: ''[[:data-types#string|string]]''
  * **Expected**: ''string value''

----

==== TaxedNameKey ====
//[[:annotations#serialized|Serialized]]//

  * **Type**: ''[[:data-types#string|string]]''
  * **Expected**: ''string value''

----

==== DescriptionKey ====
//[[:annotations#serialized|Serialized]]//

  * **Type**: ''[[:data-types#string|string]]''
  * **Expected**: ''string value''

----

==== CategoryKey ====
//[[:annotations#serialized|Serialized]]//

  * **Type**: ''[[:data-types#string|string]]''
  * **Expected**: ''string value''

----

==== IsActiveByDefault ====
//[[:annotations#serialized|Serialized]]//

  * **Type**: ''[[:data-types#boolean|boolean]]''
  * **Expected**: ''boolean value''
  * **Default value**: ''false''

----

==== IsVisitBuilding ====
//[[:annotations#serialized|Serialized]]//

If ''true'', will visit building. If ''false'', will visit buildable (part or building). If fails, will visit owner of taxable component.
  * **Type**: ''[[:data-types#boolean|boolean]]''
  * **Expected**: ''boolean value''
  * **Default value**: ''false''

----

==== IsOtherTax ====
//[[:annotations#serialized|Serialized]]//

  * **Type**: ''[[:data-types#boolean|boolean]]''
  * **Expected**: ''boolean value''
  * **Default value**: ''true''

===== Functions =====

----

==== init ====

//[[:custom-classes#Extendable classes|Virtual function]]//

''void **init**(//instTaxationFunction//)''

^ Name ^ Type ^ Description ^
| //''instTaxationFunction''// | ''[[:api:inst_taxation_function|INST_TAXATION_FUNCTION]]'' |  |

----

==== finalize ====

//[[:custom-classes#Extendable classes|Virtual function]]//

''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''// | ''[[:api:inst_taxation_function|INST_TAXATION_FUNCTION]]'' |  |

----

==== collect ====

//[[:custom-classes#Extendable classes|Virtual function]]//

''[[:api:inst_taxation_collect_info|INST_TAXATION_COLLECT_INFO]] **collect**(//compTaxCollectable//)''

Function called every frame to compute how much to cumulate.

^ Name ^ Type ^ Description ^
| //''compTaxCollectable''// | ''[[:api:comp_tax_collectable|COMP_TAX_COLLECTABLE]]'' |  |

----

==== getMaximumAmountToCollect ====

//[[:custom-classes#Extendable classes|Virtual function]]//

''[[:data-types#integer_and_unsigned_integer|integer_and_unsigned_integer]] **getMaximumAmountToCollect**(//compTaxCollectable//)''

^ Name ^ Type ^ Description ^
| //''compTaxCollectable''// | ''[[:api:comp_tax_collectable|COMP_TAX_COLLECTABLE]]'' |  |

----

==== getMinimalTimeBetweenVisits ====

//[[:custom-classes#Extendable classes|Virtual function]]//

''[[:data-types#float|float]] **getMinimalTimeBetweenVisits**()''


----

==== getTaxedCount ====

//[[:custom-classes#Extendable classes|Virtual function]]//

''[[:data-types#integer_and_unsigned_integer|integer_and_unsigned_integer]] **getTaxedCount**(//instTaxationFunction//)''

^ Name ^ Type ^ Description ^
| //''instTaxationFunction''// | ''[[:api:inst_taxation_function|INST_TAXATION_FUNCTION]]'' |  |

----

==== registerAmountAvailableToCollect ====

//[[:custom-classes#Extendable classes|Virtual function]]//

''void **registerAmountAvailableToCollect**(//compTaxCollectable//)''

^ Name ^ Type ^ Description ^
| //''compTaxCollectable''// | ''[[:api:comp_tax_collectable|COMP_TAX_COLLECTABLE]]'' |  |