Browse Source

doc: Sync classref with current source

Rémi Verschelde 7 years ago
parent
commit
237be766d4

+ 1 - 1
doc/classes/HTTPClient.xml

@@ -203,7 +203,7 @@
 		<constant name="METHOD_GET" value="0" enum="Method">
 		<constant name="METHOD_GET" value="0" enum="Method">
 			HTTP GET method. The GET method requests a representation of the specified resource. Requests using GET should only retrieve data.
 			HTTP GET method. The GET method requests a representation of the specified resource. Requests using GET should only retrieve data.
 		</constant>
 		</constant>
-		<constant name="METHOD_HEAD" value="1" enum="Method">#
+		<constant name="METHOD_HEAD" value="1" enum="Method">
 			HTTP HEAD method. The HEAD method asks for a response identical to that of a GET request, but without the response body. This is useful to request metadata like HTTP headers or to check if a resource exists.
 			HTTP HEAD method. The HEAD method asks for a response identical to that of a GET request, but without the response body. This is useful to request metadata like HTTP headers or to check if a resource exists.
 		</constant>
 		</constant>
 		<constant name="METHOD_POST" value="2" enum="Method">
 		<constant name="METHOD_POST" value="2" enum="Method">

+ 9 - 3
doc/classes/KinematicBody.xml

@@ -102,11 +102,17 @@
 		</method>
 		</method>
 	</methods>
 	</methods>
 	<members>
 	<members>
-		<member name="axis_lock_x" type="bool" setter="set_axis_lock_x" getter="get_axis_lock_x">
+		<member name="axis_lock_angular_x" type="bool" setter="set_axis_lock" getter="get_axis_lock">
 		</member>
 		</member>
-		<member name="axis_lock_y" type="bool" setter="set_axis_lock_y" getter="get_axis_lock_y">
+		<member name="axis_lock_angular_y" type="bool" setter="set_axis_lock" getter="get_axis_lock">
 		</member>
 		</member>
-		<member name="axis_lock_z" type="bool" setter="set_axis_lock_z" getter="get_axis_lock_z">
+		<member name="axis_lock_angular_z" type="bool" setter="set_axis_lock" getter="get_axis_lock">
+		</member>
+		<member name="axis_lock_linear_x" type="bool" setter="set_axis_lock" getter="get_axis_lock">
+		</member>
+		<member name="axis_lock_linear_y" type="bool" setter="set_axis_lock" getter="get_axis_lock">
+		</member>
+		<member name="axis_lock_linear_z" type="bool" setter="set_axis_lock" getter="get_axis_lock">
 		</member>
 		</member>
 		<member name="collision/safe_margin" type="float" setter="set_safe_margin" getter="get_safe_margin">
 		<member name="collision/safe_margin" type="float" setter="set_safe_margin" getter="get_safe_margin">
 			If the body is at least this close to another body, this body will consider them to be colliding.
 			If the body is at least this close to another body, this body will consider them to be colliding.

+ 23 - 10
doc/classes/PhysicsServer.xml

@@ -351,15 +351,6 @@
 				Creates a physics body. The first parameter can be any value from constants BODY_MODE*, for the type of body created. Additionally, the body can be created in sleeping state to save processing time.
 				Creates a physics body. The first parameter can be any value from constants BODY_MODE*, for the type of body created. Additionally, the body can be created in sleeping state to save processing time.
 			</description>
 			</description>
 		</method>
 		</method>
-		<method name="body_get_axis_lock" qualifiers="const">
-			<return type="bool">
-			</return>
-			<argument index="0" name="body" type="RID">
-			</argument>
-			<description>
-				Gets the information, which Axis is locked if any. The can be any calue from the constants BODY_AXIS_LOCK*
-			</description>
-		</method>
 		<method name="body_get_collision_layer" qualifiers="const">
 		<method name="body_get_collision_layer" qualifiers="const">
 			<return type="int">
 			<return type="int">
 			</return>
 			</return>
@@ -485,6 +476,16 @@
 				Returns a body state.
 				Returns a body state.
 			</description>
 			</description>
 		</method>
 		</method>
