diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/AudioEffectCapture.xml | 2 | ||||
| -rw-r--r-- | doc/classes/CanvasItem.xml | 2 | ||||
| -rw-r--r-- | doc/classes/Font.xml | 3 | ||||
| -rw-r--r-- | doc/classes/Input.xml | 8 |
4 files changed, 8 insertions, 7 deletions
diff --git a/doc/classes/AudioEffectCapture.xml b/doc/classes/AudioEffectCapture.xml index cf3d87c2e4..c7ee621ca6 100644 --- a/doc/classes/AudioEffectCapture.xml +++ b/doc/classes/AudioEffectCapture.xml @@ -67,7 +67,7 @@ </methods> <members> <member name="buffer_length" type="float" setter="set_buffer_length" getter="get_buffer_length" default="0.1"> - Length of the internal ring buffer, in seconds. + Length of the internal ring buffer, in seconds. Setting the buffer length will have no effect if already initialized. </member> </members> <constants> diff --git a/doc/classes/CanvasItem.xml b/doc/classes/CanvasItem.xml index d13f431a16..87b157db4e 100644 --- a/doc/classes/CanvasItem.xml +++ b/doc/classes/CanvasItem.xml @@ -318,7 +318,7 @@ <argument index="9" name="flags" type="int" default="3"> </argument> <description> - Draws [code]text[/code] using the specified [code]font[/code] at the [code]position[/code] (top-left corner). The text will have its color multiplied by [code]modulate[/code]. If [code]clip_w[/code] is greater than or equal to 0, the text will be clipped if it exceeds the specified width. + Draws [code]text[/code] using the specified [code]font[/code] at the [code]position[/code] (bottom-left corner using the baseline of the font). The text will have its color multiplied by [code]modulate[/code]. If [code]clip_w[/code] is greater than or equal to 0, the text will be clipped if it exceeds the specified width. [b]Example using the default project font:[/b] [codeblocks] [gdscript] diff --git a/doc/classes/Font.xml b/doc/classes/Font.xml index 409e405551..bf5237422b 100644 --- a/doc/classes/Font.xml +++ b/doc/classes/Font.xml @@ -175,7 +175,7 @@ </argument> <description> Returns the size of a character, optionally taking kerning into account if the next character is provided. - [b]Note:[/b] Do not use this function to calculate width of the string character by character, use [method get_string_size] or [TextLine] instead. + [b]Note:[/b] Do not use this function to calculate width of the string character by character, use [method get_string_size] or [TextLine] instead. The height returned is the font height (see also [method get_height]) and has no relation to the glyph height. </description> </method> <method name="get_data" qualifiers="const"> @@ -248,6 +248,7 @@ </argument> <description> Returns the size size of a bounding box of a string, taking kerning and advance into account. + [b]Note:[/b] Real height of the string is context-dependent and can be significantly different from the value returned by [method get_height]. See also [method draw_string]. </description> </method> diff --git a/doc/classes/Input.xml b/doc/classes/Input.xml index 50a675e8db..977f2bb565 100644 --- a/doc/classes/Input.xml +++ b/doc/classes/Input.xml @@ -49,9 +49,9 @@ <return type="Vector3"> </return> <description> - Returns the acceleration of the device's accelerometer sensor, if the device has one. Otherwise, the method returns [constant Vector3.ZERO]. + Returns the acceleration in m/s² of the device's accelerometer sensor, if the device has one. Otherwise, the method returns [constant Vector3.ZERO]. Note this method returns an empty [Vector3] when running from the editor even when your device has an accelerometer. You must export your project to a supported device to read values from the accelerometer. - [b]Note:[/b] This method only works on iOS, Android, and UWP. On other platforms, it always returns [constant Vector3.ZERO]. On Android the unit of measurement for each axis is m/s² while on iOS and UWP it's a multiple of the Earth's gravitational acceleration [code]g[/code] (~9.81 m/s²). + [b]Note:[/b] This method only works on iOS, Android, and UWP. On other platforms, it always returns [constant Vector3.ZERO]. </description> </method> <method name="get_action_raw_strength" qualifiers="const"> @@ -106,8 +106,8 @@ <return type="Vector3"> </return> <description> - Returns the gravity of the device's accelerometer sensor, if the device has one. Otherwise, the method returns [constant Vector3.ZERO]. - [b]Note:[/b] This method only works on Android and iOS. On other platforms, it always returns [constant Vector3.ZERO]. On Android the unit of measurement for each axis is m/s² while on iOS it's a multiple of the Earth's gravitational acceleration [code]g[/code] (~9.81 m/s²). + Returns the gravity in m/s² of the device's accelerometer sensor, if the device has one. Otherwise, the method returns [constant Vector3.ZERO]. + [b]Note:[/b] This method only works on Android and iOS. On other platforms, it always returns [constant Vector3.ZERO]. </description> </method> <method name="get_gyroscope" qualifiers="const"> |