Weir dam multiplier (Water Overlay): Difference between revisions

From Tygron Preview Support Wiki
Jump to navigation Jump to search
(Created page with "{{Overlay attributes|<onlyinclude> {{Overlay attributes|type=row|overlay=Water |attribute=WEIR_DAM_MULTIPLIER |unit=integer |description=The width with which the weir's dam s...")
 
No edit summary
 
(One intermediate revision by the same user not shown)
Line 2: Line 2:
{{Overlay attributes|type=row|overlay=Water  
{{Overlay attributes|type=row|overlay=Water  
|attribute=WEIR_DAM_MULTIPLIER
|attribute=WEIR_DAM_MULTIPLIER
|unit=integer
|unit=factor
|description=The width with which the weir's dam should be generated perpendicular to it's direction, relative to its flow width.
|description=The width with which the weir's dam should be generated perpendicular to it's direction, relative to its flow width.
|icon=
|icon=weir_dam.png
|defaultvalue=3
|defaultvalue=3
}}</onlyinclude>}}
}}</onlyinclude>}}

Latest revision as of 07:56, 17 October 2022

When a weir's dam is generated, the width of the generated dam is based on the width of its WEIR_WIDTH attribute. However, the actual dam's width may be greater than the width of the aperture the water may actually flow through. The width of the generated dam is thus computed as the WEIR_WIDTH attribute, multiplied by the WEIR_DAM_MULTIPLIER. E.g. a weir with a width set to 5, for a Water Overlay with a weir dam multiplier set to 3, will have a generated dam with a width of 15.

Notes

  • The minimum width for a generated dam is 10m. If the generated dam would be smaller than 10m, the generated dam is 10m wide.
  • The generated dam may be smaller if a shoreline is reached before the calculated width is reached.

See also