+		<method name="body_is_axis_locked" qualifiers="const">
+			<return type="bool">
+			</return>
+			<argument index="0" name="body" type="RID">
+			</argument>
+			<argument index="1" name="axis" type="int" enum="PhysicsServer.BodyAxis">
+			</argument>
+			<description>
+			</description>
+		</method>
 		<method name="body_is_continuous_collision_detection_enabled" qualifiers="const">
 		<method name="body_is_continuous_collision_detection_enabled" qualifiers="const">
 			<return type="bool">
 			<return type="bool">
 			</return>
 			</return>
@@ -540,7 +541,7 @@
 			</return>
 			</return>
 			<argument index="0" name="body" type="RID">
 			<argument index="0" name="body" type="RID">
 			</argument>
 			</argument>
-			<argument index="1" name="axis" type="int">
+			<argument index="1" name="axis" type="int" enum="PhysicsServer.BodyAxis">
 			</argument>
 			</argument>
 			<argument index="2" name="lock" type="bool">
 			<argument index="2" name="lock" type="bool">
 			</argument>
 			</argument>
@@ -1520,5 +1521,17 @@
 		<constant name="SPACE_PARAM_CONSTRAINT_DEFAULT_BIAS" value="7" enum="SpaceParameter">
 		<constant name="SPACE_PARAM_CONSTRAINT_DEFAULT_BIAS" value="7" enum="SpaceParameter">
 			Constant to set/get the default solver bias for all physics constraints. A solver bias is a factor controlling how much two objects "rebound", after violating a constraint, to avoid leaving them in that state because of numerical imprecision.
 			Constant to set/get the default solver bias for all physics constraints. A solver bias is a factor controlling how much two objects "rebound", after violating a constraint, to avoid leaving them in that state because of numerical imprecision.
 		</constant>
 		</constant>
+		<constant name="BODY_AXIS_LINEAR_X" value="1" enum="BodyAxis">
+		</constant>
+		<constant name="BODY_AXIS_LINEAR_Y" value="2" enum="BodyAxis">
+		</constant>
+		<constant name="BODY_AXIS_LINEAR_Z" value="4" enum="BodyAxis">
+		</constant>
+		<constant name="BODY_AXIS_ANGULAR_X" value="8" enum="BodyAxis">
+		</constant>
+		<constant name="BODY_AXIS_ANGULAR_Y" value="16" enum="BodyAxis">
+		</constant>
+		<constant name="BODY_AXIS_ANGULAR_Z" value="32" enum="BodyAxis">
+		</constant>
 	</constants>
 	</constants>
 </class>
 </class>

+ 9 - 3
doc/classes/RigidBody.xml

@@ -59,11 +59,17 @@
 		<member name="angular_velocity" type="Vector3" setter="set_angular_velocity" getter="get_angular_velocity">
 		<member name="angular_velocity" type="Vector3" setter="set_angular_velocity" getter="get_angular_velocity">
 			RigidBody's rotational velocity.
 			RigidBody's rotational velocity.
 		</member>
 		</member>
-		<member name="axis_lock_x" type="bool" setter="set_axis_lock_x" getter="get_axis_lock_x">
+		<member name="axis_lock_angular_x" type="bool" setter="set_axis_lock" getter="get_axis_lock">
 		</member>
 		</member>
-		<member name="axis_lock_y" type="bool" setter="set_axis_lock_y" getter="get_axis_lock_y">
+		<member name="axis_lock_angular_y" type="bool" setter="set_axis_lock" getter="get_axis_lock">
 		</member>
 		</member>
-		<member name="axis_lock_z" type="bool" setter="set_axis_lock_z" getter="get_axis_lock_z">
+		<member name="axis_lock_angular_z" type="bool" setter="set_axis_lock" getter="get_axis_lock">
+		</member>
+		<member name="axis_lock_linear_x" type="bool" setter="set_axis_lock" getter="get_axis_lock">
+		</member>
+		<member name="axis_lock_linear_y" type="bool" setter="set_axis_lock" getter="get_axis_lock">
+		</member>
+		<member name="axis_lock_linear_z" type="bool" setter="set_axis_lock" getter="get_axis_lock">
 		</member>
 		</member>
 		<member name="bounce" type="float" setter="set_bounce" getter="get_bounce">
 		<member name="bounce" type="float" setter="set_bounce" getter="get_bounce">
 			RigidBody's bounciness.
 			RigidBody's bounciness.