summaryrefslogtreecommitdiff
path: root/doc/classes
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes')
-rw-r--r--doc/classes/@GDScript.xml5
-rw-r--r--doc/classes/CanvasLayer.xml6
-rw-r--r--doc/classes/Control.xml6
-rw-r--r--doc/classes/LineEdit.xml19
-rw-r--r--doc/classes/Node2D.xml12
-rw-r--r--doc/classes/Polygon2D.xml2
-rw-r--r--doc/classes/Spatial.xml10
-rw-r--r--doc/classes/TextEdit.xml29
-rw-r--r--doc/classes/VisualScriptMathConstant.xml8
9 files changed, 74 insertions, 23 deletions
diff --git a/doc/classes/@GDScript.xml b/doc/classes/@GDScript.xml
index 9c1d9a1aa2..3c794a4c4c 100644
--- a/doc/classes/@GDScript.xml
+++ b/doc/classes/@GDScript.xml
@@ -1117,7 +1117,10 @@
</methods>
<constants>
<constant name="PI" value="3.141593" enum="">
- Constant that represents how many times the diameter of a circumference fits around its perimeter.
+ Constant that represents how many times the diameter of a circle fits around its perimeter.
+ </constant>
+ <constant name="TAU" value="6.2831853" enum="">
+ The circle constant, the circumference of the unit circle.
</constant>
<constant name="INF" value="inf" enum="">
A positive infinity. (For negative infinity, use -INF).
diff --git a/doc/classes/CanvasLayer.xml b/doc/classes/CanvasLayer.xml
index c3f2e43892..f89c4ea754 100644
--- a/doc/classes/CanvasLayer.xml
+++ b/doc/classes/CanvasLayer.xml
@@ -38,7 +38,7 @@
Return the base rotation for this layer in radians (helper).
</description>
</method>
- <method name="get_rotationd" qualifiers="const">
+ <method name="get_rotation_degrees" qualifiers="const">
<return type="float">
</return>
<description>
@@ -101,7 +101,7 @@
Set the base rotation for this layer in radians (helper).
</description>
</method>
- <method name="set_rotationd">
+ <method name="set_rotation_degrees">
<return type="void">
</return>
<argument index="0" name="degrees" type="float">
@@ -136,7 +136,7 @@
<member name="offset" type="Vector2" setter="set_offset" getter="get_offset">
The layer's base offset.
</member>
- <member name="rotation" type="float" setter="set_rotationd" getter="get_rotationd">
+ <member name="rotation" type="float" setter="set_rotation_degrees" getter="get_rotation_degrees">
The layer's rotation in degrees.
</member>
<member name="scale" type="Vector2" setter="set_scale" getter="get_scale">
diff --git a/doc/classes/Control.xml b/doc/classes/Control.xml
index e3d29c2e93..b5765ac948 100644
--- a/doc/classes/Control.xml
+++ b/doc/classes/Control.xml
@@ -347,7 +347,7 @@
Return the rotation (in radians)
</description>
</method>
- <method name="get_rotation_deg" qualifiers="const">
+ <method name="get_rotation_degrees" qualifiers="const">
<return type="float">
</return>
<description>
@@ -763,7 +763,7 @@
Set the rotation (in radians).
</description>
</method>
- <method name="set_rotation_deg">
+ <method name="set_rotation_degrees">
<return type="void">
</return>
<argument index="0" name="degrees" type="float">
@@ -910,7 +910,7 @@
<member name="rect_position" type="Vector2" setter="set_position" getter="get_position">
The node's position, relative to its parent. It corresponds to the rectangle's top-left corner. The property is not affected by [member rect_pivot_offset].
</member>
- <member name="rect_rotation" type="float" setter="set_rotation_deg" getter="get_rotation_deg">
+ <member name="rect_rotation" type="float" setter="set_rotation_degrees" getter="get_rotation_degrees">
The node's rotation around its pivot, in degrees. See [member rect_pivot_offset] to change the pivot's position.
</member>
<member name="rect_scale" type="Vector2" setter="set_scale" getter="get_scale">
diff --git a/doc/classes/LineEdit.xml b/doc/classes/LineEdit.xml
index 850f724714..bf81d90efe 100644
--- a/doc/classes/LineEdit.xml
+++ b/doc/classes/LineEdit.xml
@@ -114,6 +114,13 @@
Return the text in the [code]LineEdit[/code].
</description>
</method>
+ <method name="is_context_menu_enabled" qualifiers="const">
+ <return type="bool">
+ </return>
+ <description>
+ Returns true if the context menu is enabled.
+ </description>
+ </method>
<method name="is_editable" qualifiers="const">
<return type="bool">
</return>
@@ -170,6 +177,15 @@
Set text alignment of the [code]LineEdit[/code].
</description>
</method>
+ <method name="set_context_menu_enabled">
+ <return type="void">
+ </return>
+ <argument index="0" name="enabled" type="bool">
+ </argument>
+ <description>
+ Set the status of the context menu. When enabled, the context menu will appear when the [code]LineEdit[/code] is right clicked.
+ </description>
+ </method>
<method name="set_cursor_position">
<return type="void">
</return>
@@ -276,6 +292,9 @@
<member name="text" type="String" setter="set_text" getter="get_text">
String value of the [LineEdit].
</member>
+ <member name="context_menu_enabled" type="bool" setter="set_context_menu_enabled" getter="is_context_menu_enabled">
+ If [code]true[/code] the context menu will appear when right clicked.
+ </member>
</members>
<signals>
<signal name="text_changed">
diff --git a/doc/classes/Node2D.xml b/doc/classes/Node2D.xml
index 669a0fb9ff..2fdc6bf440 100644
--- a/doc/classes/Node2D.xml
+++ b/doc/classes/Node2D.xml
@@ -52,7 +52,7 @@
Returns the node's global rotation in radians.
</description>
</method>
- <method name="get_global_rotation_in_degrees" qualifiers="const">
+ <method name="get_global_rotation_degrees" qualifiers="const">
<return type="float">
</return>
<description>
@@ -89,7 +89,7 @@
Returns the node's rotation in radians.
</description>
</method>
- <method name="get_rotation_in_degrees" qualifiers="const">
+ <method name="get_rotation_degrees" qualifiers="const">
<return type="float">
</return>
<description>
@@ -184,7 +184,7 @@
Sets the node's global rotation in radians.
</description>
</method>
- <method name="set_global_rotation_in_degrees">
+ <method name="set_global_rotation_degrees">
<return type="void">
</return>
<argument index="0" name="degrees" type="float">
@@ -229,7 +229,7 @@
Sets the node's rotation in radians.
</description>
</method>
- <method name="set_rotation_in_degrees">
+ <method name="set_rotation_degrees">
<return type="void">
</return>
<argument index="0" name="degrees" type="float">
@@ -309,7 +309,7 @@
<member name="global_rotation" type="float" setter="set_global_rotation" getter="get_global_rotation">
Global rotation in radians.
</member>
- <member name="global_rotation_deg" type="float" setter="set_global_rotation_in_degrees" getter="get_global_rotation_in_degrees">
+ <member name="global_rotation_degrees" type="float" setter="set_global_rotation_degrees" getter="get_global_rotation_degrees">
Global rotation in degrees.
</member>
<member name="global_scale" type="Vector2" setter="set_global_scale" getter="get_global_scale">
@@ -324,7 +324,7 @@
<member name="rotation" type="float" setter="set_rotation" getter="get_rotation">
Rotation in radians, relative to the node's parent.
</member>
- <member name="rotation_deg" type="float" setter="set_rotation_in_degrees" getter="get_rotation_in_degrees">
+ <member name="rotation_degrees" type="float" setter="set_rotation_degrees" getter="get_rotation_degrees">
Rotation in degrees, relative to the node's parent.
</member>
<member name="scale" type="Vector2" setter="set_scale" getter="get_scale">
diff --git a/doc/classes/Polygon2D.xml b/doc/classes/Polygon2D.xml
index 23cb9bd91b..5aa7146ff7 100644
--- a/doc/classes/Polygon2D.xml
+++ b/doc/classes/Polygon2D.xml
@@ -227,7 +227,7 @@
<member name="texture_offset" type="Vector2" setter="set_texture_offset" getter="get_texture_offset">
Amount to offset the polygon's [code]texture[/code]. If [code](0, 0)[/code] the texture's origin (its top-left corner) will be placed at the polygon's [code]position[/code].
</member>
- <member name="texture_rotation" type="float" setter="_set_texture_rotationd" getter="_get_texture_rotationd">
+ <member name="texture_rotation" type="float" setter="set_texture_rotation_degrees" getter="get_texture_rotation_degrees">
The texture's rotation in degrees.
</member>
<member name="texture_scale" type="Vector2" setter="set_texture_scale" getter="get_texture_scale">
diff --git a/doc/classes/Spatial.xml b/doc/classes/Spatial.xml
index 38e971b6bd..07f5ea5301 100644
--- a/doc/classes/Spatial.xml
+++ b/doc/classes/Spatial.xml
@@ -39,7 +39,7 @@
Returns the rotation (in radians).
</description>
</method>
- <method name="get_rotation_deg" qualifiers="const">
+ <method name="get_rotation_degrees" qualifiers="const">
<return type="Vector3">
</return>
<description>
@@ -267,16 +267,16 @@
<method name="set_rotation">
<return type="void">
</return>
- <argument index="0" name="rotation_rad" type="Vector3">
+ <argument index="0" name="radians" type="Vector3">
</argument>
<description>
Set the rotation (in radians).
</description>
</method>
- <method name="set_rotation_deg">
+ <method name="set_rotation_degrees">
<return type="void">
</return>
- <argument index="0" name="rotation_deg" type="Vector3">
+ <argument index="0" name="degrees" type="Vector3">
</argument>
<description>
Set the rotation (in degrees).
@@ -365,7 +365,7 @@
<member name="rotation" type="Vector3" setter="set_rotation" getter="get_rotation">
Local euler rotation in radians of this node.
</member>
- <member name="rotation_deg" type="Vector3" setter="set_rotation_deg" getter="get_rotation_deg">
+ <member name="rotation_degrees" type="Vector3" setter="set_rotation_degrees" getter="get_rotation_degrees">
Local euler rotation in degrees of this node.
</member>
<member name="scale" type="Vector3" setter="set_scale" getter="get_scale">
diff --git a/doc/classes/TextEdit.xml b/doc/classes/TextEdit.xml
index 43e5158515..0af11eec31 100644
--- a/doc/classes/TextEdit.xml
+++ b/doc/classes/TextEdit.xml
@@ -239,6 +239,14 @@
Returns true if highlight all occurrences is enabled.
</description>
</method>
+ </method>
+ <method name="is_context_menu_enabled" qualifiers="const">
+ <return type="bool">
+ </return>
+ <description>
+ Returns true if the context menu is enabled.
+ </description>
+ </method>
<method name="is_highlight_current_line_enabled" qualifiers="const">
<return type="bool">
</return>
@@ -251,6 +259,13 @@
<description>
</description>
</method>
+ <method name="is_readonly" qualifiers="const">
++ <return type="bool">
++ </return>
++ <description>
++ Return true if the text editor is in read-only mode (see [method set_readonly]).
++ </description>
++ </method>
<method name="is_selection_active" qualifiers="const">
<return type="bool">
</return>
@@ -337,6 +352,15 @@
Select all the text.
</description>
</method>
+ <method name="set_context_menu_enabled">
+ <return type="void">
+ </return>
+ <argument index="0" name="enabled" type="bool">
+ </argument>
+ <description>
+ Set the status of the context menu. When enabled, the context menu will appear when the [code]TextEdit[/code] is right clicked.
+ </description>
+ </method>
<method name="set_highlight_all_occurrences">
<return type="void">
</return>
@@ -441,6 +465,9 @@
</method>
</methods>
<members>
+ <member name="readonly" type="bool" setter="set_readonly" getter="is_readonly">
+ If [code]true[/code] read-only mode is enabled. Existing text cannot be modified and new text cannot be added.
+ </member>
<member name="caret_blink" type="bool" setter="cursor_set_blink_enabled" getter="cursor_get_blink_enabled">
</member>
<member name="caret_blink_speed" type="float" setter="cursor_set_blink_speed" getter="cursor_get_blink_speed">
@@ -455,6 +482,8 @@
</member>
<member name="show_line_numbers" type="bool" setter="set_show_line_numbers" getter="is_show_line_numbers_enabled">
</member>
+ <member name="context_menu_enabled" type="bool" setter="set_context_menu_enabled" getter="is_context_menu_enabled">
+ </member>
<member name="smooth_scrolling" type="bool" setter="set_smooth_scroll_enable" getter="is_smooth_scroll_enabled">
</member>
<member name="syntax_highlighting" type="bool" setter="set_syntax_coloring" getter="is_syntax_coloring_enabled">
diff --git a/doc/classes/VisualScriptMathConstant.xml b/doc/classes/VisualScriptMathConstant.xml
index 86744e5caf..c753c16218 100644
--- a/doc/classes/VisualScriptMathConstant.xml
+++ b/doc/classes/VisualScriptMathConstant.xml
@@ -42,12 +42,12 @@
<constant name="MATH_CONSTANT_PI" value="1">
Pi: [code]3.141593[/code]
</constant>
- <constant name="MATH_CONSTANT_2PI" value="2">
- Pi times two: [code]6.283185[/code]
- </constant>
- <constant name="MATH_CONSTANT_HALF_PI" value="3">
+ <constant name="MATH_CONSTANT_HALF_PI" value="2">
Pi divided by two: [code]1.570796[/code]
</constant>
+ <constant name="MATH_CONSTANT_TAU" value="3">
+ Tau: [code]6.283185[/code]
+ </constant>
<constant name="MATH_CONSTANT_E" value="4">
Natural log: [code]2.718282[/code]
</constant>
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-18 04:44:21 +0000