summaryrefslogtreecommitdiff
path: root/doc/classes
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2018-09-21 09:33:05 +0200
committerRémi Verschelde <rverschelde@gmail.com>2018-09-21 09:33:05 +0200
commit83758a9004b313f86df496aa5f8b83b2ea14a6b2 (patch)
treea5a171f90db6dbe83f358f24468659f2e07aba3b /doc/classes
parent8e4b18a721bbf38623e9dde1b4fe8d89308cdaf9 (diff)
doc: Sync classref with current source
Diffstat (limited to 'doc/classes')
-rw-r--r--doc/classes/@GDScript.xml4
-rw-r--r--doc/classes/EditorFileSystem.xml4
-rw-r--r--doc/classes/EditorPlugin.xml14
-rw-r--r--doc/classes/EditorResourcePreviewGenerator.xml16
-rw-r--r--doc/classes/ProjectSettings.xml3
5 files changed, 19 insertions, 22 deletions
diff --git a/doc/classes/@GDScript.xml b/doc/classes/@GDScript.xml
index 3e46dc4e92..7bd332a3e4 100644
--- a/doc/classes/@GDScript.xml
+++ b/doc/classes/@GDScript.xml
@@ -120,9 +120,9 @@
<method name="atan2">
<return type="float">
</return>
- <argument index="0" name="x" type="float">
+ <argument index="0" name="y" type="float">
</argument>
- <argument index="1" name="y" type="float">
+ <argument index="1" name="x" type="float">
</argument>
<description>
Returns the arc tangent of [code]y/x[/code] in radians. Use to get the angle of tangent [code]y/x[/code]. To compute the value, the method takes into account the sign of both arguments in order to determine the quadrant.
diff --git a/doc/classes/EditorFileSystem.xml b/doc/classes/EditorFileSystem.xml
index ade6d2034d..5a8b506f9e 100644
--- a/doc/classes/EditorFileSystem.xml
+++ b/doc/classes/EditorFileSystem.xml
@@ -93,10 +93,6 @@
Remitted if a resource is reimported.
</description>
</signal>
- <signal name="script_classes_updated">
- <description>
- </description>
- </signal>
<signal name="sources_changed">
<argument index="0" name="exist" type="bool">
</argument>
diff --git a/doc/classes/EditorPlugin.xml b/doc/classes/EditorPlugin.xml
index 208780547e..66314a4ace 100644
--- a/doc/classes/EditorPlugin.xml
+++ b/doc/classes/EditorPlugin.xml
@@ -165,15 +165,15 @@
This function is used for plugins that edit specific object types (nodes or resources). It requests the editor to edit the given object.
</description>
</method>
- <method name="forward_canvas_gui_input" qualifiers="virtual">
- <return type="bool">
+ <method name="forward_canvas_draw_over_viewport" qualifiers="virtual">
+ <return type="void">
</return>
- <argument index="0" name="event" type="InputEvent">
+ <argument index="0" name="overlay" type="Control">
</argument>
<description>
</description>
</method>
- <method name="forward_draw_over_viewport" qualifiers="virtual">
+ <method name="forward_canvas_force_draw_over_viewport" qualifiers="virtual">
<return type="void">
</return>
<argument index="0" name="overlay" type="Control">
@@ -181,10 +181,10 @@
<description>
</description>
</method>
- <method name="forward_force_draw_over_viewport" qualifiers="virtual">
- <return type="void">
+ <method name="forward_canvas_gui_input" qualifiers="virtual">
+ <return type="bool">
</return>
- <argument index="0" name="overlay" type="Control">
+ <argument index="0" name="event" type="InputEvent">
</argument>
<description>
</description>
diff --git a/doc/classes/EditorResourcePreviewGenerator.xml b/doc/classes/EditorResourcePreviewGenerator.xml
index fb9af47b1f..c4dcbbbc82 100644
--- a/doc/classes/EditorResourcePreviewGenerator.xml
+++ b/doc/classes/EditorResourcePreviewGenerator.xml
@@ -16,10 +16,12 @@
</return>
<argument index="0" name="from" type="Resource">
</argument>
+ <argument index="1" name="size" type="Vector2">
+ </argument>
<description>
- Generate a preview from a given resource. This must be always implemented.
- Returning an empty texture is an OK way to fail and let another generator take care.
- Care must be taken because this function is always called from a thread (not the main thread).
+ Generate a preview from a given resource with the specified size. This must always be implemented.
+ Returning an empty texture is an OK way to fail and let another generator take care.
+ Care must be taken because this function is always called from a thread (not the main thread).
</description>
</method>
<method name="generate_from_path" qualifiers="virtual">
@@ -27,10 +29,12 @@
</return>
<argument index="0" name="path" type="String">
</argument>
+ <argument index="1" name="size" type="Vector2">
+ </argument>
<description>
- Generate a preview directly from a path, implementing this is optional, as default code will load and call generate()
- Returning an empty texture is an OK way to fail and let another generator take care.
- Care must be taken because this function is always called from a thread (not the main thread).
+ Generate a preview directly from a path with the specified size. Implementing this is optional, as default code will load and call [method generate].
+ Returning an empty texture is an OK way to fail and let another generator take care.
+ Care must be taken because this function is always called from a thread (not the main thread).
</description>
</method>
<method name="handles" qualifiers="virtual">
diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml
index 548d60fe35..c05d6bc849 100644
--- a/doc/classes/ProjectSettings.xml
+++ b/doc/classes/ProjectSettings.xml
@@ -609,9 +609,6 @@
<member name="network/remote_fs/page_size" type="int" setter="" getter="">
Page size used by remote filesystem.
</member>
- <member name="network/ssl/certificates" type="String" setter="" getter="">
- If your game or application uses HTTPS, a certificates file is needed. It must be set here.
- </member>
<member name="node/name_casing" type="int" setter="" getter="">
When creating nodes names automatically, set the type of casing in this project. This is mostly an editor setting.
</member>