浏览代码

doc: Sync classref with current source

Rémi Verschelde 7 年之前
父节点
当前提交
914f51031c
共有 3 个文件被更改,包括 39 次插入41 次删除
  1. 30 32
      doc/classes/Image.xml
  2. 3 3
      doc/classes/Node2D.xml
  3. 6 6
      doc/classes/VisualServer.xml

+ 30 - 32
doc/classes/Image.xml

@@ -446,67 +446,65 @@
 		</constant>
 		</constant>
 		<constant name="FORMAT_RGBA5551" value="7" enum="Format">
 		<constant name="FORMAT_RGBA5551" value="7" enum="Format">
 		</constant>
 		</constant>
-		<constant name="FORMAT_RGB10A2" value="8" enum="Format">
+		<constant name="FORMAT_RF" value="8" enum="Format">
 		</constant>
 		</constant>
-		<constant name="FORMAT_RF" value="9" enum="Format">
+		<constant name="FORMAT_RGF" value="9" enum="Format">
 		</constant>
 		</constant>
-		<constant name="FORMAT_RGF" value="10" enum="Format">
+		<constant name="FORMAT_RGBF" value="10" enum="Format">
 		</constant>
 		</constant>
-		<constant name="FORMAT_RGBF" value="11" enum="Format">
+		<constant name="FORMAT_RGBAF" value="11" enum="Format">
 		</constant>
 		</constant>
-		<constant name="FORMAT_RGBAF" value="12" enum="Format">
+		<constant name="FORMAT_RH" value="12" enum="Format">
 		</constant>
 		</constant>
-		<constant name="FORMAT_RH" value="13" enum="Format">
+		<constant name="FORMAT_RGH" value="13" enum="Format">
 		</constant>
 		</constant>
-		<constant name="FORMAT_RGH" value="14" enum="Format">
+		<constant name="FORMAT_RGBH" value="14" enum="Format">
 		</constant>
 		</constant>
-		<constant name="FORMAT_RGBH" value="15" enum="Format">
+		<constant name="FORMAT_RGBAH" value="15" enum="Format">
 		</constant>
 		</constant>
-		<constant name="FORMAT_RGBAH" value="16" enum="Format">
+		<constant name="FORMAT_RGBE9995" value="16" enum="Format">
 		</constant>
 		</constant>
-		<constant name="FORMAT_RGBE9995" value="17" enum="Format">
+		<constant name="FORMAT_DXT1" value="17" enum="Format">
 		</constant>
 		</constant>
-		<constant name="FORMAT_DXT1" value="18" enum="Format">
+		<constant name="FORMAT_DXT3" value="18" enum="Format">
 		</constant>
 		</constant>
-		<constant name="FORMAT_DXT3" value="19" enum="Format">
+		<constant name="FORMAT_DXT5" value="19" enum="Format">
 		</constant>
 		</constant>
-		<constant name="FORMAT_DXT5" value="20" enum="Format">
+		<constant name="FORMAT_RGTC_R" value="20" enum="Format">
 		</constant>
 		</constant>
-		<constant name="FORMAT_RGTC_R" value="21" enum="Format">
+		<constant name="FORMAT_RGTC_RG" value="21" enum="Format">
 		</constant>
 		</constant>
-		<constant name="FORMAT_RGTC_RG" value="22" enum="Format">
+		<constant name="FORMAT_BPTC_RGBA" value="22" enum="Format">
 		</constant>
 		</constant>
-		<constant name="FORMAT_BPTC_RGBA" value="23" enum="Format">
+		<constant name="FORMAT_BPTC_RGBF" value="23" enum="Format">
 		</constant>
 		</constant>
-		<constant name="FORMAT_BPTC_RGBF" value="24" enum="Format">
+		<constant name="FORMAT_BPTC_RGBFU" value="24" enum="Format">
 		</constant>
 		</constant>
-		<constant name="FORMAT_BPTC_RGBFU" value="25" enum="Format">
+		<constant name="FORMAT_PVRTC2" value="25" enum="Format">
 		</constant>
 		</constant>
-		<constant name="FORMAT_PVRTC2" value="26" enum="Format">
+		<constant name="FORMAT_PVRTC2A" value="26" enum="Format">
 		</constant>
 		</constant>
-		<constant name="FORMAT_PVRTC2A" value="27" enum="Format">
+		<constant name="FORMAT_PVRTC4" value="27" enum="Format">
 		</constant>
 		</constant>
-		<constant name="FORMAT_PVRTC4" value="28" enum="Format">
+		<constant name="FORMAT_PVRTC4A" value="28" enum="Format">
 		</constant>
 		</constant>
-		<constant name="FORMAT_PVRTC4A" value="29" enum="Format">
+		<constant name="FORMAT_ETC" value="29" enum="Format">
 		</constant>
 		</constant>
-		<constant name="FORMAT_ETC" value="30" enum="Format">
+		<constant name="FORMAT_ETC2_R11" value="30" enum="Format">
 		</constant>
 		</constant>
