| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647 |
- .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the VisibilityEnabler.xml source instead.
- .. The source is found in doc/classes or modules/<name>/doc_classes.
- .. _class_VisibilityEnabler:
- VisibilityEnabler
- =================
- **Inherits:** :ref:`VisibilityNotifier<class_visibilitynotifier>` **<** :ref:`Spatial<class_spatial>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
- **Category:** Core
- Brief Description
- -----------------
- Enable certain nodes only when visible.
- Member Variables
- ----------------
- .. _class_VisibilityEnabler_freeze_bodies:
- - :ref:`bool<class_bool>` **freeze_bodies**
- .. _class_VisibilityEnabler_pause_animations:
- - :ref:`bool<class_bool>` **pause_animations**
- Enums
- -----
- .. _enum_VisibilityEnabler_Enabler:
- enum **Enabler**
- - **ENABLER_PAUSE_ANIMATIONS** = **0** --- This enabler will pause :ref:`AnimationPlayer<class_animationplayer>` nodes.
- - **ENABLER_FREEZE_BODIES** = **1** --- This enabler will freeze :ref:`RigidBody<class_rigidbody>` nodes.
- - **ENABLER_MAX** = **2**
- Description
- -----------
- The VisibilityEnabler will disable :ref:`RigidBody<class_rigidbody>` and :ref:`AnimationPlayer<class_animationplayer>` nodes when they are not visible. It will only affect other nodes within the same scene as the VisibilityEnabler itself.
|
