浏览代码

Merge pull request #1407 from NateWardawg/documentation

Updated the internal documention for the GDScript class.
Juan Linietsky 10 年之前
父节点
当前提交
da7698073f
共有 2 个文件被更改,包括 27 次插入4 次删除
  1. 26 3
      doc/base/classes.xml
  2. 1 1
      modules/gdscript/gd_functions.cpp

+ 26 - 3
doc/base/classes.xml

@@ -257,13 +257,14 @@
 		<method name="lerp"  >
 		<method name="lerp"  >
 			<return type="float">
 			<return type="float">
 			</return>
 			</return>
-			<argument index="0" name="a" type="float">
+			<argument index="0" name="from" type="float">
 			</argument>
 			</argument>
-			<argument index="1" name="b" type="float">
+			<argument index="1" name="to" type="float">
 			</argument>
 			</argument>
-			<argument index="2" name="c" type="float">
+			<argument index="2" name="weight" type="float">
 			</argument>
 			</argument>
 			<description>
 			<description>
+			Linear interpolates between two values by a normalized value.
 			</description>
 			</description>
 		</method>
 		</method>
 		<method name="dectime"  >
 		<method name="dectime"  >
@@ -276,6 +277,7 @@
 			<argument index="2" name="step" type="float">
 			<argument index="2" name="step" type="float">
 			</argument>
 			</argument>
 			<description>
 			<description>
+			Decreases time by a specified amount.
 			</description>
 			</description>
 		</method>
 		</method>
 		<method name="randomize"  >
 		<method name="randomize"  >
@@ -421,6 +423,7 @@
 			<argument index="1" name="funcname" type="String">
 			<argument index="1" name="funcname" type="String">
 			</argument>
 			</argument>
 			<description>
 			<description>
+			Returns a reference to the specified function
 			</description>
 			</description>
 		</method>
 		</method>
 		<method name="convert"  >
 		<method name="convert"  >
@@ -475,6 +478,7 @@
 			<argument index="1" name="..." type="var">
 			<argument index="1" name="..." type="var">
 			</argument>
 			</argument>
 			<description>
 			<description>
+			Print one or more arguments to the console with a tab between each argument.
 			</description>
 			</description>
 		</method>
 		</method>
 		<method name="printerr"  >
 		<method name="printerr"  >
@@ -499,6 +503,24 @@
 			Print one or more arguments to strings in the best way possible to console. No newline is added at the end.
 			Print one or more arguments to strings in the best way possible to console. No newline is added at the end.
 			</description>
 			</description>
 		</method>
 		</method>
+		<method name="var2str"  >
+			<return type="String">
+			</return>
+			<argument index="0" name="var" type="var">
+			</argument>
+			<description>
+			Converts the value of a variable to a String.
+			</description>
+		</method>
+		<method name="str2var:var"  >
+			<return type="String">
+			</return>
+			<argument index="0" name="str" type="String">
+			</argument>
+			<description>
+			Converts the value of a String to a variable.
+			</description>
+		</method>
 		<method name="range"  >
 		<method name="range"  >
 			<return type="Array">
 			<return type="Array">
 			</return>
 			</return>
@@ -544,6 +566,7 @@
 			<argument index="0" name="var:var" type="var">
 			<argument index="0" name="var:var" type="var">
 			</argument>
 			</argument>
 			<description>
 			<description>
+			Hashes the variable passed and returns an integer.
 			</description>
 			</description>
 		</method>
 		</method>
 		<method name="print_stack"  >
 		<method name="print_stack"  >

+ 1 - 1
modules/gdscript/gd_functions.cpp

@@ -1101,7 +1101,7 @@ MethodInfo GDFunctions::get_info(Function p_func) {
 			return mi;
 			return mi;
 		} break;
 		} break;
 		case MATH_LERP: {
 		case MATH_LERP: {
-			MethodInfo mi("lerp",PropertyInfo(Variant::REAL,"a"),PropertyInfo(Variant::REAL,"b"), PropertyInfo(Variant::REAL,"c"));
+			MethodInfo mi("lerp",PropertyInfo(Variant::REAL,"from"),PropertyInfo(Variant::REAL,"to"), PropertyInfo(Variant::REAL,"weight"));
 			mi.return_val.type=Variant::REAL;
 			mi.return_val.type=Variant::REAL;
 			return mi;
 			return mi;
 		} break;
 		} break;