增加文档

Game/ObjectClass/BaseObject.nut

@@ -1,32 +1,75 @@
+/**
+ * Description placeholder
+ * @param {*} Object
+ */
 class BaseObject {
-    //c++对象指针
-    C_Object = null;
+	//c++对象指针
+	C_Object = null;
 
-    constructor(Object) {
-        C_Object = Object;
-    }
+	constructor(Object) {
+		C_Object = Object;
+	}
 
-    function GetPosition() {
-        return sq_GetPosition(C_Object);
-    }
+	/**
+	 *
+	 * @function
+	 * @returns {any}
+	 */
+	function GetPosition() {
+		return sq_GetPosition(C_Object);
+	}
+	//
+	/**
+	 *
+	 * @function
+	 * @param {integer} x
+	 * @param {integer} y
+	 * @param {integer} z
+	 * @returns {void}
+	 */
+	function SetPosition(x, y, z) {
+		sq_SetPosition(C_Object, x, y, z);
+	}
 
-    function SetPosition(x, y, z) {
-        sq_SetPosition(C_Object, x, y, z);
-    }
+	/**
+	 *
+	 * @function
+	 * @param {string} Name
+	 * @param {any} Type
+	 * @returns {any}
+	 */
+	function GetVars(Name, Type) {
+		return sq_GetVars(C_Object, Name, Type);
+	}
 
-    function GetVars(Name, Type) {
-        return sq_GetVars(C_Object, Name, Type);
-    }
+	/**
+	 *
+	 * @function
+	 * @param {string} Name
+	 * @param {any} Type
+	 * @param {any} Value
+	 * @returns {void}
+	 */
+	function SetVars(Name, Type, Value) {
+		sq_SetVars(C_Object, Name, Type, Value);
+	}
 
-    function SetVars(Name, Type, Value) {
-        sq_SetVars(C_Object, Name, Type, Value);
-    }
+	/**
+	 *
+	 * @function
+	 * @returns {integer}
+	 */
+	function GetDirection() {
+		return sq_GetDirection(C_Object);
+	}
 
-    function GetDirection() {
-        return sq_GetDirection(C_Object);
-    }
-
-    function SetDirection(Dir) {
-        sq_SetDirection(C_Object, Dir);
-    }
-}
+	/**
+	 *
+	 * @function
+	 * @param {integer} Dir
+	 * @returns {void}
+	 */
+	function SetDirection(Dir) {
+		sq_SetDirection(C_Object, Dir);
+	}
+}