VisibilityEnabler

Inherits: VisibilityNotifier < Spatial < Node < Object

Category: Core

Brief Description

Enables certain nodes only when visible.

Properties

bool freeze_bodies true
bool pause_animations true

Methods

bool is_enabler_enabled ( Enabler enabler ) const
void set_enabler ( Enabler enabler, bool enabled )

Enumerations

enum Enabler:

  • ENABLER_PAUSE_ANIMATIONS = 0 — This enabler will pause AnimationPlayer nodes.
  • ENABLER_FREEZE_BODIES = 1 — This enabler will freeze RigidBody nodes.
  • ENABLER_MAX = 2 — Represents the size of the Enabler enum.

Description

The VisibilityEnabler will disable RigidBody and AnimationPlayer nodes when they are not visible. It will only affect other nodes within the same scene as the VisibilityEnabler itself.

Property Descriptions

  • bool freeze_bodies
Default true
Setter set_enabler(value)
Getter is_enabler_enabled()

If true, RigidBody nodes will be paused.

  • bool pause_animations
Default true
Setter set_enabler(value)
Getter is_enabler_enabled()

If true, AnimationPlayer nodes will be paused.

Method Descriptions