godot-docs/classes/class_visibilitynotifier.rst

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the VisibilityNotifier.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_VisibilityNotifier:

VisibilityNotifier
==================

**Inherits:** :ref:`Spatial<class_Spatial>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`

**Inherited By:** :ref:`VisibilityEnabler<class_VisibilityEnabler>`

**Category:** Core

Brief Description
-----------------

Detects when the node is visible on screen.

Properties
----------

+-------------------------+-----------------------------------------------------+
| :ref:`AABB<class_AABB>` | :ref:`aabb<class_VisibilityNotifier_property_aabb>` |
+-------------------------+-----------------------------------------------------+

Methods
-------

+-------------------------+-------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_on_screen<class_VisibilityNotifier_method_is_on_screen>` **(** **)** const |
+-------------------------+-------------------------------------------------------------------------------------+

Signals
-------

.. _class_VisibilityNotifier_signal_camera_entered:

- **camera_entered** **(** :ref:`Camera<class_Camera>` camera **)**

Emitted when the VisibilityNotifier enters a :ref:`Camera<class_Camera>`'s view.

.. _class_VisibilityNotifier_signal_camera_exited:

- **camera_exited** **(** :ref:`Camera<class_Camera>` camera **)**

Emitted when the VisibilityNotifier exits a :ref:`Camera<class_Camera>`'s view.

.. _class_VisibilityNotifier_signal_screen_entered:

- **screen_entered** **(** **)**

Emitted when the VisibilityNotifier enters the screen.

.. _class_VisibilityNotifier_signal_screen_exited:

- **screen_exited** **(** **)**

Emitted when the VisibilityNotifier exits the screen.

Description
-----------

The VisibilityNotifier detects when it is visible on the screen. It also notifies when its bounding rectangle enters or exits the screen or a :ref:`Camera<class_Camera>`'s view.

Property Descriptions
---------------------

.. _class_VisibilityNotifier_property_aabb:

- :ref:`AABB<class_AABB>` **aabb**

+----------+-----------------+
| *Setter* | set_aabb(value) |
+----------+-----------------+
| *Getter* | get_aabb()      |
+----------+-----------------+

The VisibilityNotifier's bounding box.

Method Descriptions
-------------------

.. _class_VisibilityNotifier_method_is_on_screen:

- :ref:`bool<class_bool>` **is_on_screen** **(** **)** const

If ``true``, the bounding box 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.