maxmustermann/godot
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

doc: Sync classref with current source

Browse source
This commit is contained in:
Rémi Verschelde 2018-09-21 09:33:05 +02:00
parent 8e4b18a721
commit 83758a9004
6 changed files with 31 additions and 34 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
doc/classes/@GDScript.xml
View file

@ -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.

4
doc/classes/EditorFileSystem.xml
View file

@ -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>

32
doc/classes/EditorPlugin.xml
View file

@ -165,6 +165,22 @@
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_draw_over_viewport" qualifiers="virtual">
<return type="void">
</return>
<argument index="0" name="overlay" type="Control">
</argument>
<description>
</description>
</method>
<method name="forward_canvas_force_draw_over_viewport" qualifiers="virtual">
<return type="void">
</return>
<argument index="0" name="overlay" type="Control">
</argument>
<description>
</description>
</method>
<method name="forward_canvas_gui_input" qualifiers="virtual">
<return type="bool">
</return>
@ -173,22 +189,6 @@
<description>
</description>
</method>
<method name="forward_draw_over_viewport" qualifiers="virtual">
<return type="void">
</return>
<argument index="0" name="overlay" type="Control">
</argument>
<description>
</description>
</method>
<method name="forward_force_draw_over_viewport" qualifiers="virtual">
<return type="void">
</return>
<argument index="0" name="overlay" type="Control">
</argument>
<description>
</description>
</method>
<method name="forward_spatial_gui_input" qualifiers="virtual">
<return type="bool">
</return>

16
doc/classes/EditorResourcePreviewGenerator.xml
View file

@ -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">

3
doc/classes/ProjectSettings.xml
View file

@ -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>

6
modules/opensimplex/doc_classes/SimplexNoise.xml
View file

@ -14,7 +14,7 @@
noise.seed = randi()
noise.octaves = 4
noise.period = 20.0
noise.persistance = 0.8
noise.persistence = 0.8
# Sample
print("Values:")
@ -118,9 +118,9 @@
Period of the base octave.
A lower period results in a higher-frequency noise (more value changes across the same distance).
</member>
<member name="persistance" type="float" setter="set_persistance" getter="get_persistance">
<member name="persistence" type="float" setter="set_persistence" getter="get_persistence">
Contribution factor of the different octaves.
A [code]persistance[/code] value of 1 means all the octaves have the same contribution, a value of 0.5 means each octave contributes half as much as the previous one.
A [code]persistence[/code] value of 1 means all the octaves have the same contribution, a value of 0.5 means each octave contributes half as much as the previous one.
</member>
<member name="seed" type="int" setter="set_seed" getter="get_seed">
Seed used to generate random values, different seeds will generate different noise maps.