2017-09-12 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
2019-07-05 11:32:53 +02:00
<class name= "VisibilityNotifier2D" inherits= "Node2D" category= "Core" version= "3.1.2" >
2017-09-12 22:42:36 +02:00
<brief_description >
2017-09-16 18:09:13 +02:00
Detects when the node is visible on screen.
2017-09-12 22:42:36 +02:00
</brief_description>
<description >
2017-09-16 18:09:13 +02:00
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.
2017-09-12 22:42:36 +02:00
</description>
<tutorials >
</tutorials>
<methods >
<method name= "is_on_screen" qualifiers= "const" >
<return type= "bool" >
</return>
<description >
2018-12-20 13:46:54 +01:00
If [code]true[/code], the bounding rectangle is on the screen.
2019-04-15 17:10:33 +02:00
Note: It takes one frame for the node's visibility to be assessed once added to the scene tree, so this method will return [code]false[/code] right after it is instantiated, even if it will be on screen in the draw pass.
2017-09-12 22:42:36 +02:00
</description>
</method>
</methods>
<members >
2017-09-13 08:49:40 +02:00
<member name= "rect" type= "Rect2" setter= "set_rect" getter= "get_rect" >
2017-09-16 18:09:13 +02:00
The VisibilityNotifier2D's bounding rectangle.
2017-09-12 22:42:36 +02:00
</member>
</members>
<signals >
<signal name= "screen_entered" >
<description >
Emitted when the VisibilityNotifier2D enters the screen.
</description>
</signal>
<signal name= "screen_exited" >
<description >
Emitted when the VisibilityNotifier2D exits the screen.
</description>
</signal>
<signal name= "viewport_entered" >
2018-08-31 21:12:35 +02:00
<argument index= "0" name= "viewport" type= "Viewport" >
2017-09-12 22:42:36 +02:00
</argument>
<description >
Emitted when the VisibilityNotifier2D enters a [Viewport]'s view.
</description>
</signal>
<signal name= "viewport_exited" >
2018-08-31 21:12:35 +02:00
<argument index= "0" name= "viewport" type= "Viewport" >
2017-09-12 22:42:36 +02:00
</argument>
<description >
Emitted when the VisibilityNotifier2D exits a [Viewport]'s view.
</description>
</signal>
</signals>
<constants >
</constants>
</class>