godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2025-12-31 17:49:03 +03:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with current master branch

Browse Source 
Also fixes Sphinx warnings and missing classes thanks to deefc2a63d
This commit is contained in:
Rémi Verschelde
2017-10-14 15:24:00 +02:00
parent 63e17da1ce
commit a02c0d3111
93 changed files with 554 additions and 257 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
classes/class_@c#.rst Normal file
View File

@@ -0,0 +1,16 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the @C#.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_@C#:
@C#
===
**Category:** Core
Brief Description
-----------------

2
classes/class_acceptdialog.rst
View File

@@ -45,9 +45,11 @@ Signals
-------
- **confirmed** **(** **)**
Emitted when the dialog is accepted.
- **custom_action** **(** :ref:`String<class_string>` action **)**
Emitted when a custom button is pressed. See :ref:`add_button<class_AcceptDialog_add_button>`.

2
classes/class_animatedsprite.rst
View File

@@ -59,9 +59,11 @@ Signals
-------
- **animation_finished** **(** **)**
Emitted when the animation is finished (when it plays the last frame). If the animation is looping, this signal is emitted every time the last frame is drawn.
- **frame_changed** **(** **)**
Emitted when member frame changed.

1
classes/class_animatedsprite3d.rst
View File

@@ -43,6 +43,7 @@ Signals
-------
- **frame_changed** **(** **)**
Emitted when member frame changed.

3
classes/class_animationplayer.rst
View File

@@ -101,12 +101,15 @@ Signals
-------
- **animation_changed** **(** :ref:`String<class_string>` old_name, :ref:`String<class_string>` new_name **)**
If the currently being played animation changes, this signal will notify of such change.
- **animation_finished** **(** :ref:`String<class_string>` name **)**
Notifies when an animation finished playing.
- **animation_started** **(** :ref:`String<class_string>` name **)**
Notifies when an animation starts playing.

8
classes/class_area.rst
View File

@@ -113,27 +113,35 @@ Signals
-------
- **area_entered** **(** :ref:`Object<class_object>` area **)**
Emitted when another area enters.
- **area_exited** **(** :ref:`Object<class_object>` area **)**
Emitted when another area exits.
- **area_shape_entered** **(** :ref:`int<class_int>` area_id, :ref:`Object<class_object>` area, :ref:`int<class_int>` area_shape, :ref:`int<class_int>` self_shape **)**
Emitted when another area enters, reporting which areas overlapped.
- **area_shape_exited** **(** :ref:`int<class_int>` area_id, :ref:`Object<class_object>` area, :ref:`int<class_int>` area_shape, :ref:`int<class_int>` self_shape **)**
Emitted when another area exits, reporting which areas were overlapping.
- **body_entered** **(** :ref:`Object<class_object>` body **)**
Emitted when a :ref:`PhysicsBody<class_physicsbody>` object enters.
- **body_exited** **(** :ref:`Object<class_object>` body **)**
Emitted when a :ref:`PhysicsBody2D<class_physicsbody2d>` object exits.
- **body_shape_entered** **(** :ref:`int<class_int>` body_id, :ref:`Object<class_object>` body, :ref:`int<class_int>` body_shape, :ref:`int<class_int>` area_shape **)**
Emitted when a :ref:`PhysicsBody2D<class_physicsbody2d>` object enters, reporting which shapes overlapped.
- **body_shape_exited** **(** :ref:`int<class_int>` body_id, :ref:`Object<class_object>` body, :ref:`int<class_int>` body_shape, :ref:`int<class_int>` area_shape **)**
Emitted when a :ref:`PhysicsBody2D<class_physicsbody2d>` object exits, reporting which shapes were overlapping.

8
classes/class_area2d.rst
View File

@@ -97,27 +97,35 @@ Signals
-------
- **area_entered** **(** :ref:`Object<class_object>` area **)**
Emitted when another area enters.
- **area_exited** **(** :ref:`Object<class_object>` area **)**
Emitted when another area exits.
- **area_shape_entered** **(** :ref:`int<class_int>` area_id, :ref:`Object<class_object>` area, :ref:`int<class_int>` area_shape, :ref:`int<class_int>` self_shape **)**
Emitted when another area enters, reporting which shapes overlapped.
- **area_shape_exited** **(** :ref:`int<class_int>` area_id, :ref:`Object<class_object>` area, :ref:`int<class_int>` area_shape, :ref:`int<class_int>` self_shape **)**
Emitted when another area exits, reporting which shapes were overlapping.
- **body_entered** **(** :ref:`Object<class_object>` body **)**
Emitted when a :ref:`PhysicsBody2D<class_physicsbody2d>` object enters.
- **body_exited** **(** :ref:`Object<class_object>` body **)**
Emitted when a :ref:`PhysicsBody2D<class_physicsbody2d>` object exits.
- **body_shape_entered** **(** :ref:`int<class_int>` body_id, :ref:`Object<class_object>` body, :ref:`int<class_int>` body_shape, :ref:`int<class_int>` area_shape **)**
Emitted when a :ref:`PhysicsBody2D<class_physicsbody2d>` object enters, reporting which shapes overlapped.
- **body_shape_exited** **(** :ref:`int<class_int>` body_id, :ref:`Object<class_object>` body, :ref:`int<class_int>` body_shape, :ref:`int<class_int>` area_shape **)**
Emitted when a :ref:`PhysicsBody2D<class_physicsbody2d>` object exits, reporting which shapes were overlapping.

2
classes/class_arvrcontroller.rst
View File

@@ -41,9 +41,11 @@ Signals
-------
- **button_pressed** **(** :ref:`int<class_int>` button **)**
When a button on this controller is pressed, this signal is given.
- **button_release** **(** :ref:`int<class_int>` button **)**
When a button on this controller is released, this signal is given.

4
classes/class_arvrinterface.rst
View File

@@ -9,7 +9,7 @@ ARVRInterface
**Inherits:** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Inherited By:** :ref:`ARVRScriptInterface<class_arvrscriptinterface>`, :ref:`MobileVRInterface<class_mobilevrinterface>`
**Inherited By:** :ref:`ARVRInterfaceGDNative<class_arvrinterfacegdnative>`, :ref:`MobileVRInterface<class_mobilevrinterface>`
**Category:** Core
@@ -155,7 +155,7 @@ Enables anchor detection, this is used on AR interfaces and enables the extra lo
- void **set_is_initialized** **(** :ref:`bool<class_bool>` initialized **)**
Initialise/uninitilise this interface (same effect as calling intialize/uninitialize).
Initialize/uninitialize this interface (same effect as calling initialize/uninitialize).
.. _class_ARVRInterface_set_is_primary:

40
classes/class_arvrinterfacegdnative.rst Normal file
View File

@@ -0,0 +1,40 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the ARVRInterfaceGDNative.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_ARVRInterfaceGDNative:
ARVRInterfaceGDNative
=====================
**Inherits:** :ref:`ARVRInterface<class_arvrinterface>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
GDNative wrapper for an ARVR interface
Member Functions
----------------
+-------+---------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_gdnative_library<class_ARVRInterfaceGDNative_set_gdnative_library>` **(** :ref:`GDNativeLibrary<class_gdnativelibrary>` library **)** |
+-------+---------------------------------------------------------------------------------------------------------------------------------------------------+
Description
-----------
This is a wrapper class for GDNative implementations of the ARVR interface. To use a GDNative ARVR interface simply instantiate this object and set your GDNative library containing the ARVR interface implementation.
Member Function Description
---------------------------
.. _class_ARVRInterfaceGDNative_set_gdnative_library:
- void **set_gdnative_library** **(** :ref:`GDNativeLibrary<class_gdnativelibrary>` library **)**
Bind this GDNative library to our interface. The library must be a GDNative ARVR Interface for this to work.

136
classes/class_arvrscriptinterface.rst
View File

