Browse Source

[DOCS] Camera2D methods/constants

Will Nations 7 years ago
parent
commit
d1084df81a
1 changed files with 10 additions and 0 deletions
  1. 10 0
      doc/classes/Camera2D.xml

+ 10 - 0
doc/classes/Camera2D.xml

@@ -23,6 +23,7 @@
 			<return type="void">
 			<return type="void">
 			</return>
 			</return>
 			<description>
 			<description>
+				Removes any [code]Camera2D[/code] from the ancestor [Viewport]'s internal currently-assigned camera.
 			</description>
 			</description>
 		</method>
 		</method>
 		<method name="force_update_scroll">
 		<method name="force_update_scroll">
@@ -43,24 +44,28 @@
 			<return type="Vector2">
 			<return type="Vector2">
 			</return>
 			</return>
 			<description>
 			<description>
+				Returns the location of the [code]Camera2D[/code]'s screen-center, relative to the origin.
 			</description>
 			</description>
 		</method>
 		</method>
 		<method name="get_custom_viewport" qualifiers="const">
 		<method name="get_custom_viewport" qualifiers="const">
 			<return type="Node">
 			<return type="Node">
 			</return>
 			</return>
 			<description>
 			<description>
+				Returns the [Viewport] used by the camera if it is not using the default viewport.
 			</description>
 			</description>
 		</method>
 		</method>
 		<method name="get_h_offset" qualifiers="const">
 		<method name="get_h_offset" qualifiers="const">
 			<return type="float">
 			<return type="float">
 			</return>
 			</return>
 			<description>
 			<description>
+				Returns the horizontal offset of the camera.
 			</description>
 			</description>
 		</method>
 		</method>
 		<method name="get_v_offset" qualifiers="const">
 		<method name="get_v_offset" qualifiers="const">
 			<return type="float">
 			<return type="float">
 			</return>
 			</return>
 			<description>
 			<description>
+				Returns the vertical offset of the camera.
 			</description>
 			</description>
 		</method>
 		</method>
 		<method name="make_current">
 		<method name="make_current">
@@ -84,6 +89,7 @@
 			<argument index="0" name="viewport" type="Node">
 			<argument index="0" name="viewport" type="Node">
 			</argument>
 			</argument>
 			<description>
 			<description>
+				Assigns a custom [Viewport] node to the [code]Camera2D[/code]. If [code]viewport[/code] is not a [Viewport], it re-assigns the default viewport instead.
 			</description>
 			</description>
 		</method>
 		</method>
 		<method name="set_h_offset">
 		<method name="set_h_offset">
@@ -92,6 +98,7 @@
 			<argument index="0" name="ofs" type="float">
 			<argument index="0" name="ofs" type="float">
 			</argument>
 			</argument>
 			<description>
 			<description>
+				The camera's horizontal offset is set to [code]ofs[/code].
 			</description>
 			</description>
 		</method>
 		</method>
 		<method name="set_v_offset">
 		<method name="set_v_offset">
@@ -100,6 +107,7 @@
 			<argument index="0" name="ofs" type="float">
 			<argument index="0" name="ofs" type="float">
 			</argument>
 			</argument>
 			<description>
 			<description>
+				The camera's vertical offset is set to [code]ofs[/code].
 			</description>
 			</description>
 		</method>
 		</method>
 	</methods>
 	</methods>
@@ -170,8 +178,10 @@
 	</members>
 	</members>
 	<constants>
 	<constants>
 		<constant name="ANCHOR_MODE_FIXED_TOP_LEFT" value="0" enum="AnchorMode">
 		<constant name="ANCHOR_MODE_FIXED_TOP_LEFT" value="0" enum="AnchorMode">
+			The camera's position is fixed so that the top-left corner is always at the origin.
 		</constant>
 		</constant>
 		<constant name="ANCHOR_MODE_DRAG_CENTER" value="1" enum="AnchorMode">
 		<constant name="ANCHOR_MODE_DRAG_CENTER" value="1" enum="AnchorMode">
+			The camera's position takes into account vertical/horizontal offsets and the screen size.
 		</constant>
 		</constant>
 	</constants>
 	</constants>
 </class>
 </class>