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

Sync classref with current source

Browse Source
This commit is contained in:
Rémi Verschelde
2018-04-10 10:13:29 +02:00
parent e07b7b0494
commit 30493541db
48 changed files with 788 additions and 204 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
classes/class_animationplayer.rst
View File

@@ -40,6 +40,8 @@ Member Functions
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_blend_time<class_AnimationPlayer_get_blend_time>` **(** :ref:`String<class_string>` anim_from, :ref:`String<class_string>` anim_to **)** const |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_playing_speed<class_AnimationPlayer_get_playing_speed>` **(** **)** const |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_animation<class_AnimationPlayer_has_animation>` **(** :ref:`String<class_string>` name **)** const |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_playing<class_AnimationPlayer_is_playing>` **(** **)** const |
@@ -206,6 +208,12 @@ Returns the list of stored animation names.
Get the blend time (in seconds) between two animations, referenced by their names.
.. _class_AnimationPlayer_get_playing_speed:
- :ref:`float<class_float>` **get_playing_speed** **(** **)** const
Get the actual playing speed of current animation or 0 if not playing. This speed is the ``playback_speed`` property multiplied by ``custom_speed`` argument specified when calling the ``play`` method.
.. _class_AnimationPlayer_has_animation:
- :ref:`bool<class_bool>` **has_animation** **(** :ref:`String<class_string>` name **)** const

8
classes/class_array.rst
View File

