Skip to content

Commit 8ef33b4

Browse files
author
Redot Organization
committed
classref: Sync with current master branch (a2ae231)
1 parent 6ba1726 commit 8ef33b4

106 files changed

Lines changed: 1441 additions & 881 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

classes/class_@globalscope.rst

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,10 @@ Properties
7373
+---------------------------------------------------------------+-------------------------------------------------------------------------------------+
7474
| :ref:`JavaScriptBridge<class_JavaScriptBridge>` | :ref:`JavaScriptBridge<class_@GlobalScope_property_JavaScriptBridge>` |
7575
+---------------------------------------------------------------+-------------------------------------------------------------------------------------+
76+
| :ref:`MCPBridge<class_MCPBridge>` | :ref:`MCPBridge<class_@GlobalScope_property_MCPBridge>` |
77+
+---------------------------------------------------------------+-------------------------------------------------------------------------------------+
78+
| :ref:`MCPServer<class_MCPServer>` | :ref:`MCPServer<class_@GlobalScope_property_MCPServer>` |
79+
+---------------------------------------------------------------+-------------------------------------------------------------------------------------+
7680
| :ref:`Marshalls<class_Marshalls>` | :ref:`Marshalls<class_@GlobalScope_property_Marshalls>` |
7781
+---------------------------------------------------------------+-------------------------------------------------------------------------------------+
7882
| :ref:`NativeMenu<class_NativeMenu>` | :ref:`NativeMenu<class_@GlobalScope_property_NativeMenu>` |
@@ -5026,6 +5030,34 @@ The :ref:`JavaScriptBridge<class_JavaScriptBridge>` singleton.
50265030

50275031
----
50285032

5033+
.. _class_@GlobalScope_property_MCPBridge:
5034+
5035+
.. rst-class:: classref-property
5036+
5037+
:ref:`MCPBridge<class_MCPBridge>` **MCPBridge** :ref:`🔗<class_@GlobalScope_property_MCPBridge>`
5038+
5039+
.. container:: contribute
5040+
5041+
There is currently no description for this property. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!
5042+
5043+
.. rst-class:: classref-item-separator
5044+
5045+
----
5046+
5047+
.. _class_@GlobalScope_property_MCPServer:
5048+
5049+
.. rst-class:: classref-property
5050+
5051+
:ref:`MCPServer<class_MCPServer>` **MCPServer** :ref:`🔗<class_@GlobalScope_property_MCPServer>`
5052+
5053+
.. container:: contribute
5054+
5055+
There is currently no description for this property. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!
5056+
5057+
.. rst-class:: classref-item-separator
5058+
5059+
----
5060+
50295061
.. _class_@GlobalScope_property_Marshalls:
50305062

50315063
.. rst-class:: classref-property
@@ -5995,7 +6027,7 @@ Returns the :ref:`Object<class_Object>` that corresponds to ``instance_id``. All
59956027
func _ready():
59966028
var id = get_instance_id()
59976029
var instance = instance_from_id(id)
5998-
print(instance.foo) # Prints "water"
6030+
print(instance.drink) # Prints "water"
59996031

60006032
.. code-tab:: csharp
60016033

classes/class_array.rst

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ A built-in data structure that holds a sequence of elements.
1717
Description
1818
-----------
1919

20-
An array data structure that can contain a sequence of elements of any :ref:`Variant<class_Variant>` type. Elements are accessed by a numerical index starting at ``0``. Negative indices are used to count from the back (``-1`` is the last element, ``-2`` is the second to last, etc.).
20+
An array data structure that can contain a sequence of elements of any :ref:`Variant<class_Variant>` type by default. Values can optionally be constrained to a specific type by creating a *typed array*. Elements are accessed by a numerical index starting at ``0``. Negative indices are used to count from the back (``-1`` is the last element, ``-2`` is the second to last, etc.).
2121

2222

2323
.. tabs::
@@ -33,6 +33,10 @@ An array data structure that can contain a sequence of elements of any :ref:`Var
3333
print(array[1]) # Prints "Second"
3434
print(array[-3]) # Prints "Second"
3535

36+
# This typed array can only contain integers.
37+
# Attempting to add any other type will result in an error.
38+
var typed_array: Array[int] = [1, 2, 3]
39+
3640
.. code-tab:: csharp
3741

3842
Godot.Collections.Array array = ["First", 2, 3, "Last"];
@@ -44,6 +48,10 @@ An array data structure that can contain a sequence of elements of any :ref:`Var
4448
GD.Print(array[1]); // Prints "Second"
4549
GD.Print(array[^3]); // Prints "Second"
4650

51+
// This typed array can only contain integers.
52+
// Attempting to add any other type will result in an error.
53+
Godot.Collections.Array<int> typedArray = [1, 2, 3];
54+
4755

4856

4957
\ **Note:** Arrays are always passed by **reference**. To get a copy of an array that can be modified independently of the original array, use :ref:`duplicate()<class_Array_method_duplicate>`.
@@ -1229,8 +1237,6 @@ If you need to return the removed element, use :ref:`pop_at()<class_Array_method
12291237

12301238
\ **Note:** This method shifts every element's index after ``position`` back, which may have a noticeable performance cost, especially on larger arrays.
12311239

1232-
\ **Note:** The ``position`` cannot be negative. To remove an element relative to the end of the array, use ``arr.remove_at(arr.size() - (i + 1))``. To remove the last element from the array, use ``arr.resize(arr.size() - 1)``.
1233-
12341240
.. rst-class:: classref-item-separator
12351241

12361242
----

classes/class_arraymesh.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -436,7 +436,7 @@ Sets a name for a given surface.
436436

437437
.. container:: contribute
438438

439-
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
439+
There is currently no description for this method. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!
440440

441441
.. rst-class:: classref-item-separator
442442

@@ -450,7 +450,7 @@ Sets a name for a given surface.
450450

451451
.. container:: contribute
452452

453-
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
453+
There is currently no description for this method. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!
454454

455455
.. rst-class:: classref-item-separator
456456

@@ -464,7 +464,7 @@ Sets a name for a given surface.
464464

465465
.. container:: contribute
466466

467-
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
467+
There is currently no description for this method. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!
468468

469469
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
470470
.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`

