VisibilityNotifier2D¶
Inherits: Node2D < CanvasItem < Node < Object
Inherited By: VisibilityEnabler2D
Category: Core
Brief Description¶
Detects when the node is visible on screen.
Methods¶
| bool | is_on_screen ( ) const |
Signals¶
- screen_entered ( )
Emitted when the VisibilityNotifier2D enters the screen.
- screen_exited ( )
Emitted when the VisibilityNotifier2D exits the screen.
- viewport_entered ( Viewport viewport )
Emitted when the VisibilityNotifier2D enters a Viewport’s view.
- viewport_exited ( Viewport viewport )
Emitted when the VisibilityNotifier2D exits a Viewport’s view.
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.
Property Descriptions¶
- Rect2 rect
| Setter | set_rect(value) |
| Getter | get_rect() |
The VisibilityNotifier2D’s bounding rectangle.
Method Descriptions¶
- bool is_on_screen ( ) const
If true, the bounding rectangle is on the screen.
Note: It takes one frame for the node’s visibility to be assessed once added to the scene tree, so this method will return false right after it is instantiated, even if it will be on screen in the draw pass.