Inherits: VisibilityNotifier2D < Node2D < CanvasItem < Node < Object
Enables certain nodes only when approximately visible.
The VisibilityEnabler2D will disable RigidBody2D, AnimationPlayer, and other nodes when they are not visible. It will only affect nodes with the same root node as the VisibilityEnabler2D, and the root node itself.
If you just want to receive notifications, use VisibilityNotifier2D instead.
Note: For performance reasons, VisibilityEnabler2D uses an approximate heuristic with precision determined by ProjectSettings.world/2d/cell_size. If you need precise visibility checking, use another method such as adding an Area2D node as a child of a Camera2D node.
Note: VisibilityEnabler2D will not affect nodes added after scene initialization.
bool | freeze_bodies | true |
bool | pause_animated_sprites | true |
bool | pause_animations | true |
bool | pause_particles | true |
bool | physics_process_parent | false |
bool | process_parent | false |
bool | is_enabler_enabled ( Enabler enabler ) const |
void | set_enabler ( Enabler enabler, bool enabled ) |
enum Enabler:
Default | true |
Setter | set_enabler(value) |
Getter | is_enabler_enabled() |
If true
, RigidBody2D nodes will be paused.
Default | true |
Setter | set_enabler(value) |
Getter | is_enabler_enabled() |
If true
, AnimatedSprite nodes will be paused.
Default | true |
Setter | set_enabler(value) |
Getter | is_enabler_enabled() |
If true
, AnimationPlayer nodes will be paused.
Default | true |
Setter | set_enabler(value) |
Getter | is_enabler_enabled() |
If true
, Particles2D nodes will be paused.
Default | false |
Setter | set_enabler(value) |
Getter | is_enabler_enabled() |
If true
, the parent's Node._physics_process will be stopped.
Default | false |
Setter | set_enabler(value) |
Getter | is_enabler_enabled() |
If true
, the parent's Node._process will be stopped.
Returns whether the enabler identified by given Enabler constant is active.
Sets active state of the enabler identified by given Enabler constant.
© 2014–2020 Juan Linietsky, Ariel Manzur, Godot Engine contributors
Licensed under the MIT License.
https://docs.godotengine.org/en/3.2/classes/class_visibilityenabler2d.html