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
No known key found for this signature in database
GPG key ID: 39E8F8BE30B0A49C
4 changed files with 8 additions and 4 deletions

View file

@ -5,7 +5,8 @@
</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] For performance reasons, VisibilityNotifier2D uses an approximate heuristic with precision determined by [member ProjectSettings.world/2d/cell_size]. If you need exact visibility checking, use another method such as adding an [Area2D] node as a child of a [Camera2D] node.
If you want nodes to be disabled automatically when they exit the screen, use [VisibilityEnabler2D] instead.
[b]Note:[/b] For performance reasons, VisibilityNotifier2D uses an approximate heuristic with precision determined by [member ProjectSettings.world/2d/cell_size]. If you need precise visibility checking, use another method such as adding an [Area2D] node as a child of a [Camera2D] node.
</description>
<tutorials>
</tutorials>