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

doc: Sync classref with current source

Browse source
This commit is contained in:
Rémi Verschelde 2019-06-29 12:24:18 +02:00
parent ba6b0dc38d
commit e222e31fe6
2 changed files with 51 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

40
doc/classes/ConfigFile.xml
View file

@ -97,6 +97,26 @@
Loads the config file specified as a parameter. The file's contents are parsed and loaded in the ConfigFile object which the method was called on. Returns one of the [constant OK], [constant FAILED] or [code]ERR_*[/code] constants listed in [@GlobalScope]. If the load was successful, the return value is [constant OK].
</description>
</method>
<method name="load_encrypted">
<return type="int" enum="Error">
</return>
<argument index="0" name="path" type="String">
</argument>
<argument index="1" name="key" type="PoolByteArray">
</argument>
<description>
</description>
</method>
<method name="load_encrypted_pass">
<return type="int" enum="Error">
</return>
<argument index="0" name="path" type="String">
</argument>
<argument index="1" name="pass" type="String">
</argument>
<description>
</description>
</method>
<method name="save">
<return type="int" enum="Error">
</return>
@ -106,6 +126,26 @@
Saves the contents of the ConfigFile object to the file specified as a parameter. The output file uses an INI-style structure. Returns one of the [constant OK], [constant FAILED] or [code]ERR_*[/code] constants listed in [@GlobalScope]. If the load was successful, the return value is [constant OK].
</description>
</method>
<method name="save_encrypted">
<return type="int" enum="Error">
</return>
<argument index="0" name="path" type="String">
</argument>
<argument index="1" name="key" type="PoolByteArray">
</argument>
<description>
</description>
</method>
<method name="save_encrypted_pass">
<return type="int" enum="Error">
</return>
<argument index="0" name="path" type="String">
</argument>
<argument index="1" name="pass" type="String">
</argument>
<description>
</description>
</method>
<method name="set_value">
<return type="void">
</return>

22
doc/classes/GraphEdit.xml
View file

@ -198,6 +198,17 @@
Signal sent at the end of a GraphNode movement.
</description>
</signal>
<signal name="connection_from_empty">
<argument index="0" name="to" type="String">
</argument>
<argument index="1" name="to_slot" type="int">
</argument>
<argument index="2" name="release_position" type="Vector2">
</argument>
<description>
Signal sent when user dragging connection from input port into empty space of the graph.
</description>
</signal>
<signal name="connection_request">
<argument index="0" name="from" type="String">
</argument>
@ -211,17 +222,6 @@
Signal sent to the GraphEdit when the connection between the [code]from_slot[/code] slot of the [code]from[/code] GraphNode and the [code]to_slot[/code] slot of the [code]to[/code] GraphNode is attempted to be created.
</description>
</signal>
<signal name="connection_from_empty">
<argument index="0" name="to" type="String">
</argument>
<argument index="1" name="to_slot" type="int">
</argument>
<argument index="2" name="release_position" type="Vector2">
</argument>
<description>
Signal sent when user dragging connection from input port into empty space of the graph.
</description>
</signal>
<signal name="connection_to_empty">
<argument index="0" name="from" type="String">
</argument>