Browse Source

Merge pull request #11329 from cbscribe/kcc_visibilitynotifier2d_doc

[DOCS] update VisibilityNotifier(2D) class ref
Poommetee Ketson 8 years ago
parent
commit
b31123c670
2 changed files with 10 additions and 8 deletions
  1. 5 4
      doc/classes/VisibilityNotifier.xml
  2. 5 4
      doc/classes/VisibilityNotifier2D.xml

+ 5 - 4
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>

+ 5 - 4
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>