====== INFORMATION_LAYER_BUILDING ======

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

Parent class:  [[:api:asset|ASSET]]\\
Inherited by:
  * [[:api:information_layer_building_beautification|INFORMATION_LAYER_BUILDING_BEAUTIFICATION]]
  * [[:api:information_layer_building_splendor|INFORMATION_LAYER_BUILDING_SPLENDOR]]
  * [[:api:information_layer_building_undesirability|INFORMATION_LAYER_BUILDING_UNDESIRABILITY]]



[[:assets:information_layer_building| List of INFORMATION_LAYER_BUILDING assets]]

===== Properties =====

----

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

  * **Type**: ''[[:data-types#float|float]]''
  * **Expected**: ''float value''
  * **Default value**: ''0.5f''

----

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

  * **Type**: ''[[:data-types#float|float]]''
  * **Expected**: ''float value''
  * **Default value**: ''5.0f''

----

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

  * **Type**: ''[[:data-types#float|float]]''
  * **Expected**: ''float value''
  * **Default value**: ''10.0f''

----

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

Value added to all base value before any processing.
  * **Type**: ''[[:data-types#float|float]]''
  * **Expected**: ''float value''
  * **Default value**: ''0.0f''

----

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

Value multiplied to all base value before any processing.
  * **Type**: ''[[:data-types#float|float]]''
  * **Expected**: ''float value''
  * **Default value**: ''1.0f''

----

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

Power applied to the total boost value of each category.
  * **Type**: ''[[:data-types#float|float]]''
  * **Expected**: ''float value''
  * **Default value**: ''0.5f''

----

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

 Multiplier for the total boost value.
  * **Type**: ''[[:data-types#float|float]]''
  * **Expected**: ''float value''
  * **Default value**: ''1.0f''

----

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

Used to compute final radius. Formula: FinalMultiplier * pow(TotalBoostedValue, FinalPower).
  * **Type**: ''[[:data-types#float|float]]''
  * **Expected**: ''float value''
  * **Default value**: ''1.0f''

----

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

Used to compute final radius. Formula: FinalMultiplier * pow(TotalBoostedValue, FinalPower).
  * **Type**: ''[[:data-types#float|float]]''
  * **Expected**: ''float value''
  * **Default value**: ''1.0f''

----

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

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

----

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

Color to draw the layer
  * **Type**: ''[[:api:color|color]]''
  * **Expected**: ''color value''
  * **Default value**: ''COL_PINK''

----

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

Color to draw the preview layer
  * **Type**: ''[[:api:color|color]]''
  * **Expected**: ''color value''
  * **Default value**: ''COL_PURPLE''

----

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

Generate the 'Signed Distance Field' texture of the layer. This will be needed if the layer is displayed as a visibility layer.
  * **Type**: ''[[:data-types#boolean|boolean]]''
  * **Expected**: ''boolean value''
  * **Default value**: ''false''

===== Functions =====

----

==== internalGetValue ====

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

''[[:data-types#float|float]] **internalGetValue**(//building//, //considerPreviewParts//)''

^ Name ^ Type ^ Description ^
| //''building''// | ''[[:api:comp_building|COMP_BUILDING]]'' |  |
| //''considerPreviewParts''// | ''[[:data-types#boolean|boolean]]'' |  |

----

==== internalGetValueAndCategory ====

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

''[[:data-types#float|float]] **internalGetValueAndCategory**(//buildingPart//, //considerPreviewParts//, //outRootValue//, //outCategoryId//)''

^ Name ^ Type ^ Description ^
| //''buildingPart''// | ''[[:api:comp_building_part|COMP_BUILDING_PART]]'' |  |
| //''considerPreviewParts''// | ''[[:data-types#boolean|boolean]]'' |  |
| //''outRootValue''// | ''[[:data-types#float|float]]'' | //[[:annotations#out_argument|Out argument]]// |
| //''outCategoryId''// | ''[[:data-types#integer_and_unsigned_integer|integer_and_unsigned_integer]]'' | //[[:annotations#out_argument|Out argument]]// |