diff --git a/doc/base/classes.xml b/doc/base/classes.xml index 7cdec7ab57d..75f28e5c40d 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -5540,16 +5540,16 @@ - The normal state(Are not pressed, not hovered, not toggled and enabled) of buttons. + The normal state (i.e. not pressed, not hovered, not toggled and enabled) of buttons. - The state of buttons are pressed. + The state of buttons are pressed. - The state of buttons are hovered. + The state of buttons are hovered. - The state of buttons are disabled. + The state of buttons are disabled. @@ -5611,6 +5611,130 @@ + + + + + + + + + + + + + + + + + + + Set the total font height (ascent plus descent) in pixels. + + + + + + + Set the font ascent (number of pixels above the baseline). + + + + + + + + + + + Add a kerning pair to the [BitmapFont] as a difference. Kerning pairs are special cases where a typeface advance is determined by the next character. + + + + + + + + + + + Return a kerning pair as a difference. + + + + + + + Add a texture to the [BitmapFont]. + + + + + + + + + + + + + + + Add a character to the font, where [i]character[/i] is the unicode value, [i]texture[/i] is the texture index, [i]rect[/i] is the region in the texture (in pixels!), [i]align[/i] is the (optional) alignment for the character and [i]advance[/i] is the (optional) advance. + + + + + + + + + + + + + + + + + + + + + + + + + Return the size of a character, optionally taking kerning into account if the next character is provided. + + + + + + + + + + + Clear all the font data. + + + + + + + + + + + + + + + + + + @@ -5654,13 +5778,13 @@ - Align children with beginning of the container. + Align children with beginning of the container. - Align children with center of the container. + Align children with center of the container. - Align children with end of the container. + Align children with end of the container. @@ -7037,24 +7161,24 @@ - Tint the entire canvas + Tint the entire canvas - CanvasModulate tints the canvas elements using its asigned color + CanvasModulate tints the canvas elements using its asigned color - Sets the canvas tint color + Sets the canvas tint color - Gets the canvas tint color + Gets the canvas tint color @@ -7153,14 +7277,14 @@ - This function will anchor the container children to the top left corner of the the container boundaries, moving all its children to that position, (the children new center will be the top left corner of the container). + This function will anchor the container children to the top left corner of the the container boundaries, moving all its children to that position, (the children new center will be the top left corner of the container). - Should put children to the top left corner instead of center of the container. + Should put children to the top left corner instead of center of the container. @@ -7169,10 +7293,10 @@ - Binary choice user interface widget + Binary choice user interface widget - A checkbox allows the user to make a binary choice (choosing only one of two posible options), for example Answer 'yes' or 'no'. + A checkbox allows the user to make a binary choice (choosing only one of two posible options), for example Answer 'yes' or 'no'. @@ -8029,35 +8153,35 @@ - When set to true, every color channel will be represented as a value from 0 to 1, insetead of 0, 255. + When set to true, every color channel will be represented as a value from 0 to 1, insetead of 0, 255. - Returns whether this color picker is in raw mode or not + Returns whether this color picker is in raw mode or not - Set true if you want the color to have an alpha channel (transparency), or false if you want a solid color. + Set true if you want the color to have an alpha channel (transparency), or false if you want a solid color. - Returns whether the color has transparency or not. + Returns whether the color has transparency or not. - Adds the current selected to color to a list of colors (presets), the presets will be displayed in the color picker and the user will be able to select them, notice that the presets list is only for this color picker. + Adds the current selected to color to a list of colors (presets), the presets will be displayed in the color picker and the user will be able to select them, notice that the presets list is only for this color picker. @@ -8091,38 +8215,38 @@ - Button that pops out a [ColorPicker] + Button that pops out a [ColorPicker] - Encapsulates a [ColorPicker] making it accesible by pressing a button, pressing the button will toggle the [ColorPicker] visibility + Encapsulates a [ColorPicker] making it accesible by pressing a button, pressing the button will toggle the [ColorPicker] visibility - Sets the current color + Sets the current color - Gets the current color + Gets the current color - See [method ColorPicker.set_edit_alpha] + See [method ColorPicker.set_edit_alpha] - See [method ColorPicker.is_edit_alpha] + See [method ColorPicker.is_edit_alpha] @@ -8131,7 +8255,7 @@ - Emitted when the color is changed. + Emitted when the color is changed. @@ -12151,33 +12275,19 @@ Returns an empty String "" at the end of the list. Font contains an unicode compatible character set, as well as the ability to draw it with variable width, ascent, descent and kerning. For creating fonts from TTF files (or other font formats), see the editor support for fonts. TODO check wikipedia for graph of ascent/baseline/descent/height/etc. - - - - + + + + + + + + + + - - - - - - - Set the total font height (ascent plus descent) in pixels. - - - - - - - Return the total font height (ascent plus descent) in pixels. - - - - - - - Set the font ascent (number of pixels above the baseline). + Draw "string" into a canvas item using the font at a given "pos" position, with "modulate" color, and optionally clipping the width. "pos" specifies the baseline, not the top. To draw from the top, [i]ascent[/i] must be added to the Y axis. @@ -12194,75 +12304,19 @@ Returns an empty String "" at the end of the list. Return the font descent (number of pixels below the baseline). - - - - - - - - - Add a kerning pair to the [Font] as a difference. Kerning pairs are special cases where a typeface advance is determined by the next character. - - - - - - - - - - - Return a kerning pair as a difference. Kerning pairs are special cases where a typeface advance is determined by the next character. - - - - - - - Add a texture to the [Font]. - - - - - - - - - - - - - - - Add a character to the font, where "character" is the unicode value, "texture" is the texture index, "rect" is the region in the texture (in pixels!), "align" is the (optional) alignment for the character and "advance" is the (optional) advance. - - - - + + + Return the total font height (ascent plus descent) in pixels. - - + + - - - - - - - - - - - Return the size of a character, optionally taking kerning into account if the next character is provided. - - @@ -12272,38 +12326,6 @@ Returns an empty String "" at the end of the list. Return the size of a string, taking kerning and advance into account. - - - - - - - - - - - - - - - Clear all the font data. - - - - - - - - - - - - - - - Draw "string" into a canvas item using the font at a given "pos" position, with "modulate" color, and optionally clipping the width. "pos" specifies the baseline, not the top. To draw from the top, [i]ascent[/i] must be added to the Y axis. - - @@ -12321,18 +12343,6 @@ Returns an empty String "" at the end of the list. Draw character "char" into a canvas item using the font at a given "pos" position, with "modulate" color, and optionally kerning if "next" is passed. clipping the width. "pos" specifies the baseline, not the top. To draw from the top, [i]ascent[/i] must be added to the Y axis. The width used by the character is returned, making this function useful for drawing strings character by character. - - - - - - - - - - - - @@ -12401,7 +12411,7 @@ Returns an empty String "" at the end of the list. - Should put children to the top left corner instead of center of the container. + Should put children to the top left corner instead of center of the container. @@ -13476,24 +13486,24 @@ Returns an empty String "" at the end of the list. - Grid container used to arrange elements in a grid like layout + Grid container used to arrange elements in a grid like layout - Grid container will arrange its children in a grid like structure, the grid columns are specified using the [method set_columns] method and the number of rows will be equal to the number of children in the container divided by the number of columns, for example: if the container has 5 children, and 2 columns, there will be 3 rows in the container. Notice that grid layout will preserve the columns and rows for every size of the container. + Grid container will arrange its children in a grid like structure, the grid columns are specified using the [method set_columns] method and the number of rows will be equal to the number of children in the container divided by the number of columns, for example: if the container has 5 children, and 2 columns, there will be 3 rows in the container. Notice that grid layout will preserve the columns and rows for every size of the container. - Sets the numbers of columns in the container, then reorder its children to accommodate the new layout + Sets the numbers of columns in the container, then reorder its children to accommodate the new layout - Returns the number of columns in this container + Returns the number of columns in this container @@ -27260,94 +27270,94 @@ This method controls whether the position between two cached points is interpola - 2D polygon representation + 2D polygon representation - A Polygon2D is defined by a set of n points connected together by line segments, meaning that the point 1 will be connected with point 2, point 2 with point 3 ..., point n-1 with point n and point n with point 1 in order to close the loop and define a plane. + A Polygon2D is defined by a set of n points connected together by line segments, meaning that the point 1 will be connected with point 2, point 2 with point 3 ..., point n-1 with point n and point n with point 1 in order to close the loop and define a plane. - Defines the set of points that will represent the polygon. + Defines the set of points that will represent the polygon. - Returns the set of points that defines this polygon + Returns the set of points that defines this polygon - Sets the uv value for every point of the polygon + Sets the uv value for every point of the polygon - Returns the uv value associated with every point of the polygon + Returns the uv value associated with every point of the polygon - Sets the polygon fill color, if the polygon has a texture defined, the defined texture will be tinted to the polygon fill color. + Sets the polygon fill color, if the polygon has a texture defined, the defined texture will be tinted to the polygon fill color. - Returns the polygon fill color + Returns the polygon fill color - Sets the polygon texture. + Sets the polygon texture. - Returns the polygon texture + Returns the polygon texture - Sets the offset of the polygon texture. Initially the texture will appear anchored to the polygon position, the offset is used to move the texture location away from that point (notice that the texture origin is set to its top left corner, so when offset is 0,0 the top left corner of the texture is at the polygon position), for example setting the offset to 10, 10 will move the texture 10 units to the left and 10 units to the top. + Sets the offset of the polygon texture. Initially the texture will appear anchored to the polygon position, the offset is used to move the texture location away from that point (notice that the texture origin is set to its top left corner, so when offset is 0,0 the top left corner of the texture is at the polygon position), for example setting the offset to 10, 10 will move the texture 10 units to the left and 10 units to the top. - Returns the polygon texture offset + Returns the polygon texture offset - Sets the amount of rotation of the polygon texture, [code]texture_rotation[/code] is specified in degrees and clockwise rotation, meaning that if the texture rotation is set to 45 degrees, the texture will be rotated 45 degrees clockwise along the polygon position plus the texture offset. + Sets the amount of rotation of the polygon texture, [code]texture_rotation[/code] is specified in degrees and clockwise rotation, meaning that if the texture rotation is set to 45 degrees, the texture will be rotated 45 degrees clockwise along the polygon position plus the texture offset. - Returns the rotation in degrees of the texture polygon + Returns the rotation in degrees of the texture polygon @@ -27366,14 +27376,14 @@ This method controls whether the position between two cached points is interpola - Sets the polygon as the defined polygon bounding box minus the defined polygon (the defined polygon will appear as a hole on square that contains the defined polygon). + Sets the polygon as the defined polygon bounding box minus the defined polygon (the defined polygon will appear as a hole on square that contains the defined polygon). - Returns whether this polygon is inverted or not + Returns whether this polygon is inverted or not @@ -27392,14 +27402,14 @@ This method controls whether the position between two cached points is interpola - Sets the amount of distance from the polygon points from the polygon position, for example if the offset is set to 10,10 then all the polygon points will move 10 units to the right and 10 units to the bottom. + Sets the amount of distance from the polygon points from the polygon position, for example if the offset is set to 10,10 then all the polygon points will move 10 units to the right and 10 units to the bottom. - Returns the polygon points offset to the polygon position. + Returns the polygon points offset to the polygon position. @@ -28625,38 +28635,38 @@ This method controls whether the position between two cached points is interpola - Query the closest object intersecting a ray + Query the closest object intersecting a ray - A RayCast2D represents a line from its origin to its destination position [code]cast_to[/code], it is used to query the 2D space in order to find the closest object intersecting with the ray. + A RayCast2D represents a line from its origin to its destination position [code]cast_to[/code], it is used to query the 2D space in order to find the closest object intersecting with the ray. - Enables the RayCast2D. Only enabled raycasts will be able to query the space and report collisions. + Enables the RayCast2D. Only enabled raycasts will be able to query the space and report collisions. - Returns whether this raycast is enabled or not + Returns whether this raycast is enabled or not - Sets the ray destination point, so that the ray will test from the ray's origin to [code]local_point[/code] + Sets the ray destination point, so that the ray will test from the ray's origin to [code]local_point[/code] - Return the destination point of this ray object + Return the destination point of this ray object @@ -28677,21 +28687,21 @@ This method controls whether the position between two cached points is interpola - Returns the collision shape of the closest object the ray is pointing to. + Returns the collision shape of the closest object the ray is pointing to. - Returns the collision point in which the ray intersects the closest object. + Returns the collision point in which the ray intersects the closest object. - Returns the normal of the intersecting object shape face containing the collision point. + Returns the normal of the intersecting object shape face containing the collision point. @@ -28704,7 +28714,7 @@ This method controls whether the position between two cached points is interpola - Adds a collision exception so the ray does not report collisions with the specified [code]node[/code]. + Adds a collision exception so the ray does not report collisions with the specified [code]node[/code]. @@ -28717,12 +28727,12 @@ This method controls whether the position between two cached points is interpola - Removes a collision exception so the ray does report collisions with the specified [code]node[/code]. + Removes a collision exception so the ray does report collisions with the specified [code]node[/code]. - Removes all collision exception for this ray. + Removes all collision exception for this ray. @@ -28735,7 +28745,7 @@ This method controls whether the position between two cached points is interpola - Returns the layer mask for this ray. + Returns the layer mask for this ray. @@ -30194,7 +30204,7 @@ This method controls whether the position between two cached points is interpola - Return the body's moment of inertia. This is usually automatically computed from the mass and the shapes. Note that this doesn't seem to work in a [code]_ready[/code] function: it apparently has not been auto-computed yet. + Return the body's moment of inertia. This is usually automatically computed from the mass and the shapes. Note that this doesn't seem to work in a [code]_ready[/code] function: it apparently has not been auto-computed yet. @@ -34283,7 +34293,7 @@ This method controls whether the position between two cached points is interpola - Set visibility of the split dragger([i]mode[/i] must be one of [DRAGGER_VISIBLE], [DRAGGER_HIDDEN] or [DRAGGER_HIDDEN_COLLAPSED]). + Set visibility of the split dragger([i]mode[/i] must be one of [DRAGGER_VISIBLE], [DRAGGER_HIDDEN] or [DRAGGER_HIDDEN_COLLAPSED]). @@ -34305,13 +34315,13 @@ This method controls whether the position between two cached points is interpola - The split dragger is visible. + The split dragger is visible. - The split dragger is invisible. + The split dragger is invisible. - The split dragger is invisible and collapsed. + The split dragger is invisible and collapsed. @@ -40383,7 +40393,7 @@ This method controls whether the position between two cached points is interpola Vector used for 2D Math. - 2-element structure that can be used to represent positions in 2d-space, or any other pair of numeric values. + 2-element structure that can be used to represent positions in 2d-space, or any other pair of numeric values. @@ -40564,16 +40574,12 @@ This method controls whether the position between two cached points is interpola - The X axis value when treated as point(The first value in the pair). - The Y axis value when treated as point(The second value in the pair). - The width value when treated as size(The first value in the pair). - The height value when treated as size(The second value in the pair).