Improve the VisibilityNotifier and VisibilityEnabler class descriptions

This commit is contained in:
Hugo Locurcio
2020-07-18 00:29:03 +02:00
parent 9e34ba4855
commit ce57cc43dd
4 changed files with 8 additions and 4 deletions
+2 -1
View File
@@ -5,7 +5,8 @@
</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.
[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.
If you just want to receive notifications, use [VisibilityNotifier3D] instead.
[b]Note:[/b] VisibilityEnabler3D uses an approximate heuristic for performance reasons. It doesn't take walls and other occlusion into account. The heuristic is an implementation detail and may change in future versions. If you need precise visibility checking, use another method such as adding an [Area3D] node as a child of a [Camera3D] node and/or [method Vector3.dot].
[b]Note:[/b] VisibilityEnabler3D will not affect nodes added after scene initialization.
</description>
<tutorials>