Browse Source

Fix wrong return type of xform functions

Poommetee Ketson 7 years ago
parent
commit
ebe2337515
3 changed files with 14 additions and 14 deletions
  1. 4 4
      core/variant_call.cpp
  2. 2 2
      doc/classes/Transform.xml
  3. 8 8
      doc/classes/Transform2D.xml

+ 4 - 4
core/variant_call.cpp

@@ -1748,10 +1748,10 @@ void register_variant_methods() {
 	ADDFUNC1R(TRANSFORM2D, TRANSFORM2D, Transform2D, rotated, REAL, "phi", varray());
 	ADDFUNC1R(TRANSFORM2D, TRANSFORM2D, Transform2D, rotated, REAL, "phi", varray());
 	ADDFUNC1R(TRANSFORM2D, TRANSFORM2D, Transform2D, scaled, VECTOR2, "scale", varray());
 	ADDFUNC1R(TRANSFORM2D, TRANSFORM2D, Transform2D, scaled, VECTOR2, "scale", varray());
 	ADDFUNC1R(TRANSFORM2D, TRANSFORM2D, Transform2D, translated, VECTOR2, "offset", varray());
 	ADDFUNC1R(TRANSFORM2D, TRANSFORM2D, Transform2D, translated, VECTOR2, "offset", varray());
-	ADDFUNC1R(TRANSFORM2D, TRANSFORM2D, Transform2D, xform, NIL, "v", varray());
-	ADDFUNC1R(TRANSFORM2D, TRANSFORM2D, Transform2D, xform_inv, NIL, "v", varray());
-	ADDFUNC1R(TRANSFORM2D, TRANSFORM2D, Transform2D, basis_xform, NIL, "v", varray());
-	ADDFUNC1R(TRANSFORM2D, TRANSFORM2D, Transform2D, basis_xform_inv, NIL, "v", varray());
+	ADDFUNC1R(TRANSFORM2D, NIL, Transform2D, xform, NIL, "v", varray());
+	ADDFUNC1R(TRANSFORM2D, NIL, Transform2D, xform_inv, NIL, "v", varray());
+	ADDFUNC1R(TRANSFORM2D, VECTOR2, Transform2D, basis_xform, VECTOR2, "v", varray());
+	ADDFUNC1R(TRANSFORM2D, VECTOR2, Transform2D, basis_xform_inv, VECTOR2, "v", varray());
 	ADDFUNC2R(TRANSFORM2D, TRANSFORM2D, Transform2D, interpolate_with, TRANSFORM2D, "transform", REAL, "weight", varray());
 	ADDFUNC2R(TRANSFORM2D, TRANSFORM2D, Transform2D, interpolate_with, TRANSFORM2D, "transform", REAL, "weight", varray());
 
 
 	ADDFUNC0R(BASIS, BASIS, Basis, inverse, varray());
 	ADDFUNC0R(BASIS, BASIS, Basis, inverse, varray());

+ 2 - 2
doc/classes/Transform.xml

@@ -143,7 +143,7 @@
 			<argument index="0" name="v" type="var">
 			<argument index="0" name="v" type="var">
 			</argument>
 			</argument>
 			<description>
 			<description>
-				Transforms the given vector "v" by this transform.
+				Transforms the given [Vector3], [Plane], or [AABB] by this transform.
 			</description>
 			</description>
 		</method>
 		</method>
 		<method name="xform_inv">
 		<method name="xform_inv">
@@ -152,7 +152,7 @@
 			<argument index="0" name="v" type="var">
 			<argument index="0" name="v" type="var">
 			</argument>
 			</argument>
 			<description>
 			<description>
-				Inverse-transforms the given vector "v" by this transform.
+				Inverse-transforms the given [Vector3], [Plane], or [AABB] by this transform.
 			</description>
 			</description>
 		</method>
 		</method>
 	</methods>
 	</methods>

+ 8 - 8
doc/classes/Transform2D.xml

@@ -52,18 +52,18 @@
 			</description>
 			</description>
 		</method>
 		</method>
 		<method name="basis_xform">
 		<method name="basis_xform">
-			<return type="Transform2D">
+			<return type="Vector2">
 			</return>
 			</return>
-			<argument index="0" name="v" type="var">
+			<argument index="0" name="v" type="Vector2">
 			</argument>
 			</argument>
 			<description>
 			<description>
 				Transforms the given vector by this transform's basis (no translation).
 				Transforms the given vector by this transform's basis (no translation).
 			</description>
 			</description>
 		</method>
 		</method>
 		<method name="basis_xform_inv">
 		<method name="basis_xform_inv">
-			<return type="Transform2D">
+			<return type="Vector2">
 			</return>
 			</return>
-			<argument index="0" name="v" type="var">
+			<argument index="0" name="v" type="Vector2">
 			</argument>
 			</argument>
 			<description>
 			<description>
 				Inverse-transforms the given vector by this transform's basis (no translation).
 				Inverse-transforms the given vector by this transform's basis (no translation).
@@ -143,21 +143,21 @@
 			</description>
 			</description>
 		</method>
 		</method>
 		<method name="xform">
 		<method name="xform">
-			<return type="Transform2D">
+			<return type="var">
 			</return>
 			</return>
 			<argument index="0" name="v" type="var">
 			<argument index="0" name="v" type="var">
 			</argument>
 			</argument>
 			<description>
 			<description>
-				Transforms the given vector "v" by this transform.
+				Transforms the given [Vector2] or [Rect2] by this transform.
 			</description>
 			</description>
 		</method>
 		</method>
 		<method name="xform_inv">
 		<method name="xform_inv">
-			<return type="Transform2D">
+			<return type="var">
 			</return>
 			</return>
 			<argument index="0" name="v" type="var">
 			<argument index="0" name="v" type="var">
 			</argument>
 			</argument>
 			<description>
 			<description>
-				Inverse-transforms the given vector "v" by this transform.
+				Inverse-transforms the given [Vector2] or [Rect2] by this transform.
 			</description>
 			</description>
 		</method>
 		</method>
 	</methods>
 	</methods>