VisibleOnScreenNotifier2D

Inherits: Node2D < CanvasItem < Node < Object

Inherited By: VisibleOnScreenEnabler2D

Detects when the node extents are visible on screen.

Description

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

If you want nodes to be disabled automatically when they exit the screen, use VisibleOnScreenEnabler2D instead.

Properties

Rect2

rect

Rect2(-10, -10, 20, 20)

Methods

bool

is_on_screen ( ) const

Signals

  • screen_entered ( )

Emitted when the VisibleOnScreenNotifier2D enters the screen.


  • screen_exited ( )

Emitted when the VisibleOnScreenNotifier2D exits the screen.

Property Descriptions

Default

Rect2(-10, -10, 20, 20)

Setter

set_rect(value)

Getter

get_rect()

The VisibleOnScreenNotifier2D's bounding rectangle.

Method Descriptions

  • bool is_on_screen ( ) const

If true, the bounding rectangle is on the screen.

Note: It takes one frame for the node's visibility to be assessed once added to the scene tree, so this method will return false right after it is instantiated, even if it will be on screen in the draw pass.