@@ -1,136 +0,0 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the ARVRScriptInterface.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_ARVRScriptInterface:
ARVRScriptInterface
===================
**Inherits:** :ref:`ARVRInterface<class_arvrinterface>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Base class for GDNative based ARVR interfaces.
Member Functions
----------------
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`_get_projection_for_eye<class_ARVRScriptInterface__get_projection_for_eye>` **(** **)** virtual |
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`commit_for_eye<class_ARVRScriptInterface_commit_for_eye>` **(** :ref:`int<class_int>` eye, :ref:`RID<class_rid>` render_target **)** virtual |
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_anchor_detection_is_enabled<class_ARVRScriptInterface_get_anchor_detection_is_enabled>` **(** **)** virtual |
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_capabilities<class_ARVRScriptInterface_get_capabilities>` **(** **)** virtual |
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_recommended_render_targetsize<class_ARVRScriptInterface_get_recommended_render_targetsize>` **(** **)** virtual |
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_tracking_status<class_ARVRScriptInterface_get_tracking_status>` **(** **)** virtual |
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform<class_transform>` | :ref:`get_transform_for_eye<class_ARVRScriptInterface_get_transform_for_eye>` **(** :ref:`int<class_int>` eye, :ref:`Transform<class_transform>` cam_transform **)** virtual |
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`initialize<class_ARVRScriptInterface_initialize>` **(** **)** virtual |
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_initialized<class_ARVRScriptInterface_is_initialized>` **(** **)** virtual |
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_stereo<class_ARVRScriptInterface_is_stereo>` **(** **)** virtual |
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`process<class_ARVRScriptInterface_process>` **(** **)** virtual |
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_anchor_detection_is_enabled<class_ARVRScriptInterface_set_anchor_detection_is_enabled>` **(** :ref:`bool<class_bool>` enabled **)** virtual |
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`uninitialize<class_ARVRScriptInterface_uninitialize>` **(** **)** virtual |
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Description
-----------
This class is used as a base class/interface class for implementing GDNative based ARVR interfaces and as a result exposes more of the internals of the ARVR server.
Member Function Description
---------------------------
.. _class_ARVRScriptInterface__get_projection_for_eye:
- void **_get_projection_for_eye** **(** **)** virtual
Should return the projection 4x4 matrix for the requested eye.
.. _class_ARVRScriptInterface_commit_for_eye:
- void **commit_for_eye** **(** :ref:`int<class_int>` eye, :ref:`RID<class_rid>` render_target **)** virtual
Outputs a finished render buffer to the AR/VR device for the given eye.
.. _class_ARVRScriptInterface_get_anchor_detection_is_enabled:
- :ref:`bool<class_bool>` **get_anchor_detection_is_enabled** **(** **)** virtual
Returns true if achor detection is enabled (AR only).
.. _class_ARVRScriptInterface_get_capabilities:
- :ref:`int<class_int>` **get_capabilities** **(** **)** virtual
Returns a combination of flags providing information about the capabilities of this interface.
.. _class_ARVRScriptInterface_get_recommended_render_targetsize:
- :ref:`Vector2<class_vector2>` **get_recommended_render_targetsize** **(** **)** virtual
Returns the size at which we should render our scene to get optimal quality on the output device.
.. _class_ARVRScriptInterface_get_tracking_status:
- :ref:`int<class_int>` **get_tracking_status** **(** **)** virtual
If supported, returns the status of our tracking. This will allow you to provide feedback to the user whether there are issues with positional tracking.
.. _class_ARVRScriptInterface_get_transform_for_eye:
- :ref:`Transform<class_transform>` **get_transform_for_eye** **(** :ref:`int<class_int>` eye, :ref:`Transform<class_transform>` cam_transform **)** virtual
Get the location and orientation transform used when rendering a specific eye.
.. _class_ARVRScriptInterface_initialize:
- :ref:`bool<class_bool>` **initialize** **(** **)** virtual
Initialize this interface.
.. _class_ARVRScriptInterface_is_initialized:
- :ref:`bool<class_bool>` **is_initialized** **(** **)** virtual
Returns true if this interface has been initialized and is active.
.. _class_ARVRScriptInterface_is_stereo:
- :ref:`bool<class_bool>` **is_stereo** **(** **)** virtual
Returns true if we require stereoscopic rendering for this interface.
.. _class_ARVRScriptInterface_process:
- void **process** **(** **)** virtual
Gets called before rendering each frame so tracking data gets updated in time.
.. _class_ARVRScriptInterface_set_anchor_detection_is_enabled:
- void **set_anchor_detection_is_enabled** **(** :ref:`bool<class_bool>` enabled **)** virtual
Enables anchor detection, this is used on AR interfaces and enables the extra logic that will detect planes, features, objects, etc. and adds/modifies anchor points.
.. _class_ARVRScriptInterface_uninitialize:
- void **uninitialize** **(** **)** virtual
Turn this interface off.

6
classes/class_arvrserver.rst
View File

@@ -49,15 +49,19 @@ Signals
-------
- **interface_added** **(** :ref:`String<class_string>` name **)**
Signal send when a new interface has been added.
- **interface_removed** **(** :ref:`String<class_string>` name **)**
Signal send when an interface is removed.
- **tracker_added** **(** :ref:`String<class_string>` name, :ref:`int<class_int>` type, :ref:`int<class_int>` id **)**
Signal send when a new tracker has been added. If you don't use a fixed number of controllers or if you're using ARVRAnchors for an AR solution it is important to react to this signal and add the appropriate ARVRController or ARVRAnchor node related to this new tracker.
- **tracker_removed** **(** :ref:`String<class_string>` name, :ref:`int<class_int>` type, :ref:`int<class_int>` id **)**
Signal send when a tracker is removed, you should remove any ARVRController or ARVRAnchor points if applicable. This is not mandatory, the nodes simply become inactive and will be made active again when a new tracker becomes available (i.e. a new controller is switched on that takes the place of the previous one).
@@ -74,7 +78,7 @@ Numeric Constants
- **TRACKER_ANCHOR** = **4** --- Our tracker tracks the location and size of an AR anchor.
- **TRACKER_UNKNOWN** = **128** --- Used internally if we haven't set the tracker type yet.
- **TRACKER_ANY_KNOWN** = **127** --- Used internally to filter trackers of any known type.
- **TRACKER_ANY** = **255** --- Used interally to select all trackers.
- **TRACKER_ANY** = **255** --- Used internally to select all trackers.
Description
-----------

2
classes/class_audioeffectdistortion.rst
View File

@@ -64,7 +64,7 @@ Numeric Constants
Description
-----------
Modify the sound and make it dirty. Differents types available : clip, tan, lofi (bit crushing), overdrive, or waveshape.
Modify the sound and make it dirty. Different types are available : clip, tan, lofi (bit crushing), overdrive, or waveshape.
By distorting the waveform the frequency content change, which will often make the sound "crunchy" or "abrasive". For games, it can simulate sound coming from some saturated device or speaker very efficiently.

1
classes/class_audioserver.rst
View File

@@ -91,6 +91,7 @@ Signals
-------
- **bus_layout_changed** **(** **)**
Emitted when the :ref:`AudioBusLayout<class_audiobuslayout>` changes.

1
classes/class_audiostreamplayer.rst
View File

@@ -55,6 +55,7 @@ Signals
-------
- **finished** **(** **)**
Emitted when the audio stops playing.

1
classes/class_audiostreamplayer2d.rst
View File

@@ -63,6 +63,7 @@ Signals
-------
- **finished** **(** **)**
Emitted when the audio stops playing.

5
classes/class_audiostreamplayer3d.rst
View File

@@ -99,6 +99,7 @@ Signals
-------
- **finished** **(** **)**
Fires when the audio stops playing.
@@ -116,7 +117,7 @@ Member Variables
- :ref:`bool<class_bool>` **emission_angle_enabled** - If [code]true[/code] the audio should be dampened according to the direction of the sound.
- :ref:`float<class_float>` **emission_angle_filter_attenuation_db** - dampens audio if camera is outside of 'emission_angle_degrees' and 'emission_angle_enabled' is set by this factor, in dB.
- :ref:`float<class_float>` **max_db** - Sets the absolute maximum of the soundlevel, in dB.
- :ref:`float<class_float>` **max_distance** - Sets the distance from wich the 'out_of_range_mode' takes effect. Has no effect if set to 0.
- :ref:`float<class_float>` **max_distance** - Sets the distance from which the 'out_of_range_mode' takes effect. Has no effect if set to 0.
- :ref:`int<class_int>` **out_of_range_mode** - Decides if audio should pause when source is outside of 'max_distance' range.
- :ref:`bool<class_bool>` **playing** - If [code]true[/code], audio is playing.
- :ref:`AudioStream<class_audiostream>` **stream** - The [AudioStream] object to be played.
@@ -132,7 +133,7 @@ Numeric Constants
- **OUT_OF_RANGE_MIX** = **0** --- Mix this audio in, even when it's out of range.
- **OUT_OF_RANGE_PAUSE** = **1** --- Pause this audio when it gets out of range.
- **DOPPLER_TRACKING_DISABLED** = **0** --- Disables doppler tracking.
- **DOPPLER_TRACKING_IDLE_STEP** = **1** --- Executes doppler trackin in idle step.
- **DOPPLER_TRACKING_IDLE_STEP** = **1** --- Executes doppler tracking in idle step.
- **DOPPLER_TRACKING_PHYSICS_STEP** = **2** --- Executes doppler tracking in physics step.
Description

4
classes/class_basebutton.rst
View File

@@ -63,15 +63,19 @@ Signals
-------
- **button_down** **(** **)**
Emitted when the button starts being held down.
- **button_up** **(** **)**
Emitted when the button stops being held down.
- **pressed** **(** **)**
This signal is emitted every time the button is toggled or pressed (i.e. activated, so on ``button_down`` if "Click on press" is active and on ``button_up`` otherwise).
- **toggled** **(** :ref:`bool<class_bool>` pressed **)**
This signal is emitted when the button was just toggled between pressed and normal states (only if toggle_mode is active). The new state is contained in the *pressed* argument.

49
classes/class_bitmapfont.rst
View File

@@ -14,7 +14,7 @@ BitmapFont
Brief Description
-----------------
Renders text using ``\*.fnt`` fonts.
Member Functions
----------------
@@ -52,13 +52,18 @@ Member Functions
Member Variables
----------------
- :ref:`float<class_float>` **ascent**
- :ref:`PoolIntArray<class_poolintarray>` **chars**
- :ref:`bool<class_bool>` **distance_field**
- :ref:`BitmapFont<class_bitmapfont>` **fallback**
- :ref:`float<class_float>` **height**
- :ref:`PoolIntArray<class_poolintarray>` **kernings**
- :ref:`Array<class_array>` **textures**
- :ref:`float<class_float>` **ascent** - Ascent (number of pixels above the baseline).
- :ref:`PoolIntArray<class_poolintarray>` **chars** - The characters in the BitmapFont.
- :ref:`bool<class_bool>` **distance_field** - If [code]true[/code] distance field hint is enabled.
- :ref:`BitmapFont<class_bitmapfont>` **fallback** - The fallback font.
- :ref:`float<class_float>` **height** - Total font height (ascent plus descent) in pixels.
- :ref:`PoolIntArray<class_poolintarray>` **kernings** - The font's kernings as [PoolIntArray].
- :ref:`Array<class_array>` **textures** - The font's [Texture]\ s.
Description
-----------
Renders text using ``\*.fnt`` fonts containing texture atlases. Supports distance fields. For using vector font files like TTF directly, see :ref:`DynamicFont<class_dynamicfont>`.
Member Function Description
---------------------------
@@ -67,72 +72,84 @@ Member Function Description
- void **add_char** **(** :ref:`int<class_int>` character, :ref:`int<class_int>` texture, :ref:`Rect2<class_rect2>` rect, :ref:`Vector2<class_vector2>` align=Vector2( 0, 0 ), :ref:`float<class_float>` advance=-1 **)**
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.
Adds 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.
.. _class_BitmapFont_add_kerning_pair:
- void **add_kerning_pair** **(** :ref:`int<class_int>` char_a, :ref:`int<class_int>` char_b, :ref:`int<class_int>` kerning **)**
Add a kerning pair to the :ref:`BitmapFont<class_bitmapfont>` as a difference. Kerning pairs are special cases where a typeface advance is determined by the next character.
Adds a kerning pair to the :ref:`BitmapFont<class_bitmapfont>` as a difference. Kerning pairs are special cases where a typeface advance is determined by the next character.
.. _class_BitmapFont_add_texture:
- void **add_texture** **(** :ref:`Texture<class_texture>` texture **)**
Add a texture to the :ref:`BitmapFont<class_bitmapfont>`.
Adds a texture to the :ref:`BitmapFont<class_bitmapfont>`.
.. _class_BitmapFont_clear:
- void **clear** **(** **)**
Clear all the font data.
Clears all the font data and settings.
.. _class_BitmapFont_create_from_fnt:
- :ref:`int<class_int>` **create_from_fnt** **(** :ref:`String<class_string>` path **)**
Creates a BitmapFont from the ``\*.fnt`` file at ``path``.
.. _class_BitmapFont_get_char_size:
- :ref:`Vector2<class_vector2>` **get_char_size** **(** :ref:`int<class_int>` char, :ref:`int<class_int>` next=0 **)** const
Return the size of a character, optionally taking kerning into account if the next character is provided.
Returns the size of a character, optionally taking kerning into account if the next character is provided.
.. _class_BitmapFont_get_fallback:
- :ref:`BitmapFont<class_bitmapfont>` **get_fallback** **(** **)** const
Returns the fallback BitmapFont.
.. _class_BitmapFont_get_kerning_pair:
- :ref:`int<class_int>` **get_kerning_pair** **(** :ref:`int<class_int>` char_a, :ref:`int<class_int>` char_b **)** const
Return a kerning pair as a difference.
Returns a kerning pair as a difference.
.. _class_BitmapFont_get_texture:
- :ref:`Texture<class_texture>` **get_texture** **(** :ref:`int<class_int>` idx **)** const
Returns the font atlas texture at index ``idx``.
.. _class_BitmapFont_get_texture_count:
- :ref:`int<class_int>` **get_texture_count** **(** **)** const
Returns the number of textures in the BitmapFont atlas.
.. _class_BitmapFont_set_ascent:
- void **set_ascent** **(** :ref:`float<class_float>` px **)**
Set the font ascent (number of pixels above the baseline).
Sets the font ascent (number of pixels above the baseline).
.. _class_BitmapFont_set_distance_field_hint:
- void **set_distance_field_hint** **(** :ref:`bool<class_bool>` enable **)**
If ``true`` distance field hint is enabled.
.. _class_BitmapFont_set_fallback:
- void **set_fallback** **(** :ref:`BitmapFont<class_bitmapfont>` fallback **)**
Sets the fallback BitmapFont.
.. _class_BitmapFont_set_height:
- void **set_height** **(** :ref:`float<class_float>` px **)**
Set the total font height (ascent plus descent) in pixels.
Sets the total font height (ascent plus descent) in pixels.

4
classes/class_canvasitem.rst
View File

@@ -147,15 +147,19 @@ Signals
-------
- **draw** **(** **)**
Emitted when the CanvasItem must redraw. This can only be connected realtime, as deferred will not allow drawing.
- **hide** **(** **)**
Emitted when becoming hidden.
- **item_rect_changed** **(** **)**
Emitted when the item rect has changed.
- **visibility_changed** **(** **)**
Emitted when the visibility (hidden/visible) changes.

2
classes/class_checkbox.rst
View File

@@ -19,5 +19,5 @@ Binary choice user interface widget
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 possible options), for example Answer 'yes' or 'no'.

3
classes/class_collisionobject.rst
View File

@@ -69,10 +69,13 @@ Signals
-------
- **input_event** **(** :ref:`Object<class_object>` camera, :ref:`Object<class_object>` event, :ref:`Vector3<class_vector3>` click_position, :ref:`Vector3<class_vector3>` click_normal, :ref:`int<class_int>` shape_idx **)**
- **mouse_entered** **(** **)**
Emitted when the mouse pointer enters any of this object's shapes.
- **mouse_exited** **(** **)**
Emitted when the mouse pointer exits all this object's shapes.

3
classes/class_collisionobject2d.rst
View File

@@ -69,12 +69,15 @@ Signals
-------
- **input_event** **(** :ref:`Object<class_object>` viewport, :ref:`Object<class_object>` event, :ref:`int<class_int>` shape_idx **)**
Emitted when an input event occurs and ``input_pickable`` is ``true``.
- **mouse_entered** **(** **)**
Emitted when the mouse pointer enters any of this object's shapes.
- **mouse_exited** **(** **)**
Emitted when the mouse pointer exits all this object's shapes.

1
classes/class_colorpicker.rst
View File

@@ -39,6 +39,7 @@ Signals
-------
- **color_changed** **(** :ref:`Color<class_color>` color **)**
Emitted when the color is changed.

1
classes/class_colorpickerbutton.rst
View File

@@ -35,6 +35,7 @@ Signals
-------
- **color_changed** **(** :ref:`Color<class_color>` color **)**
Emitted when the color is changed.

35
classes/class_configfile.rst
View File

@@ -42,9 +42,18 @@ Member Functions
Description
-----------
This helper class can be used to store :ref:`Variant<class_variant>` values on the filesystem using an INI-style formatting. The stored values as referenced by a section and a key. The stored data can be saved to or parsed from a file, though ConfigFile objects can also be used directly with accessing the filesystem.
This helper class can be used to store :ref:`Variant<class_variant>` values on the filesystem using INI-style formatting. The stored values are indentified by a section and a key:
The following example shows how to parse a INI-style file from the system, read its contents and store new values in it:
::
[section]
some_key=42
string_example="Hello World!"
a_vector=Vector3( 1, 0, 2 )
The stored data can be saved to or parsed from a file, though ConfigFile objects can also be used directly without accessing the filesystem.
The following example shows how to parse an INI-style file from the system, read its contents and store new values in it:
::
@@ -53,7 +62,7 @@ The following example shows how to parse a INI-style file from the system, read
if err == OK: # if not, something went wrong with the file loading
# Look for the display/width pair, and default to 1024 if missing
var screen_width = get_value("display", "width", 1024)
# Store a variable if and only it hasn't been defined yet
# Store a variable if and only if it hasn't been defined yet
if not config.has_section_key("audio", "mute"):
config.set_value("audio", "mute", false)
# Save the changes by overwriting the previous file
@@ -66,54 +75,54 @@ Member Function Description
- void **erase_section** **(** :ref:`String<class_string>` section **)**
Deletes the specified section along with all the key-value pairs inside.
.. _class_ConfigFile_get_section_keys:
- :ref:`PoolStringArray<class_poolstringarray>` **get_section_keys** **(** :ref:`String<class_string>` section **)** const
Return an array of all defined key identifiers in the specified section.
Returns an array of all defined key identifiers in the specified section.
.. _class_ConfigFile_get_sections:
- :ref:`PoolStringArray<class_poolstringarray>` **get_sections** **(** **)** const
Return an array of all defined section identifiers.
Returns an array of all defined section identifiers.
.. _class_ConfigFile_get_value:
- :ref:`Variant<class_variant>` **get_value** **(** :ref:`String<class_string>` section, :ref:`String<class_string>` key, :ref:`Variant<class_variant>` default=null **)** const
Return the current value for the specified section and key. If the section and/or the key do not exist, the method returns the value of the optional *default* argument (and thus ``NULL`` if not specified).
Returns the current value for the specified section and key. If the section and/or the key do not exist, the method returns the value of the optional ``default`` argument, or ``null`` if it is omitted.
.. _class_ConfigFile_has_section:
- :ref:`bool<class_bool>` **has_section** **(** :ref:`String<class_string>` section **)** const
Check if the specified section exists.
Returns ``true`` if the specified section exists.
.. _class_ConfigFile_has_section_key:
- :ref:`bool<class_bool>` **has_section_key** **(** :ref:`String<class_string>` section, :ref:`String<class_string>` key **)** const
Check if the specified section-key pair exists.
Returns ``true`` if the specified section-key pair exists.
.. _class_ConfigFile_load:
- :ref:`int<class_int>` **load** **(** :ref:`String<class_string>` path **)**
Load the config file specified as a parameter. The file's contents are parsed and loaded in the ConfigFile object from which the method was called. The return value is one of the OK, FAILED or ERR\_\* constants listed in :ref:`@Global Scope<class_@global scope>` (if the load was successful, it returns OK).
Loads the config file specified as a parameter. The file's contents are parsed and loaded in the ConfigFile object which the method was called on. Returns one of the ``OK``, ``FAILED`` or ``ERR\_\*`` constants listed in :ref:`@Global Scope<class_@global scope>`. If the load was successful, the return value is ``OK``.
.. _class_ConfigFile_save:
- :ref:`int<class_int>` **save** **(** :ref:`String<class_string>` path **)**
Save the contents of the ConfigFile object to the file specified as a parameter. The output file uses an INI-style structure.
The return value is one of the OK, FAILED or ERR\_\* constants listed in :ref:`@Global Scope<class_@global scope>` (if the save was successful, it returns OK).
Saves the contents of the ConfigFile object to the file specified as a parameter. The output file uses an INI-style structure. Returns one of the ``OK``, ``FAILED`` or ``ERR\_\*`` constants listed in :ref:`@Global Scope<class_@global scope>`. If the load was successful, the return value is ``OK``.
.. _class_ConfigFile_set_value:
- void **set_value** **(** :ref:`String<class_string>` section, :ref:`String<class_string>` key, :ref:`Variant<class_variant>` value **)**
Assign a value to the specified key of the the specified section. If the section and/or the key do not exist, they are created. Passing a ``NULL`` value deletes the specified key if it exists (and deletes the section if it ends up empty once the key has been removed).
Assigns a value to the specified key of the the specified section. If the section and/or the key do not exist, they are created. Passing a ``null`` value deletes the specified key if it exists, and deletes the section if it ends up empty once the key has been removed.

1
classes/class_container.rst
View File

@@ -31,6 +31,7 @@ Signals
-------
- **sort_children** **(** **)**
Emitted when sorting the children is needed.

9
classes/class_control.rst
View File

@@ -223,30 +223,39 @@ Signals
-------
- **focus_entered** **(** **)**
Emitted when the node gains keyboard focus.
- **focus_exited** **(** **)**
Emitted when the node loses keyboard focus.
- **gui_input** **(** :ref:`Object<class_object>` ev **)**
Emitted when the node receives an :ref:`InputEvent<class_inputevent>`.
- **minimum_size_changed** **(** **)**
Emitted when the node's minimum size changes.
- **modal_closed** **(** **)**
Emitted when a modal ``Control`` is closed. See :ref:`show_modal<class_Control_show_modal>`.
- **mouse_entered** **(** **)**
Emitted when the mouse enters the control's ``Rect`` area.
- **mouse_exited** **(** **)**
Emitted when the mouse leaves the control's ``Rect`` area.
- **resized** **(** **)**
Emitted when the control changes size.
- **size_flags_changed** **(** **)**
Emitted when one of the size flags changes. See member size_flags_horizontal and member size_flags_vertical.

1
classes/class_curve.rst
View File

@@ -74,6 +74,7 @@ Signals
- **range_changed** **(** **)**
Member Variables
----------------

59
classes/class_dynamicfont.rst
View File

@@ -14,7 +14,7 @@ DynamicFont
Brief Description
-----------------
DynamicFont renders vector font files at runtime.
Member Functions
----------------
@@ -54,22 +54,27 @@ Member Functions
Member Variables
----------------
- :ref:`int<class_int>` **extra_spacing_bottom**
- :ref:`int<class_int>` **extra_spacing_char**
- :ref:`int<class_int>` **extra_spacing_space**
- :ref:`int<class_int>` **extra_spacing_top**
- :ref:`DynamicFontData<class_dynamicfontdata>` **font_data**
- :ref:`int<class_int>` **size**
- :ref:`bool<class_bool>` **use_filter**
- :ref:`bool<class_bool>` **use_mipmaps**
- :ref:`int<class_int>` **extra_spacing_bottom** - Extra spacing at the bottom in pixels.
- :ref:`int<class_int>` **extra_spacing_char** - Extra character spacing in pixels.
- :ref:`int<class_int>` **extra_spacing_space** - Extra space spacing in pixels.
- :ref:`int<class_int>` **extra_spacing_top** - Extra spacing at the top in pixels.
- :ref:`DynamicFontData<class_dynamicfontdata>` **font_data** - The font data.
- :ref:`int<class_int>` **size** - The font size.
- :ref:`bool<class_bool>` **use_filter** - If [code]true[/code] filtering is used.
- :ref:`bool<class_bool>` **use_mipmaps** - If [code]true[/code] mipmapping is used.
Numeric Constants
-----------------
- **SPACING_TOP** = **0**
- **SPACING_BOTTOM** = **1**
- **SPACING_CHAR** = **2**
- **SPACING_SPACE** = **3**
- **SPACING_TOP** = **0** --- Spacing at the top.
- **SPACING_BOTTOM** = **1** --- Spacing at the bottom.
- **SPACING_CHAR** = **2** --- Character spacing.
- **SPACING_SPACE** = **3** --- Space spacing.
Description
-----------
DynamicFont renders vector font files (such as TTF or OTF) dynamically at runtime instead of using a prerendered texture atlas like :ref:`BitmapFont<class_bitmapfont>`. This trades the faster loading time of :ref:`BitmapFont<class_bitmapfont>`\ s for the ability to change font parameters like size and spacing during runtime. :ref:`DynamicFontData<class_dynamicfontdata>` is used for referencing the font file paths.
Member Function Description
---------------------------
@@ -78,14 +83,20 @@ Member Function Description
- void **add_fallback** **(** :ref:`DynamicFontData<class_dynamicfontdata>` data **)**
Adds a fallback font.
.. _class_DynamicFont_get_fallback:
- :ref:`DynamicFontData<class_dynamicfontdata>` **get_fallback** **(** :ref:`int<class_int>` idx **)** const
Returns the fallback font at index ``idx``.
.. _class_DynamicFont_get_fallback_count:
- :ref:`int<class_int>` **get_fallback_count** **(** **)** const
Returns the number of fallback fonts.
.. _class_DynamicFont_get_font_data:
- :ref:`DynamicFontData<class_dynamicfontdata>` **get_font_data** **(** **)** const
@@ -94,44 +105,66 @@ Member Function Description
- :ref:`int<class_int>` **get_size** **(** **)** const
Returns the font size in pixels.
.. _class_DynamicFont_get_spacing:
- :ref:`int<class_int>` **get_spacing** **(** :ref:`int<class_int>` type **)** const
Returns the given type of spacing in pixels. See ``SPACING\_\*`` constants.
.. _class_DynamicFont_get_use_filter:
- :ref:`bool<class_bool>` **get_use_filter** **(** **)** const
Returns ``true`` if filtering is used.
.. _class_DynamicFont_get_use_mipmaps:
- :ref:`bool<class_bool>` **get_use_mipmaps** **(** **)** const
Returns ``true`` if mipmapping is used.
.. _class_DynamicFont_remove_fallback:
- void **remove_fallback** **(** :ref:`int<class_int>` idx **)**
Removes the fallback font at index ``idx``.
.. _class_DynamicFont_set_fallback:
- void **set_fallback** **(** :ref:`int<class_int>` idx, :ref:`DynamicFontData<class_dynamicfontdata>` data **)**
Sets the fallback font at index ``idx``.
.. _class_DynamicFont_set_font_data:
- void **set_font_data** **(** :ref:`DynamicFontData<class_dynamicfontdata>` data **)**
Sets the :ref:`DynamicFontData<class_dynamicfontdata>`.
.. _class_DynamicFont_set_size:
- void **set_size** **(** :ref:`int<class_int>` data **)**
Sets the font size.
.. _class_DynamicFont_set_spacing:
- void **set_spacing** **(** :ref:`int<class_int>` type, :ref:`int<class_int>` value **)**
Sets the spacing of the given type. See ``SPACING\_\*`` constants.
.. _class_DynamicFont_set_use_filter:
- void **set_use_filter** **(** :ref:`bool<class_bool>` enable **)**
Set to ``true`` to use filtering.
.. _class_DynamicFont_set_use_mipmaps:
- void **set_use_mipmaps** **(** :ref:`bool<class_bool>` enable **)**
Set to ``true`` to use mipmapping.

13
classes/class_dynamicfontdata.rst
View File

@@ -14,7 +14,7 @@ DynamicFontData
Brief Description
-----------------
Used with :ref:`DynamicFont<class_dynamicfont>` to describe the location of a font file.
Member Functions
----------------
@@ -28,7 +28,12 @@ Member Functions
Member Variables
----------------
- :ref:`String<class_string>` **font_path**
- :ref:`String<class_string>` **font_path** - The path to the vector font file.
Description
-----------
Used with :ref:`DynamicFont<class_dynamicfont>` to describe the location of a vector font file for dynamic rendering at runtime.
Member Function Description
---------------------------
@@ -37,8 +42,12 @@ Member Function Description
- :ref:`String<class_string>` **get_font_path** **(** **)** const
Returns the font path.
.. _class_DynamicFontData_set_font_path:
- void **set_font_path** **(** :ref:`String<class_string>` path **)**
Sets the font path.

3
classes/class_editorfiledialog.rst
View File

@@ -65,9 +65,12 @@ Signals
-------
- **dir_selected** **(** :ref:`String<class_string>` dir **)**
- **file_selected** **(** :ref:`String<class_string>` path **)**
- **files_selected** **(** :ref:`PoolStringArray<class_poolstringarray>` paths **)**
Numeric Constants
-----------------

3
classes/class_editorfilesystem.rst
View File

@@ -41,10 +41,13 @@ Signals
-------
- **filesystem_changed** **(** **)**
Emitted if the filesystem changed.
- **resources_reimported** **(** :ref:`PoolStringArray<class_poolstringarray>` resources **)**
- **sources_changed** **(** :ref:`bool<class_bool>` exist **)**
Emitted if the source of any imported file changed.

2
classes/class_editorimportplugin.rst
View File

@@ -82,7 +82,7 @@ Below is an example EditorImportPlugin that imports a :ref:`Mesh<class_mesh>` fr
func get_preset_name(i):
return "Default"
func get_import_optons(i):
func get_import_options(i):
return [{"name": "my_option", "default_value": false}]
func load(src, dst, opts, r_platform_variants, r_gen_files):

3
classes/class_editorplugin.rst
View File

@@ -97,12 +97,15 @@ Signals
-------
- **main_screen_changed** **(** :ref:`String<class_string>` screen_name **)**
Emitted when user change main screen view (2D, 3D, Script, AssetLib). Works also with screens which are defined by plugins.
- **scene_changed** **(** :ref:`Object<class_object>` scene_root **)**
Emitted when user change scene. The argument is a root node of freshly opened scene.
- **scene_closed** **(** :ref:`String<class_string>` filepath **)**
Emitted when user close scene. The argument is file path to a closed scene.

3
classes/class_editorresourcepreview.rst
View File

@@ -14,7 +14,7 @@ EditorResourcePreview
Brief Description
-----------------
Helper to generate previews of reources or files.
Helper to generate previews of resources or files.
Member Functions
----------------
@@ -35,6 +35,7 @@ Signals
-------
- **preview_invalidated** **(** :ref:`String<class_string>` path **)**
If a preview was invalidated (changed) this signal will emit (using the path of the preview)

3
classes/class_editorselection.rst
View File

@@ -35,6 +35,7 @@ Signals
-------
- **selection_changed** **(** **)**
Emitted when the selection changes.
@@ -62,7 +63,7 @@ Clear the selection.
- :ref:`Array<class_array>` **get_selected_nodes** **(** **)**
Get the list of selectes nodes.
Get the list of selected nodes.
.. _class_EditorSelection_get_transformable_selected_nodes:

1
classes/class_editorsettings.rst
View File

@@ -54,6 +54,7 @@ Signals
- **settings_changed** **(** **)**
Description
-----------

2
classes/class_editorspatialgizmo.rst
View File

@@ -97,7 +97,7 @@ Add an unscaled billboard for visualization. Call this function during :ref:`red
- void **commit_handle** **(** :ref:`int<class_int>` index, :ref:`Variant<class_variant>` restore, :ref:`bool<class_bool>` cancel=false **)** virtual
Commit a handle being edited (handles must have been prevously added by :ref:`add_handles<class_EditorSpatialGizmo_add_handles>`).
Commit a handle being edited (handles must have been previously added by :ref:`add_handles<class_EditorSpatialGizmo_add_handles>`).
If the cancel parameter is true, an option to restore the edited value to the original is provided.

