Table of Contents

Class VisibleOnScreenEnabler2D

A rectangular region of 2D space that, when visible on screen, enables a target node.

Inheritance
VisibleOnScreenEnabler2D

Remarks

VisibleOnScreenEnabler2D contains a rectangular region of 2D space and a target node. The target node will be automatically enabled (via its process_mode property) when any part of this region becomes visible on the screen, and automatically disabled otherwise. This can for example be used to activate enemies only when the player approaches them.

See VisibleOnScreenNotifier2D if you only want to be notified when the region is visible on screen.

Note: VisibleOnScreenEnabler2D uses the render culling code to determine whether it's visible on screen, so it won't function unless visible is set to true.

Properties

enable_mode

Determines how the target node is enabled. Corresponds to ProcessMode. When the node is disabled, it always uses Node.PROCESS_MODE_DISABLED.

var enable_mode : int = 0

Property Value

int

Remarks

  • void set_enable_mode(int value)
  • int get_enable_mode

enable_node_path

The path to the target node, relative to the VisibleOnScreenEnabler2D. The target node is cached; it's only assigned when setting this property (if the VisibleOnScreenEnabler2D is inside the scene tree) and every time the VisibleOnScreenEnabler2D enters the scene tree. If the path is empty, no node will be affected. If the path is invalid, an error is also generated.

var enable_node_path : NodePath = NodePath("..")

Property Value

NodePath

Remarks