Key (Sight Distance Overlay): Difference between revisions

Latest revision as of 15:42, 11 November 2026

Icon	Key	Unit	Range	Description	Default value
	KEY	m	-3.4028235E38 to 3.4028235E38	Key used to retrieve the maximum distance from an Item a line-of-sight is allowed to extend.	DISTANCE_ZONE_M

If the distance is 0, the Item is excluded from line-of-sight calculations.
Negative values are not allowed. If a negative distance value is used, it is considered 0.
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.

@@ Line 1: / Line 1: @@
 {{Overlay keys|<onlyinclude>
-{{Overlay keys|type=row|group=Water Overlay
+{{Overlay keys|type=row|overlay=Sight Distance
-|key=DISTANCE_ZONE_M
+|key=KEY
-|unit={m
+|unit=m
-|description=The maximum distance from an [[Item]] a line-of-sight is allowed to extend.
+|range=-{{Floatmaxvalue}} to {{Floatmaxvalue}}
-|defaultvalue=0
+|description=Key used to retrieve the maximum distance from an [[Item]] a line-of-sight is allowed to extend.
-|icon=
+|defaultvalue=DISTANCE_ZONE_M
+|icon=distancewizard_icon_distance_zone_m.png
 }}</onlyinclude>}}
 {{article end
 |notes=
-* If the distance is set to 0, the [[Item]] is not considered an object from which lines of sight are computed.
+* If the distance is 0, the [[Item]] is excluded from line-of-sight calculations.
+* Negative values are not allowed. If a negative distance value is used, it is considered 0.
+* 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'''.
 |seealso=
-* [[Distance Sight Overlay]]
+* [[Distance zone m (Function Value)]]
-* [[Distance zone (Function Value)]]
+* [[Key (Distance Overlay)]]
+* [[Attribute model (Sight Distance Overlay)]]
+|api=*[[Api session event editor overlay set key value]]
 }}
+{{SightDistanceOverlay nav}}