diff options
Diffstat (limited to 'doc/classes')
-rw-r--r-- | doc/classes/EditorSettings.xml | 4 | ||||
-rw-r--r-- | doc/classes/Node.xml | 2 | ||||
-rw-r--r-- | doc/classes/String.xml | 27 | ||||
-rw-r--r-- | doc/classes/Transform.xml | 4 | ||||
-rw-r--r-- | doc/classes/Transform2D.xml | 3 | ||||
-rw-r--r-- | doc/classes/Viewport.xml | 19 | ||||
-rw-r--r-- | doc/classes/VisualShaderNodeTexture.xml | 2 |
7 files changed, 43 insertions, 18 deletions
diff --git a/doc/classes/EditorSettings.xml b/doc/classes/EditorSettings.xml index 3719ad67de..5395a8fcb0 100644 --- a/doc/classes/EditorSettings.xml +++ b/doc/classes/EditorSettings.xml @@ -176,9 +176,13 @@ <signals> <signal name="settings_changed"> <description> + Emitted when editor settings change. </description> </signal> </signals> <constants> + <constant name="NOTIFICATION_EDITOR_SETTINGS_CHANGED" value="10000"> + Emitted when editor settings change. It used by various editor plugins to update their visuals on theme changes or logic on configuration changes. + </constant> </constants> </class> diff --git a/doc/classes/Node.xml b/doc/classes/Node.xml index 5a90354124..889ce4d3eb 100644 --- a/doc/classes/Node.xml +++ b/doc/classes/Node.xml @@ -553,7 +553,7 @@ <return type="void"> </return> <description> - Moves this node to the top of the array of nodes of the parent node. This is often useful in GUIs ([Control] nodes), because their order of drawing depends on their order in the tree. + Moves this node to the bottom of parent node's children hierarchy. This is often useful in GUIs ([Control] nodes), because their order of drawing depends on their order in the tree, i.e. the further they are on the node list, the higher they are drawn. After using [code]raise[/code], a Control will be drawn on top of their siblings. </description> </method> <method name="remove_and_skip"> diff --git a/doc/classes/String.xml b/doc/classes/String.xml index 2b16bd2b33..e513a44b1d 100644 --- a/doc/classes/String.xml +++ b/doc/classes/String.xml @@ -385,19 +385,30 @@ <return type="int"> </return> <description> - Converts a string containing a hexadecimal number into an integer. + Converts a string containing a hexadecimal number into an integer. Hexadecimal strings are expected to be prefixed with "[code]0x[/code]" otherwise [code]0[/code] is returned. + [codeblock] + print("0xff".hex_to_int()) # Print "255" + [/codeblock] </description> </method> <method name="http_escape"> <return type="String"> </return> <description> + Escapes (encodes) a string to URL friendly format. Also referred to as 'URL encode'. + [codeblock] + print("https://example.org/?escaped=" + "Godot Engine:'docs'".http_escape()) + [/codeblock] </description> </method> <method name="http_unescape"> <return type="String"> </return> <description> + Unescapes (decodes) a string in URL encoded format. Also referred to as 'URL decode'. + [codeblock] + print("https://example.org/?escaped=" + "Godot%20Engine%3A%27docs%27".http_unescape()) + [/codeblock] </description> </method> <method name="insert"> @@ -696,6 +707,20 @@ Returns a copy of the string with characters removed from the right. </description> </method> + <method name="sha1_buffer"> + <return type="PoolByteArray"> + </return> + <description> + Returns the SHA-1 hash of the string as an array of bytes. + </description> + </method> + <method name="sha1_text"> + <return type="String"> + </return> + <description> + Returns the SHA-1 hash of the string as a string. + </description> + </method> <method name="sha256_buffer"> <return type="PoolByteArray"> </return> diff --git a/doc/classes/Transform.xml b/doc/classes/Transform.xml index 80a393dcee..9916d25af5 100644 --- a/doc/classes/Transform.xml +++ b/doc/classes/Transform.xml @@ -167,12 +167,16 @@ </members> <constants> <constant name="IDENTITY" value="Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )"> + [Transform] with no translation, rotation or scaling applied. When applied to other data structures, [constant IDENTITY] performs no transformation. </constant> <constant name="FLIP_X" value="Transform( -1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )"> + [Transform] with mirroring applied perpendicular to the YZ plane. </constant> <constant name="FLIP_Y" value="Transform( 1, 0, 0, 0, -1, 0, 0, 0, 1, 0, 0, 0 )"> + [Transform] with mirroring applied perpendicular to the XZ plane. </constant> <constant name="FLIP_Z" value="Transform( 1, 0, 0, 0, 1, 0, 0, 0, -1, 0, 0, 0 )"> + [Transform] with mirroring applied perpendicular to the XY plane. </constant> </constants> </class> diff --git a/doc/classes/Transform2D.xml b/doc/classes/Transform2D.xml index c5ae88d050..f6fce1aaa1 100644 --- a/doc/classes/Transform2D.xml +++ b/doc/classes/Transform2D.xml @@ -172,10 +172,13 @@ </members> <constants> <constant name="IDENTITY" value="Transform2D( 1, 0, 0, 1, 0, 0 )"> + [Transform2D] with no translation, rotation or scaling applied. When applied to other data structures, [constant IDENTITY] performs no transformation. </constant> <constant name="FLIP_X" value="Transform2D( -1, 0, 0, 1, 0, 0 )"> + [Transform2D] with mirroring applied parallel to the X axis. </constant> <constant name="FLIP_Y" value="Transform2D( 1, 0, 0, -1, 0, 0 )"> + [Transform2D] with mirroring applied parallel to the Y axis. </constant> </constants> </class> diff --git a/doc/classes/Viewport.xml b/doc/classes/Viewport.xml index a9ffd9f66d..5d5a62456f 100644 --- a/doc/classes/Viewport.xml +++ b/doc/classes/Viewport.xml @@ -141,13 +141,6 @@ Returns [code]true[/code] if the size override is enabled. See [method set_size_override]. </description> </method> - <method name="is_size_override_stretch_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - Returns [code]true[/code] if the size stretch override is enabled. See [method set_size_override_stretch]. - </description> - </method> <method name="set_attach_to_screen_rect"> <return type="void"> </return> @@ -175,15 +168,6 @@ Sets the size override of the viewport. If the [code]enable[/code] parameter is [code]true[/code] the override is used, otherwise it uses the default size. If the size parameter is [code](-1, -1)[/code], it won't update the size. </description> </method> - <method name="set_size_override_stretch"> - <return type="void"> - </return> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - If [code]true[/code], the size override affects stretch as well. - </description> - </method> <method name="unhandled_input"> <return type="void"> </return> @@ -284,6 +268,9 @@ <member name="size" type="Vector2" setter="set_size" getter="get_size" default="Vector2( 0, 0 )"> The width and height of viewport. </member> + <member name="size_override_stretch" type="bool" setter="set_size_override_stretch" getter="is_size_override_stretch_enabled" default="false"> + If [code]true[/code], the size override affects stretch as well. + </member> <member name="transparent_bg" type="bool" setter="set_transparent_background" getter="has_transparent_background" default="false"> If [code]true[/code], the viewport should render its background as transparent. </member> diff --git a/doc/classes/VisualShaderNodeTexture.xml b/doc/classes/VisualShaderNodeTexture.xml index 1f4d3b16d1..b3b89eb29b 100644 --- a/doc/classes/VisualShaderNodeTexture.xml +++ b/doc/classes/VisualShaderNodeTexture.xml @@ -25,6 +25,8 @@ </constant> <constant name="SOURCE_2D_NORMAL" value="3" enum="Source"> </constant> + <constant name="SOURCE_DEPTH" value="4" enum="Source"> + </constant> <constant name="TYPE_DATA" value="0" enum="TextureType"> </constant> <constant name="TYPE_COLOR" value="1" enum="TextureType"> |