Improve the VisibilityNotifier and VisibilityEnabler class descriptions
This commit is contained in:
parent
9e34ba4855
commit
ce57cc43dd
4 changed files with 8 additions and 4 deletions
|
@ -5,7 +5,8 @@
|
|||
</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.
|
||||
[b]Note:[/b] For performance reasons, VisibilityEnabler2D 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 just want to receive notifications, use [VisibilityNotifier2D] instead.
|
||||
[b]Note:[/b] For performance reasons, VisibilityEnabler2D 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.
|
||||
[b]Note:[/b] VisibilityEnabler2D will not affect nodes added after scene initialization.
|
||||
</description>
|
||||
<tutorials>
|
||||
|
|
|
@ -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>
|
||||
|
|
|
@ -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>
|
||||
|
|
|
@ -5,7 +5,8 @@
|
|||
</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.
|
||||
If you want nodes to be disabled automatically when they exit the screen, use [VisibilityEnabler3D] instead.
|
||||
[b]Note:[/b] VisibilityNotifier3D 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].
|
||||
</description>
|
||||
<tutorials>
|
||||
</tutorials>
|
||||
|
|
Loading…
Reference in a new issue