godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: Sync classref with current source

This commit is contained in:
Rémi Verschelde 2019-11-12 21:49:04 +01:00
parent 261b9d12b9
commit bfd993b0ca
3 changed files with 19 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/classes/Input.xml
View File

@ -67,6 +67,12 @@
Returns an [Array] containing the device IDs of all currently connected joypads. Returns an [Array] containing the device IDs of all currently connected joypads.
</description> </description>
</method> </method>
<method name="get_current_cursor_shape" qualifiers="const">
<return type="int" enum="Input.CursorShape">
</return>
<description>
</description>
</method>
<method name="get_gravity" qualifiers="const"> <method name="get_gravity" qualifiers="const">
<return type="Vector3"> <return type="Vector3">
</return> </return>

10
doc/classes/ProjectSettings.xml
View File

@ -254,6 +254,8 @@
<member name="debug/gdscript/warnings/enable" type="bool" setter="" getter=""> <member name="debug/gdscript/warnings/enable" type="bool" setter="" getter="">
If [code]true[/code], enables specific GDScript warnings (see [code]debug/gdscript/warnings/*[/code] settings). If [code]false[/code], disables all GDScript warnings. If [code]true[/code], enables specific GDScript warnings (see [code]debug/gdscript/warnings/*[/code] settings). If [code]false[/code], disables all GDScript warnings.
</member> </member>
<member name="debug/gdscript/warnings/exclude_addons" type="bool" setter="" getter="">
</member>
<member name="debug/gdscript/warnings/function_conflicts_constant" type="bool" setter="" getter=""> <member name="debug/gdscript/warnings/function_conflicts_constant" type="bool" setter="" getter="">
If [code]true[/code], enables warnings when a function is declared with the same name as a constant. If [code]true[/code], enables warnings when a function is declared with the same name as a constant.
</member> </member>
@ -281,6 +283,8 @@
<member name="debug/gdscript/warnings/return_value_discarded" type="bool" setter="" getter=""> <member name="debug/gdscript/warnings/return_value_discarded" type="bool" setter="" getter="">
If [code]true[/code], enables warnings when calling a function without using its return value (by assigning it to a variable or using it as a function argument). Such return values are sometimes used to denote possible errors using the [enum @GlobalScope.Error] enum. If [code]true[/code], enables warnings when calling a function without using its return value (by assigning it to a variable or using it as a function argument). Such return values are sometimes used to denote possible errors using the [enum @GlobalScope.Error] enum.
</member> </member>
<member name="debug/gdscript/warnings/shadowed_variable" type="bool" setter="" getter="">
</member>
<member name="debug/gdscript/warnings/standalone_expression" type="bool" setter="" getter=""> <member name="debug/gdscript/warnings/standalone_expression" type="bool" setter="" getter="">
If [code]true[/code], enables warnings when calling an expression that has no effect on the surrounding code, such as writing [code]2 + 2[/code] as a statement. If [code]true[/code], enables warnings when calling an expression that has no effect on the surrounding code, such as writing [code]2 + 2[/code] as a statement.
</member> </member>
@ -705,15 +709,15 @@
<member name="rendering/limits/buffers/immediate_buffer_size_kb" type="int" setter="" getter=""> <member name="rendering/limits/buffers/immediate_buffer_size_kb" type="int" setter="" getter="">
Max buffer size for drawing immediate objects (ImmediateGeometry nodes). Nodes using more than this size will not work. Max buffer size for drawing immediate objects (ImmediateGeometry nodes). Nodes using more than this size will not work.
</member> </member>
<member name="rendering/limits/rendering/max_renderable_elements" type="int" setter="" getter="">
Max amount of elements renderable in a frame. If more than this are visible per frame, they will be dropped. Keep in mind elements refer to mesh surfaces and not meshes themselves.
</member>
<member name="rendering/limits/rendering/max_renderable_lights" type="int" setter="" getter=""> <member name="rendering/limits/rendering/max_renderable_lights" type="int" setter="" getter="">
Max number of lights renderable in a frame. If more than this number are used, they will be ignored. On some systems (particularly web) setting this number as low as possible can increase the speed of shader compilation. Max number of lights renderable in a frame. If more than this number are used, they will be ignored. On some systems (particularly web) setting this number as low as possible can increase the speed of shader compilation.
</member> </member>
<member name="rendering/limits/rendering/max_renderable_reflections" type="int" setter="" getter=""> <member name="rendering/limits/rendering/max_renderable_reflections" type="int" setter="" getter="">
Max number of reflection probes renderable in a frame. If more than this number are used, they will be ignored. On some systems (particularly web) setting this number as low as possible can increase the speed of shader compilation. Max number of reflection probes renderable in a frame. If more than this number are used, they will be ignored. On some systems (particularly web) setting this number as low as possible can increase the speed of shader compilation.
</member> </member>
<member name="rendering/limits/rendering/max_renderable_elements" type="int" setter="" getter="">
Max amount of elements renderable in a frame. If more than this are visible per frame, they will be dropped. Keep in mind elements refer to mesh surfaces and not meshes themselves.
</member>
<member name="rendering/limits/time/time_rollover_secs" type="float" setter="" getter=""> <member name="rendering/limits/time/time_rollover_secs" type="float" setter="" getter="">
Shaders have a time variable that constantly increases. At some point, it needs to be rolled back to zero to avoid precision errors on shader animations. This setting specifies when (in seconds). Shaders have a time variable that constantly increases. At some point, it needs to be rolled back to zero to avoid precision errors on shader animations. This setting specifies when (in seconds).
</member> </member>

6
doc/classes/TranslationServer.xml
View File

@ -27,6 +27,12 @@
Clears the server from all translations. Clears the server from all translations.
</description> </description>
</method> </method>
<method name="get_loaded_locales" qualifiers="const">
<return type="Array">
</return>
<description>
</description>
</method>
<method name="get_locale" qualifiers="const"> <method name="get_locale" qualifiers="const">
<return type="String"> <return type="String">
</return> </return>