Key (Distance Overlay): Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
Removed redirect to Overlay Key
Tag: Removed redirect
No edit summary
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
[[File:distance_overlay_of_windmills_500m.jpg|thumb|right|[[Key (Distance Overlay)|Distance]] to windmills (500m)]]
{{Overlay keys|<onlyinclude>
{{Overlay keys|<onlyinclude>
{{Overlay keys|type=row|overlay=Distance
{{Overlay keys|type=row|overlay=Distance
Line 4: Line 5:
|unit=m
|unit=m
|range=0 to {{Floatmaxvalue}}
|range=0 to {{Floatmaxvalue}}
|description=Key used to retrieve the maximum distance from an [[Item]] a line-of-sight is allowed to extend.
|description=Key used to retrieve the maximum distance from an [[Item]] a distance zone is allowed to extend.
|defaultvalue=DISTANCE_ZONE_M
|defaultvalue=DISTANCE_ZONE_M
|icon=distancewizard_icon_distance_zone_m.png
|icon=distancewizard_icon_distance_zone_m.png
Line 11: Line 12:
{{article end
{{article end
|notes=
|notes=
* If the distance is 0 or smaller, the [[Item]] is excluded from line-of-sight calculations.
* If the distance is set to 0, the [[Item]] is not considered an object to perform a distance zone calculation for.
* When using the [[Api session event editor overlay set key value]] endpoint, this attribute can be set for a Sight Distance Overlay using the default key '''KEY'''.
* Negative values are not allowed. If a negative distance value is used, it is considered 0.
|seealso=
|seealso=
* [[Distance zone m (Function Value)]]
* [[Distance zone m (Function Value)]]
* [[Distance zone m (Distance Overlay)]]
* [[Key (Sight Distance Overlay)]]
|api=*[[Api session event editor overlay set key value]]
}}
}}
{{SightDistanceOverlay nav}}
{{DistanceOverlay nav}}

Latest revision as of 13:59, 11 November 2026

Distance to windmills (500m)

Notes

  • If the distance is set to 0, the Item is not considered an object to perform a distance zone calculation for.
  • Negative values are not allowed. If a negative distance value is used, it is considered 0.

See also