Merge pull request #37971 from Calinou/doc-improve-visibility-enabler-notifier

Improve the VisibilityEnabler and VisibilityNotifier documentations

4 files changed, 10 insertions, 6 deletions

diff --git a/doc/classes/VisibilityEnabler2D.xml b/doc/classes/VisibilityEnabler2D.xml
index 0bdecafbfa..f0e4c999ac 100644
--- a/doc/classes/VisibilityEnabler2D.xml
+++ b/doc/classes/VisibilityEnabler2D.xml
@@ -1,11 +1,12 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <class name="VisibilityEnabler2D" inherits="VisibilityNotifier2D" version="4.0">
 	<brief_description>
-		Enables certain nodes only when visible.
+		Enables certain nodes only when approximately visible.
 	</brief_description>
 	<description>
 		The VisibilityEnabler2D will disable [RigidBody2D], [AnimationPlayer], and other nodes when they are not visible. It will only affect nodes with the same root node as the VisibilityEnabler2D, and the root node itself.
-		Note that VisibilityEnabler2D will not affect nodes added after scene initialization.
+		[b]Note:[/b] VisibilityEnabler2D uses an approximate heuristic for performance reasons. If you need exact visibility checking, use another method such as adding an [Area2D] node as a child of a [Camera2D] node.
+		[b]Note:[/b] VisibilityEnabler2D will not affect nodes added after scene initialization.
 	</description>
 	<tutorials>
 	</tutorials>
diff --git a/doc/classes/VisibilityEnabler3D.xml b/doc/classes/VisibilityEnabler3D.xml
index 9c25c6c7c8..342a37e7a4 100644
--- a/doc/classes/VisibilityEnabler3D.xml
+++ b/doc/classes/VisibilityEnabler3D.xml
@@ -1,11 +1,12 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <class name="VisibilityEnabler3D" inherits="VisibilityNotifier3D" version="4.0">
 	<brief_description>
-		Enables certain nodes only when visible.
+		Enables certain nodes only when approximately visible.
 	</brief_description>
 	<description>
 		The VisibilityEnabler3D will disable [RigidBody3D] and [AnimationPlayer] nodes when they are not visible. It will only affect other nodes within the same scene as the VisibilityEnabler3D itself.
-		Note that VisibilityEnabler3D will not affect nodes added after scene initialization.
+		[b]Note:[/b] VisibilityEnabler3D uses an approximate heuristic for performance reasons. It doesn't take walls and other occlusion into account. If you need exact visibility checking, use another method such as adding an [Area3D] node as a child of a [Camera3D] node.
+		[b]Note:[/b] VisibilityEnabler3D will not affect nodes added after scene initialization.
 	</description>
 	<tutorials>
 	</tutorials>
diff --git a/doc/classes/VisibilityNotifier2D.xml b/doc/classes/VisibilityNotifier2D.xml
index f2a4a59d77..813f74f404 100644
--- a/doc/classes/VisibilityNotifier2D.xml
+++ b/doc/classes/VisibilityNotifier2D.xml
@@ -1,10 +1,11 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <class name="VisibilityNotifier2D" inherits="Node2D" version="4.0">
 	<brief_description>
-		Detects when the node is visible on screen.
+		Detects approximately when the node is visible on screen.
 	</brief_description>
 	<description>
 		The VisibilityNotifier2D detects when it is visible on the screen. It also notifies when its bounding rectangle enters or exits the screen or a viewport.
+		[b]Note:[/b] VisibilityNotifier2D uses an approximate heuristic for performance reasons. If you need exact visibility checking, use another method such as adding an [Area2D] node as a child of a [Camera2D] node.
 	</description>
 	<tutorials>
 	</tutorials>
diff --git a/doc/classes/VisibilityNotifier3D.xml b/doc/classes/VisibilityNotifier3D.xml
index d8a605c69c..eb7bb91f26 100644
--- a/doc/classes/VisibilityNotifier3D.xml
+++ b/doc/classes/VisibilityNotifier3D.xml
@@ -1,10 +1,11 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <class name="VisibilityNotifier3D" inherits="Node3D" version="4.0">
 	<brief_description>
-		Detects when the node is visible on screen.
+		Detects approximately when the node is visible on screen.
 	</brief_description>
 	<description>
 		The VisibilityNotifier3D detects when it is visible on the screen. It also notifies when its bounding rectangle enters or exits the screen or a [Camera3D]'s view.
+		[b]Note:[/b] VisibilityNotifier3D uses an approximate heuristic for performance reasons. It doesn't take walls and other occlusion into account. If you need exact visibility checking, use another method such as adding an [Area3D] node as a child of a [Camera3D] node.
 	</description>
 	<tutorials>
 	</tutorials>