classes/class_audioeffectchorus.rst

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -607,7 +607,7 @@ Method Descriptions
607607

608608
.. container:: contribute
609609

610-
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
610+
There is currently no description for this method. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!
611611

612612
.. rst-class:: classref-item-separator
613613

@@ -621,7 +621,7 @@ Method Descriptions
621621

622622
.. container:: contribute
623623

624-
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
624+
There is currently no description for this method. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!
625625

626626
.. rst-class:: classref-item-separator
627627

@@ -635,7 +635,7 @@ Method Descriptions
635635

636636
.. container:: contribute
637637

638-
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
638+
There is currently no description for this method. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!
639639

640640
.. rst-class:: classref-item-separator
641641

@@ -649,7 +649,7 @@ Method Descriptions
649649

650650
.. container:: contribute
651651

652-
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
652+
There is currently no description for this method. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!
653653

654654
.. rst-class:: classref-item-separator
655655

@@ -663,7 +663,7 @@ Method Descriptions
663663

664664
.. container:: contribute
665665

666-
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
666+
There is currently no description for this method. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!
667667

668668
.. rst-class:: classref-item-separator
669669

@@ -677,7 +677,7 @@ Method Descriptions
677677

678678
.. container:: contribute
679679

680-
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
680+
There is currently no description for this method. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!
681681

682682
.. rst-class:: classref-item-separator
683683

@@ -691,7 +691,7 @@ Method Descriptions
691691

692692
.. container:: contribute
693693

694-
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
694+
There is currently no description for this method. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!
695695

696696
.. rst-class:: classref-item-separator
697697

@@ -705,7 +705,7 @@ Method Descriptions
705705

706706
.. container:: contribute
707707

708-
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
708+
There is currently no description for this method. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!
709709

710710
.. rst-class:: classref-item-separator
711711

@@ -719,7 +719,7 @@ Method Descriptions
719719

720720
.. container:: contribute
721721

722-
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
722+
There is currently no description for this method. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!
723723

724724
.. rst-class:: classref-item-separator
725725

@@ -733,7 +733,7 @@ Method Descriptions
733733

734734
.. container:: contribute
735735

736-
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
736+
There is currently no description for this method. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!
737737

738738
.. rst-class:: classref-item-separator
739739

@@ -747,7 +747,7 @@ Method Descriptions
747747

748748
.. container:: contribute
749749

750-
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
750+
There is currently no description for this method. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!
751751

752752
.. rst-class:: classref-item-separator
753753

@@ -761,7 +761,7 @@ Method Descriptions
761761

762762
.. container:: contribute
763763

764-
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
764+
There is currently no description for this method. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!
765765

766766
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
767767
.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`

classes/class_audioeffectdistortion.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ Digital distortion effect which cuts off peaks at the top and bottom of the wave
8383

8484
.. container:: contribute
8585

86-
There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
86+
There is currently no description for this enum. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!
8787

8888

8989

classes/class_audioeffectlimiter.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ Applies a gain to the limited waves, in decibels. Value can range from 0 to 6.
106106

107107
.. container:: contribute
108108

109-
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
109+
There is currently no description for this property. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!
110110

111111
.. rst-class:: classref-item-separator
112112

classes/class_audioeffectspectrumanalyzer.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ The size of the `Fast Fourier transform <https://en.wikipedia.org/wiki/Fast_Four
167167

168168
.. container:: contribute
169169

170-
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
170+
There is currently no description for this property. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!
171171

172172
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
173173
.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`

classes/class_audiostreammp3.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ Property Descriptions
8181

8282
.. container:: contribute
8383

84-
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
84+
There is currently no description for this property. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!
8585

8686
.. rst-class:: classref-item-separator
8787

@@ -100,7 +100,7 @@ Property Descriptions
100100

101101
.. container:: contribute
102102

103-
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
103+
There is currently no description for this property. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!
104104

105105
.. rst-class:: classref-item-separator
106106

@@ -119,7 +119,7 @@ Property Descriptions
119119

120120
.. container:: contribute
121121

122-
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
122+
There is currently no description for this property. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!
123123

124124
.. rst-class:: classref-item-separator
125125

classes/class_audiostreamoggvorbis.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ Property Descriptions
8888

8989
.. container:: contribute
9090

91-
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
91+
There is currently no description for this property. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!
9292

9393
.. rst-class:: classref-item-separator
9494

@@ -107,7 +107,7 @@ Property Descriptions
107107

108108
.. container:: contribute
109109

110-
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
110+
There is currently no description for this property. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!
111111

112112
.. rst-class:: classref-item-separator
113113

@@ -126,7 +126,7 @@ Property Descriptions
126126

127127
.. container:: contribute
128128

129-
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
129+
There is currently no description for this property. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!
130130

131131
.. rst-class:: classref-item-separator
132132

classes/class_audiostreamplaybackoggvorbis.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ AudioStreamPlaybackOggVorbis
1414

1515
.. container:: contribute
1616

17-
There is currently no description for this class. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
17+
There is currently no description for this class. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!
1818

1919
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
2020
.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`

0 commit comments

Comments
 (0)