User Tools

Site Tools


api:information_layer_building

INFORMATION_LAYER_BUILDING

Properties


ZoneSizeForPartWithNoZones

Serialized

  • Type: float
  • Expected: float value
  • Default value: 0.5f

DistanceForMaximumInfluence

Serialized

  • Type: float
  • Expected: float value
  • Default value: 5.0f

DistanceToStartInfluence

Serialized

  • Type: float
  • Expected: float value
  • Default value: 10.0f

InitialValue

Serialized

Value added to all base value before any processing.

  • Type: float
  • Expected: float value
  • Default value: 0.0f

InitialMultiplier

Serialized

Value multiplied to all base value before any processing.

  • Type: float
  • Expected: float value
  • Default value: 1.0f

BoostPowerPerCategory

Serialized

Power applied to the total boost value of each category.

  • Type: float
  • Expected: float value
  • Default value: 0.5f

BoostMultiplier

Serialized

Multiplier for the total boost value.

  • Type: float
  • Expected: float value
  • Default value: 1.0f

FinalPower

Serialized

Used to compute final radius. Formula: FinalMultiplier * pow(TotalBoostedValue, FinalPower).

  • Type: float
  • Expected: float value
  • Default value: 1.0f

FinalMultiplier

Serialized

Used to compute final radius. Formula: FinalMultiplier * pow(TotalBoostedValue, FinalPower).

  • Type: float
  • Expected: float value
  • Default value: 1.0f

DebugName

Serialized

  • Type: string
  • Expected: string value

DebugDrawColor

Serialized

Color to draw the layer

  • Type: color
  • Expected: color value
  • Default value: COL_PINK

DebugDrawColorPreview

Serialized

Color to draw the preview layer

  • Type: color
  • Expected: color value
  • Default value: COL_PURPLE

GenerateSdfTexture

Serialized

Generate the 'Signed Distance Field' texture of the layer. This will be needed if the layer is displayed as a visibility layer.

  • Type: boolean
  • Expected: boolean value
  • Default value: false

Functions


internalGetValue

Virtual function, Protected function

float internalGetValue(building, considerPreviewParts)

Name Type Description
building COMP_BUILDING
considerPreviewParts boolean

internalGetValueAndCategory

Virtual function, Protected function

float internalGetValueAndCategory(buildingPart, considerPreviewParts, outRootValue, outCategoryId)

Name Type Description
buildingPart COMP_BUILDING_PART
considerPreviewParts boolean
outRootValue float Out argument
outCategoryId integer_and_unsigned_integer Out argument
api/information_layer_building.txt · Last modified: 2024/02/06 13:53 by 127.0.0.1

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki