VisibilityNotifier

Refreshing Cache...

Inherits: Spatial < Node < Object

Inherited By: VisibilityEnabler

Detects when the node is visible on screen.

Description

The VisibilityNotifier detects when it is visible on the screen. It also notifies when its bounding rectangle enters or exits the screen or a Camera’s view.

Properties

AABBAABBAABB( -1, -1, -1, 2, 2, 2 )

Methods

boolis_on_screen ( ) const

Signals

  • camera_entered ( Camera camera )

Emitted when the VisibilityNotifier enters a Camera’s view.


  • camera_exited ( Camera camera )

Emitted when the VisibilityNotifier exits a Camera’s view.


  • screen_entered ( )

Emitted when the VisibilityNotifier enters the screen.


  • screen_exited ( )

Emitted when the VisibilityNotifier exits the screen.

Property Descriptions

DefaultAABB( -1, -1, -1, 2, 2, 2 )
Setterset_aabb(value)
Getterget_aabb()

The VisibilityNotifier’s bounding box.

Method Descriptions

  • bool is_on_screen ( ) const

If true, the bounding box 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.

doradoro's advice! Getters and Setters will be deprecated! Avoid their use!

Disclaimer: This page has been automaticaly and directly extracted from the official Godot Docs website, the 2020-03-07 at 01:43:10. It's the English Stable version because it's what most Godot users should use. The Copyright owners are Juan Linietsky, Ariel Manzur and the Godot community. CC-BY 3.0. Thanks for your patience and generosity.