asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions 1

Update Globals and EditorSettings docs

Browse source 
(cherry picked from commit 038e99e107)
This commit is contained in:
Franklin Sobrinho 2016-08-16 17:11:30 -03:00 committed by Rémi Verschelde
parent 5f9e6d2b48
commit 71a9efe604
1 changed files with 38 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

38
doc/base/classes.xml
View file

@ -11728,6 +11728,24 @@
[/codeblock]
</description>
<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">
<argument index="0" name="property" type="String">
</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.
</description>
<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">
<argument index="0" name="name" type="String">
</argument>