Skip to content

Commit

Permalink
Fix incorrect reference to VisibleOnScreenEnabler2D/3D in *Notifier2D…
Browse files Browse the repository at this point in the history
…/3D docs
  • Loading branch information
AlexAlappsis authored and akien-mga committed Aug 12, 2024
1 parent 88f3b5f commit 3c2259f
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion doc/classes/VisibleOnScreenNotifier2D.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
A rectangular region of 2D space that detects whether it is visible on screen.
</brief_description>
<description>
[VisibleOnScreenEnabler2D] represents a rectangular region of 2D space. When any part of this region becomes visible on screen or in a viewport, it will emit a [signal screen_entered] signal, and likewise it will emit a [signal screen_exited] signal when no part of it remains visible.
[VisibleOnScreenNotifier2D] represents a rectangular region of 2D space. When any part of this region becomes visible on screen or in a viewport, it will emit a [signal screen_entered] signal, and likewise it will emit a [signal screen_exited] signal when no part of it remains visible.
If you want a node to be enabled automatically when this region is visible on screen, use [VisibleOnScreenEnabler2D].
[b]Note:[/b] [VisibleOnScreenNotifier2D] uses the render culling code to determine whether it's visible on screen, so it won't function unless [member CanvasItem.visible] is set to [code]true[/code].
</description>
Expand Down
2 changes: 1 addition & 1 deletion doc/classes/VisibleOnScreenNotifier3D.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
A box-shaped region of 3D space that detects whether it is visible on screen.
</brief_description>
<description>
[VisibleOnScreenEnabler3D] represents a box-shaped region of 3D space. When any part of this region becomes visible on screen or in a [Camera3D]'s view, it will emit a [signal screen_entered] signal, and likewise it will emit a [signal screen_exited] signal when no part of it remains visible.
[VisibleOnScreenNotifier3D] represents a box-shaped region of 3D space. When any part of this region becomes visible on screen or in a [Camera3D]'s view, it will emit a [signal screen_entered] signal, and likewise it will emit a [signal screen_exited] signal when no part of it remains visible.
If you want a node to be enabled automatically when this region is visible on screen, use [VisibleOnScreenEnabler3D].
[b]Note:[/b] [VisibleOnScreenNotifier3D] uses an approximate heuristic that doesn't take walls and other occlusion into account, unless occlusion culling is used. It also won't function unless [member Node3D.visible] is set to [code]true[/code].
</description>
Expand Down

0 comments on commit 3c2259f

Please sign in to comment.