godot/doc/classes/VisibilityNotifier.xml

56 lines
1.5 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisibilityNotifier" inherits="Spatial" category="Core" version="3.0-rc1">
<brief_description>
Detects when the node is visible on screen.
</brief_description>
<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.
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
<method name="is_on_screen" qualifiers="const">
<return type="bool">
</return>
<description>
If [code]true[/code] the bounding box is on the screen.
</description>
</method>
</methods>
<members>
<member name="aabb" type="AABB" setter="set_aabb" getter="get_aabb">
The VisibilityNotifier's bounding box.
</member>
</members>
<signals>
<signal name="camera_entered">
<argument index="0" name="camera" type="Object">
</argument>
<description>
Emitted when the VisibilityNotifier enters a [Camera]'s view.
</description>
</signal>
<signal name="camera_exited">
<argument index="0" name="camera" type="Object">
</argument>
<description>
Emitted when the VisibilityNotifier exits a [Camera]'s view.
</description>
</signal>
<signal name="screen_entered">
<description>
Emitted when the VisibilityNotifier enters the screen.
</description>
</signal>
<signal name="screen_exited">
<description>
Emitted when the VisibilityNotifier exits the screen.
</description>
</signal>
</signals>
<constants>
</constants>
</class>