Pārlūkot izejas kodu

Update Globals and EditorSettings docs

(cherry picked from commit 038e99e1074111c31d9d73d2d389f73078dcd07e)
Franklin Sobrinho 9 gadi atpakaļ
vecāks
revīzija
71a9efe604
1 mainītis faili ar 38 papildinājumiem un 0 dzēšanām
  1. 38 0
      doc/base/classes.xml

+ 38 - 0
doc/base/classes.xml

@@ -11728,6 +11728,24 @@
 		[/codeblock]
 		[/codeblock]
 	</description>
 	</description>
 	<methods>
 	<methods>
+		<method name="add_property_info">
+			<argument index="0" name="info" type="Dictionary">
+			</argument>
+			<description>
+			Add a custom property info to a property. The dictionary must contain: name:[String](the name of the property) and type:[int](see TYPE_* in [@Global Scope]), and optionally hint:[int](see PROPERTY_HINT_* in [@Global Scope]), hint_string:[String].
+			Example:[codeblock]
+			editor_settings.set("category/property_name", 0)
+
+			var property_info = {
+			    "name": "category/property_name",
+			    "type": TYPE_INT,
+			    "hint": PROPERTY_HINT_ENUM,
+			    "hint_string": "one,two,three"
+			}
+
+			editor_settings.add_property_info(property_info)[/codeblock]
+			</description>
+		</method>
 		<method name="erase">
 		<method name="erase">
 			<argument index="0" name="property" type="String">
 			<argument index="0" name="property" type="String">
 			</argument>
 			</argument>
@@ -13740,6 +13758,26 @@
 		Contains global variables accessible from everywhere. Use the normal [Object] API, such as "Globals.get(variable)", "Globals.set(variable,value)" or "Globals.has(variable)" to access them. Variables stored in engine.cfg are also loaded into globals, making this object very useful for reading custom game configuration options.
 		Contains global variables accessible from everywhere. Use the normal [Object] API, such as "Globals.get(variable)", "Globals.set(variable,value)" or "Globals.has(variable)" to access them. Variables stored in engine.cfg are also loaded into globals, making this object very useful for reading custom game configuration options.
 	</description>
 	</description>
 	<methods>
 	<methods>
+		<method name="add_property_info">
+			<argument index="0" name="hint" type="Dictionary">
+			</argument>
+			<description>
+			Add a custom property info to a property. The dictionary must contain: name:[String](the name of the property) and type:[int](see TYPE_* in [@Global Scope]), and optionally hint:[int](see PROPERTY_HINT_* in [@Global Scope]), hint_string:[String].
+			Example:
+			[codeblock]
+			Globals.set("category/property_name", 0)
+
+			var property_info = {
+			    "name": "category/property_name",
+			    "type": TYPE_INT,
+			    "hint": PROPERTY_HINT_ENUM,
+			    "hint_string": "one,two,three"
+			}
+
+			Globals.add_property_info(property_info)
+			[/codeblock]
+			</description>
+		</method>
 		<method name="clear">
 		<method name="clear">
 			<argument index="0" name="name" type="String">
 			<argument index="0" name="name" type="String">
 			</argument>
 			</argument>