virtualx-engine/doc/classes/VisibilityNotifier2D.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisibilityNotifier2D" inherits="Node2D" category="Core" version="3.0-stable">
	<brief_description>
		Detects when the node is visible on screen.
	</brief_description>
	<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.
	</description>
	<tutorials>
	</tutorials>
	<demos>
	</demos>
	<methods>
		<method name="is_on_screen" qualifiers="const">
			<return type="bool">
			</return>
			<description>
				If [code]true[/code] the bounding rectangle is on the screen.
			</description>
		</method>
	</methods>
	<members>
		<member name="rect" type="Rect2" setter="set_rect" getter="get_rect">
			The VisibilityNotifier2D's bounding rectangle.
		</member>
	</members>
	<signals>
		<signal name="screen_entered">
			<description>
				Emitted when the VisibilityNotifier2D enters the screen.
			</description>
		</signal>
		<signal name="screen_exited">
			<description>
				Emitted when the VisibilityNotifier2D exits the screen.
			</description>
		</signal>
		<signal name="viewport_entered">
			<argument index="0" name="viewport" type="Object">
			</argument>
			<description>
				Emitted when the VisibilityNotifier2D enters a [Viewport]'s view.
			</description>
		</signal>
		<signal name="viewport_exited">
			<argument index="0" name="viewport" type="Object">
			</argument>
			<description>
				Emitted when the VisibilityNotifier2D exits a [Viewport]'s view.
			</description>
		</signal>
	</signals>
	<constants>
	</constants>
</class>