diff options
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/AudioStream.xml | 1 | ||||
| -rw-r--r-- | doc/classes/AudioStreamPlayer.xml | 2 | ||||
| -rw-r--r-- | doc/classes/Color.xml | 2 | ||||
| -rw-r--r-- | doc/classes/SceneTree.xml | 8 | ||||
| -rw-r--r-- | doc/classes/TileMap.xml | 2 |
5 files changed, 12 insertions, 3 deletions
diff --git a/doc/classes/AudioStream.xml b/doc/classes/AudioStream.xml index 15bbb1625c..753a506058 100644 --- a/doc/classes/AudioStream.xml +++ b/doc/classes/AudioStream.xml @@ -16,6 +16,7 @@ <return type="float"> </return> <description> + Returns the length of the audio stream in seconds. </description> </method> </methods> diff --git a/doc/classes/AudioStreamPlayer.xml b/doc/classes/AudioStreamPlayer.xml index d6e75f8377..26d0b1a83d 100644 --- a/doc/classes/AudioStreamPlayer.xml +++ b/doc/classes/AudioStreamPlayer.xml @@ -17,7 +17,7 @@ <return type="float"> </return> <description> - Returns the position in the [AudioStream]. + Returns the position in the [AudioStream] in seconds. </description> </method> <method name="play"> diff --git a/doc/classes/Color.xml b/doc/classes/Color.xml index 3d74bd7ab0..c675bbe994 100644 --- a/doc/classes/Color.xml +++ b/doc/classes/Color.xml @@ -5,7 +5,7 @@ </brief_description> <description> A color is represented as red, green and blue (r,g,b) components. Additionally, "a" represents the alpha component, often used for transparency. Values are in floating point and usually range from 0 to 1. Some methods (such as set_modulate(color)) may accept values > 1. - You can also create a color from standardised color names with [method @GDScript.ColorN]. + You can also create a color from standardised color names with Color.ColorN (e.g. Color.green) or [method @GDScript.ColorN]. </description> <tutorials> </tutorials> diff --git a/doc/classes/SceneTree.xml b/doc/classes/SceneTree.xml index f5a19ede0c..c85bee9b84 100644 --- a/doc/classes/SceneTree.xml +++ b/doc/classes/SceneTree.xml @@ -384,20 +384,28 @@ Call a group only once even if the call is executed many times. </constant> <constant name="STRETCH_MODE_DISABLED" value="0" enum="StretchMode"> + No stretching. </constant> <constant name="STRETCH_MODE_2D" value="1" enum="StretchMode"> + Render stretching in higher resolution (interpolated). </constant> <constant name="STRETCH_MODE_VIEWPORT" value="2" enum="StretchMode"> + Keep the specified display resolution. No interpolation. Content may appear pixelated. </constant> <constant name="STRETCH_ASPECT_IGNORE" value="0" enum="StretchAspect"> + Fill the window with the content stretched to cover excessive space. Content may appear elongated. </constant> <constant name="STRETCH_ASPECT_KEEP" value="1" enum="StretchAspect"> + Retain the same aspect ratio by padding with black bars in either axes. No expansion of content. </constant> <constant name="STRETCH_ASPECT_KEEP_WIDTH" value="2" enum="StretchAspect"> + Expand vertically. Left/right black bars may appear if the window is too wide. </constant> <constant name="STRETCH_ASPECT_KEEP_HEIGHT" value="3" enum="StretchAspect"> + Expand horizontally. Top/bottom black bars may appear if the window is too tall. </constant> <constant name="STRETCH_ASPECT_EXPAND" value="4" enum="StretchAspect"> + Expand in both directions, retaining the same aspect ratio. No black bars. </constant> </constants> </class> diff --git a/doc/classes/TileMap.xml b/doc/classes/TileMap.xml index 2990906f7c..73d60e49b7 100644 --- a/doc/classes/TileMap.xml +++ b/doc/classes/TileMap.xml @@ -68,7 +68,7 @@ <return type="Array"> </return> <description> - Returns an array of all cells containing a tile from the tileset (i.e. a tile index different from [code]-1[/code]). + Returns a [Vector2] array with the positions of all cells containing a tile from the tileset (i.e. a tile index different from [code]-1[/code]). </description> </method> <method name="get_used_cells_by_id" qualifiers="const"> |