Key (Distance Overlay): Difference between revisions

Revision as of 13:57, 11 November 2026

Icon	Key	Unit	Range	Description	Default value
	KEY	m	0 to 2000.0	Key used to retrieve the maximum distance from an Item a distance zone is allowed to extend.	DISTANCE_ZONE_M

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.

@@ Line 1: / Line 1: @@
+[[File:distance_overlay_of_windmills_500m.jpg|thumb|right|[[Distance zone m (Distance Overlay)|Distance]] to windmills (500m)]]
 {{Overlay keys|<onlyinclude>
 {{Overlay keys|type=row|overlay=Distance
 |key=KEY
 |unit=m
-|range=0 to {{Floatmaxvalue}}
+|range=0 to {{Grid Overlay max value}}
-|description=Key used to retrieve the distance from an [[Item]].
+|description=Key used to retrieve the maximum distance from an [[Item]] a distance zone is allowed to extend.
 |defaultvalue=DISTANCE_ZONE_M
 |icon=distancewizard_icon_distance_zone_m.png
@@ Line 11: / Line 12: @@
 {{article end
 |notes=
-* If the distance is 0 or smaller, the [[Item]] is excluded from distance 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 Distance Overlay using the default key '''KEY'''.
+* Negative values are not allowed. If a negative distance value is used, it is considered 0.
 |seealso=
+* [[Attribute (Distance Overlay)]]
 * [[Distance zone m (Function Value)]]
-* [[Distance zone m (Distance Overlay)]]
+* [[Distance zone m (Sight Distance Overlay)]]
-|api=*[[Api session event editor overlay set key value]]
 }}
-{{SightDistanceOverlay nav}}
+{{DistanceOverlay nav}}