classref: Run doctool and merge BitmapFont
BitmapFont was split from the Font class, so the relevant method descriptions were readded manually.
This commit is contained in:
Rémi Verschelde
parent
6aae63fce2
commit
18c09acf9f
1 changed files with 209 additions and 203 deletions
|
|
@ -5540,16 +5540,16 @@
|
|||
</signals>
|
||||
<constants>
|
||||
<constant name="DRAW_NORMAL" value="0">
|
||||
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.
|
||||
</constant>
|
||||
<constant name="DRAW_PRESSED" value="1">
|
||||
The state of buttons are pressed.
|
||||
The state of buttons are pressed.
|
||||
</constant>
|
||||
<constant name="DRAW_HOVER" value="2">
|
||||
The state of buttons are hovered.
|
||||
The state of buttons are hovered.
|
||||
</constant>
|
||||
<constant name="DRAW_DISABLED" value="3">
|
||||
The state of buttons are disabled.
|
||||
The state of buttons are disabled.
|
||||
</constant>
|
||||
</constants>
|
||||
</class>
|
||||
|
|
@ -5611,6 +5611,130 @@
|
|||
<constants>
|
||||
</constants>
|
||||
</class>
|
||||
<class name="BitmapFont" inherits="Font" category="Core">
|
||||
<brief_description>
|
||||
</brief_description>
|
||||
<description>
|
||||
</description>
|
||||
<methods>
|
||||
<method name="create_from_fnt">
|
||||
<return type="int">
|
||||
</return>
|
||||
<argument index="0" name="path" type="String">
|
||||
</argument>
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_height">
|
||||
<argument index="0" name="px" type="float">
|
||||
</argument>
|
||||
<description>
|
||||
Set the total font height (ascent plus descent) in pixels.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_ascent">
|
||||
<argument index="0" name="px" type="float">
|
||||
</argument>
|
||||
<description>
|
||||
Set the font ascent (number of pixels above the baseline).
|
||||
</description>
|
||||
</method>
|
||||
<method name="add_kerning_pair">
|
||||
<argument index="0" name="char_a" type="int">
|
||||
</argument>
|
||||
<argument index="1" name="char_b" type="int">
|
||||
</argument>
|
||||
<argument index="2" name="kerning" type="int">
|
||||
</argument>
|
||||
<description>
|
||||
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.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_kerning_pair" qualifiers="const">
|
||||
<return type="int">
|
||||
</return>
|
||||
<argument index="0" name="char_a" type="int">
|
||||
</argument>
|
||||
<argument index="1" name="char_b" type="int">
|
||||
</argument>
|
||||
<description>
|
||||
Return a kerning pair as a difference.
|
||||
</description>
|
||||
</method>
|
||||
<method name="add_texture">
|
||||
<argument index="0" name="texture" type="Texture">
|
||||
</argument>
|
||||
<description>
|
||||
Add a texture to the [BitmapFont].
|
||||
</description>
|
||||
</method>
|
||||
<method name="add_char">
|
||||
<argument index="0" name="character" type="int">
|
||||
</argument>
|
||||
<argument index="1" name="texture" type="int">
|
||||
</argument>
|
||||
<argument index="2" name="rect" type="Rect2">
|
||||
</argument>
|
||||
<argument index="3" name="align" type="Vector2" default="Vector2(0,0)">
|
||||
</argument>
|
||||
<argument index="4" name="advance" type="float" default="-1">
|
||||
</argument>
|
||||
<description>
|
||||
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.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_texture_count" qualifiers="const">
|
||||
<return type="int">
|
||||
</return>
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_texture" qualifiers="const">
|
||||
<return type="Texture">
|
||||
</return>
|
||||
<argument index="0" name="idx" type="int">
|
||||
</argument>
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_char_size" qualifiers="const">
|
||||
<return type="Vector2">
|
||||
</return>
|
||||
<argument index="0" name="char" type="int">
|
||||
</argument>
|
||||
<argument index="1" name="next" type="int" default="0">
|
||||
</argument>
|
||||
<description>
|
||||
Return the size of a character, optionally taking kerning into account if the next character is provided.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_distance_field_hint">
|
||||
<argument index="0" name="enable" type="bool">
|
||||
</argument>
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="clear">
|
||||
<description>
|
||||
Clear all the font data.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_fallback">
|
||||
<argument index="0" name="fallback" type="Object">
|
||||
</argument>
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_fallback" qualifiers="const">
|
||||
<return type="Object">
|
||||
</return>
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
</methods>
|
||||
<constants>
|
||||
</constants>
|
||||
</class>
|
||||
<class name="BoneAttachment" inherits="Spatial" category="Core">
|
||||
<brief_description>
|
||||
</brief_description>
|
||||
|
|
@ -5654,13 +5778,13 @@
|
|||
</methods>
|
||||
<constants>
|
||||
<constant name="ALIGN_BEGIN" value="0">
|
||||
Align children with beginning of the container.
|
||||
Align children with beginning of the container.
|
||||
</constant>
|
||||
<constant name="ALIGN_CENTER" value="1">
|
||||
Align children with center of the container.
|
||||
Align children with center of the container.
|
||||
</constant>
|
||||
<constant name="ALIGN_END" value="2">
|
||||
Align children with end of the container.
|
||||
Align children with end of the container.
|
||||
</constant>
|
||||
</constants>
|
||||
</class>
|
||||
|
|
@ -7037,24 +7161,24 @@
|
|||
</class>
|
||||
<class name="CanvasModulate" inherits="Node2D" category="Core">
|
||||
<brief_description>
|
||||
Tint the entire canvas
|
||||
Tint the entire canvas
|
||||
</brief_description>
|
||||
<description>
|
||||
CanvasModulate tints the canvas elements using its asigned color
|
||||
CanvasModulate tints the canvas elements using its asigned color
|
||||
</description>
|
||||
<methods>
|
||||
<method name="set_color">
|
||||
<argument index="0" name="color" type="Color">
|
||||
</argument>
|
||||
<description>
|
||||
Sets the canvas tint color
|
||||
Sets the canvas tint color
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_color" qualifiers="const">
|
||||
<return type="Color">
|
||||
</return>
|
||||
<description>
|
||||
Gets the canvas tint color
|
||||
Gets the canvas tint color
|
||||
</description>
|
||||
</method>
|
||||
</methods>
|
||||
|
|
@ -7153,14 +7277,14 @@
|
|||
<argument index="0" name="enable" type="bool">
|
||||
</argument>
|
||||
<description>
|
||||
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).
|
||||
</description>
|
||||
</method>
|
||||
<method name="is_using_top_left" qualifiers="const">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<description>
|
||||
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.
|
||||
</description>
|
||||
</method>
|
||||
</methods>
|
||||
|
|
@ -7169,10 +7293,10 @@
|
|||
</class>
|
||||
<class name="CheckBox" inherits="Button" category="Core">
|
||||
<brief_description>
|
||||
Binary choice user interface widget
|
||||
Binary choice user interface widget
|
||||
</brief_description>
|
||||
<description>
|
||||
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'.
|
||||
</description>
|
||||
<methods>
|
||||
</methods>
|
||||
|
|
@ -8029,35 +8153,35 @@
|
|||
<argument index="0" name="mode" type="bool">
|
||||
</argument>
|
||||
<description>
|
||||
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.
|
||||
</description>
|
||||
</method>
|
||||
<method name="is_raw_mode" qualifiers="const">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<description>
|
||||
Returns whether this color picker is in raw mode or not
|
||||
Returns whether this color picker is in raw mode or not
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_edit_alpha">
|
||||
<argument index="0" name="show" type="bool">
|
||||
</argument>
|
||||
<description>
|
||||
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.
|
||||
</description>
|
||||
</method>
|
||||
<method name="is_editing_alpha" qualifiers="const">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<description>
|
||||
Returns whether the color has transparency or not.
|
||||
Returns whether the color has transparency or not.
|
||||
</description>
|
||||
</method>
|
||||
<method name="add_preset">
|
||||
<argument index="0" name="arg0" type="Color">
|
||||
</argument>
|
||||
<description>
|
||||
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.
|
||||
</description>
|
||||
</method>
|
||||
</methods>
|
||||
|
|
@ -8091,38 +8215,38 @@
|
|||
</class>
|
||||
<class name="ColorPickerButton" inherits="Button" category="Core">
|
||||
<brief_description>
|
||||
Button that pops out a [ColorPicker]
|
||||
Button that pops out a [ColorPicker]
|
||||
</brief_description>
|
||||
<description>
|
||||
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
|
||||
</description>
|
||||
<methods>
|
||||
<method name="set_color">
|
||||
<argument index="0" name="color" type="Color">
|
||||
</argument>
|
||||
<description>
|
||||
Sets the current color
|
||||
Sets the current color
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_color" qualifiers="const">
|
||||
<return type="Color">
|
||||
</return>
|
||||
<description>
|
||||
Gets the current color
|
||||
Gets the current color
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_edit_alpha">
|
||||
<argument index="0" name="show" type="bool">
|
||||
</argument>
|
||||
<description>
|
||||
See [method ColorPicker.set_edit_alpha]
|
||||
See [method ColorPicker.set_edit_alpha]
|
||||
</description>
|
||||
</method>
|
||||
<method name="is_editing_alpha" qualifiers="const">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<description>
|
||||
See [method ColorPicker.is_edit_alpha]
|
||||
See [method ColorPicker.is_edit_alpha]
|
||||
</description>
|
||||
</method>
|
||||
</methods>
|
||||
|
|
@ -8131,7 +8255,7 @@
|
|||
<argument index="0" name="color" type="Color">
|
||||
</argument>
|
||||
<description>
|
||||
Emitted when the color is changed.
|
||||
Emitted when the color is changed.
|
||||
</description>
|
||||
</signal>
|
||||
</signals>
|
||||
|
|
@ -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.
|
||||
</description>
|
||||
<methods>
|
||||
<method name="create_from_fnt">
|
||||
<return type="int">
|
||||
</return>
|
||||
<argument index="0" name="path" type="String">
|
||||
<method name="draw" qualifiers="const">
|
||||
<argument index="0" name="canvas_item" type="RID">
|
||||
</argument>
|
||||
<argument index="1" name="pos" type="Vector2">
|
||||
</argument>
|
||||
<argument index="2" name="string" type="String">
|
||||
</argument>
|
||||
<argument index="3" name="modulate" type="Color" default="Color(1,1,1,1)">
|
||||
</argument>
|
||||
<argument index="4" name="clip_w" type="int" default="-1">
|
||||
</argument>
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_height">
|
||||
<argument index="0" name="px" type="float">
|
||||
</argument>
|
||||
<description>
|
||||
Set the total font height (ascent plus descent) in pixels.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_height" qualifiers="const">
|
||||
<return type="float">
|
||||
</return>
|
||||
<description>
|
||||
Return the total font height (ascent plus descent) in pixels.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_ascent">
|
||||
<argument index="0" name="px" type="float">
|
||||
</argument>
|
||||
<description>
|
||||
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.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_ascent" qualifiers="const">
|
||||
|
|
@ -12194,75 +12304,19 @@ Returns an empty String "" at the end of the list.
|
|||
Return the font descent (number of pixels below the baseline).
|
||||
</description>
|
||||
</method>
|
||||
<method name="add_kerning_pair">
|
||||
<argument index="0" name="char_a" type="int">
|
||||
</argument>
|
||||
<argument index="1" name="char_b" type="int">
|
||||
</argument>
|
||||
<argument index="2" name="kerning" type="int">
|
||||
</argument>
|
||||
<description>
|
||||
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.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_kerning_pair" qualifiers="const">
|
||||
<return type="int">
|
||||
</return>
|
||||
<argument index="0" name="char_a" type="int">
|
||||
</argument>
|
||||
<argument index="1" name="char_b" type="int">
|
||||
</argument>
|
||||
<description>
|
||||
Return a kerning pair as a difference. Kerning pairs are special cases where a typeface advance is determined by the next character.
|
||||
</description>
|
||||
</method>
|
||||
<method name="add_texture">
|
||||
<argument index="0" name="texture" type="Texture">
|
||||
</argument>
|
||||
<description>
|
||||
Add a texture to the [Font].
|
||||
</description>
|
||||
</method>
|
||||
<method name="add_char">
|
||||
<argument index="0" name="character" type="int">
|
||||
</argument>
|
||||
<argument index="1" name="texture" type="int">
|
||||
</argument>
|
||||
<argument index="2" name="rect" type="Rect2">
|
||||
</argument>
|
||||
<argument index="3" name="align" type="Vector2" default="Vector2(0,0)">
|
||||
</argument>
|
||||
<argument index="4" name="advance" type="float" default="-1">
|
||||
</argument>
|
||||
<description>
|
||||
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.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_texture_count" qualifiers="const">
|
||||
<return type="int">
|
||||
<method name="get_height" qualifiers="const">
|
||||
<return type="float">
|
||||
</return>
|
||||
<description>
|
||||
Return the total font height (ascent plus descent) in pixels.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_texture" qualifiers="const">
|
||||
<return type="Texture">
|
||||
<method name="is_distance_field_hint" qualifiers="const">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<argument index="0" name="idx" type="int">
|
||||
</argument>
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_char_size" qualifiers="const">
|
||||
<return type="Vector2">
|
||||
</return>
|
||||
<argument index="0" name="char" type="int">
|
||||
</argument>
|
||||
<argument index="1" name="next" type="int" default="0">
|
||||
</argument>
|
||||
<description>
|
||||
Return the size of a character, optionally taking kerning into account if the next character is provided.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_string_size" qualifiers="const">
|
||||
<return type="Vector2">
|
||||
</return>
|
||||
|
|
@ -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.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_distance_field_hint">
|
||||
<argument index="0" name="enable" type="bool">
|
||||
</argument>
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="is_distance_field_hint" qualifiers="const">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="clear">
|
||||
<description>
|
||||
Clear all the font data.
|
||||
</description>
|
||||
</method>
|
||||
<method name="draw" qualifiers="const">
|
||||
<argument index="0" name="canvas_item" type="RID">
|
||||
</argument>
|
||||
<argument index="1" name="pos" type="Vector2">
|
||||
</argument>
|
||||
<argument index="2" name="string" type="String">
|
||||
</argument>
|
||||
<argument index="3" name="modulate" type="Color" default="Color(1,1,1,1)">
|
||||
</argument>
|
||||
<argument index="4" name="clip_w" type="int" default="-1">
|
||||
</argument>
|
||||
<description>
|
||||
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.
|
||||
</description>
|
||||
</method>
|
||||
<method name="draw_char" qualifiers="const">
|
||||
<return type="float">
|
||||
</return>
|
||||
|
|
@ -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.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_fallback">
|
||||
<argument index="0" name="fallback" type="Object">
|
||||
</argument>
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_fallback" qualifiers="const">
|
||||
<return type="Object">
|
||||
</return>
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
</methods>
|
||||
<constants>
|
||||
</constants>
|
||||
|
|
@ -12401,7 +12411,7 @@ Returns an empty String "" at the end of the list.
|
|||
<return type="bool">
|
||||
</return>
|
||||
<description>
|
||||
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.
|
||||
</description>
|
||||
</method>
|
||||
</methods>
|
||||
|
|
@ -13476,24 +13486,24 @@ Returns an empty String "" at the end of the list.
|
|||
</class>
|
||||
<class name="GridContainer" inherits="Container" category="Core">
|
||||
<brief_description>
|
||||
Grid container used to arrange elements in a grid like layout
|
||||
Grid container used to arrange elements in a grid like layout
|
||||
</brief_description>
|
||||
<description>
|
||||
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.
|
||||
</description>
|
||||
<methods>
|
||||
<method name="set_columns">
|
||||
<argument index="0" name="columns" type="int">
|
||||
</argument>
|
||||
<description>
|
||||
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
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_columns" qualifiers="const">
|
||||
<return type="int">
|
||||
</return>
|
||||
<description>
|
||||
Returns the number of columns in this container
|
||||
Returns the number of columns in this container
|
||||
</description>
|
||||
</method>
|
||||
</methods>
|
||||
|
|
@ -27260,94 +27270,94 @@ This method controls whether the position between two cached points is interpola
|
|||
</class>
|
||||
<class name="Polygon2D" inherits="Node2D" category="Core">
|
||||
<brief_description>
|
||||
2D polygon representation
|
||||
2D polygon representation
|
||||
</brief_description>
|
||||
<description>
|
||||
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.
|
||||
</description>
|
||||
<methods>
|
||||
<method name="set_polygon">
|
||||
<argument index="0" name="polygon" type="Vector2Array">
|
||||
</argument>
|
||||
<description>
|
||||
Defines the set of points that will represent the polygon.
|
||||
Defines the set of points that will represent the polygon.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_polygon" qualifiers="const">
|
||||
<return type="Vector2Array">
|
||||
</return>
|
||||
<description>
|
||||
Returns the set of points that defines this polygon
|
||||
Returns the set of points that defines this polygon
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_uv">
|
||||
<argument index="0" name="uv" type="Vector2Array">
|
||||
</argument>
|
||||
<description>
|
||||
Sets the uv value for every point of the polygon
|
||||
Sets the uv value for every point of the polygon
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_uv" qualifiers="const">
|
||||
<return type="Vector2Array">
|
||||
</return>
|
||||
<description>
|
||||
Returns the uv value associated with every point of the polygon
|
||||
Returns the uv value associated with every point of the polygon
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_color">
|
||||
<argument index="0" name="color" type="Color">
|
||||
</argument>
|
||||
<description>
|
||||
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.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_color" qualifiers="const">
|
||||
<return type="Color">
|
||||
</return>
|
||||
<description>
|
||||
Returns the polygon fill color
|
||||
Returns the polygon fill color
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_texture">
|
||||
<argument index="0" name="texture" type="Object">
|
||||
</argument>
|
||||
<description>
|
||||
Sets the polygon texture.
|
||||
Sets the polygon texture.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_texture" qualifiers="const">
|
||||
<return type="Object">
|
||||
</return>
|
||||
<description>
|
||||
Returns the polygon texture
|
||||
Returns the polygon texture
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_texture_offset">
|
||||
<argument index="0" name="texture_offset" type="Vector2">
|
||||
</argument>
|
||||
<description>
|
||||
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.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_texture_offset" qualifiers="const">
|
||||
<return type="Vector2">
|
||||
</return>
|
||||
<description>
|
||||
Returns the polygon texture offset
|
||||
Returns the polygon texture offset
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_texture_rotation">
|
||||
<argument index="0" name="texture_rotation" type="float">
|
||||
</argument>
|
||||
<description>
|
||||
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.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_texture_rotation" qualifiers="const">
|
||||
<return type="float">
|
||||
</return>
|
||||
<description>
|
||||
Returns the rotation in degrees of the texture polygon
|
||||
Returns the rotation in degrees of the texture polygon
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_texture_scale">
|
||||
|
|
@ -27366,14 +27376,14 @@ This method controls whether the position between two cached points is interpola
|
|||
<argument index="0" name="invert" type="bool">
|
||||
</argument>
|
||||
<description>
|
||||
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).
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_invert" qualifiers="const">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<description>
|
||||
Returns whether this polygon is inverted or not
|
||||
Returns whether this polygon is inverted or not
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_invert_border">
|
||||
|
|
@ -27392,14 +27402,14 @@ This method controls whether the position between two cached points is interpola
|
|||
<argument index="0" name="offset" type="Vector2">
|
||||
</argument>
|
||||
<description>
|
||||
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.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_offset" qualifiers="const">
|
||||
<return type="Vector2">
|
||||
</return>
|
||||
<description>
|
||||
Returns the polygon points offset to the polygon position.
|
||||
Returns the polygon points offset to the polygon position.
|
||||
</description>
|
||||
</method>
|
||||
</methods>
|
||||
|
|
@ -28625,38 +28635,38 @@ This method controls whether the position between two cached points is interpola
|
|||
</class>
|
||||
<class name="RayCast2D" inherits="Node2D" category="Core">
|
||||
<brief_description>
|
||||
Query the closest object intersecting a ray
|
||||
Query the closest object intersecting a ray
|
||||
</brief_description>
|
||||
<description>
|
||||
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.
|
||||
</description>
|
||||
<methods>
|
||||
<method name="set_enabled">
|
||||
<argument index="0" name="enabled" type="bool">
|
||||
</argument>
|
||||
<description>
|
||||
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.
|
||||
</description>
|
||||
</method>
|
||||
<method name="is_enabled" qualifiers="const">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<description>
|
||||
Returns whether this raycast is enabled or not
|
||||
Returns whether this raycast is enabled or not
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_cast_to">
|
||||
<argument index="0" name="local_point" type="Vector2">
|
||||
</argument>
|
||||
<description>
|
||||
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]
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_cast_to" qualifiers="const">
|
||||
<return type="Vector2">
|
||||
</return>
|
||||
<description>
|
||||
Return the destination point of this ray object
|
||||
Return the destination point of this ray object
|
||||
</description>
|
||||
</method>
|
||||
<method name="is_colliding" qualifiers="const">
|
||||
|
|
@ -28677,21 +28687,21 @@ This method controls whether the position between two cached points is interpola
|
|||
<return type="int">
|
||||
</return>
|
||||
<description>
|
||||
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.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_collision_point" qualifiers="const">
|
||||
<return type="Vector2">
|
||||
</return>
|
||||
<description>
|
||||
Returns the collision point in which the ray intersects the closest object.
|
||||
Returns the collision point in which the ray intersects the closest object.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_collision_normal" qualifiers="const">
|
||||
<return type="Vector2">
|
||||
</return>
|
||||
<description>
|
||||
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.
|
||||
</description>
|
||||
</method>
|
||||
<method name="add_exception_rid">
|
||||
|
|
@ -28704,7 +28714,7 @@ This method controls whether the position between two cached points is interpola
|
|||
<argument index="0" name="node" type="Object">
|
||||
</argument>
|
||||
<description>
|
||||
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].
|
||||
</description>
|
||||
</method>
|
||||
<method name="remove_exception_rid">
|
||||
|
|
@ -28717,12 +28727,12 @@ This method controls whether the position between two cached points is interpola
|
|||
<argument index="0" name="node" type="Object">
|
||||
</argument>
|
||||
<description>
|
||||
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].
|
||||
</description>
|
||||
</method>
|
||||
<method name="clear_exceptions">
|
||||
<description>
|
||||
Removes all collision exception for this ray.
|
||||
Removes all collision exception for this ray.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_layer_mask">
|
||||
|
|
@ -28735,7 +28745,7 @@ This method controls whether the position between two cached points is interpola
|
|||
<return type="int">
|
||||
</return>
|
||||
<description>
|
||||
Returns the layer mask for this ray.
|
||||
Returns the layer mask for this ray.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_type_mask">
|
||||
|
|
@ -30194,7 +30204,7 @@ This method controls whether the position between two cached points is interpola
|
|||
<return type="float">
|
||||
</return>
|
||||
<description>
|
||||
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.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_inertia">
|
||||
|
|
@ -34283,7 +34293,7 @@ This method controls whether the position between two cached points is interpola
|
|||
<argument index="0" name="mode" type="int">
|
||||
</argument>
|
||||
<description>
|
||||
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]).
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_dragger_visibility" qualifiers="const">
|
||||
|
|
@ -34305,13 +34315,13 @@ This method controls whether the position between two cached points is interpola
|
|||
</signals>
|
||||
<constants>
|
||||
<constant name="DRAGGER_VISIBLE" value="0">
|
||||
The split dragger is visible.
|
||||
The split dragger is visible.
|
||||
</constant>
|
||||
<constant name="DRAGGER_HIDDEN" value="1">
|
||||
The split dragger is invisible.
|
||||
The split dragger is invisible.
|
||||
</constant>
|
||||
<constant name="DRAGGER_HIDDEN_COLLAPSED" value="2">
|
||||
The split dragger is invisible and collapsed.
|
||||
The split dragger is invisible and collapsed.
|
||||
</constant>
|
||||
</constants>
|
||||
</class>
|
||||
|
|
@ -40383,7 +40393,7 @@ This method controls whether the position between two cached points is interpola
|
|||
Vector used for 2D Math.
|
||||
</brief_description>
|
||||
<description>
|
||||
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.
|
||||
</description>
|
||||
<methods>
|
||||
<method name="angle">
|
||||
|
|
@ -40564,16 +40574,12 @@ This method controls whether the position between two cached points is interpola
|
|||
</methods>
|
||||
<members>
|
||||
<member name="x" type="float">
|
||||
The X axis value when treated as point(The first value in the pair).
|
||||
</member>
|
||||
<member name="y" type="float">
|
||||
The Y axis value when treated as point(The second value in the pair).
|
||||
</member>
|
||||
<member name="width" type="float">
|
||||
The width value when treated as size(The first value in the pair).
|
||||
</member>
|
||||
<member name="height" type="float">
|
||||
The height value when treated as size(The second value in the pair).
|
||||
</member>
|
||||
</members>
|
||||
<constants>
|
||||
|
|
|
|||
Loading…
Reference in a new issue