From 1b7aee3c8d8c4ebdedd04b5ccecb70b885be8de9 Mon Sep 17 00:00:00 2001 From: kobewi Date: Thu, 6 Oct 2022 21:59:48 +0200 Subject: Fill random docs --- doc/classes/@GlobalScope.xml | 3 +++ doc/classes/AABB.xml | 1 + doc/classes/Array.xml | 10 ++++++++++ doc/classes/Basis.xml | 7 +++++++ doc/classes/CPUParticles2D.xml | 34 ++++++++++++++++++++++++++++++++ doc/classes/CPUParticles3D.xml | 6 ++++-- doc/classes/Color.xml | 15 ++++++++++++++ doc/classes/ColorPicker.xml | 3 +++ doc/classes/Dictionary.xml | 3 +++ doc/classes/EditorFileDialog.xml | 3 ++- doc/classes/EditorInterface.xml | 1 + doc/classes/EditorPlugin.xml | 2 ++ doc/classes/EditorProperty.xml | 1 + doc/classes/EditorSpinSlider.xml | 3 +++ doc/classes/Engine.xml | 6 ++++++ doc/classes/ParticleProcessMaterial.xml | 2 +- doc/classes/VSlider.xml | 1 + doc/classes/VisibleOnScreenEnabler2D.xml | 7 +++++++ 18 files changed, 104 insertions(+), 4 deletions(-) diff --git a/doc/classes/@GlobalScope.xml b/doc/classes/@GlobalScope.xml index 1b57569582..8596dc7b73 100644 --- a/doc/classes/@GlobalScope.xml +++ b/doc/classes/@GlobalScope.xml @@ -1283,6 +1283,7 @@ The [Marshalls] singleton. + The [NativeExtensionManager] singleton. The [NavigationMeshGenerator] singleton. @@ -1377,8 +1378,10 @@ General horizontal alignment, usually used for [Separator], [ScrollBar], [Slider], etc. + Clockwise rotation. Used by some methods (e.g. [method Image.rotate_90]). + Counter-clockwise rotation. Used by some methods (e.g. [method Image.rotate_90]). Horizontal left alignment, usually for text-derived classes. diff --git a/doc/classes/AABB.xml b/doc/classes/AABB.xml index 23dd41f275..21fed0442e 100644 --- a/doc/classes/AABB.xml +++ b/doc/classes/AABB.xml @@ -188,6 +188,7 @@ + Returns [code]true[/code] if the given ray intersects with this [AABB]. Ray length is infinite. diff --git a/doc/classes/Array.xml b/doc/classes/Array.xml index d8c4b8fdb5..3b34d1e380 100644 --- a/doc/classes/Array.xml +++ b/doc/classes/Array.xml @@ -58,6 +58,7 @@ + Creates a typed array from the [param base] array. The base array can't be already typed. See [method set_typed] for more details. @@ -315,16 +316,19 @@ + Returns the [code]TYPE[/code] constant for a typed array. If the [Array] is not typed, returns [constant @GlobalScope.TYPE_NIL]. + Returns a class name of a typed [Array] of type [constant @GlobalScope.TYPE_OBJECT]. + Returns the script associated with a typed array tied to a class name. @@ -393,11 +397,13 @@ + Returns [code]true[/code] if the array is read-only. See [method set_read_only]. Arrays are automatically read-only if declared with [code]const[/code] keyword. + Returns [code]true[/code] if the array is typed. Typed arrays can only store elements of their associated type and provide type safety for the [code][][/code] operator. Methods of typed array still return [Variant]. @@ -517,6 +523,7 @@ + Makes the [Array] read-only, i.e. disabled modifying of the array's elements. Does not apply to nested content, e.g. content of nested arrays. @@ -525,6 +532,8 @@ + Makes the [Array] typed. The [param type] should be one of the [@GlobalScope] [code]TYPE[/code] constants. [param class_name] is optional and can only be provided for [constant @GlobalScope.TYPE_OBJECT]. [param script] can only be provided if [param class_name] is not empty. + The method fails if an array is already typed. @@ -608,6 +617,7 @@ + Assigns a different [Array] to this array reference. It the array is typed, the new array's type must be compatible and its elements will be automatically converted. diff --git a/doc/classes/Basis.xml b/doc/classes/Basis.xml index 6d9b679fbc..39f1bfbe24 100644 --- a/doc/classes/Basis.xml +++ b/doc/classes/Basis.xml @@ -70,6 +70,7 @@ + Creates a [Basis] from the given [Vector3] representing Euler angles. [param order] determines in what order rotation components are applied. Defaults to [constant EULER_ORDER_YXZ]. @@ -191,16 +192,22 @@ + Euler angle composing/decomposing order where X component is first, then Y, then Z. + Euler angle composing/decomposing order where X component is first, then Z, then Y. + Euler angle composing/decomposing order where Y component is first, then X, then Z. + Euler angle composing/decomposing order where Y component is first, then Z, then X. + Euler angle composing/decomposing order where Z component is first, then X, then Y. + Euler angle composing/decomposing order where Z component is first, then Y, then X. The identity basis, with no rotation or scaling applied. diff --git a/doc/classes/CPUParticles2D.xml b/doc/classes/CPUParticles2D.xml index 906789d09f..7119e231b2 100644 --- a/doc/classes/CPUParticles2D.xml +++ b/doc/classes/CPUParticles2D.xml @@ -29,12 +29,14 @@ + Returns the maximum value range for the given parameter. + Returns the minimum value range for the given parameter. @@ -63,6 +65,7 @@ + Sets the maximum value for the given parameter. @@ -70,6 +73,7 @@ + Sets the minimum value for the given parameter. @@ -89,29 +93,38 @@ Each particle's rotation will be animated along this [Curve]. + Maximum initial rotation applied to each particle, in degrees. + Minimum equivalent of [member angle_max]. Each particle's angular velocity will vary along this [Curve]. + Maximum initial angular velocity (rotation speed) applied to each particle in [i]degrees[/i] per second. + Minimum equivalent of [member angular_velocity_max]. Each particle's animation offset will vary along this [Curve]. + Maximum animation offset that corresponds to frame index in the texture. [code]0[/code] is the first frame, [code]1[/code] is the last one. See [member CanvasItemMaterial.particles_animation]. + Minimum equivalent of [member anim_offset_max]. Each particle's animation speed will vary along this [Curve]. + Maximum particle animation speed. Animation speed of [code]1[/code] means that the particles will make full [code]0[/code] to [code]1[/code] offset cycle during lifetime, [code]2[/code] means [code]2[/code] cycles etc. + With animation speed greater than [code]1[/code], remember to enable [member CanvasItemMaterial.particles_anim_loop] property if you want the animation to repeat. + Minimum equivalent of [member anim_speed_max]. Each particle's initial color. If [member texture] is defined, it will be multiplied by this color. @@ -126,8 +139,10 @@ Damping will vary along this [Curve]. + The maximum rate at which particles lose velocity. For example value of [code]100[/code] means that the particle will go from [code]100[/code] velocity to [code]0[/code] in [code]1[/code] second. + Minimum equivalent of [member damping_max]. Unit vector specifying the particles' emission direction. @@ -172,12 +187,16 @@ Each particle's hue will vary along this [Curve]. + Maximum initial hue variation applied to each particle. It will shift the particle color's hue. + Minimum equivalent of [member hue_variation_max]. + Maximum initial velocity magnitude for each particle. Direction comes from [member direction] and [member spread]. + Minimum equivalent of [member initial_velocity_max]. Amount of time each particle will exist. @@ -189,8 +208,10 @@ Each particle's linear acceleration will vary along this [Curve]. + Maximum linear acceleration applied to each particle in the direction of motion. + Minimum equivalent of [member linear_accel_max]. If [code]true[/code], particles use the parent node's coordinate space (known as local coordinates). This will cause particles to move and rotate along the [CPUParticles2D] node (and its parents) when it is moved or rotated. If [code]false[/code], particles use global coordinates; they will not move or rotate along the [CPUParticles2D] node (and its parents) when it is moved or rotated. @@ -202,8 +223,10 @@ Each particle's orbital velocity will vary along this [Curve]. + Maximum orbital velocity applied to each particle. Makes the particles circle around origin. Specified in number of full rotations around origin per second. + Minimum equivalent of [member orbit_velocity_max]. Align Y axis of particle with the direction of its velocity. @@ -215,8 +238,10 @@ Each particle's radial acceleration will vary along this [Curve]. + Maximum radial acceleration applied to each particle. Makes particle accelerate away from the origin or towards it if negative. + Minimum equivalent of [member radial_accel_max]. Emission lifetime randomness ratio. @@ -225,17 +250,24 @@ Each particle's scale will vary along this [Curve]. + Maximum initial scale applied to each particle. + Minimum equivalent of [member scale_amount_max]. + Each particle's horizontal scale will vary along this [Curve]. + [member split_scale] must be enabled. + Each particle's vertical scale will vary along this [Curve]. + [member split_scale] must be enabled. Particle system's running speed scaling ratio. A value of [code]0[/code] can be used to pause the particles. + If [code]true[/code], the scale curve will be split into x and y components. See [member scale_curve_x] and [member scale_curve_y]. Each particle's initial direction range from [code]+spread[/code] to [code]-spread[/code] degrees. @@ -244,8 +276,10 @@ Each particle's tangential acceleration will vary along this [Curve]. + Maximum tangential acceleration applied to each particle. Tangential acceleration is perpendicular to the particle's velocity giving the particles a swirling motion. + Minimum equivalent of [member tangential_accel_max]. Particle texture. If [code]null[/code], particles will be squares. diff --git a/doc/classes/CPUParticles3D.xml b/doc/classes/CPUParticles3D.xml index 6b39c08b3f..b4414c034e 100644 --- a/doc/classes/CPUParticles3D.xml +++ b/doc/classes/CPUParticles3D.xml @@ -28,12 +28,14 @@ + Returns the maximum value range for the given parameter. + Returns the minimum value range for the given parameter. @@ -62,7 +64,7 @@ - Sets the maximum value for the given parameter + Sets the maximum value for the given parameter. @@ -70,7 +72,7 @@ - Sets the minimum value for the given parameter + Sets the minimum value for the given parameter. diff --git a/doc/classes/Color.xml b/doc/classes/Color.xml index 3a3803c1da..a11d7157f1 100644 --- a/doc/classes/Color.xml +++ b/doc/classes/Color.xml @@ -145,6 +145,11 @@ + Returns the index of a named color. Use [method get_named_color] to get the actual color. + [codeblock] + var idx = Color.find_named_color("khaki") + modulate = Color.get_named_color(idx) + [/codeblock] @@ -187,6 +192,7 @@ + Encodes a [Color] from a RGBE9995 format integer. See [constant Image.FORMAT_RGBE9995]. @@ -194,6 +200,7 @@ + Creates a [Color] from string, which can be either a HTML color code or a named color. Fallbacks to [param default] if the string does not denote any valid color. @@ -208,29 +215,37 @@ + Returns a named color with the given index. You can get the index from [method find_named_color] or iteratively from [method get_named_color_count]. + Returns the number of available named colors. + Returns the name of a color with the given index. You can get the index from [method find_named_color] or iteratively from [method get_named_color_count]. + Returns the [Color] associated with the provided integer number, with 8 bits per channel in ARGB order. The integer should be 32-bit. Best used with hexadecimal notation. + [codeblock] + modulate = Color.hex(0xffff0000) # red + [/codeblock] + Same as [method hex], but takes 64-bit integer and the color uses 16 bits per channel. diff --git a/doc/classes/ColorPicker.xml b/doc/classes/ColorPicker.xml index e992d6f9d4..385a63250b 100644 --- a/doc/classes/ColorPicker.xml +++ b/doc/classes/ColorPicker.xml @@ -110,6 +110,7 @@ The width of the hue selection slider. + The minimum width of the color labels next to sliders. The margin around the [ColorPicker]. @@ -133,8 +134,10 @@ The indicator used to signalize that the color value is outside the 0-1 range. + The image displayed over the color box/circle (depending on the [member picker_shape]), marking the currently selected color. + Background panel for the color preview box (visible when the color is translucent). The icon for the screen color picker button. diff --git a/doc/classes/Dictionary.xml b/doc/classes/Dictionary.xml index a86aff060d..ac1f63af56 100644 --- a/doc/classes/Dictionary.xml +++ b/doc/classes/Dictionary.xml @@ -325,18 +325,21 @@ + Returns [code]true[/code] if the dictionaries differ, i.e. their key or value lists are different (including the order). + Returns [code]true[/code] if both dictionaries have the same contents, i.e. their keys list and value list are equal. + Retunrs a value at the given [param key] or [code]null[/code] and error if the key does not exist. For safe access, use [method get] or [method has]. diff --git a/doc/classes/EditorFileDialog.xml b/doc/classes/EditorFileDialog.xml index 891c8d7d92..51e3706981 100644 --- a/doc/classes/EditorFileDialog.xml +++ b/doc/classes/EditorFileDialog.xml @@ -4,6 +4,7 @@ A modified version of [FileDialog] used by the editor. + [EditorFileDialog] is an enhanced version of [FileDialog] avaiable only to editor plugins. Additional features include list of favorited/recent files and ability to see files as thumbnails grid instead of list. @@ -62,7 +63,7 @@ The dialog's open or save mode, which affects the selection behavior. See [enum FileMode] - If [code]true[/code], hidden files and directories will be visible in the [EditorFileDialog]. + If [code]true[/code], hidden files and directories will be visible in the [EditorFileDialog]. This property is synchronized with [member EditorSettings.filesystem/file_dialog/show_hidden_files]. diff --git a/doc/classes/EditorInterface.xml b/doc/classes/EditorInterface.xml index 1e3b1f07ee..0beb2459a3 100644 --- a/doc/classes/EditorInterface.xml +++ b/doc/classes/EditorInterface.xml @@ -70,6 +70,7 @@ + Returns the [EditorPaths] singleton. diff --git a/doc/classes/EditorPlugin.xml b/doc/classes/EditorPlugin.xml index 563987e2a3..e413c526f4 100644 --- a/doc/classes/EditorPlugin.xml +++ b/doc/classes/EditorPlugin.xml @@ -691,11 +691,13 @@ + Emitted when any project setting has changed. + Emitted when the given [param resource] was saved on disc. diff --git a/doc/classes/EditorProperty.xml b/doc/classes/EditorProperty.xml index 9170c449bf..2aca19510b 100644 --- a/doc/classes/EditorProperty.xml +++ b/doc/classes/EditorProperty.xml @@ -61,6 +61,7 @@ + Forces refresh of the property display. diff --git a/doc/classes/EditorSpinSlider.xml b/doc/classes/EditorSpinSlider.xml index 2ada211dab..9961e11f7d 100644 --- a/doc/classes/EditorSpinSlider.xml +++ b/doc/classes/EditorSpinSlider.xml @@ -10,13 +10,16 @@ + If [code]true[/code], the slider will not draw background. If [code]true[/code], the slider is hidden. + The text that displays to the left of the value. + If [code]true[/code], the slider can't be interacted with. The suffix to display after the value (in a faded color). This should generally be a plural word. You may have to use an abbreviation if the suffix is too long to be displayed. diff --git a/doc/classes/Engine.xml b/doc/classes/Engine.xml index 2b8663e039..821fae37a6 100644 --- a/doc/classes/Engine.xml +++ b/doc/classes/Engine.xml @@ -146,11 +146,13 @@ + Returns an instance of a [ScriptLanguage] with the given index. + Returns the number of available script languages. Use with [method get_script_language]. @@ -163,6 +165,7 @@ + Returns a list of available global singletons. @@ -244,6 +247,7 @@ + Registers a [ScriptLanguage] instance to be available with [code]ScriptServer[/code]. @@ -251,12 +255,14 @@ + Registers the given object as a singleton, globally available under [param name]. + Unregisters the singleton registered under [param name]. The singleton object is not freed. Only works with user-defined singletons created with [method register_singleton]. diff --git a/doc/classes/ParticleProcessMaterial.xml b/doc/classes/ParticleProcessMaterial.xml index a41207e9b3..7fdcbc9800 100644 --- a/doc/classes/ParticleProcessMaterial.xml +++ b/doc/classes/ParticleProcessMaterial.xml @@ -217,7 +217,7 @@ Maximum linear acceleration applied to each particle in the direction of motion. - Minimum equivalent of [member linear_accel_min]. + Minimum equivalent of [member linear_accel_max]. Each particle's orbital velocity will vary along this [CurveTexture]. diff --git a/doc/classes/VSlider.xml b/doc/classes/VSlider.xml index 36954a6912..e1b8742106 100644 --- a/doc/classes/VSlider.xml +++ b/doc/classes/VSlider.xml @@ -30,6 +30,7 @@ The background of the area below the grabber. + The background of the area below the grabber, to the left of the grabber. The background for the whole slider. Determines the width of the [code]grabber_area[/code]. diff --git a/doc/classes/VisibleOnScreenEnabler2D.xml b/doc/classes/VisibleOnScreenEnabler2D.xml index 50d0c00017..8590e9cc9f 100644 --- a/doc/classes/VisibleOnScreenEnabler2D.xml +++ b/doc/classes/VisibleOnScreenEnabler2D.xml @@ -1,23 +1,30 @@ + Automatically disables another node if not visible on screen. + VisibleOnScreenEnabler2D detects when it is visible on screen (just like [VisibleOnScreenNotifier2D]) and automatically enables or disables the target node. The target node is disabled when [VisibleOnScreenEnabler2D] is not visible on screen (including when [member CanvasItem.visible] is [code]false[/code]), and enabled when the enabler is visible. The disabling is achieved by changing [member Node.process_mode]. + Determines how the node is enabled. Corresponds to [enum Node.ProcessMode]. Disabled node uses [constant Node.PROCESS_MODE_DISABLED]. + The path to the target node, relative to the [VisibleOnScreenEnabler2D]. The target node is cached; it's only assigned when setting this property (if the [VisibleOnScreenEnabler2D] is inside scene tree) and every time the [VisibleOnScreenEnabler2D] enters the scene tree. If the path is invalid, nothing will happen. + Corresponds to [constant Node.PROCESS_MODE_INHERIT]. + Corresponds to [constant Node.PROCESS_MODE_ALWAYS]. + Corresponds to [constant Node.PROCESS_MODE_WHEN_PAUSED. -- cgit v1.2.3