-		<constant name="FORMAT_ETC2_R11" value="31" enum="Format">
+		<constant name="FORMAT_ETC2_R11S" value="31" enum="Format">
 		</constant>
 		</constant>
-		<constant name="FORMAT_ETC2_R11S" value="32" enum="Format">
+		<constant name="FORMAT_ETC2_RG11" value="32" enum="Format">
 		</constant>
 		</constant>
-		<constant name="FORMAT_ETC2_RG11" value="33" enum="Format">
+		<constant name="FORMAT_ETC2_RG11S" value="33" enum="Format">
 		</constant>
 		</constant>
-		<constant name="FORMAT_ETC2_RG11S" value="34" enum="Format">
+		<constant name="FORMAT_ETC2_RGB8" value="34" enum="Format">
 		</constant>
 		</constant>
-		<constant name="FORMAT_ETC2_RGB8" value="35" enum="Format">
+		<constant name="FORMAT_ETC2_RGBA8" value="35" enum="Format">
 		</constant>
 		</constant>
-		<constant name="FORMAT_ETC2_RGBA8" value="36" enum="Format">
+		<constant name="FORMAT_ETC2_RGB8A1" value="36" enum="Format">
 		</constant>
 		</constant>
-		<constant name="FORMAT_ETC2_RGB8A1" value="37" enum="Format">
-		</constant>
-		<constant name="FORMAT_MAX" value="38" enum="Format">
+		<constant name="FORMAT_MAX" value="37" enum="Format">
 		</constant>
 		</constant>
 		<constant name="INTERPOLATE_NEAREST" value="0" enum="Interpolation">
 		<constant name="INTERPOLATE_NEAREST" value="0" enum="Interpolation">
 		</constant>
 		</constant>

+ 3 - 3
doc/classes/Node2D.xml

@@ -157,12 +157,12 @@
 		<member name="transform" type="Transform2D" setter="set_transform" getter="get_transform">
 		<member name="transform" type="Transform2D" setter="set_transform" getter="get_transform">
 			Local [Transform2D].
 			Local [Transform2D].
 		</member>
 		</member>
-		<member name="z_index" type="int" setter="set_z_index" getter="get_z_index">
-			Z-index. Controls the order in which the nodes render. A node with a higher Z-index will display in front of others.
-		</member>
 		<member name="z_as_relative" type="bool" setter="set_z_as_relative" getter="is_z_relative">
 		<member name="z_as_relative" type="bool" setter="set_z_as_relative" getter="is_z_relative">
 			If [code]true[/code] the node's Z-index is relative to its parent's Z-index. If this node's Z-index is 2 and its parent's effective Z-index is 3, then this node's effective Z-index will be 2 + 3 = 5.
 			If [code]true[/code] the node's Z-index is relative to its parent's Z-index. If this node's Z-index is 2 and its parent's effective Z-index is 3, then this node's effective Z-index will be 2 + 3 = 5.
 		</member>
 		</member>
+		<member name="z_index" type="int" setter="set_z_index" getter="get_z_index">
+			Z-index. Controls the order in which the nodes render. A node with a higher Z-index will display in front of others.
+		</member>
 	</members>
 	</members>
 	<constants>
 	<constants>
 	</constants>
 	</constants>

+ 6 - 6
doc/classes/VisualServer.xml

@@ -504,26 +504,26 @@
 				Sets if the canvas item (including its children) is visible.
 				Sets if the canvas item (including its children) is visible.
 			</description>
 			</description>
 		</method>
 		</method>
-		<method name="canvas_item_set_z">
+		<method name="canvas_item_set_z_as_relative_to_parent">
 			<return type="void">
 			<return type="void">
 			</return>
 			</return>
 			<argument index="0" name="item" type="RID">
 			<argument index="0" name="item" type="RID">
 			</argument>
 			</argument>
-			<argument index="1" name="z" type="int">
+			<argument index="1" name="enabled" type="bool">
 			</argument>
 			</argument>
 			<description>
 			<description>
-				Sets the [CanvasItem]'s z order position.
+				If this is enabled, the z-index of the parent will be added to the children's z-index.
 			</description>
 			</description>
 		</method>
 		</method>
-		<method name="canvas_item_set_z_as_relative_to_parent">
+		<method name="canvas_item_set_z_index">
 			<return type="void">
 			<return type="void">
 			</return>
 			</return>
 			<argument index="0" name="item" type="RID">
 			<argument index="0" name="item" type="RID">
 			</argument>
 			</argument>
-			<argument index="1" name="enabled" type="bool">
+			<argument index="1" name="z_index" type="int">
 			</argument>
 			</argument>
 			<description>
 			<description>
-				If this is enabled, the z-position of the parent will be added to the childrens z-position.
+				Sets the [CanvasItem]'s z-index, i.e. its draw order (lower indexes are drawn first).
 			</description>
 			</description>
 		</method>
 		</method>
 		<method name="canvas_light_attach_to_canvas">
 		<method name="canvas_light_attach_to_canvas">