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

doc: Sync classref with current source

Browse Source
This commit is contained in:
Rémi Verschelde 2019-07-29 21:12:57 +02:00
parent cc0e5e51b8
commit 051b5b3d15
4 changed files with 5 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/classes/ProjectSettings.xml
View File

@ -724,15 +724,15 @@
<member name="rendering/limits/buffers/immediate_buffer_size_kb" type="int" setter="" getter="" default="2048"> <member name="rendering/limits/buffers/immediate_buffer_size_kb" type="int" setter="" getter="" default="2048">
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="" default="65536">
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="" default="4096"> <member name="rendering/limits/rendering/max_renderable_lights" type="int" setter="" getter="" default="4096">
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="" default="1024"> <member name="rendering/limits/rendering/max_renderable_reflections" type="int" setter="" getter="" default="1024">
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="" default="65536">
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="" default="3600"> <member name="rendering/limits/time/time_rollover_secs" type="float" setter="" getter="" default="3600">
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>

2
doc/classes/Sprite.xml
View File

@ -46,7 +46,7 @@
<member name="frame" type="int" setter="set_frame" getter="get_frame" default="0"> <member name="frame" type="int" setter="set_frame" getter="get_frame" default="0">
Current frame to display from sprite sheet. [member vframes] or [member hframes] must be greater than 1. Current frame to display from sprite sheet. [member vframes] or [member hframes] must be greater than 1.
</member> </member>
<member name="frame_coords" type="Vector2" setter="set_frame_coords" getter="get_frame_coords"> <member name="frame_coords" type="Vector2" setter="set_frame_coords" getter="get_frame_coords" default="Vector2( 0, 0 )">
Coordinates of the frame to display from sprite sheet. This is as an alias for the [member frame] property. [member vframes] or [member hframes] must be greater than 1. Coordinates of the frame to display from sprite sheet. This is as an alias for the [member frame] property. [member vframes] or [member hframes] must be greater than 1.
</member> </member>
<member name="hframes" type="int" setter="set_hframes" getter="get_hframes" default="1"> <member name="hframes" type="int" setter="set_hframes" getter="get_hframes" default="1">

2
doc/classes/Sprite3D.xml
View File

@ -14,7 +14,7 @@
<member name="frame" type="int" setter="set_frame" getter="get_frame" default="0"> <member name="frame" type="int" setter="set_frame" getter="get_frame" default="0">
Current frame to display from sprite sheet. [member vframes] or [member hframes] must be greater than 1. Current frame to display from sprite sheet. [member vframes] or [member hframes] must be greater than 1.
</member> </member>
<member name="frame_coords" type="Vector2" setter="set_frame_coords" getter="get_frame_coords"> <member name="frame_coords" type="Vector2" setter="set_frame_coords" getter="get_frame_coords" default="Vector2( 0, 0 )">
Coordinates of the frame to display from sprite sheet. This is as an alias for the [member frame] property. [member vframes] or [member hframes] must be greater than 1. Coordinates of the frame to display from sprite sheet. This is as an alias for the [member frame] property. [member vframes] or [member hframes] must be greater than 1.
</member> </member>
<member name="hframes" type="int" setter="set_hframes" getter="get_hframes" default="1"> <member name="hframes" type="int" setter="set_hframes" getter="get_hframes" default="1">

2
doc/classes/String.xml
View File

@ -281,7 +281,6 @@
</argument> </argument>
<argument index="2" name="to" type="int" default="0"> <argument index="2" name="to" type="int" default="0">
</argument> </argument>
</argument>
<description> <description>
Returns the number of occurrences of substring [code]what[/code] between [code]from[/code] and [code]to[/code] positions. If [code]from[/code] and [code]to[/code] equals 0 the whole string will be used. If only [code]to[/code] equals 0 the remained substring will be used. Returns the number of occurrences of substring [code]what[/code] between [code]from[/code] and [code]to[/code] positions. If [code]from[/code] and [code]to[/code] equals 0 the whole string will be used. If only [code]to[/code] equals 0 the remained substring will be used.
</description> </description>
@ -295,7 +294,6 @@
</argument> </argument>
<argument index="2" name="to" type="int" default="0"> <argument index="2" name="to" type="int" default="0">
</argument> </argument>
</argument>
<description> <description>
Returns the number of occurrences of substring [code]what[/code] (ignoring case) between [code]from[/code] and [code]to[/code] positions. If [code]from[/code] and [code]to[/code] equals 0 the whole string will be used. If only [code]to[/code] equals 0 the remained substring will be used. Returns the number of occurrences of substring [code]what[/code] (ignoring case) between [code]from[/code] and [code]to[/code] positions. If [code]from[/code] and [code]to[/code] equals 0 the whole string will be used. If only [code]to[/code] equals 0 the remained substring will be used.
</description> </description>