Merge pull request #11329 from cbscribe/kcc_visibilitynotifier2d_doc
[DOCS] update VisibilityNotifier(2D) class ref
This commit is contained in:
commit
b31123c670
2 changed files with 10 additions and 8 deletions
|
@ -1,10 +1,10 @@
|
||||||
<?xml version="1.0" encoding="UTF-8" ?>
|
<?xml version="1.0" encoding="UTF-8" ?>
|
||||||
<class name="VisibilityNotifier" inherits="Spatial" category="Core" version="3.0.alpha.custom_build">
|
<class name="VisibilityNotifier" inherits="Spatial" category="Core" version="3.0.alpha.custom_build">
|
||||||
<brief_description>
|
<brief_description>
|
||||||
Detect when the node is visible on screen.
|
Detects when the node is visible on screen.
|
||||||
</brief_description>
|
</brief_description>
|
||||||
<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.
|
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>
|
</description>
|
||||||
<tutorials>
|
<tutorials>
|
||||||
</tutorials>
|
</tutorials>
|
||||||
|
@ -15,14 +15,14 @@
|
||||||
<return type="Rect3">
|
<return type="Rect3">
|
||||||
</return>
|
</return>
|
||||||
<description>
|
<description>
|
||||||
Return the visibility bounding box of the VisibilityNotifier.
|
Returns the bounding box of the VisibilityNotifier.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="is_on_screen" qualifiers="const">
|
<method name="is_on_screen" qualifiers="const">
|
||||||
<return type="bool">
|
<return type="bool">
|
||||||
</return>
|
</return>
|
||||||
<description>
|
<description>
|
||||||
Return true if any part of the bounding box is on the screen.
|
If [code]true[/code] the bounding box is on the screen.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="set_aabb">
|
<method name="set_aabb">
|
||||||
|
@ -37,6 +37,7 @@
|
||||||
</methods>
|
</methods>
|
||||||
<members>
|
<members>
|
||||||
<member name="aabb" type="Rect3" setter="set_aabb" getter="get_aabb">
|
<member name="aabb" type="Rect3" setter="set_aabb" getter="get_aabb">
|
||||||
|
The VisibilityNotifier's bounding box.
|
||||||
</member>
|
</member>
|
||||||
</members>
|
</members>
|
||||||
<signals>
|
<signals>
|
||||||
|
|
|
@ -1,10 +1,10 @@
|
||||||
<?xml version="1.0" encoding="UTF-8" ?>
|
<?xml version="1.0" encoding="UTF-8" ?>
|
||||||
<class name="VisibilityNotifier2D" inherits="Node2D" category="Core" version="3.0.alpha.custom_build">
|
<class name="VisibilityNotifier2D" inherits="Node2D" category="Core" version="3.0.alpha.custom_build">
|
||||||
<brief_description>
|
<brief_description>
|
||||||
Detect when the node is visible on screen.
|
Detects when the node is visible on screen.
|
||||||
</brief_description>
|
</brief_description>
|
||||||
<description>
|
<description>
|
||||||
The VisibilityNotifier2D is used to notify when its bounding rectangle enters the screen, is visible on the screen, or when it exits the 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.
|
||||||
</description>
|
</description>
|
||||||
<tutorials>
|
<tutorials>
|
||||||
</tutorials>
|
</tutorials>
|
||||||
|
@ -15,14 +15,14 @@
|
||||||
<return type="Rect2">
|
<return type="Rect2">
|
||||||
</return>
|
</return>
|
||||||
<description>
|
<description>
|
||||||
Return the visibility bounding rectangle of the VisibilityNotifier2D.
|
Returns the bounding rectangle of the VisibilityNotifier2D.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="is_on_screen" qualifiers="const">
|
<method name="is_on_screen" qualifiers="const">
|
||||||
<return type="bool">
|
<return type="bool">
|
||||||
</return>
|
</return>
|
||||||
<description>
|
<description>
|
||||||
Return true if any part of the bounding rectangle is on the screen.
|
If [code]true[/code] the bounding rectangle is on the screen.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="set_rect">
|
<method name="set_rect">
|
||||||
|
@ -37,6 +37,7 @@
|
||||||
</methods>
|
</methods>
|
||||||
<members>
|
<members>
|
||||||
<member name="rect" type="Rect2" setter="set_rect" getter="get_rect">
|
<member name="rect" type="Rect2" setter="set_rect" getter="get_rect">
|
||||||
|
The VisibilityNotifier2D's bounding rectangle.
|
||||||
</member>
|
</member>
|
||||||
</members>
|
</members>
|
||||||
<signals>
|
<signals>
|
||||||
|
|
Loading…
Reference in a new issue