godot/doc/classes/VisibilityNotifier.xml
2017-09-13 08:53:01 +02:00

71 lines
1.9 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisibilityNotifier" inherits="Spatial" category="Core" version="3.0.alpha.custom_build">
<brief_description>
Detect when the node is visible on screen.
</brief_description>
<description>
The VisibilityNotifier is used to notify when its bounding box enters the screen, is visible on the screen, or when it exits the screen.
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
<method name="get_aabb" qualifiers="const">
<return type="Rect3">
</return>
<description>
Return the visibility bounding box of the VisibilityNotifier.
</description>
</method>
<method name="is_on_screen" qualifiers="const">
<return type="bool">
</return>
<description>
Return true if any part of the bounding box is on the screen.
</description>
</method>
<method name="set_aabb">
<return type="void">
</return>
<argument index="0" name="rect" type="Rect3">
</argument>
<description>
Set the visibility bounding box of the VisibilityNotifier.
</description>
</method>
</methods>
<members>
<member name="aabb" type="Rect3" setter="set_aabb" getter="get_aabb">
</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>