From 3a2cdf7d5bf1058194e15b77161126652a4daa37 Mon Sep 17 00:00:00 2001 From: Hugo Locurcio Date: Fri, 17 Apr 2020 22:04:19 +0200 Subject: [PATCH] Improve the VisibilityEnabler and VisibilityNotifier documentations This closes #4803. (cherry picked from commit 7f2d60210672fb046b8c2bfffa9f6c55af0393ac) --- doc/classes/VisibilityEnabler.xml | 5 +++-- doc/classes/VisibilityEnabler2D.xml | 5 +++-- doc/classes/VisibilityNotifier.xml | 3 ++- doc/classes/VisibilityNotifier2D.xml | 3 ++- 4 files changed, 10 insertions(+), 6 deletions(-) diff --git a/doc/classes/VisibilityEnabler.xml b/doc/classes/VisibilityEnabler.xml index a8a3d6244ff..763e3c49785 100644 --- a/doc/classes/VisibilityEnabler.xml +++ b/doc/classes/VisibilityEnabler.xml @@ -1,11 +1,12 @@ - Enables certain nodes only when visible. + Enables certain nodes only when approximately visible. The VisibilityEnabler will disable [RigidBody] and [AnimationPlayer] nodes when they are not visible. It will only affect other nodes within the same scene as the VisibilityEnabler itself. - Note that VisibilityEnabler will not affect nodes added after scene initialization. + [b]Note:[/b] VisibilityEnabler 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 [Area] node as a child of a [Camera] node. + [b]Note:[/b] VisibilityEnabler will not affect nodes added after scene initialization. diff --git a/doc/classes/VisibilityEnabler2D.xml b/doc/classes/VisibilityEnabler2D.xml index 860597d8b07..ca342300e05 100644 --- a/doc/classes/VisibilityEnabler2D.xml +++ b/doc/classes/VisibilityEnabler2D.xml @@ -1,11 +1,12 @@ - Enables certain nodes only when visible. + Enables certain nodes only when approximately visible. 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. diff --git a/doc/classes/VisibilityNotifier.xml b/doc/classes/VisibilityNotifier.xml index 9a2a6a986cb..67d650db8b5 100644 --- a/doc/classes/VisibilityNotifier.xml +++ b/doc/classes/VisibilityNotifier.xml @@ -1,10 +1,11 @@ - Detects when the node is visible on screen. + Detects approximately when the node is visible on screen. The VisibilityNotifier detects when it is visible on the screen. It also notifies when its bounding rectangle enters or exits the screen or a [Camera]'s view. + [b]Note:[/b] VisibilityNotifier 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 [Area] node as a child of a [Camera] node. diff --git a/doc/classes/VisibilityNotifier2D.xml b/doc/classes/VisibilityNotifier2D.xml index bbff3bb460c..09d3e62acf6 100644 --- a/doc/classes/VisibilityNotifier2D.xml +++ b/doc/classes/VisibilityNotifier2D.xml @@ -1,10 +1,11 @@ - Detects when the node is visible on screen. + Detects approximately when the node is visible on screen. 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.