diff options
| author | Chris Bradfield <chris@kidscancode.org> | 2017-09-16 09:09:13 -0700 |
|---|---|---|
| committer | Chris Bradfield <chris@kidscancode.org> | 2017-09-16 17:13:33 -0700 |
| commit | b5838bc4de6176b07293e9a5200f11607b93b420 (patch) | |
| tree | 2a6ca3ce7d5171f3b94b6e63de5ff76918ffedf5 | |
| parent | 82f9836a1c178700aa3a7470eda4c40c28310841 (diff) | |
[DOCS] update VisibilityNotifier2D class ref.
| -rw-r--r-- | doc/classes/VisibilityNotifier.xml | 9 | ||||
| -rw-r--r-- | doc/classes/VisibilityNotifier2D.xml | 9 |
2 files changed, 10 insertions, 8 deletions
diff --git a/doc/classes/VisibilityNotifier.xml b/doc/classes/VisibilityNotifier.xml index 4d76c7c927..816523fc27 100644 --- a/doc/classes/VisibilityNotifier.xml +++ b/doc/classes/VisibilityNotifier.xml @@ -1,10 +1,10 @@ <?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. + Detects 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. + 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> @@ -15,14 +15,14 @@ <return type="Rect3"> </return> <description> - Return the visibility bounding box of the VisibilityNotifier. + Returns the 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. + If [code]true[/code] the bounding box is on the screen. </description> </method> <method name="set_aabb"> @@ -37,6 +37,7 @@ </methods> <members> <member name="aabb" type="Rect3" setter="set_aabb" getter="get_aabb"> + The VisibilityNotifier's bounding box. </member> </members> <signals> diff --git a/doc/classes/VisibilityNotifier2D.xml b/doc/classes/VisibilityNotifier2D.xml index 1058e3d6d4..86227a0277 100644 --- a/doc/classes/VisibilityNotifier2D.xml +++ b/doc/classes/VisibilityNotifier2D.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="VisibilityNotifier2D" inherits="Node2D" category="Core" version="3.0.alpha.custom_build"> <brief_description> - Detect when the node is visible on screen. + Detects when the node is visible on screen. </brief_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> <tutorials> </tutorials> @@ -15,14 +15,14 @@ <return type="Rect2"> </return> <description> - Return the visibility bounding rectangle of the VisibilityNotifier2D. + Returns the bounding rectangle of the VisibilityNotifier2D. </description> </method> <method name="is_on_screen" qualifiers="const"> <return type="bool"> </return> <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> </method> <method name="set_rect"> @@ -37,6 +37,7 @@ </methods> <members> <member name="rect" type="Rect2" setter="set_rect" getter="get_rect"> + The VisibilityNotifier2D's bounding rectangle. </member> </members> <signals> |