@@ -44,7 +44,7 @@ Member Functions
+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`count<class_Array_count>` **(** var value **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`duplicate<class_Array_duplicate>` **(** **)** |
| :ref:`Array<class_array>` | :ref:`duplicate<class_Array_duplicate>` **(** :ref:`bool<class_bool>` deep=False **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`empty<class_Array_empty>` **(** **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -175,9 +175,11 @@ Return the amount of times an element is in the array.
.. _class_Array_duplicate:
- :ref:`Array<class_array>` **duplicate** **(** **)**
- :ref:`Array<class_array>` **duplicate** **(** :ref:`bool<class_bool>` deep=False **)**
Returns a copy of this ``Array``.
Returns a copy of the array.
If ``deep`` is ``true``, a deep copy is be performed: all nested arrays and dictionaries are duplicated and will not be shared with the original array. If ``false``, a shallow copy is made and references to the original nested arrays and dictionaries are kept, so that modifying a sub-array or dictionary in the copy will also impact those referenced in the source array.
.. _class_Array_empty:

2
classes/class_arvranchor.rst
View File

@@ -14,7 +14,7 @@ ARVRAnchor
Brief Description
-----------------
Anchor point in AR Space
Anchor point in AR Space.
Member Functions
----------------

30
classes/class_arvrserver.rst
View File

@@ -24,12 +24,22 @@ Member Functions
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`ARVRInterface<class_arvrinterface>` | :ref:`find_interface<class_ARVRServer_find_interface>` **(** :ref:`String<class_string>` name **)** const |
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform<class_transform>` | :ref:`get_hmd_transform<class_ARVRServer_get_hmd_transform>` **(** **)** |
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`ARVRInterface<class_arvrinterface>` | :ref:`get_interface<class_ARVRServer_get_interface>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_interface_count<class_ARVRServer_get_interface_count>` **(** **)** const |
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`get_interfaces<class_ARVRServer_get_interfaces>` **(** **)** const |
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_last_commit_usec<class_ARVRServer_get_last_commit_usec>` **(** **)** |
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_last_frame_usec<class_ARVRServer_get_last_frame_usec>` **(** **)** |
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_last_process_usec<class_ARVRServer_get_last_process_usec>` **(** **)** |
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`ARVRInterface<class_arvrinterface>` | :ref:`get_primary_interface<class_ARVRServer_get_primary_interface>` **(** **)** const |
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform<class_transform>` | :ref:`get_reference_frame<class_ARVRServer_get_reference_frame>` **(** **)** const |
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`ARVRPositionalTracker<class_arvrpositionaltracker>` | :ref:`get_tracker<class_ARVRServer_get_tracker>` **(** :ref:`int<class_int>` idx **)** const |
@@ -128,6 +138,10 @@ You should call this method after a few seconds have passed, when the user reque
Find an interface by its name. Say that you're making a game that uses specific capabilities of an AR/VR platform you can find the interface for that platform by name and initialize it.
.. _class_ARVRServer_get_hmd_transform:
- :ref:`Transform<class_transform>` **get_hmd_transform** **(** **)**
.. _class_ARVRServer_get_interface:
- :ref:`ARVRInterface<class_arvrinterface>` **get_interface** **(** :ref:`int<class_int>` idx **)** const
@@ -146,6 +160,22 @@ Get the number of interfaces currently registered with the AR/VR server. If you'
Returns a list of available interfaces with both id and name of the interface.
.. _class_ARVRServer_get_last_commit_usec:
- :ref:`int<class_int>` **get_last_commit_usec** **(** **)**
.. _class_ARVRServer_get_last_frame_usec:
- :ref:`int<class_int>` **get_last_frame_usec** **(** **)**
.. _class_ARVRServer_get_last_process_usec:
- :ref:`int<class_int>` **get_last_process_usec** **(** **)**
.. _class_ARVRServer_get_primary_interface:
- :ref:`ARVRInterface<class_arvrinterface>` **get_primary_interface** **(** **)** const
.. _class_ARVRServer_get_reference_frame:
- :ref:`Transform<class_transform>` **get_reference_frame** **(** **)** const

18
classes/class_audioserver.rst
View File

@@ -44,6 +44,10 @@ Member Functions
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_bus_volume_db<class_AudioServer_get_bus_volume_db>` **(** :ref:`int<class_int>` bus_idx **)** const |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_device<class_AudioServer_get_device>` **(** **)** |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`get_device_list<class_AudioServer_get_device_list>` **(** **)** |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_mix_rate<class_AudioServer_get_mix_rate>` **(** **)** const |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_speaker_mode<class_AudioServer_get_speaker_mode>` **(** **)** const |
@@ -82,6 +86,8 @@ Member Functions
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bus_volume_db<class_AudioServer_set_bus_volume_db>` **(** :ref:`int<class_int>` bus_idx, :ref:`float<class_float>` volume_db **)** |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_device<class_AudioServer_set_device>` **(** :ref:`String<class_string>` arg0 **)** |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`swap_bus_effects<class_AudioServer_swap_bus_effects>` **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx, :ref:`int<class_int>` by_effect_idx **)** |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`unlock<class_AudioServer_unlock>` **(** **)** |
@@ -189,6 +195,14 @@ Returns the name of the bus that the bus at index ``bus_idx`` sends to.
Returns the volume of the bus at index ``bus_idx`` in dB.
.. _class_AudioServer_get_device:
- :ref:`String<class_string>` **get_device** **(** **)**
.. _class_AudioServer_get_device_list:
- :ref:`Array<class_array>` **get_device_list** **(** **)**
.. _class_AudioServer_get_mix_rate:
- :ref:`float<class_float>` **get_mix_rate** **(** **)** const
@@ -303,6 +317,10 @@ If ``true`` the bus at index ``bus_idx`` is in solo mode.
Sets the volume of the bus at index ``bus_idx`` to ``volume_db``.
.. _class_AudioServer_set_device:
- void **set_device** **(** :ref:`String<class_string>` arg0 **)**
.. _class_AudioServer_swap_bus_effects:
- void **swap_bus_effects** **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx, :ref:`int<class_int>` by_effect_idx **)**

2
classes/class_audiostreamplayer3d.rst
View File

@@ -14,7 +14,7 @@ AudioStreamPlayer3D
Brief Description
-----------------
Plays 3D sound in 3D space
Plays 3D sound in 3D space.
Member Functions
----------------

26
classes/class_camera.rst
View File

@@ -22,7 +22,7 @@ Member Functions
----------------
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_current<class_Camera_clear_current>` **(** **)** |
| void | :ref:`clear_current<class_Camera_clear_current>` **(** :ref:`bool<class_bool>` enable_next=true **)** |
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform<class_transform>` | :ref:`get_camera_transform<class_Camera_get_camera_transform>` **(** **)** const |
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -62,7 +62,7 @@ Member Variables
.. _class_Camera_environment:
- :ref:`Environment<class_environment>` **environment** - Set the :ref:`Environment<class_environment>` to use for this Camera.
- :ref:`Environment<class_environment>` **environment** - The :ref:`Environment<class_environment>` to use for this Camera.
.. _class_Camera_far:
@@ -78,7 +78,7 @@ Member Variables
.. _class_Camera_keep_aspect:
- :ref:`KeepAspect<enum_camera_keepaspect>` **keep_aspect** - The axis to lock during :ref:`fov<class_Camera_fov>`/:ref:`size<class_Camera_size>` adjustments.
- :ref:`KeepAspect<enum_camera_keepaspect>` **keep_aspect** - The axis to lock during :ref:`fov<class_Camera_fov>`/:ref:`size<class_Camera_size>` adjustments. Can be either ``KEEP_WIDTH`` or ``KEEP_HEIGHT``.
.. _class_Camera_near:
@@ -94,7 +94,7 @@ Member Variables
.. _class_Camera_v_offset:
- :ref:`float<class_float>` **v_offset** - The horizontal (Y) offset of the Camera viewport.
- :ref:`float<class_float>` **v_offset** - The vertical (Y) offset of the Camera viewport.
Enums
@@ -133,27 +133,27 @@ Member Function Description
.. _class_Camera_clear_current:
- void **clear_current** **(** **)**
- void **clear_current** **(** :ref:`bool<class_bool>` enable_next=true **)**
If this is the current Camera, remove it from being current. If it is inside the node tree, request to make the next Camera current, if any.
If this is the current Camera, remove it from being current. If it is inside the node tree and ``enabled_next`` is ``true[/true], request to make the next Camera current, if any.
.. _class_Camera_get_camera_transform:
- :ref:`Transform<class_transform>` **get_camera_transform** **(** **)** const
Get the camera transform. Subclassed cameras (such as CharacterCamera) may provide different transforms than the :ref:`Node<class_node>` transform.
Gets the camera transform. Subclassed cameras (such as CharacterCamera) may provide different transforms than the :ref:`Node<class_node>` transform.
.. _class_Camera_is_position_behind:
- :ref:`bool<class_bool>` **is_position_behind** **(** :ref:`Vector3<class_vector3>` world_point **)** const
Returns ``true`` if the given position is behind the Camera.
Returns ``true`` if the given position is behind the Camera. Note that a position which returns ``false`` may still be outside the Camera's field of view.
.. _class_Camera_make_current:
- void **make_current** **(** **)**
Make this camera the current Camera for the :ref:`Viewport<class_viewport>` (see class description). If the Camera Node is outside the scene tree, it will attempt to become current once it's added.
Makes this camera the current Camera for the :ref:`Viewport<class_viewport>` (see class description). If the Camera Node is outside the scene tree, it will attempt to become current once it's added.
.. _class_Camera_project_local_ray_normal:
@@ -165,7 +165,7 @@ Returns a normal vector from the screen point location directed along the camera
- :ref:`Vector3<class_vector3>` **project_position** **(** :ref:`Vector2<class_vector2>` screen_point **)** const
Returns how a 2D coordinate in the Viewport rectangle maps to a 3D point in worldspace.
Returns the 3D point in worldspace that maps to the given 2D coordinate in the :ref:`Viewport<class_viewport>` rectangle.
.. _class_Camera_project_ray_normal:
@@ -183,18 +183,18 @@ Returns a 3D position in worldspace, that is the result of projecting a point on
- void **set_orthogonal** **(** :ref:`float<class_float>` size, :ref:`float<class_float>` z_near, :ref:`float<class_float>` z_far **)**
Set the camera projection to orthogonal mode, by specifying a width and the *near* and *far* clip planes in worldspace units. (As a hint, 2D games often use this projection, with values specified in pixels)
Sets the camera projection to orthogonal mode, by specifying a width and the *near* and *far* clip planes in worldspace units. (As a hint, 2D games often use this projection, with values specified in pixels)
.. _class_Camera_set_perspective:
- void **set_perspective** **(** :ref:`float<class_float>` fov, :ref:`float<class_float>` z_near, :ref:`float<class_float>` z_far **)**
Set the camera projection to perspective mode, by specifying a *FOV* Y angle in degrees (FOV means Field of View), and the *near* and *far* clip planes in worldspace units.
Sets the camera projection to perspective mode, by specifying a *FOV* Y angle in degrees (FOV means Field of View), and the *near* and *far* clip planes in worldspace units.
.. _class_Camera_unproject_position:
- :ref:`Vector2<class_vector2>` **unproject_position** **(** :ref:`Vector3<class_vector3>` world_point **)** const
Returns how a 3D point in worldspace maps to a 2D coordinate in the :ref:`Viewport<class_viewport>` rectangle.
Returns the 2D coordinate in the :ref:`Viewport<class_viewport>` rectangle that maps to the given 3D point in worldspace.

12
classes/class_canvaslayer.rst
View File

@@ -21,9 +21,9 @@ Canvas drawing layer.
Member Functions
----------------
+--------------------------------+-----------------------------------------------------------------------+
| :ref:`World2D<class_world2d>` | :ref:`get_world_2d<class_CanvasLayer_get_world_2d>` **(** **)** const |
+--------------------------------+-----------------------------------------------------------------------+
+------------------------+-------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`get_canvas<class_CanvasLayer_get_canvas>` **(** **)** const |
+------------------------+-------------------------------------------------------------------+
Member Variables
----------------
@@ -65,10 +65,10 @@ Canvas drawing layer. :ref:`CanvasItem<class_canvasitem>` nodes that are direct
Member Function Description
---------------------------
.. _class_CanvasLayer_get_world_2d:
.. _class_CanvasLayer_get_canvas:
- :ref:`World2D<class_world2d>` **get_world_2d** **(** **)** const
- :ref:`RID<class_rid>` **get_canvas** **(** **)** const
Return the :ref:`World2D<class_world2d>` used by this layer.
Returns the RID of the canvas used by this layer.

2
classes/class_checkbox.rst
View File

@@ -14,7 +14,7 @@ CheckBox
Brief Description
-----------------
Binary choice user interface widget
Binary choice user interface widget.
Description
-----------

2
classes/class_collisionshape.rst
View File

@@ -40,7 +40,7 @@ Member Variables
Description
-----------
Editor facility for creating and editing collision shapes in 3D space. You can use this node to represent all sorts of collision shapes, for example, add this to an :ref:`Area<class_area>` to give it a detection shape, or add it to a :ref:`PhysicsBody<class_physicsbody>` to give create solid object. **IMPORTANT**: this is an Editor-only helper to create shapes, use :ref:`get_shape<class_CollisionShape_get_shape>` to get the actual shape.
Editor facility for creating and editing collision shapes in 3D space. You can use this node to represent all sorts of collision shapes, for example, add this to an :ref:`Area<class_area>` to give it a detection shape, or add it to a :ref:`PhysicsBody<class_physicsbody>` to create a solid object. **IMPORTANT**: this is an Editor-only helper to create shapes, use :ref:`get_shape<class_CollisionShape_get_shape>` to get the actual shape.
Member Function Description
---------------------------

2
classes/class_collisionshape2d.rst
View File

@@ -35,5 +35,5 @@ Member Variables
Description
-----------
Editor facility for creating and editing collision shapes in 2D space. You can use this node to represent all sorts of collision shapes, for example, add this to an :ref:`Area2D<class_area2d>` to give it a detection shape, or add it to a :ref:`PhysicsBody2D<class_physicsbody2d>` to give create solid object. **IMPORTANT**: this is an Editor-only helper to create shapes, use :ref:`get_shape<class_CollisionShape2D_get_shape>` to get the actual shape.
Editor facility for creating and editing collision shapes in 2D space. You can use this node to represent all sorts of collision shapes, for example, add this to an :ref:`Area2D<class_area2d>` to give it a detection shape, or add it to a :ref:`PhysicsBody2D<class_physicsbody2d>` to create a solid object. **IMPORTANT**: this is an Editor-only helper to create shapes, use :ref:`get_shape<class_CollisionShape2D_get_shape>` to get the actual shape.

2
classes/class_colorpickerbutton.rst
View File

@@ -14,7 +14,7 @@ ColorPickerButton
Brief Description
-----------------
Button that pops out a :ref:`ColorPicker<class_colorpicker>`
Button that pops out a :ref:`ColorPicker<class_colorpicker>`.
Member Functions
----------------

2
classes/class_conetwistjoint.rst
View File

@@ -14,7 +14,7 @@ ConeTwistJoint
Brief Description
-----------------
A twist joint between two 3D bodies
A twist joint between two 3D bodies.
Member Variables
----------------

7
classes/class_control.rst
View File

@@ -345,6 +345,8 @@ Numeric Constants
- **NOTIFICATION_FOCUS_EXIT** = **44** --- Sent when the node loses focus.
- **NOTIFICATION_THEME_CHANGED** = **45** --- Sent when the node's :ref:`theme<class_Control_theme>` changes, right before Godot redraws the ``Control``. Happens when you call one of the ``add_*_override``
- **NOTIFICATION_MODAL_CLOSE** = **46** --- Sent when an open modal dialog closes. See :ref:`show_modal<class_Control_show_modal>`.
- **NOTIFICATION_SCROLL_BEGIN** = **47**
- **NOTIFICATION_SCROLL_END** = **48**
Enums
-----
@@ -395,6 +397,7 @@ enum **GrowDirection**
- **GROW_DIRECTION_BEGIN** = **0**
- **GROW_DIRECTION_END** = **1**
- **GROW_DIRECTION_BOTH** = **2**
.. _enum_Control_LayoutPresetMode:
@@ -557,7 +560,7 @@ Godot calls this method to pass you the ``data`` from a control's :ref:`get_drag
Forces drag and bypasses :ref:`get_drag_data<class_Control_get_drag_data>` and :ref:`set_drag_preview<class_Control_set_drag_preview>` by passing ``data`` and ``preview``. Drag will start even if the mouse is neither over nor pressed on this control.
The methods :ref:`can_drop_data<class_Control_can_drop_data>` and :ref:`drop_data<class_Control_drop_data>` must be implemented on controls that want to recieve drop data.
The methods :ref:`can_drop_data<class_Control_can_drop_data>` and :ref:`drop_data<class_Control_drop_data>` must be implemented on controls that want to receive drop data.
.. _class_Control_get_begin:
@@ -585,7 +588,7 @@ Returns the mouse cursor shape the control displays on mouse hover, one of the `
- :ref:`Object<class_object>` **get_drag_data** **(** :ref:`Vector2<class_vector2>` position **)** virtual
Godot calls this method to get data that can be dragged and dropped onto controls that expect drop data. Return null if there is no data to drag. Controls that want to recieve drop data should implement :ref:`can_drop_data<class_Control_can_drop_data>` and :ref:`drop_data<class_Control_drop_data>`. ``position`` is local to this control. Drag may be forced with :ref:`force_drag<class_Control_force_drag>`.
Godot calls this method to get data that can be dragged and dropped onto controls that expect drop data. Return null if there is no data to drag. Controls that want to receive drop data should implement :ref:`can_drop_data<class_Control_can_drop_data>` and :ref:`drop_data<class_Control_drop_data>`. ``position`` is local to this control. Drag may be forced with :ref:`force_drag<class_Control_force_drag>`.
A preview that will follow the mouse that should represent the data can be set with :ref:`set_drag_preview<class_Control_set_drag_preview>`. A good time to set the preview is in this method.

44
classes/class_dictionary.rst
View File

@@ -17,27 +17,27 @@ Dictionary type.
Member Functions
----------------
+--------------------------------------+-------------------------------------------------------------------------------------+
| void | :ref:`clear<class_Dictionary_clear>` **(** **)** |
+--------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`Dictionary<class_dictionary>` | :ref:`duplicate<class_Dictionary_duplicate>` **(** **)** |
+--------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`empty<class_Dictionary_empty>` **(** **)** |
+--------------------------------------+-------------------------------------------------------------------------------------+
| void | :ref:`erase<class_Dictionary_erase>` **(** var key **)** |
+--------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has<class_Dictionary_has>` **(** var key **)** |
+--------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_all<class_Dictionary_has_all>` **(** :ref:`Array<class_array>` keys **)** |
+--------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`hash<class_Dictionary_hash>` **(** **)** |
+--------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`keys<class_Dictionary_keys>` **(** **)** |
+--------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`size<class_Dictionary_size>` **(** **)** |
+--------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`values<class_Dictionary_values>` **(** **)** |
+--------------------------------------+-------------------------------------------------------------------------------------+
+--------------------------------------+---------------------------------------------------------------------------------------------+
| void | :ref:`clear<class_Dictionary_clear>` **(** **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`Dictionary<class_dictionary>` | :ref:`duplicate<class_Dictionary_duplicate>` **(** :ref:`bool<class_bool>` deep=False **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`empty<class_Dictionary_empty>` **(** **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------+
| void | :ref:`erase<class_Dictionary_erase>` **(** var key **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has<class_Dictionary_has>` **(** var key **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_all<class_Dictionary_has_all>` **(** :ref:`Array<class_array>` keys **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`hash<class_Dictionary_hash>` **(** **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`keys<class_Dictionary_keys>` **(** **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`size<class_Dictionary_size>` **(** **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`values<class_Dictionary_values>` **(** **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------+
Description
-----------
@@ -55,7 +55,7 @@ Clear the dictionary, removing all key/value pairs.
.. _class_Dictionary_duplicate:
- :ref:`Dictionary<class_dictionary>` **duplicate** **(** **)**
- :ref:`Dictionary<class_dictionary>` **duplicate** **(** :ref:`bool<class_bool>` deep=False **)**
.. _class_Dictionary_empty:

190
classes/class_editorplugin.rst
View File

@@ -19,95 +19,99 @@ Used by the editor to extend its functionality.
Member Functions
----------------
+------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_autoload_singleton<class_EditorPlugin_add_autoload_singleton>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` path **)** |
+------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`ToolButton<class_toolbutton>` | :ref:`add_control_to_bottom_panel<class_EditorPlugin_add_control_to_bottom_panel>` **(** :ref:`Control<class_control>` control, :ref:`String<class_string>` title **)** |
+------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_control_to_container<class_EditorPlugin_add_control_to_container>` **(** :ref:`int<class_int>` container, :ref:`Control<class_control>` control **)** |
+------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_control_to_dock<class_EditorPlugin_add_control_to_dock>` **(** :ref:`int<class_int>` slot, :ref:`Control<class_control>` control **)** |
+------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_custom_type<class_EditorPlugin_add_custom_type>` **(** :ref:`String<class_string>` type, :ref:`String<class_string>` base, :ref:`Script<class_script>` script, :ref:`Texture<class_texture>` icon **)** |
+------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_export_plugin<class_EditorPlugin_add_export_plugin>` **(** :ref:`EditorExportPlugin<class_editorexportplugin>` exporter **)** |
+------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_import_plugin<class_EditorPlugin_add_import_plugin>` **(** :ref:`EditorImportPlugin<class_editorimportplugin>` importer **)** |
+------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_scene_import_plugin<class_EditorPlugin_add_scene_import_plugin>` **(** :ref:`EditorSceneImporter<class_editorsceneimporter>` scene_importer **)** |
+------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_tool_submenu_item<class_EditorPlugin_add_tool_submenu_item>` **(** :ref:`String<class_string>` name, :ref:`Object<class_object>` submenu **)** |
+------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`apply_changes<class_EditorPlugin_apply_changes>` **(** **)** virtual |
+------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear<class_EditorPlugin_clear>` **(** **)** virtual |
+------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`EditorSpatialGizmo<class_editorspatialgizmo>` | :ref:`create_spatial_gizmo<class_EditorPlugin_create_spatial_gizmo>` **(** :ref:`Spatial<class_spatial>` for_spatial **)** virtual |
+------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`edit<class_EditorPlugin_edit>` **(** :ref:`Object<class_object>` object **)** virtual |
+------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`forward_canvas_gui_input<class_EditorPlugin_forward_canvas_gui_input>` **(** :ref:`InputEvent<class_inputevent>` event **)** virtual |
+------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`forward_draw_over_viewport<class_EditorPlugin_forward_draw_over_viewport>` **(** :ref:`Control<class_control>` overlay **)** virtual |
+------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`forward_force_draw_over_viewport<class_EditorPlugin_forward_force_draw_over_viewport>` **(** :ref:`Control<class_control>` overlay **)** virtual |
+------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`forward_spatial_gui_input<class_EditorPlugin_forward_spatial_gui_input>` **(** :ref:`Camera<class_camera>` camera, :ref:`InputEvent<class_inputevent>` event **)** virtual |
+------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolStringArray<class_poolstringarray>` | :ref:`get_breakpoints<class_EditorPlugin_get_breakpoints>` **(** **)** virtual |
+------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`EditorInterface<class_editorinterface>` | :ref:`get_editor_interface<class_EditorPlugin_get_editor_interface>` **(** **)** |
+------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Object<class_object>` | :ref:`get_plugin_icon<class_EditorPlugin_get_plugin_icon>` **(** **)** virtual |
+------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_plugin_name<class_EditorPlugin_get_plugin_name>` **(** **)** virtual |
+------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Dictionary<class_dictionary>` | :ref:`get_state<class_EditorPlugin_get_state>` **(** **)** virtual |
+------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`UndoRedo<class_undoredo>` | :ref:`get_undo_redo<class_EditorPlugin_get_undo_redo>` **(** **)** |
+------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`get_window_layout<class_EditorPlugin_get_window_layout>` **(** :ref:`ConfigFile<class_configfile>` layout **)** virtual |
+------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`handles<class_EditorPlugin_handles>` **(** :ref:`Object<class_object>` object **)** virtual |
+------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_main_screen<class_EditorPlugin_has_main_screen>` **(** **)** virtual |
+------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`hide_bottom_panel<class_EditorPlugin_hide_bottom_panel>` **(** **)** |
+------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`make_bottom_panel_item_visible<class_EditorPlugin_make_bottom_panel_item_visible>` **(** :ref:`Control<class_control>` item **)** |
+------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`make_visible<class_EditorPlugin_make_visible>` **(** :ref:`bool<class_bool>` visible **)** virtual |
+------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`queue_save_layout<class_EditorPlugin_queue_save_layout>` **(** **)** const |
+------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_autoload_singleton<class_EditorPlugin_remove_autoload_singleton>` **(** :ref:`String<class_string>` name **)** |
+------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_control_from_bottom_panel<class_EditorPlugin_remove_control_from_bottom_panel>` **(** :ref:`Control<class_control>` control **)** |
+------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_control_from_container<class_EditorPlugin_remove_control_from_container>` **(** :ref:`int<class_int>` container, :ref:`Control<class_control>` control **)** |
+------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_control_from_docks<class_EditorPlugin_remove_control_from_docks>` **(** :ref:`Control<class_control>` control **)** |
+------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_custom_type<class_EditorPlugin_remove_custom_type>` **(** :ref:`String<class_string>` type **)** |
+------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_export_plugin<class_EditorPlugin_remove_export_plugin>` **(** :ref:`EditorExportPlugin<class_editorexportplugin>` exporter **)** |
+------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_import_plugin<class_EditorPlugin_remove_import_plugin>` **(** :ref:`EditorImportPlugin<class_editorimportplugin>` importer **)** |
+------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_scene_import_plugin<class_EditorPlugin_remove_scene_import_plugin>` **(** :ref:`EditorSceneImporter<class_editorsceneimporter>` scene_importer **)** |
+------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`save_external_data<class_EditorPlugin_save_external_data>` **(** **)** virtual |
+------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_force_draw_over_forwarding_enabled<class_EditorPlugin_set_force_draw_over_forwarding_enabled>` **(** **)** |
+------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_input_event_forwarding_always_enabled<class_EditorPlugin_set_input_event_forwarding_always_enabled>` **(** **)** |
+------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_state<class_EditorPlugin_set_state>` **(** :ref:`Dictionary<class_dictionary>` state **)** virtual |
+------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_window_layout<class_EditorPlugin_set_window_layout>` **(** :ref:`ConfigFile<class_configfile>` layout **)** virtual |
+------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`update_overlays<class_EditorPlugin_update_overlays>` **(** **)** const |
+------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_autoload_singleton<class_EditorPlugin_add_autoload_singleton>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` path **)** |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`ToolButton<class_toolbutton>` | :ref:`add_control_to_bottom_panel<class_EditorPlugin_add_control_to_bottom_panel>` **(** :ref:`Control<class_control>` control, :ref:`String<class_string>` title **)** |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_control_to_container<class_EditorPlugin_add_control_to_container>` **(** :ref:`int<class_int>` container, :ref:`Control<class_control>` control **)** |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_control_to_dock<class_EditorPlugin_add_control_to_dock>` **(** :ref:`int<class_int>` slot, :ref:`Control<class_control>` control **)** |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_custom_type<class_EditorPlugin_add_custom_type>` **(** :ref:`String<class_string>` type, :ref:`String<class_string>` base, :ref:`Script<class_script>` script, :ref:`Texture<class_texture>` icon **)** |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_export_plugin<class_EditorPlugin_add_export_plugin>` **(** :ref:`EditorExportPlugin<class_editorexportplugin>` exporter **)** |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_import_plugin<class_EditorPlugin_add_import_plugin>` **(** :ref:`EditorImportPlugin<class_editorimportplugin>` importer **)** |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_scene_import_plugin<class_EditorPlugin_add_scene_import_plugin>` **(** :ref:`EditorSceneImporter<class_editorsceneimporter>` scene_importer **)** |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_tool_menu_item<class_EditorPlugin_add_tool_menu_item>` **(** :ref:`String<class_string>` name, :ref:`Object<class_object>` handler, :ref:`String<class_string>` callback, :ref:`Variant<class_variant>` ud=null **)** |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_tool_submenu_item<class_EditorPlugin_add_tool_submenu_item>` **(** :ref:`String<class_string>` name, :ref:`Object<class_object>` submenu **)** |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`apply_changes<class_EditorPlugin_apply_changes>` **(** **)** virtual |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear<class_EditorPlugin_clear>` **(** **)** virtual |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`EditorSpatialGizmo<class_editorspatialgizmo>` | :ref:`create_spatial_gizmo<class_EditorPlugin_create_spatial_gizmo>` **(** :ref:`Spatial<class_spatial>` for_spatial **)** virtual |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`edit<class_EditorPlugin_edit>` **(** :ref:`Object<class_object>` object **)** virtual |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`forward_canvas_gui_input<class_EditorPlugin_forward_canvas_gui_input>` **(** :ref:`InputEvent<class_inputevent>` event **)** virtual |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`forward_draw_over_viewport<class_EditorPlugin_forward_draw_over_viewport>` **(** :ref:`Control<class_control>` overlay **)** virtual |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`forward_force_draw_over_viewport<class_EditorPlugin_forward_force_draw_over_viewport>` **(** :ref:`Control<class_control>` overlay **)** virtual |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`forward_spatial_gui_input<class_EditorPlugin_forward_spatial_gui_input>` **(** :ref:`Camera<class_camera>` camera, :ref:`InputEvent<class_inputevent>` event **)** virtual |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolStringArray<class_poolstringarray>` | :ref:`get_breakpoints<class_EditorPlugin_get_breakpoints>` **(** **)** virtual |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`EditorInterface<class_editorinterface>` | :ref:`get_editor_interface<class_EditorPlugin_get_editor_interface>` **(** **)** |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Object<class_object>` | :ref:`get_plugin_icon<class_EditorPlugin_get_plugin_icon>` **(** **)** virtual |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_plugin_name<class_EditorPlugin_get_plugin_name>` **(** **)** virtual |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Dictionary<class_dictionary>` | :ref:`get_state<class_EditorPlugin_get_state>` **(** **)** virtual |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`UndoRedo<class_undoredo>` | :ref:`get_undo_redo<class_EditorPlugin_get_undo_redo>` **(** **)** |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`get_window_layout<class_EditorPlugin_get_window_layout>` **(** :ref:`ConfigFile<class_configfile>` layout **)** virtual |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`handles<class_EditorPlugin_handles>` **(** :ref:`Object<class_object>` object **)** virtual |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_main_screen<class_EditorPlugin_has_main_screen>` **(** **)** virtual |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`hide_bottom_panel<class_EditorPlugin_hide_bottom_panel>` **(** **)** |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`make_bottom_panel_item_visible<class_EditorPlugin_make_bottom_panel_item_visible>` **(** :ref:`Control<class_control>` item **)** |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`make_visible<class_EditorPlugin_make_visible>` **(** :ref:`bool<class_bool>` visible **)** virtual |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`queue_save_layout<class_EditorPlugin_queue_save_layout>` **(** **)** const |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_autoload_singleton<class_EditorPlugin_remove_autoload_singleton>` **(** :ref:`String<class_string>` name **)** |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_control_from_bottom_panel<class_EditorPlugin_remove_control_from_bottom_panel>` **(** :ref:`Control<class_control>` control **)** |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_control_from_container<class_EditorPlugin_remove_control_from_container>` **(** :ref:`int<class_int>` container, :ref:`Control<class_control>` control **)** |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_control_from_docks<class_EditorPlugin_remove_control_from_docks>` **(** :ref:`Control<class_control>` control **)** |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_custom_type<class_EditorPlugin_remove_custom_type>` **(** :ref:`String<class_string>` type **)** |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_export_plugin<class_EditorPlugin_remove_export_plugin>` **(** :ref:`EditorExportPlugin<class_editorexportplugin>` exporter **)** |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_import_plugin<class_EditorPlugin_remove_import_plugin>` **(** :ref:`EditorImportPlugin<class_editorimportplugin>` importer **)** |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_scene_import_plugin<class_EditorPlugin_remove_scene_import_plugin>` **(** :ref:`EditorSceneImporter<class_editorsceneimporter>` scene_importer **)** |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_tool_menu_item<class_EditorPlugin_remove_tool_menu_item>` **(** :ref:`String<class_string>` name **)** |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`save_external_data<class_EditorPlugin_save_external_data>` **(** **)** virtual |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_force_draw_over_forwarding_enabled<class_EditorPlugin_set_force_draw_over_forwarding_enabled>` **(** **)** |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_input_event_forwarding_always_enabled<class_EditorPlugin_set_input_event_forwarding_always_enabled>` **(** **)** |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_state<class_EditorPlugin_set_state>` **(** :ref:`Dictionary<class_dictionary>` state **)** virtual |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_window_layout<class_EditorPlugin_set_window_layout>` **(** :ref:`ConfigFile<class_configfile>` layout **)** virtual |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`update_overlays<class_EditorPlugin_update_overlays>` **(** **)** const |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Signals
-------
@@ -226,6 +230,10 @@ During run-time, this will be a simple object with a script so this function doe
- void **add_scene_import_plugin** **(** :ref:`EditorSceneImporter<class_editorsceneimporter>` scene_importer **)**
.. _class_EditorPlugin_add_tool_menu_item:
- void **add_tool_menu_item** **(** :ref:`String<class_string>` name, :ref:`Object<class_object>` handler, :ref:`String<class_string>` callback, :ref:`Variant<class_variant>` ud=null **)**
.. _class_EditorPlugin_add_tool_submenu_item:
- void **add_tool_submenu_item** **(** :ref:`String<class_string>` name, :ref:`Object<class_object>` submenu **)**
@@ -388,6 +396,10 @@ Remove a custom type added by :ref:`EditorPlugin.add_custom_type<class_EditorPlu
- void **remove_scene_import_plugin** **(** :ref:`EditorSceneImporter<class_editorsceneimporter>` scene_importer **)**
.. _class_EditorPlugin_remove_tool_menu_item:
- void **remove_tool_menu_item** **(** :ref:`String<class_string>` name **)**
.. _class_EditorPlugin_save_external_data:
- void **save_external_data** **(** **)** virtual

8
classes/class_file.rst
View File

@@ -56,9 +56,9 @@ Member Functions
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_pascal_string<class_File_get_pascal_string>` **(** **)** |
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_path<class_File_get_path>` **(** **)** |
| :ref:`String<class_string>` | :ref:`get_path<class_File_get_path>` **(** **)** const |
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_path_absolute<class_File_get_path_absolute>` **(** **)** |
| :ref:`String<class_string>` | :ref:`get_path_absolute<class_File_get_path_absolute>` **(** **)** const |
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_position<class_File_get_position>` **(** **)** const |
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -274,13 +274,13 @@ Returns a :ref:`String<class_string>` saved in Pascal format from the file.
.. _class_File_get_path:
- :ref:`String<class_string>` **get_path** **(** **)**
- :ref:`String<class_string>` **get_path** **(** **)** const
Returns the path as a :ref:`String<class_string>` for the current open file.
.. _class_File_get_path_absolute:
- :ref:`String<class_string>` **get_path_absolute** **(** **)**
- :ref:`String<class_string>` **get_path_absolute** **(** **)** const
Returns the absolute path as a :ref:`String<class_string>` for the current open file.

10
classes/class_gdnativelibrary.rst
View File

@@ -19,8 +19,6 @@ Brief Description
Member Functions
----------------
+------------------------------------------------+---------------------------------------------------------------------------------------------------+
| :ref:`ConfigFile<class_configfile>` | :ref:`get_config_file<class_GDNativeLibrary_get_config_file>` **(** **)** |
+------------------------------------------------+---------------------------------------------------------------------------------------------------+
| :ref:`PoolStringArray<class_poolstringarray>` | :ref:`get_current_dependencies<class_GDNativeLibrary_get_current_dependencies>` **(** **)** const |
+------------------------------------------------+---------------------------------------------------------------------------------------------------+
@@ -30,6 +28,10 @@ Member Functions
Member Variables
----------------
.. _class_GDNativeLibrary_config_file:
- :ref:`ConfigFile<class_configfile>` **config_file**
.. _class_GDNativeLibrary_load_once:
- :ref:`bool<class_bool>` **load_once**
@@ -50,10 +52,6 @@ Member Variables
Member Function Description
---------------------------
.. _class_GDNativeLibrary_get_config_file:
- :ref:`ConfigFile<class_configfile>` **get_config_file** **(** **)**
.. _class_GDNativeLibrary_get_current_dependencies:
- :ref:`PoolStringArray<class_poolstringarray>` **get_current_dependencies** **(** **)** const

14
classes/class_generic6dofjoint.rst
View File

@@ -27,7 +27,7 @@ The lower, the longer an impulse from one side takes to travel to the other side
.. _class_Generic6DOFJoint_angular_limit_x/enabled:
- :ref:`bool<class_bool>` **angular_limit_x/enabled** - If ``true`` rotation across the x-axis is enabled.
- :ref:`bool<class_bool>` **angular_limit_x/enabled** - If ``true`` rotation across the x-axis is limited.
.. _class_Generic6DOFJoint_angular_limit_x/erp:
@@ -59,7 +59,7 @@ The lower, the longer an impulse from one side takes to travel to the other side
.. _class_Generic6DOFJoint_angular_limit_y/enabled:
- :ref:`bool<class_bool>` **angular_limit_y/enabled** - If ``true`` rotation across the y-axis is enabled.
- :ref:`bool<class_bool>` **angular_limit_y/enabled** - If ``true`` rotation across the y-axis is limited.
.. _class_Generic6DOFJoint_angular_limit_y/erp:
@@ -91,7 +91,7 @@ The lower, the longer an impulse from one side takes to travel to the other side
.. _class_Generic6DOFJoint_angular_limit_z/enabled:
- :ref:`bool<class_bool>` **angular_limit_z/enabled** - If ``true`` rotation across the z-axis is enabled.
- :ref:`bool<class_bool>` **angular_limit_z/enabled** - If ``true`` rotation across the z-axis is limited.
.. _class_Generic6DOFJoint_angular_limit_z/erp:
@@ -159,7 +159,7 @@ The lower, the longer an impulse from one side takes to travel to the other side
.. _class_Generic6DOFJoint_linear_limit_x/enabled:
- :ref:`bool<class_bool>` **linear_limit_x/enabled** - If ``true`` the linear motion across the x-axis is enabled.
- :ref:`bool<class_bool>` **linear_limit_x/enabled** - If ``true`` the linear motion across the x-axis is limited.
.. _class_Generic6DOFJoint_linear_limit_x/lower_distance:
@@ -183,7 +183,7 @@ The lower, the longer an impulse from one side takes to travel to the other side
.. _class_Generic6DOFJoint_linear_limit_y/enabled:
- :ref:`bool<class_bool>` **linear_limit_y/enabled** - If ``true`` the linear motion across the y-axis is enabled.
- :ref:`bool<class_bool>` **linear_limit_y/enabled** - If ``true`` the linear motion across the y-axis is limited.
.. _class_Generic6DOFJoint_linear_limit_y/lower_distance:
@@ -207,7 +207,7 @@ The lower, the longer an impulse from one side takes to travel to the other side
.. _class_Generic6DOFJoint_linear_limit_z/enabled:
- :ref:`bool<class_bool>` **linear_limit_z/enabled** - If ``true`` the linear motion across the z-axis is enabled.
- :ref:`bool<class_bool>` **linear_limit_z/enabled** - If ``true`` the linear motion across the z-axis is limited.
.. _class_Generic6DOFJoint_linear_limit_z/lower_distance:
@@ -262,5 +262,5 @@ enum **Param**
Description
-----------
The first 3 dof axes are linear axes, which represent translation of Bodies, and the latter 3 dof axes represent the angular motion. Each axis can be either locked, or limited.
The first 3 DOF axes are linear axes, which represent translation of Bodies, and the latter 3 DOF axes represent the angular motion. Each axis can be either locked, or limited.

2
classes/class_gridcontainer.rst
View File

@@ -14,7 +14,7 @@ GridContainer
Brief Description
-----------------
Grid container used to arrange elements in a grid like layout
Grid container used to arrange elements in a grid like layout.
Member Variables
----------------

8
classes/class_httpclient.rst
View File

@@ -259,6 +259,14 @@ Generates a GET/POST application/x-www-form-urlencoded style query string from a
String queryString = httpClient.query_string_from_dict(fields)
returns:= "username=user&password=pass"
Furthermore, if a key has a null value, only the key itself is added, without equal sign and value. If the value is an array, for each value in it a pair with the same key is added.
::
var fields = {"single": 123, "not_valued": null, "multiple": [22, 33, 44]}
String queryString = httpClient.query_string_from_dict(fields)
returns:= "single=123&not_valued&multiple=22&multiple=33&multiple=44"
.. _class_HTTPClient_read_response_body_chunk:
- :ref:`PoolByteArray<class_poolbytearray>` **read_response_body_chunk** **(** **)**

6
classes/class_image.rst
View File

@@ -28,6 +28,8 @@ Member Functions
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`blit_rect_mask<class_Image_blit_rect_mask>` **(** :ref:`Image<class_image>` src, :ref:`Image<class_image>` mask, :ref:`Rect2<class_rect2>` src_rect, :ref:`Vector2<class_vector2>` dst **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`bumpmap_to_normalmap<class_Image_bumpmap_to_normalmap>` **(** :ref:`float<class_float>` bump_scale=1.0 **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_mipmaps<class_Image_clear_mipmaps>` **(** **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`compress<class_Image_compress>` **(** :ref:`int<class_int>` mode, :ref:`int<class_int>` source, :ref:`float<class_float>` lossy_quality **)** |
@@ -232,6 +234,10 @@ Copies ``src_rect`` from ``src`` image to this image at coordinates ``dst``.
Blits ``src_rect`` area from ``src`` image to this image at the coordinates given by ``dst``. ``src`` pixel is copied onto ``dst`` if the corresponding ``mask`` pixel's alpha value is not 0. ``src`` image and ``mask`` image **must** have the same size (width and height) but they can have different formats.
.. _class_Image_bumpmap_to_normalmap:
- void **bumpmap_to_normalmap** **(** :ref:`float<class_float>` bump_scale=1.0 **)**
.. _class_Image_clear_mipmaps:
- void **clear_mipmaps** **(** **)**

2
classes/class_input.rst
View File

@@ -98,7 +98,7 @@ Signals
.. _class_Input_joy_connection_changed:
- **joy_connection_changed** **(** :ref:`int<class_int>` index, :ref:`bool<class_bool>` connected **)**
- **joy_connection_changed** **(** :ref:`int<class_int>` device, :ref:`bool<class_bool>` connected **)**
Emitted when a joypad device has been connected or disconnected.

17
classes/class_interpolatedcamera.rst
View File

@@ -14,7 +14,7 @@ InterpolatedCamera
Brief Description
-----------------
Camera which moves toward another node.
Member Functions
----------------
@@ -28,17 +28,24 @@ Member Variables
.. _class_InterpolatedCamera_enabled:
- :ref:`bool<class_bool>` **enabled**
- :ref:`bool<class_bool>` **enabled** - If ``true`` and a target is set, the camera will move automatically.
.. _class_InterpolatedCamera_speed:
- :ref:`float<class_float>` **speed**
- :ref:`float<class_float>` **speed** - How quickly the camera moves toward its target. Higher values will result in tighter camera motion.
.. _class_InterpolatedCamera_target:
- :ref:`NodePath<class_nodepath>` **target**
- :ref:`NodePath<class_nodepath>` **target** - The target's :ref:`NodePath<class_nodepath>`.
Description
-----------
InterpolatedCamera is a :ref:`Camera<class_camera>` which smoothly moves to match a target node's position and rotation.
If it is not :ref:`enabled<class_InterpolatedCamera_enabled>` or does not have a valid target set, InterpolatedCamera acts like a normal Camera.
Member Function Description
---------------------------
@@ -46,4 +53,6 @@ Member Function Description
- void **set_target** **(** :ref:`Object<class_object>` target **)**
Sets the node to move toward and orient with.

34
classes/class_itemlist.rst
View File

@@ -36,6 +36,8 @@ Member Functions
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture<class_texture>` | :ref:`get_item_icon<class_ItemList_get_item_icon>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`get_item_icon_modulate<class_ItemList_get_item_icon_modulate>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Rect2<class_rect2>` | :ref:`get_item_icon_region<class_ItemList_get_item_icon_region>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_variant>` | :ref:`get_item_metadata<class_ItemList_get_item_metadata>` **(** :ref:`int<class_int>` idx **)** const |
@@ -48,6 +50,8 @@ Member Functions
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`VScrollBar<class_vscrollbar>` | :ref:`get_v_scroll<class_ItemList_get_v_scroll>` **(** **)** |
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_anything_selected<class_ItemList_is_anything_selected>` **(** **)** |
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_item_disabled<class_ItemList_is_item_disabled>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_item_selectable<class_ItemList_is_item_selectable>` **(** :ref:`int<class_int>` idx **)** const |
@@ -56,6 +60,8 @@ Member Functions
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_selected<class_ItemList_is_selected>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`move_item<class_ItemList_move_item>` **(** :ref:`int<class_int>` p_from_idx, :ref:`int<class_int>` p_to_idx **)** |
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_item<class_ItemList_remove_item>` **(** :ref:`int<class_int>` idx **)** |
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`select<class_ItemList_select>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` single=true **)** |
@@ -66,6 +72,8 @@ Member Functions
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_item_icon<class_ItemList_set_item_icon>` **(** :ref:`int<class_int>` idx, :ref:`Texture<class_texture>` icon **)** |
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_item_icon_modulate<class_ItemList_set_item_icon_modulate>` **(** :ref:`int<class_int>` idx, :ref:`Color<class_color>` modulate **)** |
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_item_icon_region<class_ItemList_set_item_icon_region>` **(** :ref:`int<class_int>` idx, :ref:`Rect2<class_rect2>` rect **)** |
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_item_metadata<class_ItemList_set_item_metadata>` **(** :ref:`int<class_int>` idx, :ref:`Variant<class_variant>` metadata **)** |
@@ -82,6 +90,8 @@ Member Functions
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`unselect<class_ItemList_unselect>` **(** :ref:`int<class_int>` idx **)** |
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`unselect_all<class_ItemList_unselect_all>` **(** **)** |
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Signals
-------
@@ -249,6 +259,12 @@ Return count of items currently in the item list.
- :ref:`Texture<class_texture>` **get_item_icon** **(** :ref:`int<class_int>` idx **)** const
.. _class_ItemList_get_item_icon_modulate:
- :ref:`Color<class_color>` **get_item_icon_modulate** **(** :ref:`int<class_int>` idx **)** const
Returns a :ref:`Color<class_color>` modulating item's icon at the specified index.
.. _class_ItemList_get_item_icon_region:
- :ref:`Rect2<class_rect2>` **get_item_icon_region** **(** :ref:`int<class_int>` idx **)** const
@@ -281,6 +297,10 @@ Returns the list of selected indexes.
Returns the current vertical scroll bar for the List.
.. _class_ItemList_is_anything_selected:
- :ref:`bool<class_bool>` **is_anything_selected** **(** **)**
.. _class_ItemList_is_item_disabled:
- :ref:`bool<class_bool>` **is_item_disabled** **(** :ref:`int<class_int>` idx **)** const
@@ -305,6 +325,10 @@ Returns whether the tooltip is enabled for specified item index.
Returns whether or not item at the specified index is currently selected.
.. _class_ItemList_move_item:
- void **move_item** **(** :ref:`int<class_int>` p_from_idx, :ref:`int<class_int>` p_to_idx **)**
.. _class_ItemList_remove_item:
- void **remove_item** **(** :ref:`int<class_int>` idx **)**
@@ -337,6 +361,12 @@ Disabled items are not be selectable and do not fire activation (Enter or double
Set (or replace) icon of the item at the specified index.
.. _class_ItemList_set_item_icon_modulate:
- void **set_item_icon_modulate** **(** :ref:`int<class_int>` idx, :ref:`Color<class_color>` modulate **)**
Sets a modulating :ref:`Color<class_color>` for item's icon at the specified index.
.. _class_ItemList_set_item_icon_region:
- void **set_item_icon_region** **(** :ref:`int<class_int>` idx, :ref:`Rect2<class_rect2>` rect **)**
@@ -383,4 +413,8 @@ Sorts items in the list by their text.
Ensure item at specified index is not selected.
.. _class_ItemList_unselect_all:
- void **unselect_all** **(** **)**

2
classes/class_linkbutton.rst
View File

@@ -14,7 +14,7 @@ LinkButton
Brief Description
-----------------
Simple button used to represent a link to some resource
Simple button used to represent a link to some resource.
Member Variables
----------------

141
classes/class_multiplayerapi.rst Normal file
View File

@@ -0,0 +1,141 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the MultiplayerAPI.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_MultiplayerAPI:
MultiplayerAPI
==============
**Inherits:** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Member Functions
----------------
+------------------------------------------+--------------------------------------------------------------------------------------------------------+
| void | :ref:`add_peer<class_MultiplayerAPI_add_peer>` **(** :ref:`int<class_int>` id **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------+
| void | :ref:`clear<class_MultiplayerAPI_clear>` **(** **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------+
| void | :ref:`connected_to_server<class_MultiplayerAPI_connected_to_server>` **(** **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------+
| void | :ref:`connection_failed<class_MultiplayerAPI_connection_failed>` **(** **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------+
| void | :ref:`del_peer<class_MultiplayerAPI_del_peer>` **(** :ref:`int<class_int>` id **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------+
| :ref:`PoolIntArray<class_poolintarray>` | :ref:`get_network_connected_peers<class_MultiplayerAPI_get_network_connected_peers>` **(** **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_network_unique_id<class_MultiplayerAPI_get_network_unique_id>` **(** **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_rpc_sender_id<class_MultiplayerAPI_get_rpc_sender_id>` **(** **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_network_peer<class_MultiplayerAPI_has_network_peer>` **(** **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_network_server<class_MultiplayerAPI_is_network_server>` **(** **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------+
| void | :ref:`poll<class_MultiplayerAPI_poll>` **(** **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------+
| void | :ref:`server_disconnected<class_MultiplayerAPI_server_disconnected>` **(** **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------+
| void | :ref:`set_root_node<class_MultiplayerAPI_set_root_node>` **(** :ref:`Node<class_node>` node **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------+
Signals
-------
.. _class_MultiplayerAPI_connected_to_server:
- **connected_to_server** **(** **)**
.. _class_MultiplayerAPI_connection_failed:
- **connection_failed** **(** **)**
.. _class_MultiplayerAPI_network_peer_connected:
- **network_peer_connected** **(** :ref:`int<class_int>` id **)**
.. _class_MultiplayerAPI_network_peer_disconnected:
- **network_peer_disconnected** **(** :ref:`int<class_int>` id **)**
.. _class_MultiplayerAPI_server_disconnected:
- **server_disconnected** **(** **)**
Member Variables
----------------
.. _class_MultiplayerAPI_network_peer:
- :ref:`NetworkedMultiplayerPeer<class_networkedmultiplayerpeer>` **network_peer**
.. _class_MultiplayerAPI_refuse_new_network_connections:
- :ref:`bool<class_bool>` **refuse_new_network_connections**
Member Function Description
---------------------------
.. _class_MultiplayerAPI_add_peer:
- void **add_peer** **(** :ref:`int<class_int>` id **)**
.. _class_MultiplayerAPI_clear:
- void **clear** **(** **)**
.. _class_MultiplayerAPI_connected_to_server:
- void **connected_to_server** **(** **)**
.. _class_MultiplayerAPI_connection_failed:
- void **connection_failed** **(** **)**
.. _class_MultiplayerAPI_del_peer:
- void **del_peer** **(** :ref:`int<class_int>` id **)**
.. _class_MultiplayerAPI_get_network_connected_peers:
- :ref:`PoolIntArray<class_poolintarray>` **get_network_connected_peers** **(** **)** const
.. _class_MultiplayerAPI_get_network_unique_id:
- :ref:`int<class_int>` **get_network_unique_id** **(** **)** const
.. _class_MultiplayerAPI_get_rpc_sender_id:
- :ref:`int<class_int>` **get_rpc_sender_id** **(** **)** const
.. _class_MultiplayerAPI_has_network_peer:
- :ref:`bool<class_bool>` **has_network_peer** **(** **)** const
.. _class_MultiplayerAPI_is_network_server:
- :ref:`bool<class_bool>` **is_network_server** **(** **)** const
.. _class_MultiplayerAPI_poll:
- void **poll** **(** **)**
.. _class_MultiplayerAPI_server_disconnected:
- void **server_disconnected** **(** **)**
.. _class_MultiplayerAPI_set_root_node:
- void **set_root_node** **(** :ref:`Node<class_node>` node **)**

22
classes/class_navigation.rst
View File

@@ -14,7 +14,7 @@ Navigation
Brief Description
-----------------
A collection of ``NavigationMesh`` resources and methods used for pathfinding.
Mesh-based navigation and pathfinding node.
Member Functions
----------------
@@ -42,13 +42,13 @@ Member Variables
.. _class_Navigation_up_vector:
- :ref:`Vector3<class_vector3>` **up_vector** - Defines which direction is up. The default defines 0,1,0 as up which is the world up direction. To make this a ceiling use 0,-1,0 to define down as up.
- :ref:`Vector3<class_vector3>` **up_vector** - Defines which direction is up. By default this is ``(0, 1, 0)``, which is the world up direction.
Description
-----------
The Navigation node is used for basic or advanced navigation. By default it will automatically collect all child ``NavigationMesh`` resources, but they can also be added on the fly through scripting. It can be used for generating a simple path between two points or it can be used to ensure that a navigation agent is angled perfectly to the terrain it is navigating.
Provides navigation and pathfinding within a collection of :ref:`NavigationMesh<class_navigationmesh>`\ es. By default these will be automatically collected from child :ref:`NavigationMeshInstance<class_navigationmeshinstance>` nodes, but they can also be added on the fly with :ref:`navmesh_add<class_Navigation_navmesh_add>`. In addition to basic pathfinding, this class also assists with aligning navigation agents with the meshes they are navigating on.
Member Function Description
---------------------------
@@ -57,48 +57,48 @@ Member Function Description
- :ref:`Vector3<class_vector3>` **get_closest_point** **(** :ref:`Vector3<class_vector3>` to_point **)**
Returns the closest navigation point to the point passed.
Returns the navigation point closest to the point given. Points are in local coordinate space.
.. _class_Navigation_get_closest_point_normal:
- :ref:`Vector3<class_vector3>` **get_closest_point_normal** **(** :ref:`Vector3<class_vector3>` to_point **)**
Returns the surface normal of the navigation mesh at the point passed. For instance, if the point passed was at a 45 degree slope it would return something like (0.5,0.5,0). This is useful for rotating a navigation agent in accordance with the ``NavigationMesh``.
Returns the surface normal at the navigation point closest to the point given. Useful for rotating a navigation agent according to the navigation mesh it moves on.
.. _class_Navigation_get_closest_point_owner:
- :ref:`Object<class_object>` **get_closest_point_owner** **(** :ref:`Vector3<class_vector3>` to_point **)**
Returns the nearest ``NavigationMeshInstance`` to the point passed.
Returns the owner of the :ref:`NavigationMesh<class_navigationmesh>` which contains the navigation point closest to the point given. This is usually a NavigtionMeshInstance. For meshes added via :ref:`navmesh_add<class_Navigation_navmesh_add>`, returns the owner that was given (or ``null`` if the ``owner`` parameter was omitted).
.. _class_Navigation_get_closest_point_to_segment:
- :ref:`Vector3<class_vector3>` **get_closest_point_to_segment** **(** :ref:`Vector3<class_vector3>` start, :ref:`Vector3<class_vector3>` end, :ref:`bool<class_bool>` use_collision=false **)**
Returns the nearest point to the line segment passed. The third optional parameter takes collisions into account.
Returns the navigation point closest to the given line segment. When enabling ``use_collision``, only considers intersection points between segment and navigation meshes. If multiple intersection points are found, the one closest to the segment start point is returned.
.. _class_Navigation_get_simple_path:
- :ref:`PoolVector3Array<class_poolvector3array>` **get_simple_path** **(** :ref:`Vector3<class_vector3>` start, :ref:`Vector3<class_vector3>` end, :ref:`bool<class_bool>` optimize=true **)**
Returns a path of points as a ``PoolVector3Array``. If ``optimize`` is false the ``NavigationMesh`` agent properties will be taken into account, otherwise it will return the nearest path and ignore agent radius, height, etc.
Returns the path between two given points. Points are in local coordinate space. If ``optimize`` is ``true`` (the default), the agent properties associated with each :ref:`NavigationMesh<class_navigationmesh>` (raidus, height, etc.) are considered in the path calculation, otherwise they are ignored.
.. _class_Navigation_navmesh_add:
- :ref:`int<class_int>` **navmesh_add** **(** :ref:`NavigationMesh<class_navigationmesh>` mesh, :ref:`Transform<class_transform>` xform, :ref:`Object<class_object>` owner=null **)**
Adds a ``NavigationMesh`` to the list of NavigationMesh's in this node. Returns an id. Its position, rotation and scale are associated with the ``Transform`` passed. The ``Node`` (or ``Object``) that owns this node is an optional parameter.
Adds a :ref:`NavigationMesh<class_navigationmesh>`. Returns an ID for use with :ref:`navmesh_remove<class_Navigation_navmesh_remove>` or :ref:`navmesh_set_transform<class_Navigation_navmesh_set_transform>`. If given, a :ref:`Transform2D<class_transform2d>` is applied to the polygon. The optional ``owner`` is used as return value for :ref:`get_closest_point_owner<class_Navigation_get_closest_point_owner>`.
.. _class_Navigation_navmesh_remove:
- void **navmesh_remove** **(** :ref:`int<class_int>` id **)**
Removes a ``NavigationMesh`` from the list of NavigationMesh's in this node.
Removes the :ref:`NavigationMesh<class_navigationmesh>` with the given ID.
.. _class_Navigation_navmesh_set_transform:
- void **navmesh_set_transform** **(** :ref:`int<class_int>` id, :ref:`Transform<class_transform>` xform **)**
Associates a ``NavigationMesh``'s id with a ``Transform``. Its position, rotation and scale are based on the ``Transform`` passed.
Sets the transform applied to the :ref:`NavigationMesh<class_navigationmesh>` with the given ID.

19
classes/class_navigation2d.rst
View File

@@ -14,7 +14,7 @@ Navigation2D
Brief Description
-----------------
Class to assist with character navigation and pathfinding.
2D navigation and pathfinding node.
Member Functions
----------------
@@ -33,6 +33,11 @@ Member Functions
| void | :ref:`navpoly_set_transform<class_Navigation2D_navpoly_set_transform>` **(** :ref:`int<class_int>` id, :ref:`Transform2D<class_transform2d>` xform **)** |
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Description
-----------
Navigation2D provides navigation and pathfinding within a 2D area, specified as a collection of :ref:`NavigationPolygon<class_navigationpolygon>` resources. By default these are automatically collected from child :ref:`NavigationPolygonInstance<class_navigationpolygoninstance>` nodes, but they can also be added on the fly with :ref:`navpoly_add<class_Navigation2D_navpoly_add>`.
Member Function Description
---------------------------
@@ -40,24 +45,36 @@ Member Function Description
- :ref:`Vector2<class_vector2>` **get_closest_point** **(** :ref:`Vector2<class_vector2>` to_point **)**
Returns the navigation point closest to the point given. Points are in local coordinate space.
.. _class_Navigation2D_get_closest_point_owner:
- :ref:`Object<class_object>` **get_closest_point_owner** **(** :ref:`Vector2<class_vector2>` to_point **)**
Returns the owner of the :ref:`NavigationPolygon<class_navigationpolygon>` which contains the navigation point closest to the point given. This is usually a NavigtionPolygonInstance. For polygons added via :ref:`navpoly_add<class_Navigation2D_navpoly_add>`, returns the owner that was given (or ``null`` if the ``owner`` parameter was omitted).
.. _class_Navigation2D_get_simple_path:
- :ref:`PoolVector2Array<class_poolvector2array>` **get_simple_path** **(** :ref:`Vector2<class_vector2>` start, :ref:`Vector2<class_vector2>` end, :ref:`bool<class_bool>` optimize=true **)**
Returns the path between two given points. Points are in local coordinate space. If ``optimize`` is ``true`` (the default), the path is smoothed by merging path segments where possible.
.. _class_Navigation2D_navpoly_add:
- :ref:`int<class_int>` **navpoly_add** **(** :ref:`NavigationPolygon<class_navigationpolygon>` mesh, :ref:`Transform2D<class_transform2d>` xform, :ref:`Object<class_object>` owner=null **)**
Adds a :ref:`NavigationPolygon<class_navigationpolygon>`. Returns an ID for use with :ref:`navpoly_remove<class_Navigation2D_navpoly_remove>` or :ref:`navpoly_set_transform<class_Navigation2D_navpoly_set_transform>`. If given, a :ref:`Transform2D<class_transform2d>` is applied to the polygon. The optional ``owner`` is used as return value for :ref:`get_closest_point_owner<class_Navigation2D_get_closest_point_owner>`.
.. _class_Navigation2D_navpoly_remove:
- void **navpoly_remove** **(** :ref:`int<class_int>` id **)**
Removes the :ref:`NavigationPolygon<class_navigationpolygon>` with the given ID.
.. _class_Navigation2D_navpoly_set_transform:
- void **navpoly_set_transform** **(** :ref:`int<class_int>` id, :ref:`Transform2D<class_transform2d>` xform **)**
Sets the transform applied to the :ref:`NavigationPolygon<class_navigationpolygon>` with the given ID.

38
classes/class_node.rst
View File

@@ -120,6 +120,8 @@ Member Functions
+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`print_tree<class_Node_print_tree>` **(** **)** |
+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`print_tree_pretty<class_Node_print_tree_pretty>` **(** **)** |
+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`propagate_call<class_Node_propagate_call>` **(** :ref:`String<class_string>` method, :ref:`Array<class_array>` args=[ ], :ref:`bool<class_bool>` parent_first=false **)** |
+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`propagate_notification<class_Node_propagate_notification>` **(** :ref:`int<class_int>` what **)** |
@@ -210,17 +212,25 @@ Emitted when the node is still active but about to exit the tree. This is the ri
Member Variables
----------------
.. _class_Node_custom_multiplayer_api:
- :ref:`MultiplayerAPI<class_multiplayerapi>` **custom_multiplayer_api**
.. _class_Node_filename:
- :ref:`String<class_string>` **filename** - When a scene is instanced from a file, its topmost node contains the filename from which it was loaded.
.. _class_Node_multiplayer_api:
- :ref:`MultiplayerAPI<class_multiplayerapi>` **multiplayer_api**
.. _class_Node_name:
- :ref:`String<class_string>` **name** - The name of the node. This name is unique among the siblings (other child nodes from the same parent). When set to an existing name, the node will be automatically renamed
.. _class_Node_owner:
- :ref:`Node<class_node>` **owner** - The node owner. A node can have any other node as owner (as long as it is a valid parent, grandparent, etc. ascending in the tree). When saving a node (using SceneSaver) all the nodes it owns will be saved with it. This allows for the creation of complex :ref:`SceneTree<class_scenetree>`\ s, with instancing and subinstancing.
- :ref:`Node<class_node>` **owner** - The node owner. A node can have any other node as owner (as long as it is a valid parent, grandparent, etc. ascending in the tree). When saving a node (using :ref:`PackedScene<class_packedscene>`) all the nodes it owns will be saved with it. This allows for the creation of complex :ref:`SceneTree<class_scenetree>`\ s, with instancing and subinstancing.
.. _class_Node_pause_mode:
@@ -659,7 +669,31 @@ Prints all stray nodes (nodes outside the :ref:`SceneTree<class_scenetree>`). Us
- void **print_tree** **(** **)**
Prints the scene hierarchy of this node and all it's children to stdout. Used mainly for debugging purposes.
Prints the tree to stdout. Used mainly for debugging purposes. This version displays the path relative to the current node, and is good for copy/pasting into the :ref:`get_node<class_Node_get_node>` function. Example output:
::
TheGame
TheGame/Menu
TheGame/Menu/Label
TheGame/Menu/Camera2D
TheGame/SplashScreen
TheGame/SplashScreen/Camera2D
.. _class_Node_print_tree_pretty:
- void **print_tree_pretty** **(** **)**
Similar to :ref:`print_tree<class_Node_print_tree>`, this prints the tree to stdout. This version displays a more graphical representation similar to what is displayed in the scene inspector. It is useful for inspecting larger trees. Example output:
::
┖╴TheGame
┠╴Menu
┃ ┠╴Label
┃ ┖╴Camera2D
┖-SplashScreen
┖╴Camera2D
.. _class_Node_propagate_call:

4
classes/class_optionbutton.rst
View File

@@ -64,6 +64,10 @@ Member Functions
Signals
-------
.. _class_OptionButton_item_focused:
- **item_focused** **(** :ref:`int<class_int>` ID **)**
.. _class_OptionButton_item_selected:
- **item_selected** **(** :ref:`int<class_int>` ID **)**

24
classes/class_os.rst
View File

@@ -40,6 +40,10 @@ Member Functions
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`find_scancode_from_string<class_OS_find_scancode_from_string>` **(** :ref:`String<class_string>` string **)** const |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_audio_driver_count<class_OS_get_audio_driver_count>` **(** **)** const |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_audio_driver_name<class_OS_get_audio_driver_name>` **(** :ref:`int<class_int>` arg0 **)** const |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolStringArray<class_poolstringarray>` | :ref:`get_cmdline_args<class_OS_get_cmdline_args>` **(** **)** |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Dictionary<class_dictionary>` | :ref:`get_date<class_OS_get_date>` **(** :ref:`bool<class_bool>` utc=false **)** const |
@@ -108,6 +112,10 @@ Member Functions
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_user_data_dir<class_OS_get_user_data_dir>` **(** **)** const |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_video_driver_count<class_OS_get_video_driver_count>` **(** **)** const |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_video_driver_name<class_OS_get_video_driver_name>` **(** :ref:`int<class_int>` arg0 **)** const |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_virtual_keyboard_height<class_OS_get_virtual_keyboard_height>` **(** **)** |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_environment<class_OS_has_environment>` **(** :ref:`String<class_string>` environment **)** const |
@@ -388,6 +396,14 @@ If you wish to access a shell built-in or perform a composite command, a platfor
Returns the scancode of the given string (e.g. "Escape")
.. _class_OS_get_audio_driver_count:
- :ref:`int<class_int>` **get_audio_driver_count** **(** **)** const
.. _class_OS_get_audio_driver_name:
- :ref:`String<class_string>` **get_audio_driver_name** **(** :ref:`int<class_int>` arg0 **)** const
.. _class_OS_get_cmdline_args:
- :ref:`PoolStringArray<class_poolstringarray>` **get_cmdline_args** **(** **)**
@@ -622,6 +638,14 @@ On Windows, this is ``%APPDATA%/Godot/app_userdata/[project_name]``, or ``%APPDA
If the project name is empty, ``user://`` falls back to ``res://``.
.. _class_OS_get_video_driver_count:
- :ref:`int<class_int>` **get_video_driver_count** **(** **)** const
.. _class_OS_get_video_driver_name:
- :ref:`String<class_string>` **get_video_driver_name** **(** :ref:`int<class_int>` arg0 **)** const
.. _class_OS_get_virtual_keyboard_height:
- :ref:`int<class_int>` **get_virtual_keyboard_height** **(** **)**

11
classes/class_packedscene.rst
View File

@@ -56,7 +56,16 @@ Description
A simplified interface to a scene file. Provides access to operations and checks that can be performed on the scene resource itself.
TODO: explain ownership, and that node does not need to own itself
Can be used to save a node to a file. When saving, the node as well as all the node it owns get saved (see ``owner`` property on :ref:`Node<class_node>`). Note that the node doesn't need to own itself.
Example of saving a node:
::
var scene = PackedScene.new()
var result = scene.pack(child)
if result == OK:
ResourceSaver.save("res://path/name.scn", scene) // or user://...
Member Function Description
---------------------------

40
classes/class_popupmenu.rst
View File

@@ -34,6 +34,10 @@ Member Functions
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_item<class_PopupMenu_add_item>` **(** :ref:`String<class_string>` label, :ref:`int<class_int>` id=-1, :ref:`int<class_int>` accel=0 **)** |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_radio_check_item<class_PopupMenu_add_radio_check_item>` **(** :ref:`String<class_string>` label, :ref:`int<class_int>` id=-1, :ref:`int<class_int>` accel=0 **)** |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_radio_check_shortcut<class_PopupMenu_add_radio_check_shortcut>` **(** :ref:`ShortCut<class_shortcut>` shortcut, :ref:`int<class_int>` id=-1, :ref:`bool<class_bool>` global=false **)** |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_separator<class_PopupMenu_add_separator>` **(** **)** |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_shortcut<class_PopupMenu_add_shortcut>` **(** :ref:`ShortCut<class_shortcut>` shortcut, :ref:`int<class_int>` id=-1, :ref:`bool<class_bool>` global=false **)** |
@@ -68,6 +72,8 @@ Member Functions
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_item_disabled<class_PopupMenu_is_item_disabled>` **(** :ref:`int<class_int>` idx **)** const |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_item_radio_checkable<class_PopupMenu_is_item_radio_checkable>` **(** :ref:`int<class_int>` idx **)** const |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_item_separator<class_PopupMenu_is_item_separator>` **(** :ref:`int<class_int>` idx **)** const |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_item<class_PopupMenu_remove_item>` **(** :ref:`int<class_int>` idx **)** |
@@ -76,6 +82,8 @@ Member Functions
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_item_as_checkable<class_PopupMenu_set_item_as_checkable>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` enable **)** |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_item_as_radio_checkable<class_PopupMenu_set_item_as_radio_checkable>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` enable **)** |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_item_as_separator<class_PopupMenu_set_item_as_separator>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` enable **)** |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_item_checked<class_PopupMenu_set_item_checked>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` checked **)** |
@@ -106,6 +114,10 @@ Member Functions
Signals
-------
.. _class_PopupMenu_id_focused:
- **id_focused** **(** :ref:`int<class_int>` ID **)**
.. _class_PopupMenu_id_pressed:
- **id_pressed** **(** :ref:`int<class_int>` ID **)**
@@ -181,6 +193,16 @@ Add a new item with text "label" and icon "texture". An id can optionally be pro
Add a new item with text "label". An id can optionally be provided, as well as an accelerator keybinding. If no id is provided, one will be created from the index.
.. _class_PopupMenu_add_radio_check_item:
- void **add_radio_check_item** **(** :ref:`String<class_string>` label, :ref:`int<class_int>` id=-1, :ref:`int<class_int>` accel=0 **)**
The same as :ref:`add_check_item<class_PopupMenu_add_check_item>` but the inserted item will look as a radio button. Remember this is just cosmetic and you have to add the logic for checking/unchecking items in radio groups.
.. _class_PopupMenu_add_radio_check_shortcut:
- void **add_radio_check_shortcut** **(** :ref:`ShortCut<class_shortcut>` shortcut, :ref:`int<class_int>` id=-1, :ref:`bool<class_bool>` global=false **)**
.. _class_PopupMenu_add_separator:
- void **add_separator** **(** **)**
@@ -263,13 +285,13 @@ Return the text of the item at index "idx".
- :ref:`bool<class_bool>` **is_item_checkable** **(** :ref:`int<class_int>` idx **)** const
Return whether the item at index "idx" has a checkbox. Note that checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually.
Return whether the item at index "idx" is checkable in some way, i.e., whether has a checkbox or radio button. Note that checkable items just display a checkmark or radio button, but don't have any built-in checking behavior and must be checked/unchecked manually.
.. _class_PopupMenu_is_item_checked:
- :ref:`bool<class_bool>` **is_item_checked** **(** :ref:`int<class_int>` idx **)** const
Return the checkstate status of the item at index "idx".
Return whether the item at index "idx" is checked.
.. _class_PopupMenu_is_item_disabled:
@@ -277,6 +299,12 @@ Return the checkstate status of the item at index "idx".
Return whether the item at index "idx" is disabled. When it is disabled it can't be selected, or its action invoked.
.. _class_PopupMenu_is_item_radio_checkable:
- :ref:`bool<class_bool>` **is_item_radio_checkable** **(** :ref:`int<class_int>` idx **)** const
Return whether the item at index "idx" has radio-button-style checkability. Remember this is just cosmetic and you have to add the logic for checking/unchecking items in radio groups.
.. _class_PopupMenu_is_item_separator:
- :ref:`bool<class_bool>` **is_item_separator** **(** :ref:`int<class_int>` idx **)** const
@@ -301,6 +329,14 @@ Set the accelerator of the item at index "idx". Accelerators are special combina
Set whether the item at index "idx" has a checkbox. Note that checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually.
.. _class_PopupMenu_set_item_as_radio_checkable:
- void **set_item_as_radio_checkable** **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` enable **)**
The same as :ref:`set_item_as_checkable<class_PopupMenu_set_item_as_checkable>` but placing a radio button in case of enabling. If used for disabling, it's the same.
Remember this is just cosmetic and you have to add the logic for checking/unchecking items in radio groups.
.. _class_PopupMenu_set_item_as_separator:
- void **set_item_as_separator** **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` enable **)**

2
classes/class_position3d.rst
View File

@@ -14,7 +14,7 @@ Position3D
Brief Description
-----------------
Generic 3D Position hint for editing
Generic 3D Position hint for editing.
Description
-----------

2
classes/class_reference.rst
View File

@@ -9,7 +9,7 @@ Reference
**Inherits:** :ref:`Object<class_object>`
**Inherited By:** :ref:`RegExMatch<class_regexmatch>`, :ref:`RegEx<class_regex>`, :ref:`EncodedObjectAsID<class_encodedobjectasid>`, :ref:`SpatialGizmo<class_spatialgizmo>`, :ref:`TriangleMesh<class_trianglemesh>`, :ref:`EditorScenePostImport<class_editorscenepostimport>`, :ref:`PhysicsShapeQueryResult<class_physicsshapequeryresult>`, :ref:`EditorSceneImporter<class_editorsceneimporter>`, :ref:`Physics2DTestMotionResult<class_physics2dtestmotionresult>`, :ref:`FuncRef<class_funcref>`, :ref:`File<class_file>`, :ref:`TCP_Server<class_tcp_server>`, :ref:`Physics2DShapeQueryResult<class_physics2dshapequeryresult>`, :ref:`ConfigFile<class_configfile>`, :ref:`StreamPeer<class_streampeer>`, :ref:`GDScriptNativeClass<class_gdscriptnativeclass>`, :ref:`HTTPClient<class_httpclient>`, :ref:`AudioStreamPlayback<class_audiostreamplayback>`, :ref:`VisualScriptFunctionState<class_visualscriptfunctionstate>`, :ref:`Resource<class_resource>`, :ref:`KinematicCollision<class_kinematiccollision>`, :ref:`SurfaceTool<class_surfacetool>`, :ref:`JSONParseResult<class_jsonparseresult>`, :ref:`SpatialVelocityTracker<class_spatialvelocitytracker>`, :ref:`EditorResourcePreviewGenerator<class_editorresourcepreviewgenerator>`, :ref:`Physics2DShapeQueryParameters<class_physics2dshapequeryparameters>`, :ref:`EditorExportPlugin<class_editorexportplugin>`, :ref:`ARVRInterface<class_arvrinterface>`, :ref:`EditorScript<class_editorscript>`, :ref:`Mutex<class_mutex>`, :ref:`PacketPeer<class_packetpeer>`, :ref:`Semaphore<class_semaphore>`, :ref:`XMLParser<class_xmlparser>`, :ref:`EditorImportPlugin<class_editorimportplugin>`, :ref:`Directory<class_directory>`, :ref:`WeakRef<class_weakref>`, :ref:`GDScriptFunctionState<class_gdscriptfunctionstate>`, :ref:`Marshalls<class_marshalls>`, :ref:`SceneState<class_scenestate>`, :ref:`PCKPacker<class_pckpacker>`, :ref:`MeshDataTool<class_meshdatatool>`, :ref:`AStar<class_astar>`, :ref:`ResourceImporter<class_resourceimporter>`, :ref:`EditorResourceConversionPlugin<class_editorresourceconversionplugin>`, :ref:`SceneTreeTimer<class_scenetreetimer>`, :ref:`Thread<class_thread>`, :ref:`ResourceInteractiveLoader<class_resourceinteractiveloader>`, :ref:`PackedDataContainerRef<class_packeddatacontainerref>`, :ref:`KinematicCollision2D<class_kinematiccollision2d>`, :ref:`GDNative<class_gdnative>`, :ref:`PhysicsShapeQueryParameters<class_physicsshapequeryparameters>`
**Inherited By:** :ref:`RegExMatch<class_regexmatch>`, :ref:`RegEx<class_regex>`, :ref:`EncodedObjectAsID<class_encodedobjectasid>`, :ref:`SpatialGizmo<class_spatialgizmo>`, :ref:`TriangleMesh<class_trianglemesh>`, :ref:`EditorScenePostImport<class_editorscenepostimport>`, :ref:`PhysicsShapeQueryResult<class_physicsshapequeryresult>`, :ref:`EditorSceneImporter<class_editorsceneimporter>`, :ref:`Physics2DTestMotionResult<class_physics2dtestmotionresult>`, :ref:`FuncRef<class_funcref>`, :ref:`File<class_file>`, :ref:`TCP_Server<class_tcp_server>`, :ref:`Physics2DShapeQueryResult<class_physics2dshapequeryresult>`, :ref:`ConfigFile<class_configfile>`, :ref:`StreamPeer<class_streampeer>`, :ref:`GDScriptNativeClass<class_gdscriptnativeclass>`, :ref:`HTTPClient<class_httpclient>`, :ref:`AudioStreamPlayback<class_audiostreamplayback>`, :ref:`VisualScriptFunctionState<class_visualscriptfunctionstate>`, :ref:`Resource<class_resource>`, :ref:`KinematicCollision<class_kinematiccollision>`, :ref:`SurfaceTool<class_surfacetool>`, :ref:`JSONParseResult<class_jsonparseresult>`, :ref:`SpatialVelocityTracker<class_spatialvelocitytracker>`, :ref:`EditorResourcePreviewGenerator<class_editorresourcepreviewgenerator>`, :ref:`Physics2DShapeQueryParameters<class_physics2dshapequeryparameters>`, :ref:`EditorExportPlugin<class_editorexportplugin>`, :ref:`ARVRInterface<class_arvrinterface>`, :ref:`EditorScript<class_editorscript>`, :ref:`MultiplayerAPI<class_multiplayerapi>`, :ref:`Mutex<class_mutex>`, :ref:`PacketPeer<class_packetpeer>`, :ref:`Semaphore<class_semaphore>`, :ref:`XMLParser<class_xmlparser>`, :ref:`EditorImportPlugin<class_editorimportplugin>`, :ref:`Directory<class_directory>`, :ref:`WeakRef<class_weakref>`, :ref:`GDScriptFunctionState<class_gdscriptfunctionstate>`, :ref:`Marshalls<class_marshalls>`, :ref:`SceneState<class_scenestate>`, :ref:`PCKPacker<class_pckpacker>`, :ref:`MeshDataTool<class_meshdatatool>`, :ref:`AStar<class_astar>`, :ref:`ResourceImporter<class_resourceimporter>`, :ref:`EditorResourceConversionPlugin<class_editorresourceconversionplugin>`, :ref:`SceneTreeTimer<class_scenetreetimer>`, :ref:`Thread<class_thread>`, :ref:`ResourceInteractiveLoader<class_resourceinteractiveloader>`, :ref:`PackedDataContainerRef<class_packeddatacontainerref>`, :ref:`KinematicCollision2D<class_kinematiccollision2d>`, :ref:`GDNative<class_gdnative>`, :ref:`PhysicsShapeQueryParameters<class_physicsshapequeryparameters>`
**Category:** Core

99
classes/class_scenetree.rst
View File

@@ -14,7 +14,7 @@ SceneTree
Brief Description
-----------------
SceneTree manages a hierarchy of nodes.
Member Functions
----------------
@@ -80,61 +80,87 @@ Signals
- **connected_to_server** **(** **)**
Emitted whenever this SceneTree's :ref:`network_peer<class_SceneTree_network_peer>` successfully connected to a server. Only emitted on clients.
.. _class_SceneTree_connection_failed:
- **connection_failed** **(** **)**
Emitted whenever this SceneTree's :ref:`network_peer<class_SceneTree_network_peer>` fails to establish a connection to a server. Only emitted on clients.
.. _class_SceneTree_files_dropped:
- **files_dropped** **(** :ref:`PoolStringArray<class_poolstringarray>` files, :ref:`int<class_int>` screen **)**
Emitted whenever files are drag-and-dropped onto the window.
.. _class_SceneTree_idle_frame:
- **idle_frame** **(** **)**
Emitted immediately before :ref:`Node._process<class_Node__process>` is called on every node in the SceneTree.
.. _class_SceneTree_network_peer_connected:
- **network_peer_connected** **(** :ref:`int<class_int>` id **)**
Emitted whenever this SceneTree's :ref:`network_peer<class_SceneTree_network_peer>` connects with a new peer. ID is the peer ID of the new peer. Clients get notified when other clients connect to the same server. Upon connecting to a server, a client also receives this signal for the server (with ID being 1).
.. _class_SceneTree_network_peer_disconnected:
- **network_peer_disconnected** **(** :ref:`int<class_int>` id **)**
Emitted whenever this SceneTree's :ref:`network_peer<class_SceneTree_network_peer>` disconnects from a peer. Clients get notified when other clients disconnect from the same server.
.. _class_SceneTree_node_added:
- **node_added** **(** :ref:`Object<class_object>` node **)**
Emitted whenever a node is added to the SceneTree.
.. _class_SceneTree_node_configuration_warning_changed:
- **node_configuration_warning_changed** **(** :ref:`Object<class_object>` node **)**
Emitted when a node's configuration changed. Only emitted in tool mode.
.. _class_SceneTree_node_removed:
- **node_removed** **(** :ref:`Object<class_object>` node **)**
Emitted whenever a node is removed from the SceneTree.
.. _class_SceneTree_physics_frame:
- **physics_frame** **(** **)**
Emitted immediately before :ref:`Node._physics_process<class_Node__physics_process>` is called on every node in the SceneTree.
.. _class_SceneTree_screen_resized:
- **screen_resized** **(** **)**
Emitted whenever the screen resolution (fullscreen) or window size (windowed) changes.
.. _class_SceneTree_server_disconnected:
- **server_disconnected** **(** **)**
Emitted whenever this SceneTree's :ref:`network_peer<class_SceneTree_network_peer>` disconnected from server. Only emitted on clients.
.. _class_SceneTree_tree_changed:
- **tree_changed** **(** **)**
Emitted whenever the SceneTree hierarchy changed (children being moved or renamed, etc.).
Member Variables
----------------
.. _class_SceneTree_current_scene:
- :ref:`Node<class_node>` **current_scene**
- :ref:`Node<class_node>` **current_scene** - The current scene.
.. _class_SceneTree_debug_collisions_hint:
@@ -146,7 +172,11 @@ Member Variables
.. _class_SceneTree_edited_scene_root:
- :ref:`Node<class_node>` **edited_scene_root**
- :ref:`Node<class_node>` **edited_scene_root** - The root of the edited scene.
.. _class_SceneTree_multiplayer_api:
- :ref:`MultiplayerAPI<class_multiplayerapi>` **multiplayer_api**
.. _class_SceneTree_network_peer:
@@ -154,19 +184,19 @@ Member Variables
.. _class_SceneTree_paused:
- :ref:`bool<class_bool>` **paused**
- :ref:`bool<class_bool>` **paused** - If ``true`` the SceneTree is paused.
.. _class_SceneTree_refuse_new_network_connections:
- :ref:`bool<class_bool>` **refuse_new_network_connections**
- :ref:`bool<class_bool>` **refuse_new_network_connections** - If ``true`` the SceneTree's :ref:`network_peer<class_SceneTree_network_peer>` refuses new incoming connections.
.. _class_SceneTree_root:
- :ref:`Viewport<class_viewport>` **root**
- :ref:`Viewport<class_viewport>` **root** - The SceneTree's :ref:`Viewport<class_viewport>`.
.. _class_SceneTree_use_font_oversampling:
- :ref:`bool<class_bool>` **use_font_oversampling**
- :ref:`bool<class_bool>` **use_font_oversampling** - If ``true`` font oversampling is used.
Enums
@@ -200,6 +230,11 @@ enum **StretchAspect**
- **STRETCH_ASPECT_EXPAND** = **4**
Description
-----------
As one of the most important classes, the ``SceneTree`` manages the hierarchy of nodes in a scene as well as scenes themselves. Nodes can be added, retrieved and removed. The whole scene tree (and thus the current scene) can be paused. Scenes can be loaded, switched and reloaded. You can also use the SceneTree to organize your nodes into groups: every node can be assigned as many groups as you want to create, e.g. a "enemy" group. You can then iterate these groups or even call methods and set properties on all the group's members at once.
Member Function Description
---------------------------
@@ -207,22 +242,32 @@ Member Function Description
- :ref:`Variant<class_variant>` **call_group** **(** :ref:`String<class_string>` group, :ref:`String<class_string>` method **)** vararg
Calls ``method`` on each member of the given group.
.. _class_SceneTree_call_group_flags:
- :ref:`Variant<class_variant>` **call_group_flags** **(** :ref:`int<class_int>` flags, :ref:`String<class_string>` group, :ref:`String<class_string>` method **)** vararg
Calls ``method`` on each member of the given group, respecting the given enum GROUP_CALL flags.
.. _class_SceneTree_change_scene:
- :ref:`int<class_int>` **change_scene** **(** :ref:`String<class_string>` path **)**
Changes to the scene at the given ``path``.
.. _class_SceneTree_change_scene_to:
- :ref:`int<class_int>` **change_scene_to** **(** :ref:`PackedScene<class_packedscene>` packed_scene **)**
Changes to the given :ref:`PackedScene<class_packedscene>`.
.. _class_SceneTree_create_timer:
- :ref:`SceneTreeTimer<class_scenetreetimer>` **create_timer** **(** :ref:`float<class_float>` time_sec, :ref:`bool<class_bool>` pause_mode_process=true **)**
Returns a :ref:`SceneTreeTimer<class_scenetreetimer>` which will :ref:`SceneTreeTimer.timeout<class_SceneTreeTimer_timeout>` after the given time in seconds elapsed in this SceneTree. If ``pause_mode_process`` is set to false, pausing the SceneTree will also pause the timer.
.. _class_SceneTree_get_frame:
- :ref:`int<class_int>` **get_frame** **(** **)** const
@@ -231,84 +276,120 @@ Member Function Description
- :ref:`PoolIntArray<class_poolintarray>` **get_network_connected_peers** **(** **)** const
Returns the peer IDs of all connected peers of this SceneTree's :ref:`network_peer<class_SceneTree_network_peer>`.
.. _class_SceneTree_get_network_unique_id:
- :ref:`int<class_int>` **get_network_unique_id** **(** **)** const
Returns the unique peer ID of this SceneTree's :ref:`network_peer<class_SceneTree_network_peer>`.
.. _class_SceneTree_get_node_count:
- :ref:`int<class_int>` **get_node_count** **(** **)** const
Returns the number of nodes in this SceneTree.
.. _class_SceneTree_get_nodes_in_group:
- :ref:`Array<class_array>` **get_nodes_in_group** **(** :ref:`String<class_string>` group **)**
Returns all nodes assigned to the given group.
.. _class_SceneTree_get_rpc_sender_id:
- :ref:`int<class_int>` **get_rpc_sender_id** **(** **)** const
Returns the sender's peer ID for the most recently received RPC call.
.. _class_SceneTree_has_group:
- :ref:`bool<class_bool>` **has_group** **(** :ref:`String<class_string>` name **)** const
Returns ``true`` if the given group exists.
.. _class_SceneTree_has_network_peer:
- :ref:`bool<class_bool>` **has_network_peer** **(** **)** const
Returns true if there is a :ref:`NetworkedMultiplayerPeer<class_networkedmultiplayerpeer>` set (with :ref:`SceneTree.set_network_peer<class_SceneTree_set_network_peer>`).
Returns ``true`` if there is a :ref:`network_peer<class_SceneTree_network_peer>` set.
.. _class_SceneTree_is_input_handled:
- :ref:`bool<class_bool>` **is_input_handled** **(** **)**
Returns ``true`` if the most recent InputEvent was marked as handled with :ref:`set_input_as_handled<class_SceneTree_set_input_as_handled>`.
.. _class_SceneTree_is_network_server:
- :ref:`bool<class_bool>` **is_network_server** **(** **)** const
Returns true if this SceneTree's :ref:`NetworkedMultiplayerPeer<class_networkedmultiplayerpeer>` is in server mode (listening for connections).
Returns ``true`` if this SceneTree's :ref:`network_peer<class_SceneTree_network_peer>` is in server mode (listening for connections).
.. _class_SceneTree_notify_group:
- void **notify_group** **(** :ref:`String<class_string>` group, :ref:`int<class_int>` notification **)**
Sends the given notification to all members of the ``group``.
.. _class_SceneTree_notify_group_flags:
- void **notify_group_flags** **(** :ref:`int<class_int>` call_flags, :ref:`String<class_string>` group, :ref:`int<class_int>` notification **)**
Sends the given notification to all members of the ``group``, respecting the given enum GROUP_CALL flags.
.. _class_SceneTree_queue_delete:
- void **queue_delete** **(** :ref:`Object<class_object>` obj **)**
Queues the given object for deletion, delaying the call to :ref:`Object.free<class_Object_free>` to after the current frame.
.. _class_SceneTree_quit:
- void **quit** **(** **)**
Quits the application.
.. _class_SceneTree_reload_current_scene:
- :ref:`int<class_int>` **reload_current_scene** **(** **)**
Reloads the currently active scene.
.. _class_SceneTree_set_auto_accept_quit:
- void **set_auto_accept_quit** **(** :ref:`bool<class_bool>` enabled **)**
If ``true`` the application automatically accepts quitting.
.. _class_SceneTree_set_group:
- void **set_group** **(** :ref:`String<class_string>` group, :ref:`String<class_string>` property, :ref:`Variant<class_variant>` value **)**
Sets the given ``property`` to ``value`` on all members of the given group.
.. _class_SceneTree_set_group_flags:
- void **set_group_flags** **(** :ref:`int<class_int>` call_flags, :ref:`String<class_string>` group, :ref:`String<class_string>` property, :ref:`Variant<class_variant>` value **)**
Sets the given ``property`` to ``value`` on all members of the given group, respecting the given enum GROUP_CALL flags.
.. _class_SceneTree_set_input_as_handled:
- void **set_input_as_handled** **(** **)**
Marks the most recent input event as handled.
.. _class_SceneTree_set_quit_on_go_back:
- void **set_quit_on_go_back** **(** :ref:`bool<class_bool>` enabled **)**
If ``true`` the application quits automatically on going back (e.g. on Android).
.. _class_SceneTree_set_screen_stretch:
- void **set_screen_stretch** **(** :ref:`int<class_int>` mode, :ref:`int<class_int>` aspect, :ref:`Vector2<class_vector2>` minsize, :ref:`float<class_float>` shrink=1 **)**
Configures screen stretching to the given enum StretchMode, enum StretchAspect, minimum size and ``shrink``.

16
classes/class_scrollcontainer.rst
View File

@@ -16,9 +16,25 @@ Brief Description
A helper node for displaying scrollable elements (e.g. lists).
Signals
-------
.. _class_ScrollContainer_scroll_ended:
- **scroll_ended** **(** **)**
.. _class_ScrollContainer_scroll_started:
- **scroll_started** **(** **)**
Member Variables
----------------
.. _class_ScrollContainer_scroll_deadzone:
- :ref:`int<class_int>` **scroll_deadzone**
.. _class_ScrollContainer_scroll_horizontal:
- :ref:`int<class_int>` **scroll_horizontal** - The current horizontal scroll value.

6
classes/class_surfacetool.rst
View File

@@ -56,7 +56,7 @@ Member Functions
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`deindex<class_SurfaceTool_deindex>` **(** **)** |
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`generate_normals<class_SurfaceTool_generate_normals>` **(** **)** |
| void | :ref:`generate_normals<class_SurfaceTool_generate_normals>` **(** :ref:`bool<class_bool>` flip=false **)** |
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`generate_tangents<class_SurfaceTool_generate_tangents>` **(** **)** |
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -189,10 +189,12 @@ Removes index array by expanding Vertex array.
.. _class_SurfaceTool_generate_normals:
- void **generate_normals** **(** **)**
- void **generate_normals** **(** :ref:`bool<class_bool>` flip=false **)**
Generates normals from Vertices so you do not have to do it manually.
Setting "flip" ``true`` inverts resulting normals.
.. _class_SurfaceTool_generate_tangents:
- void **generate_tangents** **(** **)**

16
classes/class_tabcontainer.rst
View File

@@ -36,6 +36,8 @@ Member Functions
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_tab_title<class_TabContainer_get_tab_title>` **(** :ref:`int<class_int>` tab_idx **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_tabs_rearrange_group<class_TabContainer_get_tabs_rearrange_group>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_popup<class_TabContainer_set_popup>` **(** :ref:`Node<class_node>` popup **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_tab_disabled<class_TabContainer_set_tab_disabled>` **(** :ref:`int<class_int>` tab_idx, :ref:`bool<class_bool>` disabled **)** |
@@ -44,6 +46,8 @@ Member Functions
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_tab_title<class_TabContainer_set_tab_title>` **(** :ref:`int<class_int>` tab_idx, :ref:`String<class_string>` title **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_tabs_rearrange_group<class_TabContainer_set_tabs_rearrange_group>` **(** :ref:`int<class_int>` group_id **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
Signals
-------
@@ -74,6 +78,10 @@ Member Variables
- :ref:`int<class_int>` **current_tab** - The current tab index. When set, this index's :ref:`Control<class_control>` node's ``visible`` property is set to ``true`` and all others are set to ``false``.
.. _class_TabContainer_drag_to_rearrange_enabled:
- :ref:`bool<class_bool>` **drag_to_rearrange_enabled**
.. _class_TabContainer_tab_align:
- :ref:`TabAlign<enum_tabcontainer_tabalign>` **tab_align** - The alignment of all tabs in the tab container. See the ``ALIGN_*`` constants for details.
@@ -157,6 +165,10 @@ Returns the :ref:`Texture<class_texture>` for the tab at index ``tab_idx`` or nu
Returns the title of the tab at index ``tab_idx``. Tab titles default to the name of the indexed child node, but this can be overridden with :ref:`set_tab_title<class_TabContainer_set_tab_title>`.
.. _class_TabContainer_get_tabs_rearrange_group:
- :ref:`int<class_int>` **get_tabs_rearrange_group** **(** **)** const
.. _class_TabContainer_set_popup:
- void **set_popup** **(** :ref:`Node<class_node>` popup **)**
@@ -181,4 +193,8 @@ Sets an icon for the tab at index ``tab_idx``.
Sets a title for the tab at index ``tab_idx``. Tab titles default to the name of the indexed child node, but this can be overridden with :ref:`set_tab_title<class_TabContainer_set_tab_title>`.
.. _class_TabContainer_set_tabs_rearrange_group:
- void **set_tabs_rearrange_group** **(** :ref:`int<class_int>` group_id **)**

16
classes/class_tabs.rst
View File

@@ -38,6 +38,8 @@ Member Functions
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_tab_title<class_Tabs_get_tab_title>` **(** :ref:`int<class_int>` tab_idx **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_tabs_rearrange_group<class_Tabs_get_tabs_rearrange_group>` **(** **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`move_tab<class_Tabs_move_tab>` **(** :ref:`int<class_int>` from, :ref:`int<class_int>` to **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_tab<class_Tabs_remove_tab>` **(** :ref:`int<class_int>` tab_idx **)** |
@@ -48,6 +50,8 @@ Member Functions
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_tab_title<class_Tabs_set_tab_title>` **(** :ref:`int<class_int>` tab_idx, :ref:`String<class_string>` title **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_tabs_rearrange_group<class_Tabs_set_tabs_rearrange_group>` **(** :ref:`int<class_int>` group_id **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
Signals
-------
@@ -84,6 +88,10 @@ Member Variables
- :ref:`int<class_int>` **current_tab**
.. _class_Tabs_drag_to_rearrange_enabled:
- :ref:`bool<class_bool>` **drag_to_rearrange_enabled**
.. _class_Tabs_scrolling_enabled:
- :ref:`bool<class_bool>` **scrolling_enabled**
@@ -165,6 +173,10 @@ Returns tab :ref:`Rect2<class_rect2>` with local position and size.
- :ref:`String<class_string>` **get_tab_title** **(** :ref:`int<class_int>` tab_idx **)** const
.. _class_Tabs_get_tabs_rearrange_group:
- :ref:`int<class_int>` **get_tabs_rearrange_group** **(** **)** const
.. _class_Tabs_move_tab:
- void **move_tab** **(** :ref:`int<class_int>` from, :ref:`int<class_int>` to **)**
@@ -187,4 +199,8 @@ Rearrange tab.
- void **set_tab_title** **(** :ref:`int<class_int>` tab_idx, :ref:`String<class_string>` title **)**
.. _class_Tabs_set_tabs_rearrange_group:
- void **set_tabs_rearrange_group** **(** :ref:`int<class_int>` group_id **)**

12
classes/class_textedit.rst
View File

@@ -48,6 +48,8 @@ Member Functions
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`fold_line<class_TextEdit_fold_line>` **(** :ref:`int<class_int>` line **)** |
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`get_keyword_color<class_TextEdit_get_keyword_color>` **(** :ref:`String<class_string>` keyword **)** const |
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_line<class_TextEdit_get_line>` **(** :ref:`int<class_int>` line **)** const |
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_line_count<class_TextEdit_get_line_count>` **(** **)** const |
@@ -66,6 +68,8 @@ Member Functions
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_word_under_cursor<class_TextEdit_get_word_under_cursor>` **(** **)** const |
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_keyword_color<class_TextEdit_has_keyword_color>` **(** :ref:`String<class_string>` keyword **)** const |
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`insert_text_at_cursor<class_TextEdit_insert_text_at_cursor>` **(** :ref:`String<class_string>` text **)** |
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_folded<class_TextEdit_is_folded>` **(** :ref:`int<class_int>` line **)** const |
@@ -305,6 +309,10 @@ Clears the current selection.
- void **fold_line** **(** :ref:`int<class_int>` line **)**
.. _class_TextEdit_get_keyword_color:
- :ref:`Color<class_color>` **get_keyword_color** **(** :ref:`String<class_string>` keyword **)** const
.. _class_TextEdit_get_line:
- :ref:`String<class_string>` **get_line** **(** :ref:`int<class_int>` line **)** const
@@ -355,6 +363,10 @@ Return the selection end line.
- :ref:`String<class_string>` **get_word_under_cursor** **(** **)** const
.. _class_TextEdit_has_keyword_color:
- :ref:`bool<class_bool>` **has_keyword_color** **(** :ref:`String<class_string>` keyword **)** const
.. _class_TextEdit_insert_text_at_cursor:
- void **insert_text_at_cursor** **(** :ref:`String<class_string>` text **)**

12
classes/class_textureprogress.rst
View File

@@ -71,6 +71,18 @@ The ``value`` property comes from :ref:`Range<class_range>`. See :ref:`Range.val
- :ref:`Texture<class_texture>` **texture_under** - :ref:`Texture<class_texture>` that draws under the progress bar. The bar's background.
.. _class_TextureProgress_tint_over:
- :ref:`Color<class_color>` **tint_over**
.. _class_TextureProgress_tint_progress:
- :ref:`Color<class_color>` **tint_progress**
.. _class_TextureProgress_tint_under:
- :ref:`Color<class_color>` **tint_under**
Enums
-----

20
classes/class_tileset.rst
View File

@@ -72,6 +72,8 @@ Member Functions
+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`tile_get_texture_offset<class_TileSet_tile_get_texture_offset>` **(** :ref:`int<class_int>` id **)** const |
+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`tile_get_tile_mode<class_TileSet_tile_get_tile_mode>` **(** :ref:`int<class_int>` id **)** const |
+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`tile_set_light_occluder<class_TileSet_tile_set_light_occluder>` **(** :ref:`int<class_int>` id, :ref:`OccluderPolygon2D<class_occluderpolygon2d>` light_occluder **)** |
+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`tile_set_material<class_TileSet_tile_set_material>` **(** :ref:`int<class_int>` id, :ref:`ShaderMaterial<class_shadermaterial>` material **)** |
@@ -100,6 +102,8 @@ Member Functions
+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`tile_set_texture_offset<class_TileSet_tile_set_texture_offset>` **(** :ref:`int<class_int>` id, :ref:`Vector2<class_vector2>` texture_offset **)** |
+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`tile_set_tile_mode<class_TileSet_tile_set_tile_mode>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` tilemode **)** |
+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Enums
-----
@@ -111,6 +115,14 @@ enum **BitmaskMode**
- **BITMASK_2X2** = **0**
- **BITMASK_3X3** = **1**
.. _enum_TileSet_TileMode:
enum **TileMode**
- **SINGLE_TILE** = **0**
- **AUTO_TILE** = **1**
- **ANIMATED_TILE** = **2**
.. _enum_TileSet_AutotileBindings:
enum **AutotileBindings**
@@ -271,6 +283,10 @@ Return the texture of the tile.
Return the texture offset of the tile.
.. _class_TileSet_tile_get_tile_mode:
- :ref:`int<class_int>` **tile_get_tile_mode** **(** :ref:`int<class_int>` id **)** const
.. _class_TileSet_tile_set_light_occluder:
- void **tile_set_light_occluder** **(** :ref:`int<class_int>` id, :ref:`OccluderPolygon2D<class_occluderpolygon2d>` light_occluder **)**
@@ -347,4 +363,8 @@ Set the texture of the tile.
Set the texture offset of the tile.
.. _class_TileSet_tile_set_tile_mode:
- void **tile_set_tile_mode** **(** :ref:`int<class_int>` id, :ref:`int<class_int>` tilemode **)**

4
classes/class_vector2.rst
View File

@@ -34,7 +34,7 @@ Member Functions
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`clamped<class_Vector2_clamped>` **(** :ref:`float<class_float>` length **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`cross<class_Vector2_cross>` **(** :ref:`Vector2<class_vector2>` b **)** |
| :ref:`float<class_float>` | :ref:`cross<class_Vector2_cross>` **(** :ref:`Vector2<class_vector2>` with **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`cubic_interpolate<class_Vector2_cubic_interpolate>` **(** :ref:`Vector2<class_vector2>` b, :ref:`Vector2<class_vector2>` pre_a, :ref:`Vector2<class_vector2>` post_b, :ref:`float<class_float>` t **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -139,7 +139,7 @@ Returns the vector with a maximum length.
.. _class_Vector2_cross:
- :ref:`float<class_float>` **cross** **(** :ref:`Vector2<class_vector2>` b **)**
- :ref:`float<class_float>` **cross** **(** :ref:`Vector2<class_vector2>` with **)**
Returns the 2-dimensional analog of the cross product with ``b``.

12
classes/class_vehiclewheel.rst
View File

@@ -34,19 +34,19 @@ Member Variables
.. _class_VehicleWheel_damping_relaxation:
- :ref:`float<class_float>` **damping_relaxation** - The damping applied to the spring when relaxing. This value should be between 0.0 (no damping) and 1.0. This value should always be slighly higher then the :ref:`damping_compression<class_VehicleWheel_damping_compression>` property. For a :ref:`damping_compression<class_VehicleWheel_damping_compression>` value of 0.3, try a relaxation value of 0.5
- :ref:`float<class_float>` **damping_relaxation** - The damping applied to the spring when relaxing. This value should be between 0.0 (no damping) and 1.0. This value should always be slightly higher than the :ref:`damping_compression<class_VehicleWheel_damping_compression>` property. For a :ref:`damping_compression<class_VehicleWheel_damping_compression>` value of 0.3, try a relaxation value of 0.5
.. _class_VehicleWheel_suspension_max_force:
- :ref:`float<class_float>` **suspension_max_force** - The maximum force the spring can resist. This value should be higher then a quarter of the :ref:`RigidBody.mass<class_RigidBody_mass>` of the :ref:`VehicleBody<class_vehiclebody>` or the spring will not carry the weight of the vehicle. Good results are often obtained by a value that is about 3x to 4x this number.
- :ref:`float<class_float>` **suspension_max_force** - The maximum force the spring can resist. This value should be higher than a quarter of the :ref:`RigidBody.mass<class_RigidBody_mass>` of the :ref:`VehicleBody<class_vehiclebody>` or the spring will not carry the weight of the vehicle. Good results are often obtained by a value that is about 3x to 4x this number.
.. _class_VehicleWheel_suspension_stiffness:
- :ref:`float<class_float>` **suspension_stiffness** - This value defines the stiffness of the suspension. Use a value lower then 50 for an offroad car, a value between 50 and 100 for a race car and try something around 200 for something like a Formula 1 car.
- :ref:`float<class_float>` **suspension_stiffness** - This value defines the stiffness of the suspension. Use a value lower than 50 for an off-road car, a value between 50 and 100 for a race car and try something around 200 for something like a Formula 1 car.
.. _class_VehicleWheel_suspension_travel:
- :ref:`float<class_float>` **suspension_travel** - This is the distance the suspension can travel. As Godots measures are in meters keep this setting relatively low. Try a value between 0.1 and 0.3 depending on the type of car .
- :ref:`float<class_float>` **suspension_travel** - This is the distance the suspension can travel. As Godot measures are in meters keep this setting relatively low. Try a value between 0.1 and 0.3 depending on the type of car .
.. _class_VehicleWheel_use_as_steering:
@@ -58,7 +58,7 @@ Member Variables
.. _class_VehicleWheel_wheel_friction_slip:
- :ref:`float<class_float>` **wheel_friction_slip** - This determines how much grip this wheel has. It is combined with the friction setting of the surface the wheel is in contact with. 0.0 means no grip, 1.0 is normal grip. For a drift car setup, try setting the grip of the rear wheels slightly lower then the front wheels, or use a lower value to simulate tire wear.
- :ref:`float<class_float>` **wheel_friction_slip** - This determines how much grip this wheel has. It is combined with the friction setting of the surface the wheel is in contact with. 0.0 means no grip, 1.0 is normal grip. For a drift car setup, try setting the grip of the rear wheels slightly lower than the front wheels, or use a lower value to simulate tire wear.
It's best to set this to 1.0 when starting out.
@@ -68,7 +68,7 @@ It's best to set this to 1.0 when starting out.
.. _class_VehicleWheel_wheel_rest_length:
- :ref:`float<class_float>` **wheel_rest_length** - This is the distance in meters the wheel is lowered from its origin point. Don't set this to 0.0 and move the wheel into position, instead move the origin point of your wheel (the gizmo in Godot) to the position the wheel will take when bottoming out, then use the rest lenght to move the wheel down to the position it should be in when the car is in rest.
- :ref:`float<class_float>` **wheel_rest_length** - This is the distance in meters the wheel is lowered from its origin point. Don't set this to 0.0 and move the wheel into position, instead move the origin point of your wheel (the gizmo in Godot) to the position the wheel will take when bottoming out, then use the rest length to move the wheel down to the position it should be in when the car is in rest.
.. _class_VehicleWheel_wheel_roll_influence:

8
classes/class_videoplayer.rst
View File

@@ -31,6 +31,14 @@ Member Functions
| void | :ref:`stop<class_VideoPlayer_stop>` **(** **)** |
+--------------------------------+-----------------------------------------------------------------------------+
Signals
-------
.. _class_VideoPlayer_finished:
- **finished** **(** **)**
Member Variables
----------------

8
classes/class_websocketclient.rst
View File

@@ -45,6 +45,14 @@ Signals
- **data_received** **(** **)**
Member Variables
----------------
.. _class_WebSocketClient_verify_ssl:
- :ref:`bool<class_bool>` **verify_ssl**
Member Function Description
---------------------------