godot-docs/classes/class_visibleonscreenenabler2d.rst

:github_url: hide

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

.. _class_VisibleOnScreenEnabler2D:

VisibleOnScreenEnabler2D
========================

**Inherits:** :ref:`VisibleOnScreenNotifier2D<class_VisibleOnScreenNotifier2D>` **<** :ref:`Node2D<class_Node2D>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`



Properties
----------

+-------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------+
| :ref:`EnableMode<enum_VisibleOnScreenEnabler2D_EnableMode>` | :ref:`enable_mode<class_VisibleOnScreenEnabler2D_property_enable_mode>`           | ``0``              |
+-------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------+
| :ref:`NodePath<class_NodePath>`                             | :ref:`enable_node_path<class_VisibleOnScreenEnabler2D_property_enable_node_path>` | ``NodePath("..")`` |
+-------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------+

Enumerations
------------

.. _enum_VisibleOnScreenEnabler2D_EnableMode:

.. _class_VisibleOnScreenEnabler2D_constant_ENABLE_MODE_INHERIT:

.. _class_VisibleOnScreenEnabler2D_constant_ENABLE_MODE_ALWAYS:

.. _class_VisibleOnScreenEnabler2D_constant_ENABLE_MODE_WHEN_PAUSED:

enum **EnableMode**:

- **ENABLE_MODE_INHERIT** = **0**

- **ENABLE_MODE_ALWAYS** = **1**

- **ENABLE_MODE_WHEN_PAUSED** = **2**

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

.. _class_VisibleOnScreenEnabler2D_property_enable_mode:

- :ref:`EnableMode<enum_VisibleOnScreenEnabler2D_EnableMode>` **enable_mode**

+-----------+------------------------+
| *Default* | ``0``                  |
+-----------+------------------------+
| *Setter*  | set_enable_mode(value) |
+-----------+------------------------+
| *Getter*  | get_enable_mode()      |
+-----------+------------------------+

----

.. _class_VisibleOnScreenEnabler2D_property_enable_node_path:

- :ref:`NodePath<class_NodePath>` **enable_node_path**

+-----------+-----------------------------+
| *Default* | ``NodePath("..")``          |
+-----------+-----------------------------+
| *Setter*  | set_enable_node_path(value) |
+-----------+-----------------------------+
| *Getter*  | get_enable_node_path()      |
+-----------+-----------------------------+

.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`