VisibleOnScreenEnabler3D

Inherits: VisibleOnScreenNotifier3D < VisualInstance3D < Node3D < Node < Object

Enables certain nodes only when approximately visible.

Description

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

If you just want to receive notifications, use VisibleOnScreenNotifier3D instead.

Note: VisibleOnScreenEnabler3D uses an approximate heuristic for performance reasons. It doesn't take walls and other occlusion into account. The heuristic is an implementation detail and may change in future versions. If you need precise visibility checking, use another method such as adding an Area3D node as a child of a Camera3D node and/or Vector3.dot.

Note: VisibleOnScreenEnabler3D will not affect nodes added after scene initialization.

Properties

EnableMode

enable_mode

0

NodePath

enable_node_path

NodePath("..")

Enumerations

enum EnableMode:

  • ENABLE_MODE_INHERIT = 0

  • ENABLE_MODE_ALWAYS = 1

  • ENABLE_MODE_WHEN_PAUSED = 2

Property Descriptions

Default

0

Setter

set_enable_mode(value)

Getter

get_enable_mode()


Default

NodePath("..")

Setter

set_enable_node_path(value)

Getter

get_enable_node_path()