VisibilityNotifier2D

Inherits: Node2D < CanvasItem < Node < Object

Inherited By: VisibilityEnabler2D

Category: Core

Brief Description

Detects when the node is visible on screen.

Member Functions

bool is_on_screen ( ) const

Signals

  • screen_entered ( )

Emitted when the VisibilityNotifier2D enters the screen.

  • screen_exited ( )

Emitted when the VisibilityNotifier2D exits the screen.

  • viewport_entered ( Object viewport )

Emitted when the VisibilityNotifier2D enters a Viewport‘s view.

  • viewport_exited ( Object viewport )

Emitted when the VisibilityNotifier2D exits a Viewport‘s view.

Member Variables

  • Rect2 rect - The VisibilityNotifier2D’s bounding rectangle.

Description

The VisibilityNotifier2D detects when it is visible on the screen. It also notifies when its bounding rectangle enters or exits the screen or a viewport.

Member Function Description

  • bool is_on_screen ( ) const

If true the bounding rectangle is on the screen.