VisibilityNotifier2D

    Inherited By: VisibilityEnabler2D

    Detects approximately when the node is visible on screen.

    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.

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

    Note: For performance reasons, VisibilityNotifier2D uses an approximate heuristic with precision determined by . If you need precise visibility checking, use another method such as adding an Area2D node as a child of a node.

    Tutorials

    Methods

    • screen_entered ( )

    Emitted when the VisibilityNotifier2D enters the screen.

    Emitted when the VisibilityNotifier2D exits the screen.

    • viewport_entered ( viewport )

    Emitted when the VisibilityNotifier2D enters a Viewport‘s view.

    • viewport_exited ( viewport )

    Emitted when the VisibilityNotifier2D exits a Viewport‘s view.

    Property Descriptions

    The VisibilityNotifier2D’s bounding rectangle.

    • bool is_on_screen ( ) const

    If , 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 right after it is instantiated, even if it will be on screen in the draw pass.