9
classes/class_filedialog.rst
View File

@@ -61,12 +61,15 @@ Signals
-------
- **dir_selected** **(** :ref:`String<class_string>` dir **)**
Event emitted when the user selects a directory.
- **file_selected** **(** :ref:`String<class_string>` path **)**
Event emitted when the user selects a file (double clicks it or presses the OK button).
- **files_selected** **(** :ref:`PoolStringArray<class_poolstringarray>` paths **)**
Event emitted when the user selects multiple files.
@@ -87,8 +90,8 @@ Numeric Constants
- **MODE_OPEN_ANY** = **3** --- The dialog allows the selection of a file or a directory.
- **MODE_SAVE_FILE** = **4** --- The dialog will warn when a file exists.
- **ACCESS_RESOURCES** = **0** --- The dialog allows the selection of file and directory.
- **ACCESS_USERDATA** = **1** --- The dialog allows ascess files under :ref:`Resource<class_resource>` path(res://) .
- **ACCESS_FILESYSTEM** = **2** --- The dialog allows ascess files in whole file system.
- **ACCESS_USERDATA** = **1** --- The dialog allows access files under :ref:`Resource<class_resource>` path(res://) .
- **ACCESS_FILESYSTEM** = **2** --- The dialog allows access files in whole file system.
Description
-----------
@@ -160,7 +163,7 @@ Invalidate and update the current dialog content list.
- :ref:`bool<class_bool>` **is_showing_hidden_files** **(** **)** const
Return true if the diaog allows show hidden files.
Return true if the dialog allows show hidden files.
.. _class_FileDialog_set_access:

1
classes/class_gdfunctionstate.rst
View File

@@ -30,6 +30,7 @@ Signals
- **completed** **(** :ref:`Nil<class_nil>` result **)**
Description
-----------

59
classes/class_godotsharp.rst Normal file
View File

@@ -0,0 +1,59 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the GodotSharp.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_GodotSharp:
GodotSharp
==========
**Inherits:** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Member Functions
----------------
+--------------------------+---------------------------------------------------------------------------------+
| void | :ref:`attach_thread<class_GodotSharp_attach_thread>` **(** **)** |
+--------------------------+---------------------------------------------------------------------------------+
| void | :ref:`detach_thread<class_GodotSharp_detach_thread>` **(** **)** |
+--------------------------+---------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_domain_loaded<class_GodotSharp_is_domain_loaded>` **(** **)** |
+--------------------------+---------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_finalizing_domain<class_GodotSharp_is_finalizing_domain>` **(** **)** |
+--------------------------+---------------------------------------------------------------------------------+
Member Function Description
---------------------------
.. _class_GodotSharp_attach_thread:
- void **attach_thread** **(** **)**
Attaches the current thread to the mono runtime.
.. _class_GodotSharp_detach_thread:
- void **detach_thread** **(** **)**
Detaches the current thread from the mono runtime.
.. _class_GodotSharp_is_domain_loaded:
- :ref:`bool<class_bool>` **is_domain_loaded** **(** **)**
Returns whether the scripts domain is loaded.
.. _class_GodotSharp_is_finalizing_domain:
- :ref:`bool<class_bool>` **is_finalizing_domain** **(** **)**
Returns whether the scripts domain is being finalized.

10
classes/class_graphedit.rst
View File

@@ -55,30 +55,40 @@ Signals
-------
- **_begin_node_move** **(** **)**
Signal sent at the beginning of a GraphNode movement.
- **_end_node_move** **(** **)**
Signal sent at the end of a GraphNode movement.
- **connection_request** **(** :ref:`String<class_string>` from, :ref:`int<class_int>` from_slot, :ref:`String<class_string>` to, :ref:`int<class_int>` to_slot **)**
Signal sent to the GraphEdit when the connection between 'from_slot' slot of 'from' GraphNode and 'to_slot' slot of 'to' GraphNode is attempted to be created.
- **connection_to_empty** **(** :ref:`String<class_string>` from, :ref:`int<class_int>` from_slot, :ref:`Vector2<class_vector2>` release_position **)**
- **delete_nodes_request** **(** **)**
Signal sent when a GraphNode is attempted to be removed from the GraphEdit.
- **disconnection_request** **(** :ref:`String<class_string>` from, :ref:`int<class_int>` from_slot, :ref:`String<class_string>` to, :ref:`int<class_int>` to_slot **)**
Signal sent to the GraphEdit when the connection between 'from_slot' slot of 'from' GraphNode and 'to_slot' slot of 'to' GraphNode is attempted to be removed.
- **duplicate_nodes_request** **(** **)**
Signal sent when a GraphNode is attempted to be duplicated in the GraphEdit.
- **node_selected** **(** :ref:`Object<class_object>` node **)**
- **popup_request** **(** :ref:`Vector2<class_vector2>` p_position **)**
Signal sent when a popup is requested. Happens on right-clicking in the GraphEdit. 'p_position' is the position of the mouse pointer when the signal is sent.
- **scroll_offset_changed** **(** :ref:`Vector2<class_vector2>` ofs **)**
Description
-----------

5
classes/class_graphnode.rst
View File

@@ -87,19 +87,24 @@ Signals
-------
- **close_request** **(** **)**
Signal sent on closing the GraphNode.
- **dragged** **(** :ref:`Vector2<class_vector2>` from, :ref:`Vector2<class_vector2>` to **)**
Signal sent when the GraphNode is dragged.
- **offset_changed** **(** **)**
Signal sent when the GraphNode is moved.
- **raise_request** **(** **)**
Signal sent when the GraphNode is requested to be displayed over other ones. Happens on focusing (clicking into) the GraphNode.
- **resize_request** **(** :ref:`Vector2<class_vector2>` new_minsize **)**
Member Variables
----------------

3
classes/class_httprequest.rst
View File

@@ -51,6 +51,7 @@ Signals
-------
- **request_completed** **(** :ref:`int<class_int>` result, :ref:`int<class_int>` response_code, :ref:`PoolStringArray<class_poolstringarray>` headers, :ref:`PoolByteArray<class_poolbytearray>` body **)**
This signal is emitted upon request completion.
@@ -71,7 +72,7 @@ Numeric Constants
- **RESULT_CONNECTION_ERROR** = **4** --- Request failed due to connection(read/write) error.
- **RESULT_SSL_HANDSHAKE_ERROR** = **5** --- Request failed on SSL handshake.
- **RESULT_NO_RESPONSE** = **6** --- Request does not have a response(yet).
- **RESULT_BODY_SIZE_LIMIT_EXCEEDED** = **7** --- Request exceded its maximum size limit, see :ref:`set_body_size_limit<class_HTTPRequest_set_body_size_limit>`.
- **RESULT_BODY_SIZE_LIMIT_EXCEEDED** = **7** --- Request exceeded its maximum size limit, see :ref:`set_body_size_limit<class_HTTPRequest_set_body_size_limit>`.
- **RESULT_REQUEST_FAILED** = **8** --- Request failed. (unused)
- **RESULT_DOWNLOAD_FILE_CANT_OPEN** = **9** --- HTTPRequest couldn't open the download file.
- **RESULT_DOWNLOAD_FILE_WRITE_ERROR** = **10** --- HTTPRequest couldn't write to the download file.

19
classes/class_input.rst
View File

@@ -97,6 +97,7 @@ Signals
-------
- **joy_connection_changed** **(** :ref:`int<class_int>` index, :ref:`bool<class_bool>` connected **)**
Emitted when a joypad device has been connected or disconnected
@@ -111,7 +112,7 @@ Numeric Constants
Description
-----------
A Singleton that deals with inputs. This includes key presses, mouse buttons and movement, joypads, and input actions.
A Singleton that deals with inputs. This includes key presses, mouse buttons and movement, joypads, and input actions. Actions and their events can be set in the Project Settings / Input Map tab. Or be set with :ref:`InputMap<class_inputmap>`.
Member Function Description
---------------------------
@@ -160,7 +161,7 @@ If the device has a gyroscope, this will return the rate of rotation in rad/s ar
- :ref:`float<class_float>` **get_joy_axis** **(** :ref:`int<class_int>` device, :ref:`int<class_int>` axis **)** const
Returns the current value of the joypad axis at given index (see JOY\_\* constants in :ref:`@Global Scope<class_@global scope>`)
Returns the current value of the joypad axis at given index (see ``JOY\_\*`` constants in :ref:`@Global Scope<class_@global scope>`)
.. _class_Input_get_joy_axis_index_from_string:
@@ -230,39 +231,43 @@ Return the mouse mode. See the constants for more information.
- :ref:`bool<class_bool>` **is_action_just_pressed** **(** :ref:`String<class_string>` action **)** const
Returns ``true`` when you start pressing the action event.
.. _class_Input_is_action_just_released:
- :ref:`bool<class_bool>` **is_action_just_released** **(** :ref:`String<class_string>` action **)** const
Returns ``true`` when you stop pressing the action event.
.. _class_Input_is_action_pressed:
- :ref:`bool<class_bool>` **is_action_pressed** **(** :ref:`String<class_string>` action **)** const
Returns true or false depending on whether the action event is pressed. Actions and their events can be set in the Project Settings / Input Map tab. Or be set with :ref:`InputMap<class_inputmap>`.
Returns ``true`` if you are pressing the action event.
.. _class_Input_is_joy_button_pressed:
- :ref:`bool<class_bool>` **is_joy_button_pressed** **(** :ref:`int<class_int>` device, :ref:`int<class_int>` button **)** const
Returns if the joypad button at the given index is currently pressed. (see JOY\_\* constants in :ref:`@Global Scope<class_@global scope>`)
Returns ``true`` if you are pressing the joypad button. (see ``JOY\_\*`` constants in :ref:`@Global Scope<class_@global scope>`)
.. _class_Input_is_joy_known:
- :ref:`bool<class_bool>` **is_joy_known** **(** :ref:`int<class_int>` device **)**
Returns if the specified device is known by the system. This means that it sets all button and axis indices exactly as defined in the JOY\_\* constants (see :ref:`@Global Scope<class_@global scope>`). Unknown joypads are not expected to match these constants, but you can still retrieve events from them.
Returns ``true`` if the system knows the specified device. This means that it sets all button and axis indices exactly as defined in the ``JOY\_\*`` constants (see :ref:`@Global Scope<class_@global scope>`). Unknown joypads are not expected to match these constants, but you can still retrieve events from them.
.. _class_Input_is_key_pressed:
- :ref:`bool<class_bool>` **is_key_pressed** **(** :ref:`int<class_int>` scancode **)** const
Returns true or false depending on whether the key is pressed or not. You can pass KEY\_\*, which are pre-defined constants listed in :ref:`@Global Scope<class_@global scope>`.
Returns ``true`` if you are pressing the key. You can pass ``KEY\_\*``, which are pre-defined constants listed in :ref:`@Global Scope<class_@global scope>`.
.. _class_Input_is_mouse_button_pressed:
- :ref:`bool<class_bool>` **is_mouse_button_pressed** **(** :ref:`int<class_int>` button **)** const
Returns true or false depending on whether mouse button is pressed or not. You can pass BUTTON\_\*, which are pre-defined constants listed in :ref:`@Global Scope<class_@global scope>`.
Returns ``true`` if you are pressing the mouse button. You can pass ``BUTTON\_\*``, which are pre-defined constants listed in :ref:`@Global Scope<class_@global scope>`.
.. _class_Input_joy_connection_changed:

8
classes/class_itemlist.rst
View File

@@ -127,9 +127,11 @@ Signals
-------
- **item_activated** **(** :ref:`int<class_int>` index **)**
Fired when specified list item is activated via double click or Enter.
- **item_rmb_selected** **(** :ref:`int<class_int>` index, :ref:`Vector2<class_vector2>` at_position **)**
Fired when specified list item has been selected via right mouse clicking.
The click position is also provided to allow appropriate popup of context menus
@@ -137,10 +139,12 @@ The click position is also provided to allow appropriate popup of context menus
at the correct location.
- **item_selected** **(** :ref:`int<class_int>` index **)**
Fired when specified item has been selected.
- **multi_selected** **(** :ref:`int<class_int>` index, :ref:`bool<class_bool>` selected **)**
Fired when a multiple selection is altered on a list allowing mutliple selection.
Fired when a multiple selection is altered on a list allowing multiple selection.
Member Variables
@@ -317,7 +321,7 @@ Returns whether or not the item at the specified index is selectable.
- :ref:`bool<class_bool>` **is_item_tooltip_enabled** **(** :ref:`int<class_int>` idx **)** const
Returns whether the tooptip is enabled for specified item index.
Returns whether the tooltip is enabled for specified item index.
.. _class_ItemList_is_same_column_width:

2
classes/class_jsonparseresult.rst
View File

@@ -43,7 +43,7 @@ Member Variables
- :ref:`int<class_int>` **error** - The error type if JSON source was not successfully parsed. See [@Global Scope]ERR_* constants.
- :ref:`int<class_int>` **error_line** - The line number where the error occurred if JSON source was not successfully parsed.
- :ref:`String<class_string>` **error_string** - The error message if JSON source was not successfully parsed. See [@Global Scope]ERR_* constants.
- :ref:`Variant<class_variant>` **result** - A [Variant] containing the parsed JSON. Use typeof() to check if it is what you expect. For exemple, if JSON source starts with braces [code]{}[/code] a [Dictionary] will be returned, if JSON source starts with array braces [code][][/code] an [Array] will be returned.
- :ref:`Variant<class_variant>` **result** - A [Variant] containing the parsed JSON. Use typeof() to check if it is what you expect. For example, if JSON source starts with braces [code]{}[/code] a [Dictionary] will be returned, if JSON source starts with array braces [code][][/code] an [Array] will be returned.
[i]Be aware that the JSON specification does not define integer or float types, but only a number type. Therefore, parsing a JSON text will convert all numerical values to float types.[/i]
[codeblock]
p = JSON.parse('["hello", "world", "!"]')

2
classes/class_lineedit.rst
View File

@@ -81,9 +81,11 @@ Signals
-------
- **text_changed** **(** :ref:`String<class_string>` text **)**
When the text changes, this signal is emitted.
- **text_entered** **(** :ref:`String<class_string>` text **)**
This signal is emitted when the user presses KEY_ENTER on the :ref:`LineEdit<class_lineedit>`. This signal is often used as an alternate confirmation mechanism in dialogs.

1
classes/class_menubutton.rst
View File

@@ -27,6 +27,7 @@ Signals
-------
- **about_to_show** **(** **)**
Emitted when :ref:`PopupMenu<class_popupmenu>` of this MenuButton is about to show.

5
classes/class_networkedmultiplayerpeer.rst
View File

@@ -43,18 +43,23 @@ Signals
-------
- **connection_failed** **(** **)**
Emitted when failed to connect to server.
- **connection_succeeded** **(** **)**
Emitted when successfully connected to server.
- **peer_connected** **(** :ref:`int<class_int>` id **)**
Emitted by the server when a client is connected.
- **peer_disconnected** **(** :ref:`int<class_int>` id **)**
Emitted by the server when a client is disconnected.
- **server_disconnected** **(** **)**
Emitted by clients when server is disconnected.

3
classes/class_ninepatchrect.rst
View File

@@ -49,6 +49,7 @@ Signals
-------
- **texture_changed** **(** **)**
Fired when the node's texture changes.
@@ -58,7 +59,7 @@ Member Variables
- :ref:`int<class_int>` **axis_stretch_horizontal** - Doesn't do anything at the time of writing.
- :ref:`int<class_int>` **axis_stretch_vertical** - Doesn't do anything at the time of writing.
- :ref:`bool<class_bool>` **draw_center** - If [code]true[/code], draw the panel's center. Else, only draw the 9-slice's borders. Default value: [code]true[/code]
- :ref:`int<class_int>` **patch_margin_bottom** - The height of the 9-slice's bottom row. A margin of 16 means the 9-slice's bottom corners and side will have a height of 16 pixels. You can set all 4 margin values indivually to create panels with non-uniform borders.
- :ref:`int<class_int>` **patch_margin_bottom** - The height of the 9-slice's bottom row. A margin of 16 means the 9-slice's bottom corners and side will have a height of 16 pixels. You can set all 4 margin values individually to create panels with non-uniform borders.
- :ref:`int<class_int>` **patch_margin_left** - The height of the 9-slice's left column.
- :ref:`int<class_int>` **patch_margin_right** - The height of the 9-slice's right column.
- :ref:`int<class_int>` **patch_margin_top** - The height of the 9-slice's top row.

3
classes/class_node.rst
View File

@@ -199,12 +199,15 @@ Signals
-------
- **renamed** **(** **)**
Emitted when the node is renamed.
- **tree_entered** **(** **)**
Emitted when Node enters the tree.
- **tree_exited** **(** **)**
Emitted when Node exits the tree.

7
classes/class_object.rst
View File

@@ -7,7 +7,7 @@
Object
======
**Inherited By:** :ref:`Physics2DServer<class_physics2dserver>`, :ref:`MainLoop<class_mainloop>`, :ref:`Input<class_input>`, :ref:`Node<class_node>`, :ref:`Geometry<class_geometry>`, :ref:`ARVRPositionalTracker<class_arvrpositionaltracker>`, :ref:`TreeItem<class_treeitem>`, :ref:`PhysicsDirectBodyState<class_physicsdirectbodystate>`, :ref:`ARVRServer<class_arvrserver>`, :ref:`PhysicsDirectSpaceState<class_physicsdirectspacestate>`, :ref:`Reference<class_reference>`, :ref:`Engine<class_engine>`, :ref:`Physics2DDirectSpaceState<class_physics2ddirectspacestate>`, :ref:`InputMap<class_inputmap>`, :ref:`UndoRedo<class_undoredo>`, :ref:`PhysicsServer<class_physicsserver>`, :ref:`ProjectSettings<class_projectsettings>`, :ref:`ResourceSaver<class_resourcesaver>`, :ref:`Performance<class_performance>`, :ref:`ResourceLoader<class_resourceloader>`, :ref:`JSON<class_json>`, :ref:`AudioServer<class_audioserver>`, :ref:`IP<class_ip>`, :ref:`ClassDB<class_classdb>`, :ref:`VisualServer<class_visualserver>`, :ref:`OS<class_os>`, :ref:`EditorSelection<class_editorselection>`, :ref:`Physics2DDirectBodyState<class_physics2ddirectbodystate>`, :ref:`TranslationServer<class_translationserver>`, :ref:`EditorFileSystemDirectory<class_editorfilesystemdirectory>`
**Inherited By:** :ref:`Physics2DServer<class_physics2dserver>`, :ref:`MainLoop<class_mainloop>`, :ref:`Input<class_input>`, :ref:`Node<class_node>`, :ref:`Geometry<class_geometry>`, :ref:`ARVRPositionalTracker<class_arvrpositionaltracker>`, :ref:`TreeItem<class_treeitem>`, :ref:`PhysicsDirectBodyState<class_physicsdirectbodystate>`, :ref:`ARVRServer<class_arvrserver>`, :ref:`PhysicsDirectSpaceState<class_physicsdirectspacestate>`, :ref:`Reference<class_reference>`, :ref:`Engine<class_engine>`, :ref:`Physics2DDirectSpaceState<class_physics2ddirectspacestate>`, :ref:`InputMap<class_inputmap>`, :ref:`UndoRedo<class_undoredo>`, :ref:`PhysicsServer<class_physicsserver>`, :ref:`ProjectSettings<class_projectsettings>`, :ref:`ResourceSaver<class_resourcesaver>`, :ref:`Performance<class_performance>`, :ref:`ResourceLoader<class_resourceloader>`, :ref:`JSON<class_json>`, :ref:`AudioServer<class_audioserver>`, :ref:`IP<class_ip>`, :ref:`ClassDB<class_classdb>`, :ref:`VisualServer<class_visualserver>`, :ref:`OS<class_os>`, :ref:`GodotSharp<class_godotsharp>`, :ref:`EditorSelection<class_editorselection>`, :ref:`Physics2DDirectBodyState<class_physics2ddirectbodystate>`, :ref:`TranslationServer<class_translationserver>`, :ref:`EditorFileSystemDirectory<class_editorfilesystemdirectory>`
**Category:** Core
@@ -106,6 +106,7 @@ Signals
- **script_changed** **(** **)**
Numeric Constants
-----------------
@@ -122,7 +123,7 @@ Base class for all non built-in types. Everything not a built-in type starts the
Objects do not manage memory, if inheriting from one the object will most likely have to be deleted manually (call the :ref:`free<class_Object_free>` function from the script or delete from C++).
Some derivates add memory management, such as :ref:`Reference<class_reference>` (which keeps a reference count and deletes itself automatically when no longer referenced) and :ref:`Node<class_node>`, which deletes the children tree when deleted.
Some derivatives add memory management, such as :ref:`Reference<class_reference>` (which keeps a reference count and deletes itself automatically when no longer referenced) and :ref:`Node<class_node>`, which deletes the children tree when deleted.
Objects export properties, which are mainly useful for storage and editing, but not really so much in programming. Properties are exported in :ref:`_get_property_list<class_Object__get_property_list>` and handled in :ref:`_get<class_Object__get>` and :ref:`_set<class_Object__set>`. However, scripting languages and C++ have simpler means to export them.
@@ -219,7 +220,7 @@ Return the class of the object as a string.
- :ref:`Array<class_array>` **get_incoming_connections** **(** **)** const
Returns an :ref:`Array<class_array>` of dictionaries with informations about signals that are connected to this object.
Returns an :ref:`Array<class_array>` of dictionaries with information about signals that are connected to this object.
Inside each :ref:`Dictionary<class_dictionary>` there are 3 fields:

1
classes/class_optionbutton.rst
View File

@@ -65,6 +65,7 @@ Signals
-------
- **item_selected** **(** :ref:`int<class_int>` ID **)**
This signal is emitted when the current item was changed by the user. ID of the item selected is passed as argument (if no IDs were added, ID will be just the item index).

2
classes/class_physics2dshapequeryparameters.rst
View File

@@ -147,6 +147,6 @@ Set the :ref:`RID<class_rid>` of the shape to be used in queries.
- void **set_transform** **(** :ref:`Transform2D<class_transform2d>` transform **)**
Set the transormation matrix of the shape. This is necessary to set its position/rotation/scale.
Set the transformation matrix of the shape. This is necessary to set its position/rotation/scale.

2
classes/class_popup.rst
View File

@@ -39,9 +39,11 @@ Signals
-------
- **about_to_show** **(** **)**
This signal is emitted when a popup is about to be shown. (often used in :ref:`PopupMenu<class_popupmenu>` for clearing the list of options and creating a new one according to the current context).
- **popup_hide** **(** **)**
This signal is emitted when a popup is hidden.

2
classes/class_popupmenu.rst
View File

@@ -111,9 +111,11 @@ Signals
-------
- **id_pressed** **(** :ref:`int<class_int>` ID **)**
This event is emitted when an item of some id is pressed or its accelerator is activated.
- **index_pressed** **(** :ref:`int<class_int>` index **)**
This event is emitted when an item of some index is pressed or its accelerator is activated.

1
classes/class_proximitygroup.rst
View File

@@ -36,6 +36,7 @@ Signals
- **broadcast** **(** :ref:`String<class_string>` name, :ref:`Array<class_array>` parameters **)**
Member Variables
----------------

2
classes/class_range.rst
View File

@@ -63,9 +63,11 @@ Signals
-------
- **changed** **(** **)**
This signal is emitted when min, max, range or step change.
- **value_changed** **(** :ref:`float<class_float>` value **)**
This signal is emitted when value changes.

2
classes/class_raycast.rst
View File

@@ -63,7 +63,7 @@ Member Variables
----------------
- :ref:`Vector3<class_vector3>` **cast_to** - The ray's destination point, relative to the RayCast's [code]position[/code].
- :ref:`int<class_int>` **collision_layer** - The RayCast's collison layer(s). Only bodies in the same collision layer(s) will be detected.
- :ref:`int<class_int>` **collision_layer** - The RayCast's collision layer(s). Only bodies in the same collision layer(s) will be detected.
- :ref:`bool<class_bool>` **enabled** - If [code]true[/code], collisions will be reported. Default value: [code]false[/code].
- :ref:`int<class_int>` **type_mask** - Object types to detect using a logical sum (OR operation) of type constants defined in [Physics2DDirectSpaceState].
Example:

2
classes/class_raycast2d.rst
View File

@@ -67,7 +67,7 @@ Member Variables
----------------
- :ref:`Vector2<class_vector2>` **cast_to** - The ray's destination point, relative to the RayCast's [code]position[/code].
- :ref:`int<class_int>` **collision_layer** - The RayCast2D's collison layer(s). Only bodies in the same collision layer(s) will be detected.
- :ref:`int<class_int>` **collision_layer** - The RayCast2D's collision layer(s). Only bodies in the same collision layer(s) will be detected.
- :ref:`bool<class_bool>` **enabled** - If [code]true[/code], collisions will be reported. Default value: [code]false[/code].
- :ref:`bool<class_bool>` **exclude_parent** - If [code]true[/code], the parent node will be excluded from collision detection. Default value: [code]true[/code].
- :ref:`int<class_int>` **type_mask** - Object types to detect using a logical sum (OR operation) of type constants defined in [Physics2DDirectSpaceState].

1
classes/class_resource.rst
View File

@@ -52,6 +52,7 @@ Signals
- **changed** **(** **)**
Member Variables
----------------

1
classes/class_richtextlabel.rst
View File

@@ -112,6 +112,7 @@ Signals
- **meta_clicked** **(** :ref:`Nil<class_nil>` meta **)**
Member Variables
----------------

5
classes/class_rigidbody.rst
View File

@@ -101,22 +101,27 @@ Signals
-------
- **body_entered** **(** :ref:`Object<class_object>` body **)**
Emitted when a body enters into contact with this one. Contact monitor and contacts reported must be enabled for this to work.
- **body_exited** **(** :ref:`Object<class_object>` body **)**
Emitted when a body shape exits contact with this one. Contact monitor and contacts reported must be enabled for this to work.
- **body_shape_entered** **(** :ref:`int<class_int>` body_id, :ref:`Object<class_object>` body, :ref:`int<class_int>` body_shape, :ref:`int<class_int>` local_shape **)**
Emitted when a body enters into contact with this one. Contact monitor and contacts reported must be enabled for this to work.
This signal not only receives the body that collided with this one, but also its :ref:`RID<class_rid>` (body_id), the shape index from the colliding body (body_shape), and the shape index from this body (local_shape) the other body collided with.
- **body_shape_exited** **(** :ref:`int<class_int>` body_id, :ref:`Object<class_object>` body, :ref:`int<class_int>` body_shape, :ref:`int<class_int>` local_shape **)**
Emitted when a body shape exits contact with this one. Contact monitor and contacts reported must be enabled for this to work.
This signal not only receives the body that stopped colliding with this one, but also its :ref:`RID<class_rid>` (body_id), the shape index from the colliding body (body_shape), and the shape index from this body (local_shape) the other body stopped colliding with.
- **sleeping_state_changed** **(** **)**
Emitted when the body changes its sleeping state. Either by sleeping or waking up.

5
classes/class_rigidbody2d.rst
View File

@@ -113,22 +113,27 @@ Signals
-------
- **body_entered** **(** :ref:`Object<class_object>` body **)**
Emitted when a body enters into contact with this one. Contact monitor and contacts reported must be enabled for this to work.
- **body_exited** **(** :ref:`Object<class_object>` body **)**
Emitted when a body exits contact with this one. Contact monitor and contacts reported must be enabled for this to work.
- **body_shape_entered** **(** :ref:`int<class_int>` body_id, :ref:`Object<class_object>` body, :ref:`int<class_int>` body_shape, :ref:`int<class_int>` local_shape **)**
Emitted when a body enters into contact with this one. Contact monitor and contacts reported must be enabled for this to work.
This signal not only receives the body that collided with this one, but also its :ref:`RID<class_rid>` (body_id), the shape index from the colliding body (body_shape), and the shape index from this body (local_shape) the other body collided with.
- **body_shape_exited** **(** :ref:`int<class_int>` body_id, :ref:`Object<class_object>` body, :ref:`int<class_int>` body_shape, :ref:`int<class_int>` local_shape **)**
Emitted when a body shape exits contact with this one. Contact monitor and contacts reported must be enabled for this to work.
This signal not only receives the body that stopped colliding with this one, but also its :ref:`RID<class_rid>` (body_id), the shape index from the colliding body (body_shape), and the shape index from this body (local_shape) the other body stopped colliding with.
- **sleeping_state_changed** **(** **)**
Emitted when the body changes its sleeping state. Either by sleeping or waking up.

12
classes/class_scenetree.rst
View File

@@ -103,18 +103,30 @@ Signals
-------
- **connected_to_server** **(** **)**
- **connection_failed** **(** **)**
- **files_dropped** **(** :ref:`PoolStringArray<class_poolstringarray>` files, :ref:`int<class_int>` screen **)**
- **idle_frame** **(** **)**
- **network_peer_connected** **(** :ref:`int<class_int>` id **)**
- **network_peer_disconnected** **(** :ref:`int<class_int>` id **)**
- **node_configuration_warning_changed** **(** :ref:`Object<class_object>` node **)**
- **node_removed** **(** :ref:`Object<class_object>` node **)**
- **physics_frame** **(** **)**
- **screen_resized** **(** **)**
- **server_disconnected** **(** **)**
- **tree_changed** **(** **)**
Numeric Constants
-----------------

1
classes/class_scenetreetimer.rst
View File

@@ -30,6 +30,7 @@ Signals
- **timeout** **(** **)**
Member Function Description
---------------------------

2
classes/class_scripteditor.rst
View File

@@ -29,9 +29,11 @@ Signals
-------
- **editor_script_changed** **(** :ref:`Object<class_object>` script **)**
Emitted when user changed active script. Argument is a freshly activated :ref:`Script<class_script>`.
- **script_close** **(** :ref:`Object<class_object>` script **)**
Emitted when editor is about to close the active script. Argument is a :ref:`Script<class_script>` that is going to be closed.

1
classes/class_scrollbar.rst
View File

@@ -32,6 +32,7 @@ Signals
- **scrolling** **(** **)**
Member Variables
----------------

9
classes/class_spatial.rst
View File

@@ -111,6 +111,7 @@ Signals
-------
- **visibility_changed** **(** **)**
Emitted when node visibility changes.
@@ -287,7 +288,7 @@ Rotates the node in local space on Z axis by angle in radians.
- void **set_as_toplevel** **(** :ref:`bool<class_bool>` enable **)**
Makes the node ignore its parents tranformations. Node tranformations are only in global space.
Makes the node ignore its parents transformations. Node transformations are only in global space.
.. _class_Spatial_set_gizmo:
@@ -305,7 +306,7 @@ Set the transform globally, relative to world space.
- void **set_identity** **(** **)**
Reset all tranformations for this node. Set its Transform3D to identity matrix.
Reset all transformations for this node. Set its Transform3D to identity matrix.
.. _class_Spatial_set_ignore_transform_notification:
@@ -367,13 +368,13 @@ Enables rendering of this node. Change Spatial Visible property to "True".
- :ref:`Vector3<class_vector3>` **to_global** **(** :ref:`Vector3<class_vector3>` local_point **)** const
Tranforms :ref:`Vector3<class_vector3>` "local_point" from this node's local space to world space.
Transforms :ref:`Vector3<class_vector3>` "local_point" from this node's local space to world space.
.. _class_Spatial_to_local:
- :ref:`Vector3<class_vector3>` **to_local** **(** :ref:`Vector3<class_vector3>` global_point **)** const
Tranforms :ref:`Vector3<class_vector3>` "global_point" from world space to this node's local space.
Transforms :ref:`Vector3<class_vector3>` "global_point" from world space to this node's local space.
.. _class_Spatial_translate:

1
classes/class_splitcontainer.rst
View File

@@ -39,6 +39,7 @@ Signals
-------
- **dragged** **(** :ref:`int<class_int>` offset **)**
Emitted when the dragger is dragged by user.

2
classes/class_sprite.rst
View File

@@ -73,9 +73,11 @@ Signals
-------
- **frame_changed** **(** **)**
Emitted when the member frame changes.
- **texture_changed** **(** **)**
Emitted when the member texture changes.

1
classes/class_sprite3d.rst
View File

@@ -49,6 +49,7 @@ Signals
-------
- **frame_changed** **(** **)**
Emitted when the member frame changes.

6
classes/class_styleboxflat.rst
View File

@@ -84,7 +84,7 @@ Member Functions
Member Variables
----------------
- :ref:`bool<class_bool>` **anti_aliasing** - Anti Aliasing draws a small ring around edges. This ring fades to transparent. As a result edges look much smoother. This is only noticable when using rounded corners.
- :ref:`bool<class_bool>` **anti_aliasing** - Anti Aliasing draws a small ring around edges. This ring fades to transparent. As a result edges look much smoother. This is only noticeable when using rounded corners.
- :ref:`int<class_int>` **anti_aliasing_size** - This changes the size of the faded ring. Higher values can be used to achieve a "blurry" effect.
- :ref:`Color<class_color>` **bg_color** - The background color of the stylebox.
- :ref:`bool<class_bool>` **border_blend** - When set to true, the border will fade into the background color.
@@ -129,14 +129,14 @@ This stylebox can be used to achieve all kinds of looks without the need of a te
height = 30
corner_radius_top_left = 50
corner_raidus_bottom_left = 100
corner_radius_bottom_left = 100
The relative system now would take the 1:2 ratio of the two left corners to calculate the actual corner width. Both corners added will **never** be more than the height. Result:
::
corner_radius_top_left: 10
corner_raidus_bottom_left: 20
corner_radius_bottom_left: 20
Member Function Description
---------------------------

1
classes/class_styleboxtexture.rst
View File

@@ -66,6 +66,7 @@ Signals
- **texture_changed** **(** **)**
Member Variables
----------------

35
classes/class_tabcontainer.rst
View File

@@ -61,19 +61,22 @@ Signals
-------
- **pre_popup_pressed** **(** **)**
- **tab_changed** **(** :ref:`int<class_int>` tab **)**
Emitted only when the current tab changes.
- **tab_selected** **(** :ref:`int<class_int>` tab **)**
Emitted when a tab is being selected, even if it is the same tab.
Member Variables
----------------
- :ref:`int<class_int>` **current_tab**
- :ref:`int<class_int>` **tab_align**
- :ref:`bool<class_bool>` **tabs_visible**
- :ref:`int<class_int>` **current_tab** - The current tab.
- :ref:`int<class_int>` **tab_align** - The alignment of all the tabs of the tab container. See the [code]ALIGN_*[/code] constants.
- :ref:`bool<class_bool>` **tabs_visible** - If [code]true[/code] all tabs that are children of the TabContainer will be visible.
Numeric Constants
-----------------
@@ -96,13 +99,13 @@ Member Function Description
- :ref:`bool<class_bool>` **are_tabs_visible** **(** **)** const
Return whether the tabs should be visible or hidden.
Returns ``true`` if the tabs are visible.
.. _class_TabContainer_get_current_tab:
- :ref:`int<class_int>` **get_current_tab** **(** **)** const
Return the current tab index that is being shown.
Returns the current tab index that is being shown.
.. _class_TabContainer_get_current_tab_control:
@@ -116,39 +119,43 @@ Return the current tab index that is being shown.
- :ref:`int<class_int>` **get_previous_tab** **(** **)** const
Return the previous tab index that was being shown.
Returns the previous tab index that was being shown.
.. _class_TabContainer_get_tab_align:
- :ref:`int<class_int>` **get_tab_align** **(** **)** const
Return tab alignment, from the ALIGN\_\* enum.
Returns the tab alignment.See the ALIGN\_\* constants.
.. _class_TabContainer_get_tab_control:
- :ref:`Control<class_control>` **get_tab_control** **(** :ref:`int<class_int>` idx **)** const
Return the current tab control that is being shown.
Returns the current tab control that is being shown.
.. _class_TabContainer_get_tab_count:
- :ref:`int<class_int>` **get_tab_count** **(** **)** const
Return the amount of tabs.
Returns the amount of tabs.
.. _class_TabContainer_get_tab_disabled:
- :ref:`bool<class_bool>` **get_tab_disabled** **(** :ref:`int<class_int>` tab_idx **)** const
Returns ``true`` if the tab at index ``tab_idx`` is disabled.
.. _class_TabContainer_get_tab_icon:
- :ref:`Texture<class_texture>` **get_tab_icon** **(** :ref:`int<class_int>` tab_idx **)** const
Returns the :ref:`Texture<class_texture>` for the tab at index ``tab_idx`` or null if the tab has no :ref:`Texture<class_texture>`.
.. _class_TabContainer_get_tab_title:
- :ref:`String<class_string>` **get_tab_title** **(** :ref:`int<class_int>` tab_idx **)** const
Return the title for the tab. Tab titles are by default the children node name, but this can be overridden.
Returns the title for the tab at index ``tab_idx``. Tab titles are by default the children node name, but this can be overridden.
.. _class_TabContainer_set_current_tab:
@@ -170,22 +177,24 @@ Set tab alignment, from the ALIGN\_\* enum. Moves tabs to the left, right or cen
- void **set_tab_disabled** **(** :ref:`int<class_int>` tab_idx, :ref:`bool<class_bool>` disabled **)**
Set tab at index ``tab_idx`` disabled.
.. _class_TabContainer_set_tab_icon:
- void **set_tab_icon** **(** :ref:`int<class_int>` tab_idx, :ref:`Texture<class_texture>` icon **)**
Set an icon for a tab.
Set an icon for a tab at index ``tab_idx``.
.. _class_TabContainer_set_tab_title:
- void **set_tab_title** **(** :ref:`int<class_int>` tab_idx, :ref:`String<class_string>` title **)**
Set a title for the tab. Tab titles are by default the children node name, but this can be overridden.
Set a title for the tab at index ``tab_idx``. Tab titles are by default the children node name, but this can be overridden.
.. _class_TabContainer_set_tabs_visible:
- void **set_tabs_visible** **(** :ref:`bool<class_bool>` visible **)**
Set whether the tabs should be visible or hidden.
If ``true`` all the tabs will be visible.

6
classes/class_tabs.rst
View File

@@ -61,12 +61,18 @@ Signals
-------
- **reposition_active_tab_request** **(** :ref:`int<class_int>` idx_to **)**
- **right_button_pressed** **(** :ref:`int<class_int>` tab **)**
- **tab_changed** **(** :ref:`int<class_int>` tab **)**
- **tab_clicked** **(** :ref:`int<class_int>` tab **)**
- **tab_close** **(** :ref:`int<class_int>` tab **)**
- **tab_hover** **(** :ref:`int<class_int>` tab **)**
Member Variables
----------------

5
classes/class_textedit.rst
View File

@@ -123,14 +123,19 @@ Signals
-------
- **breakpoint_toggled** **(** :ref:`int<class_int>` row **)**
Emitted when a breakpoint is placed via the breakpoint gutter.
- **cursor_changed** **(** **)**
Emitted when the cursor changes.
- **request_completion** **(** **)**
- **symbol_lookup** **(** :ref:`String<class_string>` symbol, :ref:`int<class_int>` row, :ref:`int<class_int>` column **)**
- **text_changed** **(** **)**
Emitted when the text changes.

1
classes/class_tilemap.rst
View File

@@ -123,6 +123,7 @@ Signals
-------
- **settings_changed** **(** **)**
Emitted when a tilemap setting has changed.

1
classes/class_timer.rst
View File

@@ -53,6 +53,7 @@ Signals
-------
- **timeout** **(** **)**
Emitted when the Timer reaches 0.

67
classes/class_touchscreenbutton.rst
View File

@@ -14,7 +14,7 @@ TouchScreenButton
Brief Description
-----------------
Button for touch screen devices.
Member Functions
----------------
@@ -63,26 +63,37 @@ Signals
-------
- **pressed** **(** **)**
Emitted when the button is pressed (down).
- **released** **(** **)**
Emitted when the button is released (up).
Member Variables
----------------
- :ref:`String<class_string>` **action**
- :ref:`BitMap<class_bitmap>` **bitmask**
- :ref:`Texture<class_texture>` **normal**
- :ref:`bool<class_bool>` **passby_press**
- :ref:`Texture<class_texture>` **pressed**
- :ref:`Shape2D<class_shape2d>` **shape**
- :ref:`bool<class_bool>` **shape_centered**
- :ref:`bool<class_bool>` **shape_visible**
- :ref:`int<class_int>` **visibility_mode**
- :ref:`String<class_string>` **action** - The button's action. Actions can be handled with [InputEventAction].
- :ref:`BitMap<class_bitmap>` **bitmask** - The button's bitmask.
- :ref:`Texture<class_texture>` **normal** - The button's texture for the normal state.
- :ref:`bool<class_bool>` **passby_press** - If [code]true[/code] passby presses are enabled.
- :ref:`Texture<class_texture>` **pressed** - The button's texture for the pressed state.
- :ref:`Shape2D<class_shape2d>` **shape** - The button's shape.
- :ref:`bool<class_bool>` **shape_centered** - If [code]true[/code] the button's shape is centered.
- :ref:`bool<class_bool>` **shape_visible** - If [code]true[/code] the button's shape is visible.
- :ref:`int<class_int>` **visibility_mode** - The button's visibility mode. See [code]VISIBILITY_*[/code] constants.
Numeric Constants
-----------------
- **VISIBILITY_ALWAYS** = **0**
- **VISIBILITY_TOUCHSCREEN_ONLY** = **1**
- **VISIBILITY_ALWAYS** = **0** --- Always visible.
- **VISIBILITY_TOUCHSCREEN_ONLY** = **1** --- Visible on touch screens only.
Description
-----------
Button for touch screen devices. You can set it to be visible on all screens, or only on touch devices.
Member Function Description
---------------------------
@@ -91,26 +102,38 @@ Member Function Description
- :ref:`String<class_string>` **get_action** **(** **)** const
Returns the button's action.
.. _class_TouchScreenButton_get_bitmask:
- :ref:`BitMap<class_bitmap>` **get_bitmask** **(** **)** const
Returns the button's bitmask.
.. _class_TouchScreenButton_get_shape:
- :ref:`Shape2D<class_shape2d>` **get_shape** **(** **)** const
Returns the button's shape.
.. _class_TouchScreenButton_get_texture:
- :ref:`Texture<class_texture>` **get_texture** **(** **)** const
Returns the button's texture for the normal state.
.. _class_TouchScreenButton_get_texture_pressed:
- :ref:`Texture<class_texture>` **get_texture_pressed** **(** **)** const
Returns the button's texture for the pressed state.
.. _class_TouchScreenButton_get_visibility_mode:
- :ref:`int<class_int>` **get_visibility_mode** **(** **)** const
Sets the button's visibility mode. See ``VISIBILITY\_\*`` constants.
.. _class_TouchScreenButton_is_passby_press_enabled:
- :ref:`bool<class_bool>` **is_passby_press_enabled** **(** **)** const
@@ -119,6 +142,8 @@ Member Function Description
- :ref:`bool<class_bool>` **is_pressed** **(** **)** const
Returns ``true`` if this button is currently pressed.
.. _class_TouchScreenButton_is_shape_centered:
- :ref:`bool<class_bool>` **is_shape_centered** **(** **)** const
@@ -131,36 +156,54 @@ Member Function Description
- void **set_action** **(** :ref:`String<class_string>` action **)**
Sets the button's action.
.. _class_TouchScreenButton_set_bitmask:
- void **set_bitmask** **(** :ref:`BitMap<class_bitmap>` bitmask **)**
Sets the button's :ref:`BitMap<class_bitmap>` bitmask.
.. _class_TouchScreenButton_set_passby_press:
- void **set_passby_press** **(** :ref:`bool<class_bool>` enabled **)**
If ``true`` passby presses are enabled for this button.
.. _class_TouchScreenButton_set_shape:
- void **set_shape** **(** :ref:`Shape2D<class_shape2d>` shape **)**
Sets the button's shape.
.. _class_TouchScreenButton_set_shape_centered:
- void **set_shape_centered** **(** :ref:`bool<class_bool>` bool **)**
If ``true`` the button's shape is centered.
.. _class_TouchScreenButton_set_shape_visible:
- void **set_shape_visible** **(** :ref:`bool<class_bool>` bool **)**
If ``true`` the button's shape is visible.
.. _class_TouchScreenButton_set_texture:
- void **set_texture** **(** :ref:`Texture<class_texture>` texture **)**
Sets the button's :ref:`Texture<class_texture>` for the normal state.
.. _class_TouchScreenButton_set_texture_pressed:
- void **set_texture_pressed** **(** :ref:`Texture<class_texture>` texture_pressed **)**
Sets the button's :ref:`Texture<class_texture>` for the pressed state.
.. _class_TouchScreenButton_set_visibility_mode:
- void **set_visibility_mode** **(** :ref:`int<class_int>` mode **)**
Sets the button's visibility mode. See the ``VISIBILITY\_\*`` constants.

4
classes/class_transform.rst
View File

@@ -97,7 +97,7 @@ Constructs the Transform from a :ref:`Basis<class_basis>`. The origin will be Ve
- :ref:`Transform<class_transform>` **affine_inverse** **(** **)**
Returns the inverse of the transfrom, under the assumption that the transformation is composed of rotation, scaling and translation.
Returns the inverse of the transform, under the assumption that the transformation is composed of rotation, scaling and translation.
.. _class_Transform_interpolate_with:
@@ -121,7 +121,7 @@ Rotate the transform around the up vector to face the target.
- :ref:`Transform<class_transform>` **orthonormalized** **(** **)**
Returns the transfrom with the basis orthogonal (90 degrees), and normalized axis vectors.
Returns the transform with the basis orthogonal (90 degrees), and normalized axis vectors.
.. _class_Transform_rotated:

2
classes/class_transform2d.rst
View File

@@ -138,7 +138,7 @@ Returns the inverse of the transform, under the assumption that the transformati
- :ref:`Transform2D<class_transform2d>` **orthonormalized** **(** **)**
Returns the transfrom with the basis orthogonal (90 degrees), and normalized axis vectors.
Returns the transform with the basis orthogonal (90 degrees), and normalized axis vectors.
.. _class_Transform2D_rotated:

14
classes/class_tree.rst
View File

@@ -95,43 +95,57 @@ Signals
-------
- **button_pressed** **(** :ref:`Object<class_object>` item, :ref:`int<class_int>` column, :ref:`int<class_int>` id **)**
Emitted when a button on the tree was pressed (see :ref:`TreeItem.add_button<class_TreeItem_add_button>`).
- **cell_selected** **(** **)**
Emitted when a cell is selected.
- **column_title_pressed** **(** :ref:`int<class_int>` column **)**
Emitted when a column's title is pressed.
- **custom_popup_edited** **(** :ref:`bool<class_bool>` arrow_clicked **)**
Emitted when a cell with the ``CELL_MODE_CUSTOM`` is clicked to be edited.
- **empty_tree_rmb_selected** **(** :ref:`Vector2<class_vector2>` position **)**
Emitted when the right mouse button is pressed if RMB selection is active and the tree is empty.
- **item_activated** **(** **)**
Emitted when an item is activated (double-clicked).
- **item_collapsed** **(** :ref:`Object<class_object>` item **)**
Emitted when an item is collapsed by a click on the folding arrow.
- **item_custom_button_pressed** **(** **)**
- **item_double_clicked** **(** **)**
Emitted when an item is double clicked.
- **item_edited** **(** **)**
Emitted when an item is edited.
- **item_rmb_edited** **(** **)**
Emitted when an item is edited using the right mouse button.
- **item_rmb_selected** **(** :ref:`Vector2<class_vector2>` position **)**
Emitted when an item is selected with right mouse button.
- **item_selected** **(** **)**
Emitted when an item is selected with right mouse button.
- **multi_selected** **(** :ref:`Object<class_object>` item, :ref:`int<class_int>` column, :ref:`bool<class_bool>` selected **)**
Emitted instead of ``item_selected`` when ``select_mode`` is ``SELECT_MULTI``.

11
classes/class_tween.rst
View File

@@ -81,12 +81,15 @@ Signals
-------
- **tween_completed** **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` key **)**
This signal is emitted when a tween ends.
- **tween_started** **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` key **)**
This signal is emitted when a tween starts.
- **tween_step** **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` key, :ref:`float<class_float>` elapsed, :ref:`Object<class_object>` value **)**
This signal is emitted each step of the tweening.
@@ -131,7 +134,7 @@ Because it is easy to get it wrong, here is a quick usage example:
Some of the methods of this class require a property name. You can get the property name by hovering over the property in the inspector of the editor.
Many of the methods accept ``trans_type`` and ``ease_type``. The first accepts an TRANS\_\* constant, and refers to the way the timing of the animation is handled (you might want to see ``http://easings.net/`` for some examples). The second accepts an EASE\_\* constant, and controls the where ``trans_type`` is applied to the interpolation (in the beginning, the end, or both). If you don't know which transision and easing to pick, you can try different TRANS\_\* constants with EASE_IN_OUT, and use the one that looks best.
Many of the methods accept ``trans_type`` and ``ease_type``. The first accepts an TRANS\_\* constant, and refers to the way the timing of the animation is handled (you might want to see ``http://easings.net/`` for some examples). The second accepts an EASE\_\* constant, and controls the where ``trans_type`` is applied to the interpolation (in the beginning, the end, or both). If you don't know which transition and easing to pick, you can try different TRANS\_\* constants with EASE_IN_OUT, and use the one that looks best.
Member Function Description
---------------------------
@@ -180,13 +183,13 @@ Call ``callback`` of ``object`` after ``duration``. ``arg1``-``arg5`` are argume
- :ref:`bool<class_bool>` **interpolate_deferred_callback** **(** :ref:`Object<class_object>` object, :ref:`float<class_float>` duration, :ref:`String<class_string>` callback, :ref:`Variant<class_variant>` arg1=null, :ref:`Variant<class_variant>` arg2=null, :ref:`Variant<class_variant>` arg3=null, :ref:`Variant<class_variant>` arg4=null, :ref:`Variant<class_variant>` arg5=null **)**
Call ``callback`` of ``object`` after ``duration`` on the main thread (similar to methog Object.call_deferred). [codearg1``-``arg5`` are arguments to be passed to the callback.
Call ``callback`` of ``object`` after ``duration`` on the main thread (similar to :ref:`Object.call_deferred<class_Object_call_deferred>`). ``arg1``-``arg5`` are arguments to be passed to the callback.
.. _class_Tween_interpolate_method:
- :ref:`bool<class_bool>` **interpolate_method** **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` method, :ref:`Variant<class_variant>` initial_val, :ref:`Variant<class_variant>` final_val, :ref:`float<class_float>` duration, :ref:`int<class_int>` trans_type, :ref:`int<class_int>` ease_type, :ref:`float<class_float>` delay=0 **)**
Animate ``method`` of ``object`` from ``initial_val`` to ``final_val`` for ``duration`` seconds, ``delay`` seconds later. Methods are animated by calling them with consecuitive values.
Animate ``method`` of ``object`` from ``initial_val`` to ``final_val`` for ``duration`` seconds, ``delay`` seconds later. Methods are animated by calling them with consecutive values.
``trans_type`` accepts TRANS\_\* constants, and is the way the animation is interpolated, while ``ease_type`` accepts EASE\_\* constants, and controls the place of the interpolation (the beginning, the end, or both). You can read more about them in the class description.
@@ -298,7 +301,7 @@ Stop animating all tweens.
- :ref:`bool<class_bool>` **targeting_method** **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` method, :ref:`Object<class_object>` initial, :ref:`String<class_string>` initial_method, :ref:`Variant<class_variant>` final_val, :ref:`float<class_float>` duration, :ref:`int<class_int>` trans_type, :ref:`int<class_int>` ease_type, :ref:`float<class_float>` delay=0 **)**
Animate ``method`` of ``object`` from the value returned by ``initial.initial_method`` to ``final_val`` for ``duration`` seconds, ``delay`` seconds later. Methods are animated by calling them with consecuitive values.
Animate ``method`` of ``object`` from the value returned by ``initial.initial_method`` to ``final_val`` for ``duration`` seconds, ``delay`` seconds later. Methods are animated by calling them with consecutive values.
``trans_type`` accepts TRANS\_\* constants, and is the way the animation is interpolated, while ``ease_type`` accepts EASE\_\* constants, and controls the place of the interpolation (the beginning, the end, or both). You can read more about them in the class description.

4
classes/class_videoplayer.rst
View File

@@ -95,7 +95,7 @@ Get the selected audio track (for multitrack videos).
- :ref:`int<class_int>` **get_buffering_msec** **(** **)** const
Get the amount of miliseconds to store in buffer while playing.
Get the amount of milliseconds to store in buffer while playing.
.. _class_VideoPlayer_get_stream:
@@ -179,7 +179,7 @@ Set whether this node should start playing automatically.
- void **set_buffering_msec** **(** :ref:`int<class_int>` msec **)**
Set the amount of miliseconds to buffer during playback.
Set the amount of milliseconds to buffer during playback.
.. _class_VideoPlayer_set_expand:

5
classes/class_viewport.rst
View File

@@ -159,6 +159,7 @@ Signals
-------
- **size_changed** **(** **)**
Emitted when the size of the viewport is changed, whether by :ref:`set_size_override<class_Viewport_set_size_override>`, resize of window, or some other means.
@@ -386,13 +387,13 @@ Return the 2D world of the viewport.
- :ref:`Variant<class_variant>` **gui_get_drag_data** **(** **)** const
Returs the drag data from the GUI, that was previously returned by :ref:`Control.get_drag_data<class_Control_get_drag_data>`.
Returns the drag data from the GUI, that was previously returned by :ref:`Control.get_drag_data<class_Control_get_drag_data>`.
.. _class_Viewport_gui_has_modal_stack:
- :ref:`bool<class_bool>` **gui_has_modal_stack** **(** **)** const
Returs whether there are shown modals on-screen.
Returns whether there are shown modals on-screen.
.. _class_Viewport_has_transparent_background:

4
classes/class_visibilitynotifier.rst
View File

@@ -33,15 +33,19 @@ Signals
-------
- **camera_entered** **(** :ref:`Object<class_object>` camera **)**
Emitted when the VisibilityNotifier enters a :ref:`Camera<class_camera>`'s view.
- **camera_exited** **(** :ref:`Object<class_object>` camera **)**
Emitted when the VisibilityNotifier exits a :ref:`Camera<class_camera>`'s view.
- **screen_entered** **(** **)**
Emitted when the VisibilityNotifier enters the screen.
- **screen_exited** **(** **)**
Emitted when the VisibilityNotifier exits the screen.

4
classes/class_visibilitynotifier2d.rst
View File

@@ -33,15 +33,19 @@ Signals
-------
- **screen_entered** **(** **)**
Emitted when the VisibilityNotifier2D enters the screen.
- **screen_exited** **(** **)**
Emitted when the VisibilityNotifier2D exits the screen.
- **viewport_entered** **(** :ref:`Object<class_object>` viewport **)**
Emitted when the VisibilityNotifier2D enters a :ref:`Viewport<class_viewport>`'s view.
- **viewport_exited** **(** :ref:`Object<class_object>` viewport **)**
Emitted when the VisibilityNotifier2D exits a :ref:`Viewport<class_viewport>`'s view.

3
classes/class_visualscript.rst
View File

@@ -109,6 +109,7 @@ Signals
-------
- **node_ports_changed** **(** :ref:`String<class_string>` function, :ref:`int<class_int>` id **)**
Emitted when the ports of a node are changed.
@@ -120,7 +121,7 @@ Member Variables
Description
-----------
A script implemented in the Visual Script programming environment. The script exends the functionality of all objects that instance it.
A script implemented in the Visual Script programming environment. The script extends the functionality of all objects that instance it.
:ref:`Object.set_script<class_Object_set_script>` extends an existing object, if that object's class matches one of the script's base classes.

1
classes/class_visualscriptnode.rst
View File

@@ -35,6 +35,7 @@ Signals
-------
- **ports_changed** **(** **)**
Emitted when the available input/output ports are changed.

2
classes/class_weakref.rst
View File

@@ -26,7 +26,7 @@ Member Functions
Description
-----------
A weakref can hold a :ref:`Reference<class_reference>`, without contributing to the reference counter. A weakref can be created from an :ref:`Object<class_object>` using :ref:`@GDScript.weakref<class_@GDScript_weakref>`. If this object is not a reference, weakref still works, however, it does not have any effect on the object. Weakrefs are useful in cases where multiple classes have variables that refer to eachother. Without weakrefs, using these classes could lead to memory leaks, since both references keep eachother from being released. Making part of the variables a weakref can prevent this cyclic dependency, and allows the references to be released.
A weakref can hold a :ref:`Reference<class_reference>`, without contributing to the reference counter. A weakref can be created from an :ref:`Object<class_object>` using :ref:`@GDScript.weakref<class_@GDScript_weakref>`. If this object is not a reference, weakref still works, however, it does not have any effect on the object. Weakrefs are useful in cases where multiple classes have variables that refer to each other. Without weakrefs, using these classes could lead to memory leaks, since both references keep each other from being released. Making part of the variables a weakref can prevent this cyclic dependency, and allows the references to be released.
Member Function Description
---------------------------