From cedcbd1c5c61026376b57be6499003ea3b22aece Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Tue, 28 May 2019 18:41:24 +0200 Subject: [PATCH] Sync classref with current source --- classes/class_@globalscope.rst | 92 +++-- classes/class_acceptdialog.rst | 4 +- classes/class_animatedsprite.rst | 2 +- classes/class_animatedsprite3d.rst | 2 +- classes/class_animation.rst | 38 +- classes/class_animationnode.rst | 6 +- classes/class_animationnodestatemachine.rst | 52 ++- ...lass_animationnodestatemachineplayback.rst | 22 +- classes/class_animationtreeplayer.rst | 4 +- classes/class_area2d.rst | 4 +- classes/class_arraymesh.rst | 10 +- classes/class_basebutton.rst | 4 +- classes/class_basis.rst | 12 +- classes/class_camera.rst | 8 + classes/class_camera2d.rst | 2 +- classes/class_canvasitem.rst | 4 +- classes/class_classdb.rst | 6 +- classes/class_color.rst | 4 + classes/class_colorpicker.rst | 2 +- classes/class_concavepolygonshape.rst | 2 +- classes/class_confirmationdialog.rst | 2 +- classes/class_control.rst | 2 +- classes/class_dictionary.rst | 14 +- classes/class_directory.rst | 16 +- classes/class_editorexportplugin.rst | 6 + classes/class_editorfilesystem.rst | 4 +- classes/class_editorinspectorplugin.rst | 2 +- .../class_editornavigationmeshgenerator.rst | 38 ++ classes/class_editorplugin.rst | 4 +- .../class_editorresourcepreviewgenerator.rst | 22 +- classes/class_editorspatialgizmo.rst | 2 +- classes/class_filedialog.rst | 2 +- classes/class_font.rst | 8 +- classes/class_geometry.rst | 265 +++++++++--- classes/class_graphedit.rst | 4 +- classes/class_graphnode.rst | 28 +- classes/class_imagetexture.rst | 2 +- classes/class_input.rst | 2 +- classes/class_itemlist.rst | 6 +- classes/class_marshalls.rst | 12 +- classes/class_menubutton.rst | 2 +- classes/class_mesh.rst | 4 +- classes/class_meshlibrary.rst | 6 +- classes/class_multimesh.rst | 8 +- classes/class_navigationmesh.rst | 78 +++- classes/class_nodepath.rst | 4 +- classes/class_object.rst | 2 +- classes/class_optionbutton.rst | 12 +- classes/class_os.rst | 384 +++++++++--------- classes/class_packetpeer.rst | 6 +- classes/class_packetpeerudp.rst | 6 +- classes/class_poolbytearray.rst | 4 +- classes/class_poolcolorarray.rst | 2 +- classes/class_poolintarray.rst | 2 +- classes/class_poolrealarray.rst | 2 +- classes/class_poolstringarray.rst | 2 +- classes/class_poolvector2array.rst | 2 +- classes/class_poolvector3array.rst | 2 +- classes/class_popup.rst | 26 +- classes/class_popupmenu.rst | 24 +- classes/class_projectsettings.rst | 12 + classes/class_quat.rst | 2 +- classes/class_raycast.rst | 4 +- classes/class_raycast2d.rst | 6 +- classes/class_reference.rst | 2 +- classes/class_resourceinteractiveloader.rst | 6 +- classes/class_resourceloader.rst | 2 +- classes/class_rigidbody.rst | 2 +- classes/class_scenetree.rst | 4 + classes/class_shape2d.rst | 2 +- classes/class_skeleton.rst | 20 +- classes/class_spatialmaterial.rst | 18 +- classes/class_sprite.rst | 11 +- classes/class_streampeer.rst | 6 +- classes/class_streampeerssl.rst | 2 +- classes/class_streampeertcp.rst | 6 +- classes/class_stylebox.rst | 6 +- classes/class_surfacetool.rst | 12 + classes/class_tcp_server.rst | 2 +- classes/class_textedit.rst | 22 +- classes/class_texture.rst | 6 +- classes/class_theme.rst | 5 + classes/class_tree.rst | 4 + classes/class_vehiclewheel.rst | 6 + classes/class_viewport.rst | 14 + classes/class_visualserver.rst | 20 +- classes/class_visualshader.rst | 12 + classes/class_visualshadernode.rst | 2 +- classes/class_visualshadernodeexpression.rst | 52 +++ classes/class_visualshadernodegroupbase.rst | 172 ++++++++ classes/class_webrtcdatachannel.rst | 149 +++++++ classes/class_webrtcdatachannelgdnative.rst | 18 + classes/class_webrtcpeer.rst | 144 ------- classes/class_webrtcpeerconnection.rst | 128 ++++++ .../class_webrtcpeerconnectiongdnative.rst | 18 + classes/class_webrtcpeergdnative.rst | 18 - classes/class_windowdialog.rst | 2 +- 97 files changed, 1548 insertions(+), 668 deletions(-) create mode 100644 classes/class_editornavigationmeshgenerator.rst create mode 100644 classes/class_visualshadernodeexpression.rst create mode 100644 classes/class_visualshadernodegroupbase.rst create mode 100644 classes/class_webrtcdatachannel.rst create mode 100644 classes/class_webrtcdatachannelgdnative.rst delete mode 100644 classes/class_webrtcpeer.rst create mode 100644 classes/class_webrtcpeerconnection.rst create mode 100644 classes/class_webrtcpeerconnectiongdnative.rst delete mode 100644 classes/class_webrtcpeergdnative.rst diff --git a/classes/class_@globalscope.rst b/classes/class_@globalscope.rst index b5ef84b8a..c725380bc 100644 --- a/classes/class_@globalscope.rst +++ b/classes/class_@globalscope.rst @@ -17,49 +17,51 @@ Global scope constants and variables. Properties ---------- -+-----------------------------------------------------+---------------------------------------------------------------------------+ -| :ref:`ARVRServer` | :ref:`ARVRServer` | -+-----------------------------------------------------+---------------------------------------------------------------------------+ -| :ref:`AudioServer` | :ref:`AudioServer` | -+-----------------------------------------------------+---------------------------------------------------------------------------+ -| :ref:`ClassDB` | :ref:`ClassDB` | -+-----------------------------------------------------+---------------------------------------------------------------------------+ -| :ref:`Engine` | :ref:`Engine` | -+-----------------------------------------------------+---------------------------------------------------------------------------+ -| :ref:`Geometry` | :ref:`Geometry` | -+-----------------------------------------------------+---------------------------------------------------------------------------+ -| :ref:`IP` | :ref:`IP` | -+-----------------------------------------------------+---------------------------------------------------------------------------+ -| :ref:`Input` | :ref:`Input` | -+-----------------------------------------------------+---------------------------------------------------------------------------+ -| :ref:`InputMap` | :ref:`InputMap` | -+-----------------------------------------------------+---------------------------------------------------------------------------+ -| :ref:`JSON` | :ref:`JSON` | -+-----------------------------------------------------+---------------------------------------------------------------------------+ -| :ref:`JavaScript` | :ref:`JavaScript` | -+-----------------------------------------------------+---------------------------------------------------------------------------+ -| :ref:`Reference` | :ref:`Marshalls` | -+-----------------------------------------------------+---------------------------------------------------------------------------+ -| :ref:`OS` | :ref:`OS` | -+-----------------------------------------------------+---------------------------------------------------------------------------+ -| :ref:`Performance` | :ref:`Performance` | -+-----------------------------------------------------+---------------------------------------------------------------------------+ -| :ref:`Physics2DServer` | :ref:`Physics2DServer` | -+-----------------------------------------------------+---------------------------------------------------------------------------+ -| :ref:`PhysicsServer` | :ref:`PhysicsServer` | -+-----------------------------------------------------+---------------------------------------------------------------------------+ -| :ref:`ProjectSettings` | :ref:`ProjectSettings` | -+-----------------------------------------------------+---------------------------------------------------------------------------+ -| :ref:`ResourceLoader` | :ref:`ResourceLoader` | -+-----------------------------------------------------+---------------------------------------------------------------------------+ -| :ref:`ResourceSaver` | :ref:`ResourceSaver` | -+-----------------------------------------------------+---------------------------------------------------------------------------+ -| :ref:`TranslationServer` | :ref:`TranslationServer` | -+-----------------------------------------------------+---------------------------------------------------------------------------+ -| :ref:`VisualScriptEditor` | :ref:`VisualScriptEditor` | -+-----------------------------------------------------+---------------------------------------------------------------------------+ -| :ref:`VisualServer` | :ref:`VisualServer` | -+-----------------------------------------------------+---------------------------------------------------------------------------+ ++---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`ARVRServer` | :ref:`ARVRServer` | ++---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`AudioServer` | :ref:`AudioServer` | ++---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`ClassDB` | :ref:`ClassDB` | ++---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`Engine` | :ref:`Engine` | ++---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`Geometry` | :ref:`Geometry` | ++---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`IP` | :ref:`IP` | ++---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`Input` | :ref:`Input` | ++---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`InputMap` | :ref:`InputMap` | ++---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`JSON` | :ref:`JSON` | ++---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`JavaScript` | :ref:`JavaScript` | ++---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`Reference` | :ref:`Marshalls` | ++---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`EditorNavigationMeshGenerator` | :ref:`NavigationMeshGenerator` | ++---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`OS` | :ref:`OS` | ++---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`Performance` | :ref:`Performance` | ++---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`Physics2DServer` | :ref:`Physics2DServer` | ++---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`PhysicsServer` | :ref:`PhysicsServer` | ++---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`ProjectSettings` | :ref:`ProjectSettings` | ++---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`ResourceLoader` | :ref:`ResourceLoader` | ++---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`ResourceSaver` | :ref:`ResourceSaver` | ++---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`TranslationServer` | :ref:`TranslationServer` | ++---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`VisualScriptEditor` | :ref:`VisualScriptEditor` | ++---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`VisualServer` | :ref:`VisualServer` | ++---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ Enumerations ------------ @@ -2155,6 +2157,10 @@ Property Descriptions :ref:`Marshalls` singleton +.. _class_@GlobalScope_property_NavigationMeshGenerator: + +- :ref:`EditorNavigationMeshGenerator` **NavigationMeshGenerator** + .. _class_@GlobalScope_property_OS: - :ref:`OS` **OS** diff --git a/classes/class_acceptdialog.rst b/classes/class_acceptdialog.rst index 60d599e73..64038b0be 100644 --- a/classes/class_acceptdialog.rst +++ b/classes/class_acceptdialog.rst @@ -112,13 +112,13 @@ Adds a button with label *name* and a cancel action to the dialog and returns th - :ref:`Label` **get_label** **(** **)** -Return the label used for built-in text. +Returns the label used for built-in text. .. _class_AcceptDialog_method_get_ok: - :ref:`Button` **get_ok** **(** **)** -Return the OK Button. +Returns the OK Button. .. _class_AcceptDialog_method_register_text_enter: diff --git a/classes/class_animatedsprite.rst b/classes/class_animatedsprite.rst index 92a07cce2..1050cb297 100644 --- a/classes/class_animatedsprite.rst +++ b/classes/class_animatedsprite.rst @@ -182,7 +182,7 @@ Method Descriptions - :ref:`bool` **is_playing** **(** **)** const -Return ``true`` if an animation if currently being played. +Returns ``true`` if an animation if currently being played. .. _class_AnimatedSprite_method_play: diff --git a/classes/class_animatedsprite3d.rst b/classes/class_animatedsprite3d.rst index e74778758..704b02509 100644 --- a/classes/class_animatedsprite3d.rst +++ b/classes/class_animatedsprite3d.rst @@ -106,7 +106,7 @@ Method Descriptions - :ref:`bool` **is_playing** **(** **)** const -Return ``true`` if an animation if currently being played. +Returns ``true`` if an animation if currently being played. .. _class_AnimatedSprite3D_method_play: diff --git a/classes/class_animation.rst b/classes/class_animation.rst index b279265e3..81e6a6668 100644 --- a/classes/class_animation.rst +++ b/classes/class_animation.rst @@ -111,6 +111,8 @@ Methods +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`track_move_down` **(** :ref:`int` idx **)** | +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`track_move_to` **(** :ref:`int` idx, :ref:`int` to_idx **)** | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`track_move_up` **(** :ref:`int` idx **)** | +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`track_remove_key` **(** :ref:`int` idx, :ref:`int` key_idx **)** | @@ -376,31 +378,31 @@ Adds a new track that is a copy of the given track from ``to_animation``. - :ref:`int` **find_track** **(** :ref:`NodePath` path **)** const -Return the index of the specified track. If the track is not found, return -1. +Returns the index of the specified track. If the track is not found, return -1. .. _class_Animation_method_get_track_count: - :ref:`int` **get_track_count** **(** **)** const -Return the amount of tracks in the animation. +Returns the amount of tracks in the animation. .. _class_Animation_method_method_track_get_key_indices: - :ref:`PoolIntArray` **method_track_get_key_indices** **(** :ref:`int` idx, :ref:`float` time_sec, :ref:`float` delta **)** const -Return all the key indices of a method track, given a position and delta time. +Returns all the key indices of a method track, given a position and delta time. .. _class_Animation_method_method_track_get_name: - :ref:`String` **method_track_get_name** **(** :ref:`int` idx, :ref:`int` key_idx **)** const -Return the method name of a method track. +Returns the method name of a method track. .. _class_Animation_method_method_track_get_params: - :ref:`Array` **method_track_get_params** **(** :ref:`int` idx, :ref:`int` key_idx **)** const -Return the arguments values to be called on a method track for a given key in a given track. +Returns the arguments values to be called on a method track for a given key in a given track. .. _class_Animation_method_remove_track: @@ -424,31 +426,31 @@ Returns ``true`` if the track at ``idx`` wraps the interpolation loop. Default v - :ref:`InterpolationType` **track_get_interpolation_type** **(** :ref:`int` idx **)** const -Return the interpolation type of a given track, from the INTERPOLATION\_\* enum. +Returns the interpolation type of a given track, from the INTERPOLATION\_\* enum. .. _class_Animation_method_track_get_key_count: - :ref:`int` **track_get_key_count** **(** :ref:`int` idx **)** const -Return the amount of keys in a given track. +Returns the amount of keys in a given track. .. _class_Animation_method_track_get_key_time: - :ref:`float` **track_get_key_time** **(** :ref:`int` idx, :ref:`int` key_idx **)** const -Return the time at which the key is located. +Returns the time at which the key is located. .. _class_Animation_method_track_get_key_transition: - :ref:`float` **track_get_key_transition** **(** :ref:`int` idx, :ref:`int` key_idx **)** const -Return the transition curve (easing) for a specific key (see built-in math function "ease"). +Returns the transition curve (easing) for a specific key (see built-in math function "ease"). .. _class_Animation_method_track_get_key_value: - :ref:`Variant` **track_get_key_value** **(** :ref:`int` idx, :ref:`int` key_idx **)** const -Return the value of a given key in a given track. +Returns the value of a given key in a given track. .. _class_Animation_method_track_get_path: @@ -478,7 +480,7 @@ Returns ``true`` if the track at index ``idx`` is enabled. - :ref:`bool` **track_is_imported** **(** :ref:`int` idx **)** const -Return ``true`` if the given track is imported. Else, return ``false``. +Returns ``true`` if the given track is imported. Else, return ``false``. .. _class_Animation_method_track_move_down: @@ -486,6 +488,12 @@ Return ``true`` if the given track is imported. Else, return ``false``. Move a track down. +.. _class_Animation_method_track_move_to: + +- void **track_move_to** **(** :ref:`int` idx, :ref:`int` to_idx **)** + +Changes the index position of track ``idx`` to the one defined in ``to_idx``. + .. _class_Animation_method_track_move_up: - void **track_move_up** **(** :ref:`int` idx **)** @@ -552,6 +560,8 @@ Set the path of a track. Paths must be valid scene-tree paths to a node, and mus - void **track_swap** **(** :ref:`int` idx, :ref:`int` with_idx **)** +Swaps the track ``idx``'s index position with the track ``with_idx``. + .. _class_Animation_method_transform_track_insert_key: - :ref:`int` **transform_track_insert_key** **(** :ref:`int` idx, :ref:`float` time, :ref:`Vector3` location, :ref:`Quat` rotation, :ref:`Vector3` scale **)** @@ -562,19 +572,19 @@ Insert a transform key for a transform track. - :ref:`Array` **transform_track_interpolate** **(** :ref:`int` idx, :ref:`float` time_sec **)** const -Return the interpolated value of a transform track at a given time (in seconds). An array consisting of 3 elements: position (:ref:`Vector3`), rotation (:ref:`Quat`) and scale (:ref:`Vector3`). +Returns the interpolated value of a transform track at a given time (in seconds). An array consisting of 3 elements: position (:ref:`Vector3`), rotation (:ref:`Quat`) and scale (:ref:`Vector3`). .. _class_Animation_method_value_track_get_key_indices: - :ref:`PoolIntArray` **value_track_get_key_indices** **(** :ref:`int` idx, :ref:`float` time_sec, :ref:`float` delta **)** const -Return all the key indices of a value track, given a position and delta time. +Returns all the key indices of a value track, given a position and delta time. .. _class_Animation_method_value_track_get_update_mode: - :ref:`UpdateMode` **value_track_get_update_mode** **(** :ref:`int` idx **)** const -Return the update mode of a value track. +Returns the update mode of a value track. .. _class_Animation_method_value_track_set_update_mode: diff --git a/classes/class_animationnode.rst b/classes/class_animationnode.rst index b9facd0a2..b81d29766 100644 --- a/classes/class_animationnode.rst +++ b/classes/class_animationnode.rst @@ -122,7 +122,7 @@ Property Descriptions | *Getter* | is_filter_enabled() | +----------+---------------------------+ -Return whether filtering is enabled. +Returns whether filtering is enabled. Method Descriptions ------------------- @@ -203,13 +203,13 @@ Get the property information for parameter. Parameters are custom local memory u - :ref:`String` **has_filter** **(** **)** virtual -Return ``true`` whether you want the blend tree editor to display filter editing on this node. +Returns ``true`` whether you want the blend tree editor to display filter editing on this node. .. _class_AnimationNode_method_is_path_filtered: - :ref:`bool` **is_path_filtered** **(** :ref:`NodePath` path **)** const -Return ``true`` whether a given path is filtered. +Returns ``true`` whether a given path is filtered. .. _class_AnimationNode_method_process: diff --git a/classes/class_animationnodestatemachine.rst b/classes/class_animationnodestatemachine.rst index 905a0e5a9..8d7fd8f85 100644 --- a/classes/class_animationnodestatemachine.rst +++ b/classes/class_animationnodestatemachine.rst @@ -14,7 +14,7 @@ AnimationNodeStateMachine Brief Description ----------------- - +State machine for control of animations. Methods ------- @@ -68,12 +68,12 @@ Methods Description ----------- -Contains multiple root nodes as children in a graph. Each node is used as a state, and provides multiple functions to alternate between states. Retrieve the AnimationNodeStateMachinePlayback object from the :ref:`AnimationTree` node to control it programmatically. +Contains multiple nodes representing animation states, connected in a graph. Nodes transitions can be configured to happen automatically or via code, using a shortest-path algorithm. Retrieve the AnimationNodeStateMachinePlayback object from the :ref:`AnimationTree` node to control it programatically. Example: :: - var state_machine = anim_tree["parameters/StateMachine/playback"] - state_machine.travel("SomeState") + var state_machine = $AnimationTree.get("parameters/playback") + state_machine.travel("some_state") Method Descriptions ------------------- @@ -82,87 +82,131 @@ Method Descriptions - void **add_node** **(** :ref:`String` name, :ref:`AnimationNode` node, :ref:`Vector2` position=Vector2( 0, 0 ) **)** +Adds a new node to the graph. The ``position`` is used for display in the editor. + .. _class_AnimationNodeStateMachine_method_add_transition: - void **add_transition** **(** :ref:`String` from, :ref:`String` to, :ref:`AnimationNodeStateMachineTransition` transition **)** +Adds a transition between the given nodes. + .. _class_AnimationNodeStateMachine_method_get_end_node: - :ref:`String` **get_end_node** **(** **)** const +Returns the graph's end node. + .. _class_AnimationNodeStateMachine_method_get_graph_offset: - :ref:`Vector2` **get_graph_offset** **(** **)** const +Returns the draw offset of the graph. Used for display in the editor. + .. _class_AnimationNodeStateMachine_method_get_node: - :ref:`AnimationNode` **get_node** **(** :ref:`String` name **)** const +Returns the animation node with the given name. + .. _class_AnimationNodeStateMachine_method_get_node_name: - :ref:`String` **get_node_name** **(** :ref:`AnimationNode` node **)** const +Returns the given animation node's name. + .. _class_AnimationNodeStateMachine_method_get_node_position: - :ref:`Vector2` **get_node_position** **(** :ref:`String` name **)** const +Returns the given node's coordinates. Used for display in the editor. + .. _class_AnimationNodeStateMachine_method_get_start_node: - :ref:`String` **get_start_node** **(** **)** const +Returns the graph's end node. + .. _class_AnimationNodeStateMachine_method_get_transition: - :ref:`AnimationNodeStateMachineTransition` **get_transition** **(** :ref:`int` idx **)** const +Returns the given transition. + .. _class_AnimationNodeStateMachine_method_get_transition_count: - :ref:`int` **get_transition_count** **(** **)** const +Returns the number of connections in the graph. + .. _class_AnimationNodeStateMachine_method_get_transition_from: - :ref:`String` **get_transition_from** **(** :ref:`int` idx **)** const +Returns the given transition's start node. + .. _class_AnimationNodeStateMachine_method_get_transition_to: - :ref:`String` **get_transition_to** **(** :ref:`int` idx **)** const +Returns the given transition's end node. + .. _class_AnimationNodeStateMachine_method_has_node: - :ref:`bool` **has_node** **(** :ref:`String` name **)** const +Returns ``true`` if the graph contains the given node. + .. _class_AnimationNodeStateMachine_method_has_transition: - :ref:`bool` **has_transition** **(** :ref:`String` from, :ref:`String` to **)** const +Returns ``true`` if there is a transition between the given nodes. + .. _class_AnimationNodeStateMachine_method_remove_node: - void **remove_node** **(** :ref:`String` name **)** +Deletes the given node from the graph. + .. _class_AnimationNodeStateMachine_method_remove_transition: - void **remove_transition** **(** :ref:`String` from, :ref:`String` to **)** +Deletes the given transition. + .. _class_AnimationNodeStateMachine_method_remove_transition_by_index: - void **remove_transition_by_index** **(** :ref:`int` idx **)** +Deletes the given transition. + .. _class_AnimationNodeStateMachine_method_rename_node: - void **rename_node** **(** :ref:`String` name, :ref:`String` new_name **)** +Renames the given node. + .. _class_AnimationNodeStateMachine_method_set_end_node: - void **set_end_node** **(** :ref:`String` name **)** +Sets the given node as the graph end point. + .. _class_AnimationNodeStateMachine_method_set_graph_offset: - void **set_graph_offset** **(** :ref:`Vector2` offset **)** +Sets the draw offset of the graph. Used for display in the editor. + .. _class_AnimationNodeStateMachine_method_set_node_position: - void **set_node_position** **(** :ref:`String` name, :ref:`Vector2` position **)** +Sets the node's coordinates. Used for display in the editor. + .. _class_AnimationNodeStateMachine_method_set_start_node: - void **set_start_node** **(** :ref:`String` name **)** +Sets the given node as the graph start point. + diff --git a/classes/class_animationnodestatemachineplayback.rst b/classes/class_animationnodestatemachineplayback.rst index 20baa1263..95bde2a7d 100644 --- a/classes/class_animationnodestatemachineplayback.rst +++ b/classes/class_animationnodestatemachineplayback.rst @@ -14,7 +14,7 @@ AnimationNodeStateMachinePlayback Brief Description ----------------- - +Playback control for AnimationNodeStateMachine. Methods ------- @@ -33,6 +33,16 @@ Methods | void | :ref:`travel` **(** :ref:`String` to_node **)** | +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ +Description +----------- + +Allows control of :ref:`AnimationTree` state machines created with :ref:`AnimationNodeStateMachine`. Retrieve with ``$AnimationTree.get("parameters/playback")``. Example: + +:: + + var state_machine = $AnimationTree.get("parameters/playback") + state_machine.travel("some_state") + Method Descriptions ------------------- @@ -40,6 +50,8 @@ Method Descriptions - :ref:`String` **get_current_node** **(** **)** const +Returns the currently playing animation state. + .. _class_AnimationNodeStateMachinePlayback_method_get_travel_path: - :ref:`PoolStringArray` **get_travel_path** **(** **)** const @@ -48,17 +60,23 @@ Method Descriptions - :ref:`bool` **is_playing** **(** **)** const +Returns ``true`` if an animation is playing. + .. _class_AnimationNodeStateMachinePlayback_method_start: - void **start** **(** :ref:`String` node **)** +Starts playing the given animation. + .. _class_AnimationNodeStateMachinePlayback_method_stop: - void **stop** **(** **)** +Stops the currently playing animation. + .. _class_AnimationNodeStateMachinePlayback_method_travel: - void **travel** **(** :ref:`String` to_node **)** -Transition from the current state to another one, while visiting all the intermediate ones. This is done via the A\* algorithm. +Transitions from the current state to another one, following the shortest path. diff --git a/classes/class_animationtreeplayer.rst b/classes/class_animationtreeplayer.rst index 7dd8139ca..09c45e5c7 100644 --- a/classes/class_animationtreeplayer.rst +++ b/classes/class_animationtreeplayer.rst @@ -432,13 +432,13 @@ Check if a node exists (by name). - :ref:`int` **node_get_input_count** **(** :ref:`String` id **)** const -Return the input count for a given node. Different types of nodes have different amount of inputs. +Returns the input count for a given node. Different types of nodes have different amount of inputs. .. _class_AnimationTreePlayer_method_node_get_input_source: - :ref:`String` **node_get_input_source** **(** :ref:`String` id, :ref:`int` idx **)** const -Return the input source for a given node input. +Returns the input source for a given node input. .. _class_AnimationTreePlayer_method_node_get_position: diff --git a/classes/class_area2d.rst b/classes/class_area2d.rst index 42f92aa9d..6c01634cc 100644 --- a/classes/class_area2d.rst +++ b/classes/class_area2d.rst @@ -331,13 +331,13 @@ Method Descriptions - :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** const -Return an individual bit on the layer mask. Describes whether other areas will collide with this one on the given layer. +Returns an individual bit on the layer mask. Describes whether other areas will collide with this one on the given layer. .. _class_Area2D_method_get_collision_mask_bit: - :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const -Return an individual bit on the collision mask. Describes whether this area will collide with others on the given layer. +Returns an individual bit on the collision mask. Describes whether this area will collide with others on the given layer. .. _class_Area2D_method_get_overlapping_areas: diff --git a/classes/class_arraymesh.rst b/classes/class_arraymesh.rst index 9a49d1d9d..c915f59d9 100644 --- a/classes/class_arraymesh.rst +++ b/classes/class_arraymesh.rst @@ -267,25 +267,25 @@ Will regenerate normal maps for the ``ArrayMesh``. - :ref:`int` **surface_find_by_name** **(** :ref:`String` name **)** const -Return the index of the first surface with this name held within this ``ArrayMesh``. If none are found -1 is returned. +Returns the index of the first surface with this name held within this ``ArrayMesh``. If none are found -1 is returned. .. _class_ArrayMesh_method_surface_get_array_index_len: - :ref:`int` **surface_get_array_index_len** **(** :ref:`int` surf_idx **)** const -Return the length in indices of the index array in the requested surface (see :ref:`add_surface_from_arrays`). +Returns the length in indices of the index array in the requested surface (see :ref:`add_surface_from_arrays`). .. _class_ArrayMesh_method_surface_get_array_len: - :ref:`int` **surface_get_array_len** **(** :ref:`int` surf_idx **)** const -Return the length in vertices of the vertex array in the requested surface (see :ref:`add_surface_from_arrays`). +Returns the length in vertices of the vertex array in the requested surface (see :ref:`add_surface_from_arrays`). .. _class_ArrayMesh_method_surface_get_format: - :ref:`int` **surface_get_format** **(** :ref:`int` surf_idx **)** const -Return the format mask of the requested surface (see :ref:`add_surface_from_arrays`). +Returns the format mask of the requested surface (see :ref:`add_surface_from_arrays`). .. _class_ArrayMesh_method_surface_get_name: @@ -297,7 +297,7 @@ Get the name assigned to this surface. - :ref:`PrimitiveType` **surface_get_primitive_type** **(** :ref:`int` surf_idx **)** const -Return the primitive type of the requested surface (see :ref:`add_surface_from_arrays`). +Returns the primitive type of the requested surface (see :ref:`add_surface_from_arrays`). .. _class_ArrayMesh_method_surface_remove: diff --git a/classes/class_basebutton.rst b/classes/class_basebutton.rst index 852f28ada..2f5b7d5ba 100644 --- a/classes/class_basebutton.rst +++ b/classes/class_basebutton.rst @@ -271,11 +271,11 @@ Called when the button is toggled (only if toggle_mode is active). - :ref:`DrawMode` **get_draw_mode** **(** **)** const -Return the visual state used to draw the button. This is useful mainly when implementing your own draw code by either overriding _draw() or connecting to "draw" signal. The visual state of the button is defined by the DRAW\_\* enum. +Returns the visual state used to draw the button. This is useful mainly when implementing your own draw code by either overriding _draw() or connecting to "draw" signal. The visual state of the button is defined by the DRAW\_\* enum. .. _class_BaseButton_method_is_hovered: - :ref:`bool` **is_hovered** **(** **)** const -Return ``true`` if the mouse has entered the button and has not left it yet. +Returns ``true`` if the mouse has entered the button and has not left it yet. diff --git a/classes/class_basis.rst b/classes/class_basis.rst index 8ea6f397a..5509cb799 100644 --- a/classes/class_basis.rst +++ b/classes/class_basis.rst @@ -130,7 +130,7 @@ Create a matrix from 3 axis vectors. - :ref:`float` **determinant** **(** **)** -Return the determinant of the matrix. +Returns the determinant of the matrix. .. _class_Basis_method_get_euler: @@ -158,7 +158,7 @@ Assuming that the matrix is the combination of a rotation and scaling, return th - :ref:`Basis` **inverse** **(** **)** -Return the inverse of the matrix. +Returns the inverse of the matrix. .. _class_Basis_method_is_equal_approx: @@ -168,7 +168,7 @@ Return the inverse of the matrix. - :ref:`Basis` **orthonormalized** **(** **)** -Return the orthonormalized version of the matrix (useful to call from time to time to avoid rounding error for orthogonal matrices). This performs a Gram-Schmidt orthonormalization on the basis of the matrix. +Returns the orthonormalized version of the matrix (useful to call from time to time to avoid rounding error for orthogonal matrices). This performs a Gram-Schmidt orthonormalization on the basis of the matrix. .. _class_Basis_method_rotated: @@ -210,17 +210,17 @@ Transposed dot product with the z axis of the matrix. - :ref:`Basis` **transposed** **(** **)** -Return the transposed version of the matrix. +Returns the transposed version of the matrix. .. _class_Basis_method_xform: - :ref:`Vector3` **xform** **(** :ref:`Vector3` v **)** -Return a vector transformed (multiplied) by the matrix. +Returns a vector transformed (multiplied) by the matrix. .. _class_Basis_method_xform_inv: - :ref:`Vector3` **xform_inv** **(** :ref:`Vector3` v **)** -Return a vector transformed (multiplied) by the transposed matrix. Note that this results in a multiplication by the inverse of the matrix only if it represents a rotation-reflection. +Returns a vector transformed (multiplied) by the transposed matrix. Note that this results in a multiplication by the inverse of the matrix only if it represents a rotation-reflection. diff --git a/classes/class_camera.rst b/classes/class_camera.rst index a228e3a92..21d3fad34 100644 --- a/classes/class_camera.rst +++ b/classes/class_camera.rst @@ -55,6 +55,8 @@ Methods +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_current` **(** :ref:`bool` enable_next=true **)** | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_camera_rid` **(** **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform` | :ref:`get_camera_transform` **(** **)** const | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_cull_mask_bit` **(** :ref:`int` layer **)** const | @@ -302,6 +304,12 @@ Method Descriptions If this is the current Camera, remove it from being current. If ``enable_next`` is ``true``, request to make the next Camera current, if any. +.. _class_Camera_method_get_camera_rid: + +- :ref:`RID` **get_camera_rid** **(** **)** const + +Returns the camera's RID from the :ref:`VisualServer`. + .. _class_Camera_method_get_camera_transform: - :ref:`Transform` **get_camera_transform** **(** **)** const diff --git a/classes/class_camera2d.rst b/classes/class_camera2d.rst index 2954bae18..3290ce597 100644 --- a/classes/class_camera2d.rst +++ b/classes/class_camera2d.rst @@ -448,7 +448,7 @@ Force the camera to update scroll immediately. - :ref:`Vector2` **get_camera_position** **(** **)** const -Return the camera position. +Returns the camera position. .. _class_Camera2D_method_get_camera_screen_center: diff --git a/classes/class_canvasitem.rst b/classes/class_canvasitem.rst index bb477d6d2..2de73c562 100644 --- a/classes/class_canvasitem.rst +++ b/classes/class_canvasitem.rst @@ -461,13 +461,13 @@ Draws a textured rectangle region at a given position, optionally modulated by a - :ref:`RID` **get_canvas** **(** **)** const -Return the :ref:`RID` of the :ref:`World2D` canvas where this item is in. +Returns the :ref:`RID` of the :ref:`World2D` canvas where this item is in. .. _class_CanvasItem_method_get_canvas_item: - :ref:`RID` **get_canvas_item** **(** **)** const -Return the canvas item RID used by :ref:`VisualServer` for this item. +Returns the canvas item RID used by :ref:`VisualServer` for this item. .. _class_CanvasItem_method_get_canvas_transform: diff --git a/classes/class_classdb.rst b/classes/class_classdb.rst index 8aac94722..7c63e829f 100644 --- a/classes/class_classdb.rst +++ b/classes/class_classdb.rst @@ -133,19 +133,19 @@ Returns an array with all the signals of 'class' or its ancestry if 'no_inherita - :ref:`bool` **class_has_integer_constant** **(** :ref:`String` class, :ref:`String` name **)** const -Return whether 'class' or its ancestry has an integer constant called 'name' or not. +Returns whether 'class' or its ancestry has an integer constant called 'name' or not. .. _class_ClassDB_method_class_has_method: - :ref:`bool` **class_has_method** **(** :ref:`String` class, :ref:`String` method, :ref:`bool` no_inheritance=false **)** const -Return whether 'class' (or its ancestry if 'no_inheritance' is false) has a method called 'method' or not. +Returns whether 'class' (or its ancestry if 'no_inheritance' is false) has a method called 'method' or not. .. _class_ClassDB_method_class_has_signal: - :ref:`bool` **class_has_signal** **(** :ref:`String` class, :ref:`String` signal **)** const -Return whether 'class' or its ancestry has a signal called 'signal' or not. +Returns whether 'class' or its ancestry has a signal called 'signal' or not. .. _class_ClassDB_method_class_set_property: diff --git a/classes/class_color.rst b/classes/class_color.rst index e722de6b3..59c078d33 100644 --- a/classes/class_color.rst +++ b/classes/class_color.rst @@ -355,6 +355,8 @@ Constants .. _class_Color_constant_tomato: +.. _class_Color_constant_transparent: + .. _class_Color_constant_turquoise: .. _class_Color_constant_violet: @@ -645,6 +647,8 @@ Constants - **tomato** = **Color( 1, 0.39, 0.28, 1 )** +- **transparent** = **Color( 1, 1, 1, 0 )** + - **turquoise** = **Color( 0.25, 0.88, 0.82, 1 )** - **violet** = **Color( 0.93, 0.51, 0.93, 1 )** diff --git a/classes/class_colorpicker.rst b/classes/class_colorpicker.rst index 0b2eaae6b..fc15c9b93 100644 --- a/classes/class_colorpicker.rst +++ b/classes/class_colorpicker.rst @@ -185,5 +185,5 @@ Remove the given color from the list of color presets of this color picker. - :ref:`PoolColorArray` **get_presets** **(** **)** const -Return the list of colors in the presets of the color picker. +Returns the list of colors in the presets of the color picker. diff --git a/classes/class_concavepolygonshape.rst b/classes/class_concavepolygonshape.rst index 7e0c30539..6886ca37b 100644 --- a/classes/class_concavepolygonshape.rst +++ b/classes/class_concavepolygonshape.rst @@ -37,7 +37,7 @@ Method Descriptions - :ref:`PoolVector3Array` **get_faces** **(** **)** const -Return the faces (an array of triangles). +Returns the faces (an array of triangles). .. _class_ConcavePolygonShape_method_set_faces: diff --git a/classes/class_confirmationdialog.rst b/classes/class_confirmationdialog.rst index 238142cd8..661c2b3a8 100644 --- a/classes/class_confirmationdialog.rst +++ b/classes/class_confirmationdialog.rst @@ -37,5 +37,5 @@ Method Descriptions - :ref:`Button` **get_cancel** **(** **)** -Return the cancel button. +Returns the cancel button. diff --git a/classes/class_control.rst b/classes/class_control.rst index 7087780bf..59802aac2 100644 --- a/classes/class_control.rst +++ b/classes/class_control.rst @@ -1114,7 +1114,7 @@ Returns the mouse cursor shape the control displays on mouse hover. See :ref:`Cu - :ref:`Object` **get_drag_data** **(** :ref:`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 receive drop data should implement :ref:`can_drop_data` and :ref:`drop_data`. ``position`` is local to this control. Drag may be forced with :ref:`force_drag`. +Godot calls this method to get data that can be dragged and dropped onto controls that expect drop data. Returns null if there is no data to drag. Controls that want to receive drop data should implement :ref:`can_drop_data` and :ref:`drop_data`. ``position`` is local to this control. Drag may be forced with :ref:`force_drag`. A preview that will follow the mouse that should represent the data can be set with :ref:`set_drag_preview`. A good time to set the preview is in this method. diff --git a/classes/class_dictionary.rst b/classes/class_dictionary.rst index 5a7d5301f..ab6c06a6a 100644 --- a/classes/class_dictionary.rst +++ b/classes/class_dictionary.rst @@ -85,7 +85,7 @@ Creates a copy of the dictionary, and returns it. - :ref:`bool` **empty** **(** **)** -Return ``true`` if the dictionary is empty. +Returns ``true`` if the dictionary is empty. .. _class_Dictionary_method_erase: @@ -103,35 +103,35 @@ Returns the current value for the specified key in the ``Dictionary``. If the ke - :ref:`bool` **has** **(** :ref:`Variant` key **)** -Return ``true`` if the dictionary has a given key. +Returns ``true`` if the dictionary has a given key. .. _class_Dictionary_method_has_all: - :ref:`bool` **has_all** **(** :ref:`Array` keys **)** -Return ``true`` if the dictionary has all of the keys in the given array. +Returns ``true`` if the dictionary has all of the keys in the given array. .. _class_Dictionary_method_hash: - :ref:`int` **hash** **(** **)** -Return a hashed integer value representing the dictionary contents. +Returns a hashed integer value representing the dictionary contents. .. _class_Dictionary_method_keys: - :ref:`Array` **keys** **(** **)** -Return the list of keys in the ``Dictionary``. +Returns the list of keys in the ``Dictionary``. .. _class_Dictionary_method_size: - :ref:`int` **size** **(** **)** -Return the size of the dictionary (in pairs). +Returns the size of the dictionary (in pairs). .. _class_Dictionary_method_values: - :ref:`Array` **values** **(** **)** -Return the list of values in the ``Dictionary``. +Returns the list of values in the ``Dictionary``. diff --git a/classes/class_directory.rst b/classes/class_directory.rst index c504ebe82..15ae5eedf 100644 --- a/classes/class_directory.rst +++ b/classes/class_directory.rst @@ -108,25 +108,25 @@ Returns one of the error code constants defined in :ref:`@GlobalScope` **current_is_dir** **(** **)** const -Return whether the current item processed with the last :ref:`get_next` call is a directory (``.`` and ``..`` are considered directories). +Returns whether the current item processed with the last :ref:`get_next` call is a directory (``.`` and ``..`` are considered directories). .. _class_Directory_method_dir_exists: - :ref:`bool` **dir_exists** **(** :ref:`String` path **)** -Return whether the target directory exists. The argument can be relative to the current directory, or an absolute path. +Returns whether the target directory exists. The argument can be relative to the current directory, or an absolute path. .. _class_Directory_method_file_exists: - :ref:`bool` **file_exists** **(** :ref:`String` path **)** -Return whether the target file exists. The argument can be relative to the current directory, or an absolute path. +Returns whether the target file exists. The argument can be relative to the current directory, or an absolute path. .. _class_Directory_method_get_current_dir: - :ref:`String` **get_current_dir** **(** **)** -Return the absolute path to the currently opened directory (e.g. ``res://folder`` or ``C:\tmp\folder``). +Returns the absolute path to the currently opened directory (e.g. ``res://folder`` or ``C:\tmp\folder``). .. _class_Directory_method_get_current_drive: @@ -150,7 +150,7 @@ On Windows, return the number of drives (partitions) mounted on the current file - :ref:`String` **get_next** **(** **)** -Return the next element (file or directory) in the current directory (including ``.`` and ``..``, unless ``skip_navigational`` was given to :ref:`list_dir_begin`). +Returns the next element (file or directory) in the current directory (including ``.`` and ``..``, unless ``skip_navigational`` was given to :ref:`list_dir_begin`). The name of the file or directory is returned (and not its full path). Once the stream has been fully processed, the method returns an empty String and closes the stream automatically (i.e. :ref:`list_dir_end` would not be mandatory in such a case). @@ -190,7 +190,7 @@ The method returns one of the error code constants defined in :ref:`@GlobalScope Create a target directory and all necessary intermediate directories in its path, by calling :ref:`make_dir` recursively. The argument can be relative to the current directory, or an absolute path. -Return one of the error code constants defined in :ref:`@GlobalScope` (OK, FAILED or ERR\_\*). +Returns one of the error code constants defined in :ref:`@GlobalScope` (OK, FAILED or ERR\_\*). .. _class_Directory_method_open: @@ -206,7 +206,7 @@ The method returns one of the error code constants defined in :ref:`@GlobalScope Delete the target file or an empty directory. The argument can be relative to the current directory, or an absolute path. If the target directory is not empty, the operation will fail. -Return one of the error code constants defined in :ref:`@GlobalScope` (OK or FAILED). +Returns one of the error code constants defined in :ref:`@GlobalScope` (OK or FAILED). .. _class_Directory_method_rename: @@ -214,5 +214,5 @@ Return one of the error code constants defined in :ref:`@GlobalScope` (OK or FAILED). +Returns one of the error code constants defined in :ref:`@GlobalScope` (OK or FAILED). diff --git a/classes/class_editorexportplugin.rst b/classes/class_editorexportplugin.rst index 46dad96e6..c0606ba9d 100644 --- a/classes/class_editorexportplugin.rst +++ b/classes/class_editorexportplugin.rst @@ -22,6 +22,8 @@ Methods +------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_export_begin` **(** :ref:`PoolStringArray` features, :ref:`bool` is_debug, :ref:`String` path, :ref:`int` flags **)** virtual | +------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_export_end` **(** **)** virtual | ++------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_export_file` **(** :ref:`String` path, :ref:`String` type, :ref:`PoolStringArray` features **)** virtual | +------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_file` **(** :ref:`String` path, :ref:`PoolByteArray` file, :ref:`bool` remap **)** | @@ -48,6 +50,10 @@ Method Descriptions - void **_export_begin** **(** :ref:`PoolStringArray` features, :ref:`bool` is_debug, :ref:`String` path, :ref:`int` flags **)** virtual +.. _class_EditorExportPlugin_method__export_end: + +- void **_export_end** **(** **)** virtual + .. _class_EditorExportPlugin_method__export_file: - void **_export_file** **(** :ref:`String` path, :ref:`String` type, :ref:`PoolStringArray` features **)** virtual diff --git a/classes/class_editorfilesystem.rst b/classes/class_editorfilesystem.rst index 1151b429f..1fbc4d9f1 100644 --- a/classes/class_editorfilesystem.rst +++ b/classes/class_editorfilesystem.rst @@ -94,13 +94,13 @@ Returns a view into the filesystem at ``path``. - :ref:`float` **get_scanning_progress** **(** **)** const -Return the scan progress for 0 to 1 if the FS is being scanned. +Returns the scan progress for 0 to 1 if the FS is being scanned. .. _class_EditorFileSystem_method_is_scanning: - :ref:`bool` **is_scanning** **(** **)** const -Return ``true`` of the filesystem is being scanned. +Returns ``true`` of the filesystem is being scanned. .. _class_EditorFileSystem_method_scan: diff --git a/classes/class_editorinspectorplugin.rst b/classes/class_editorinspectorplugin.rst index dbbbbf426..cc743f960 100644 --- a/classes/class_editorinspectorplugin.rst +++ b/classes/class_editorinspectorplugin.rst @@ -79,7 +79,7 @@ Add am editor that allows modifying multiple properties, this must inherit :ref: - :ref:`bool` **can_handle** **(** :ref:`Object` object **)** virtual -Return true if this object can be handled by this plugin. +Returns true if this object can be handled by this plugin. .. _class_EditorInspectorPlugin_method_parse_begin: diff --git a/classes/class_editornavigationmeshgenerator.rst b/classes/class_editornavigationmeshgenerator.rst new file mode 100644 index 000000000..ae206418b --- /dev/null +++ b/classes/class_editornavigationmeshgenerator.rst @@ -0,0 +1,38 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the EditorNavigationMeshGenerator.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_EditorNavigationMeshGenerator: + +EditorNavigationMeshGenerator +============================= + +**Inherits:** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Methods +------- + ++------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`bake` **(** :ref:`NavigationMesh` nav_mesh, :ref:`Node` root_node **)** | ++------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** :ref:`NavigationMesh` nav_mesh **)** | ++------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Method Descriptions +------------------- + +.. _class_EditorNavigationMeshGenerator_method_bake: + +- void **bake** **(** :ref:`NavigationMesh` nav_mesh, :ref:`Node` root_node **)** + +.. _class_EditorNavigationMeshGenerator_method_clear: + +- void **clear** **(** :ref:`NavigationMesh` nav_mesh **)** + diff --git a/classes/class_editorplugin.rst b/classes/class_editorplugin.rst index ef2615a58..f4d947fef 100644 --- a/classes/class_editorplugin.rst +++ b/classes/class_editorplugin.rst @@ -404,7 +404,7 @@ This is for editors that edit script based objects. You can return a list of bre - :ref:`EditorInterface` **get_editor_interface** **(** **)** -Return the :ref:`EditorInterface` object that gives you control over Godot editor's window and its functionalities. +Returns the :ref:`EditorInterface` object that gives you control over Godot editor's window and its functionalities. .. _class_EditorPlugin_method_get_plugin_icon: @@ -448,7 +448,7 @@ Implement this function if your plugin edits a specific type of object (Resource - :ref:`bool` **has_main_screen** **(** **)** virtual -Return ``true`` if this is a main screen editor plugin (it goes in the workspaces selector together with '2D', '3D', and 'Script'). +Returns ``true`` if this is a main screen editor plugin (it goes in the workspaces selector together with '2D', '3D', and 'Script'). .. _class_EditorPlugin_method_hide_bottom_panel: diff --git a/classes/class_editorresourcepreviewgenerator.rst b/classes/class_editorresourcepreviewgenerator.rst index 776b9e57e..064496df2 100644 --- a/classes/class_editorresourcepreviewgenerator.rst +++ b/classes/class_editorresourcepreviewgenerator.rst @@ -19,11 +19,15 @@ Custom generator of previews. Methods ------- ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`can_generate_small_preview` **(** **)** virtual | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Texture` | :ref:`generate` **(** :ref:`Resource` from, :ref:`Vector2` size **)** virtual | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Texture` | :ref:`generate_from_path` **(** :ref:`String` path, :ref:`Vector2` size **)** virtual | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`generate_small_preview_automatically` **(** **)** virtual | ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`handles` **(** :ref:`String` type **)** virtual | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -35,6 +39,14 @@ Custom code to generate previews. Please check "file_dialog/thumbnail_size" in E Method Descriptions ------------------- +.. _class_EditorResourcePreviewGenerator_method_can_generate_small_preview: + +- :ref:`bool` **can_generate_small_preview** **(** **)** virtual + +If this function returns true the generator will call :ref:`generate` or :ref:`generate_from_path` for small previews too. + +By default it returns false. + .. _class_EditorResourcePreviewGenerator_method_generate: - :ref:`Texture` **generate** **(** :ref:`Resource` from, :ref:`Vector2` size **)** virtual @@ -55,9 +67,17 @@ Returning an empty texture is an OK way to fail and let another generator take c Care must be taken because this function is always called from a thread (not the main thread). +.. _class_EditorResourcePreviewGenerator_method_generate_small_preview_automatically: + +- :ref:`bool` **generate_small_preview_automatically** **(** **)** virtual + +If this function returns true the generator will automatically generate the small previews from the normal preview texture generated by the methods :ref:`generate` or :ref:`generate_from_path`. + +By default it returns false. + .. _class_EditorResourcePreviewGenerator_method_handles: - :ref:`bool` **handles** **(** :ref:`String` type **)** virtual -Return if your generator supports this resource type. +Returns if your generator supports this resource type. diff --git a/classes/class_editorspatialgizmo.rst b/classes/class_editorspatialgizmo.rst index 612e8897b..9a0b8dfb1 100644 --- a/classes/class_editorspatialgizmo.rst +++ b/classes/class_editorspatialgizmo.rst @@ -127,7 +127,7 @@ Get actual value of a handle. This value can be anything and used for eventually - :ref:`EditorSpatialGizmoPlugin` **get_plugin** **(** **)** const -Return the :ref:`EditorSpatialGizmoPlugin` that owns this gizmo. It's useful to retrieve materials using :ref:`EditorSpatialGizmoPlugin.get_material`. +Returns the :ref:`EditorSpatialGizmoPlugin` that owns this gizmo. It's useful to retrieve materials using :ref:`EditorSpatialGizmoPlugin.get_material`. .. _class_EditorSpatialGizmo_method_get_spatial_node: diff --git a/classes/class_filedialog.rst b/classes/class_filedialog.rst index 51fe25f1d..eb2b71cfc 100644 --- a/classes/class_filedialog.rst +++ b/classes/class_filedialog.rst @@ -266,7 +266,7 @@ Returns the LineEdit for the selected file. - :ref:`VBoxContainer` **get_vbox** **(** **)** -Return the vertical box container of the dialog, custom controls can be added to it. +Returns the vertical box container of the dialog, custom controls can be added to it. .. _class_FileDialog_method_invalidate: diff --git a/classes/class_font.rst b/classes/class_font.rst index 5e49f3893..56084c132 100644 --- a/classes/class_font.rst +++ b/classes/class_font.rst @@ -67,25 +67,25 @@ Draw character "char" into a canvas item using the font at a given position, wit - :ref:`float` **get_ascent** **(** **)** const -Return the font ascent (number of pixels above the baseline). +Returns the font ascent (number of pixels above the baseline). .. _class_Font_method_get_descent: - :ref:`float` **get_descent** **(** **)** const -Return the font descent (number of pixels below the baseline). +Returns the font descent (number of pixels below the baseline). .. _class_Font_method_get_height: - :ref:`float` **get_height** **(** **)** const -Return the total font height (ascent plus descent) in pixels. +Returns the total font height (ascent plus descent) in pixels. .. _class_Font_method_get_string_size: - :ref:`Vector2` **get_string_size** **(** :ref:`String` string **)** const -Return the size of a string, taking kerning and advance into account. +Returns the size of a string, taking kerning and advance into account. .. _class_Font_method_get_wordwrap_string_size: diff --git a/classes/class_geometry.rst b/classes/class_geometry.rst index c3d4cfe4c..249a5d93b 100644 --- a/classes/class_geometry.rst +++ b/classes/class_geometry.rst @@ -19,53 +19,138 @@ Brief Description Methods ------- -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`build_box_planes` **(** :ref:`Vector3` extents **)** | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`build_capsule_planes` **(** :ref:`float` radius, :ref:`float` height, :ref:`int` sides, :ref:`int` lats, Vector3.Axis axis=2 **)** | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`build_cylinder_planes` **(** :ref:`float` radius, :ref:`float` height, :ref:`int` sides, Vector3.Axis axis=2 **)** | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`clip_polygon` **(** :ref:`PoolVector3Array` points, :ref:`Plane` plane **)** | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`convex_hull_2d` **(** :ref:`PoolVector2Array` points **)** | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_closest_point_to_segment` **(** :ref:`Vector3` point, :ref:`Vector3` s1, :ref:`Vector3` s2 **)** | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_closest_point_to_segment_2d` **(** :ref:`Vector2` point, :ref:`Vector2` s1, :ref:`Vector2` s2 **)** | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_closest_point_to_segment_uncapped` **(** :ref:`Vector3` point, :ref:`Vector3` s1, :ref:`Vector3` s2 **)** | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_closest_point_to_segment_uncapped_2d` **(** :ref:`Vector2` point, :ref:`Vector2` s1, :ref:`Vector2` s2 **)** | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`get_closest_points_between_segments` **(** :ref:`Vector3` p1, :ref:`Vector3` p2, :ref:`Vector3` q1, :ref:`Vector3` q2 **)** | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`get_closest_points_between_segments_2d` **(** :ref:`Vector2` p1, :ref:`Vector2` q1, :ref:`Vector2` p2, :ref:`Vector2` q2 **)** | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_uv84_normal_bit` **(** :ref:`Vector3` normal **)** | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`line_intersects_line_2d` **(** :ref:`Vector2` from_a, :ref:`Vector2` dir_a, :ref:`Vector2` from_b, :ref:`Vector2` dir_b **)** | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`make_atlas` **(** :ref:`PoolVector2Array` sizes **)** | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`point_is_inside_triangle` **(** :ref:`Vector2` point, :ref:`Vector2` a, :ref:`Vector2` b, :ref:`Vector2` c **)** const | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`ray_intersects_triangle` **(** :ref:`Vector3` from, :ref:`Vector3` dir, :ref:`Vector3` a, :ref:`Vector3` b, :ref:`Vector3` c **)** | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`segment_intersects_circle` **(** :ref:`Vector2` segment_from, :ref:`Vector2` segment_to, :ref:`Vector2` circle_position, :ref:`float` circle_radius **)** | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`segment_intersects_convex` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Array` planes **)** | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`segment_intersects_cylinder` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`float` height, :ref:`float` radius **)** | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`segment_intersects_segment_2d` **(** :ref:`Vector2` from_a, :ref:`Vector2` to_a, :ref:`Vector2` from_b, :ref:`Vector2` to_b **)** | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`segment_intersects_sphere` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Vector3` sphere_position, :ref:`float` sphere_radius **)** | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`segment_intersects_triangle` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Vector3` a, :ref:`Vector3` b, :ref:`Vector3` c **)** | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`triangulate_polygon` **(** :ref:`PoolVector2Array` polygon **)** | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`build_box_planes` **(** :ref:`Vector3` extents **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`build_capsule_planes` **(** :ref:`float` radius, :ref:`float` height, :ref:`int` sides, :ref:`int` lats, Vector3.Axis axis=2 **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`build_cylinder_planes` **(** :ref:`float` radius, :ref:`float` height, :ref:`int` sides, Vector3.Axis axis=2 **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`clip_polygon` **(** :ref:`PoolVector3Array` points, :ref:`Plane` plane **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`clip_polygons_2d` **(** :ref:`PoolVector2Array` polygon_a, :ref:`PoolVector2Array` polygon_b **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`clip_polyline_with_polygon_2d` **(** :ref:`PoolVector2Array` polyline, :ref:`PoolVector2Array` polygon **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`convex_hull_2d` **(** :ref:`PoolVector2Array` points **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`exclude_polygons_2d` **(** :ref:`PoolVector2Array` polygon_a, :ref:`PoolVector2Array` polygon_b **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_closest_point_to_segment` **(** :ref:`Vector3` point, :ref:`Vector3` s1, :ref:`Vector3` s2 **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_closest_point_to_segment_2d` **(** :ref:`Vector2` point, :ref:`Vector2` s1, :ref:`Vector2` s2 **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_closest_point_to_segment_uncapped` **(** :ref:`Vector3` point, :ref:`Vector3` s1, :ref:`Vector3` s2 **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_closest_point_to_segment_uncapped_2d` **(** :ref:`Vector2` point, :ref:`Vector2` s1, :ref:`Vector2` s2 **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`get_closest_points_between_segments` **(** :ref:`Vector3` p1, :ref:`Vector3` p2, :ref:`Vector3` q1, :ref:`Vector3` q2 **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`get_closest_points_between_segments_2d` **(** :ref:`Vector2` p1, :ref:`Vector2` q1, :ref:`Vector2` p2, :ref:`Vector2` q2 **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_uv84_normal_bit` **(** :ref:`Vector3` normal **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`intersect_polygons_2d` **(** :ref:`PoolVector2Array` polygon_a, :ref:`PoolVector2Array` polygon_b **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`intersect_polyline_with_polygon_2d` **(** :ref:`PoolVector2Array` polyline, :ref:`PoolVector2Array` polygon **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_polygon_clockwise` **(** :ref:`PoolVector2Array` polygon **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`line_intersects_line_2d` **(** :ref:`Vector2` from_a, :ref:`Vector2` dir_a, :ref:`Vector2` from_b, :ref:`Vector2` dir_b **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`make_atlas` **(** :ref:`PoolVector2Array` sizes **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`merge_polygons_2d` **(** :ref:`PoolVector2Array` polygon_a, :ref:`PoolVector2Array` polygon_b **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`offset_polygon_2d` **(** :ref:`PoolVector2Array` polygon, :ref:`float` delta, :ref:`PolyJoinType` join_type=0 **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`offset_polyline_2d` **(** :ref:`PoolVector2Array` polyline, :ref:`float` delta, :ref:`PolyJoinType` join_type=0, :ref:`PolyEndType` end_type=3 **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`point_is_inside_triangle` **(** :ref:`Vector2` point, :ref:`Vector2` a, :ref:`Vector2` b, :ref:`Vector2` c **)** const | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`ray_intersects_triangle` **(** :ref:`Vector3` from, :ref:`Vector3` dir, :ref:`Vector3` a, :ref:`Vector3` b, :ref:`Vector3` c **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`segment_intersects_circle` **(** :ref:`Vector2` segment_from, :ref:`Vector2` segment_to, :ref:`Vector2` circle_position, :ref:`float` circle_radius **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`segment_intersects_convex` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Array` planes **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`segment_intersects_cylinder` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`float` height, :ref:`float` radius **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`segment_intersects_segment_2d` **(** :ref:`Vector2` from_a, :ref:`Vector2` to_a, :ref:`Vector2` from_b, :ref:`Vector2` to_b **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`segment_intersects_sphere` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Vector3` sphere_position, :ref:`float` sphere_radius **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`segment_intersects_triangle` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Vector3` a, :ref:`Vector3` b, :ref:`Vector3` c **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`transform_points_2d` **(** :ref:`PoolVector2Array` points, :ref:`Transform2D` transform **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`triangulate_delaunay_2d` **(** :ref:`PoolVector2Array` points **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`triangulate_polygon` **(** :ref:`PoolVector2Array` polygon **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Enumerations +------------ + +.. _enum_Geometry_PolyBooleanOperation: + +.. _class_Geometry_constant_OPERATION_UNION: + +.. _class_Geometry_constant_OPERATION_DIFFERENCE: + +.. _class_Geometry_constant_OPERATION_INTERSECTION: + +.. _class_Geometry_constant_OPERATION_XOR: + +enum **PolyBooleanOperation**: + +- **OPERATION_UNION** = **0** --- Create regions where either subject or clip polygons (or both) are filled. + +- **OPERATION_DIFFERENCE** = **1** --- Create regions where subject polygons are filled except where clip polygons are filled. + +- **OPERATION_INTERSECTION** = **2** --- Create regions where both subject and clip polygons are filled. + +- **OPERATION_XOR** = **3** --- Create regions where either subject or clip polygons are filled but not where both are filled. + +.. _enum_Geometry_PolyJoinType: + +.. _class_Geometry_constant_JOIN_SQUARE: + +.. _class_Geometry_constant_JOIN_ROUND: + +.. _class_Geometry_constant_JOIN_MITER: + +enum **PolyJoinType**: + +- **JOIN_SQUARE** = **0** --- Squaring is applied uniformally at all convex edge joins at ``1 * delta``. + +- **JOIN_ROUND** = **1** --- While flattened paths can never perfectly trace an arc, they are approximated by a series of arc chords. + +- **JOIN_MITER** = **2** --- There's a necessary limit to mitered joins since offsetting edges that join at very acute angles will produce excessively long and narrow 'spikes'. For any given edge join, when miter offsetting would exceed that maximum distance, 'square' joining is applied. + +.. _enum_Geometry_PolyEndType: + +.. _class_Geometry_constant_END_POLYGON: + +.. _class_Geometry_constant_END_JOINED: + +.. _class_Geometry_constant_END_BUTT: + +.. _class_Geometry_constant_END_SQUARE: + +.. _class_Geometry_constant_END_ROUND: + +enum **PolyEndType**: + +- **END_POLYGON** = **0** --- Endpoints are joined using the :ref:`PolyJoinType` value and the path filled as a polygon. + +- **END_JOINED** = **1** --- Endpoints are joined using the :ref:`PolyJoinType` value and the path filled as a polyline. + +- **END_BUTT** = **2** --- Endpoints are squared off with no extension. + +- **END_SQUARE** = **3** --- Endpoints are squared off and extended by ``delta`` units. + +- **END_ROUND** = **4** --- Endpoints are rounded off and extended by ``delta`` units. Method Descriptions ------------------- @@ -94,12 +179,34 @@ Returns an array of :ref:`Plane`\ s closely bounding a faceted cyli Clips the polygon defined by the points in ``points`` against the ``plane`` and returns the points of the clipped polygon. +.. _class_Geometry_method_clip_polygons_2d: + +- :ref:`Array` **clip_polygons_2d** **(** :ref:`PoolVector2Array` polygon_a, :ref:`PoolVector2Array` polygon_b **)** + +Clips ``polygon_a`` against ``polygon_b`` and returns an array of clipped polygons. This performs ``OPERATION_DIFFERENCE`` between polygons. Returns an empty array if ``polygon_b`` completely overlaps ``polygon_a``. + +If ``polygon_b`` is enclosed by ``polygon_a``, returns an outer polygon (boundary) and inner polygon (hole) which could be distiguished by calling :ref:`is_polygon_clockwise`. + +.. _class_Geometry_method_clip_polyline_with_polygon_2d: + +- :ref:`Array` **clip_polyline_with_polygon_2d** **(** :ref:`PoolVector2Array` polyline, :ref:`PoolVector2Array` polygon **)** + +Clips ``polyline`` against ``polygon`` and returns an array of clipped polylines. This performs ``OPERATION_DIFFERENCE`` between the polyline and the polygon. This operation can be thought of as cutting a line with a closed shape. + .. _class_Geometry_method_convex_hull_2d: - :ref:`PoolVector2Array` **convex_hull_2d** **(** :ref:`PoolVector2Array` points **)** Given an array of :ref:`Vector2`\ s, returns the convex hull as a list of points in counter-clockwise order. The last point is the same as the first one. +.. _class_Geometry_method_exclude_polygons_2d: + +- :ref:`Array` **exclude_polygons_2d** **(** :ref:`PoolVector2Array` polygon_a, :ref:`PoolVector2Array` polygon_b **)** + +Mutually excludes common area defined by intersection of ``polygon_a`` and ``polygon_b`` (see :ref:`intersect_polygons_2d`) and returns an array of excluded polygons. This performs ``OPERATION_XOR`` between polygons. In other words, returns all but common area between polygons. + +The operation may result in an outer polygon (boundary) and inner polygon (hole) produced which could be distiguished by calling :ref:`is_polygon_clockwise`. + .. _class_Geometry_method_get_closest_point_to_segment: - :ref:`Vector3` **get_closest_point_to_segment** **(** :ref:`Vector3` point, :ref:`Vector3` s1, :ref:`Vector3` s2 **)** @@ -140,6 +247,26 @@ Given the two 2d segments (``p1``, ``p2``) and (``q1``, ``q2``), finds those two - :ref:`int` **get_uv84_normal_bit** **(** :ref:`Vector3` normal **)** +.. _class_Geometry_method_intersect_polygons_2d: + +- :ref:`Array` **intersect_polygons_2d** **(** :ref:`PoolVector2Array` polygon_a, :ref:`PoolVector2Array` polygon_b **)** + +Intersects ``polygon_a`` with ``polygon_b`` and returns an array of intersected polygons. This performs ``OPERATION_INTERSECTION`` between polygons. In other words, returns common area shared by polygons. Returns an empty array if no intersection occurs. + +The operation may result in an outer polygon (boundary) and inner polygon (hole) produced which could be distiguished by calling :ref:`is_polygon_clockwise`. + +.. _class_Geometry_method_intersect_polyline_with_polygon_2d: + +- :ref:`Array` **intersect_polyline_with_polygon_2d** **(** :ref:`PoolVector2Array` polyline, :ref:`PoolVector2Array` polygon **)** + +Intersects ``polyline`` with ``polygon`` and returns an array of intersected polylines. This performs ``OPERATION_INTERSECTION`` between the polyline and the polygon. This operation can be thought of as chopping a line with a closed shape. + +.. _class_Geometry_method_is_polygon_clockwise: + +- :ref:`bool` **is_polygon_clockwise** **(** :ref:`PoolVector2Array` polygon **)** + +Returns ``true`` if ``polygon``'s vertices are ordered in clockwise order, otherwise returns ``false``. + .. _class_Geometry_method_line_intersects_line_2d: - :ref:`Variant` **line_intersects_line_2d** **(** :ref:`Vector2` from_a, :ref:`Vector2` dir_a, :ref:`Vector2` from_b, :ref:`Vector2` dir_b **)** @@ -152,6 +279,36 @@ Checks if the two lines (``from_a``, ``dir_a``) and (``from_b``, ``dir_b``) inte Given an array of :ref:`Vector2`\ s representing tiles, builds an atlas. The returned dictionary has two keys: ``points`` is a vector of :ref:`Vector2` that specifies the positions of each tile, ``size`` contains the overall size of the whole atlas as :ref:`Vector2`. +.. _class_Geometry_method_merge_polygons_2d: + +- :ref:`Array` **merge_polygons_2d** **(** :ref:`PoolVector2Array` polygon_a, :ref:`PoolVector2Array` polygon_b **)** + +Merges (combines) ``polygon_a`` and ``polygon_b`` and returns an array of merged polygons. This performs ``OPERATION_UNION`` between polygons. + +The operation may result in an outer polygon (boundary) and inner polygon (hole) produced which could be distiguished by calling :ref:`is_polygon_clockwise`. + +.. _class_Geometry_method_offset_polygon_2d: + +- :ref:`Array` **offset_polygon_2d** **(** :ref:`PoolVector2Array` polygon, :ref:`float` delta, :ref:`PolyJoinType` join_type=0 **)** + +Inflates or deflates ``polygon`` by ``delta`` units (pixels). If ``delta`` is positive, makes the polygon grow outward. If ``delta`` is negative, shrinks the polygon inward. Returns an array of polygons because inflating/deflating may result in multiple discrete polygons. Returns an empty array if ``delta`` is negative and the absolute value of it approximately exceeds the minimum bounding rectangle dimensions of the polygon. + +Each polygon's vertices will be rounded as determined by ``join_type``, see :ref:`PolyJoinType`. + +The operation may result in an outer polygon (boundary) and inner polygon (hole) produced which could be distiguished by calling :ref:`is_polygon_clockwise`. + +.. _class_Geometry_method_offset_polyline_2d: + +- :ref:`Array` **offset_polyline_2d** **(** :ref:`PoolVector2Array` polyline, :ref:`float` delta, :ref:`PolyJoinType` join_type=0, :ref:`PolyEndType` end_type=3 **)** + +Inflates or deflates ``polyline`` by ``delta`` units (pixels), producing polygons. If ``delta`` is positive, makes the polyline grow outward. Returns an array of polygons because inflating/deflating may result in multiple discrete polygons. If ``delta`` is negative, returns an empty array. + +Each polygon's vertices will be rounded as determined by ``join_type``, see :ref:`PolyJoinType`. + +Each polygon's endpoints will be rounded as determined by ``end_type``, see :ref:`PolyEndType`. + +The operation may result in an outer polygon (boundary) and inner polygon (hole) produced which could be distiguished by calling :ref:`is_polygon_clockwise`. + .. _class_Geometry_method_point_is_inside_triangle: - :ref:`bool` **point_is_inside_triangle** **(** :ref:`Vector2` point, :ref:`Vector2` a, :ref:`Vector2` b, :ref:`Vector2` c **)** const @@ -200,6 +357,20 @@ Checks if the segment (``from``, ``to``) intersects the sphere that is located a Tests if the segment (``from``, ``to``) intersects the triangle ``a``, ``b``, ``c``. If yes, returns the point of intersection as :ref:`Vector3`. If no intersection takes place, an empty :ref:`Variant` is returned. +.. _class_Geometry_method_transform_points_2d: + +- :ref:`PoolVector2Array` **transform_points_2d** **(** :ref:`PoolVector2Array` points, :ref:`Transform2D` transform **)** + +Transforms an array of points by ``transform`` and returns the result. + +Can be useful in conjuction with performing polygon boolean operations in CSG manner, see :ref:`merge_polygons_2d`, :ref:`clip_polygons_2d`, :ref:`intersect_polygons_2d`, :ref:`exclude_polygons_2d`. + +.. _class_Geometry_method_triangulate_delaunay_2d: + +- :ref:`PoolIntArray` **triangulate_delaunay_2d** **(** :ref:`PoolVector2Array` points **)** + +Triangulates the area specified by discrete set of ``points`` such that no point is inside the circumcircle of any resulting triangle. Returns a :ref:`PoolIntArray` where each triangle consists of three consecutive point indices into ``points`` (i.e. the returned array will have ``n * 3`` elements, with ``n`` being the number of found triangles). If the triangulation did not succeed, an empty :ref:`PoolIntArray` is returned. + .. _class_Geometry_method_triangulate_polygon: - :ref:`PoolIntArray` **triangulate_polygon** **(** :ref:`PoolVector2Array` polygon **)** diff --git a/classes/class_graphedit.rst b/classes/class_graphedit.rst index 9dfd4fc0b..d67251fd0 100644 --- a/classes/class_graphedit.rst +++ b/classes/class_graphedit.rst @@ -267,7 +267,7 @@ Remove the connection between 'from_port' slot of 'from' GraphNode and 'to_port' - :ref:`Array` **get_connection_list** **(** **)** const -Return an Array containing the list of connections. A connection consists in a structure of the form {from_port: 0, from: "GraphNode name 0", to_port: 1, to: "GraphNode name 1" } +Returns an Array containing the list of connections. A connection consists in a structure of the form {from_port: 0, from: "GraphNode name 0", to_port: 1, to: "GraphNode name 1" } .. _class_GraphEdit_method_get_zoom_hbox: @@ -277,7 +277,7 @@ Return an Array containing the list of connections. A connection consists in a s - :ref:`bool` **is_node_connected** **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port **)** -Return ``true`` if the 'from_port' slot of 'from' GraphNode is connected to the 'to_port' slot of 'to' GraphNode. +Returns ``true`` if the 'from_port' slot of 'from' GraphNode is connected to the 'to_port' slot of 'to' GraphNode. .. _class_GraphEdit_method_is_valid_connection_type: diff --git a/classes/class_graphnode.rst b/classes/class_graphnode.rst index 2722f98bd..adf6cfccc 100644 --- a/classes/class_graphnode.rst +++ b/classes/class_graphnode.rst @@ -264,85 +264,85 @@ Disable input and output slot whose index is 'idx'. - :ref:`Color` **get_connection_input_color** **(** :ref:`int` idx **)** -Return the color of the input connection 'idx'. +Returns the color of the input connection 'idx'. .. _class_GraphNode_method_get_connection_input_count: - :ref:`int` **get_connection_input_count** **(** **)** -Return the number of enabled input slots (connections) to the GraphNode. +Returns the number of enabled input slots (connections) to the GraphNode. .. _class_GraphNode_method_get_connection_input_position: - :ref:`Vector2` **get_connection_input_position** **(** :ref:`int` idx **)** -Return the position of the input connection 'idx'. +Returns the position of the input connection 'idx'. .. _class_GraphNode_method_get_connection_input_type: - :ref:`int` **get_connection_input_type** **(** :ref:`int` idx **)** -Return the type of the input connection 'idx'. +Returns the type of the input connection 'idx'. .. _class_GraphNode_method_get_connection_output_color: - :ref:`Color` **get_connection_output_color** **(** :ref:`int` idx **)** -Return the color of the output connection 'idx'. +Returns the color of the output connection 'idx'. .. _class_GraphNode_method_get_connection_output_count: - :ref:`int` **get_connection_output_count** **(** **)** -Return the number of enabled output slots (connections) of the GraphNode. +Returns the number of enabled output slots (connections) of the GraphNode. .. _class_GraphNode_method_get_connection_output_position: - :ref:`Vector2` **get_connection_output_position** **(** :ref:`int` idx **)** -Return the position of the output connection 'idx'. +Returns the position of the output connection 'idx'. .. _class_GraphNode_method_get_connection_output_type: - :ref:`int` **get_connection_output_type** **(** :ref:`int` idx **)** -Return the type of the output connection 'idx'. +Returns the type of the output connection 'idx'. .. _class_GraphNode_method_get_slot_color_left: - :ref:`Color` **get_slot_color_left** **(** :ref:`int` idx **)** const -Return the color set to 'idx' left (input) slot. +Returns the color set to 'idx' left (input) slot. .. _class_GraphNode_method_get_slot_color_right: - :ref:`Color` **get_slot_color_right** **(** :ref:`int` idx **)** const -Return the color set to 'idx' right (output) slot. +Returns the color set to 'idx' right (output) slot. .. _class_GraphNode_method_get_slot_type_left: - :ref:`int` **get_slot_type_left** **(** :ref:`int` idx **)** const -Return the (integer) type of left (input) 'idx' slot. +Returns the (integer) type of left (input) 'idx' slot. .. _class_GraphNode_method_get_slot_type_right: - :ref:`int` **get_slot_type_right** **(** :ref:`int` idx **)** const -Return the (integer) type of right (output) 'idx' slot. +Returns the (integer) type of right (output) 'idx' slot. .. _class_GraphNode_method_is_slot_enabled_left: - :ref:`bool` **is_slot_enabled_left** **(** :ref:`int` idx **)** const -Return ``true`` if left (input) slot 'idx' is enabled, ``false`` otherwise. +Returns ``true`` if left (input) slot 'idx' is enabled, ``false`` otherwise. .. _class_GraphNode_method_is_slot_enabled_right: - :ref:`bool` **is_slot_enabled_right** **(** :ref:`int` idx **)** const -Return ``true`` if right (output) slot 'idx' is enabled, ``false`` otherwise. +Returns ``true`` if right (output) slot 'idx' is enabled, ``false`` otherwise. .. _class_GraphNode_method_set_slot: diff --git a/classes/class_imagetexture.rst b/classes/class_imagetexture.rst index 40d2ccaa0..c0b204c01 100644 --- a/classes/class_imagetexture.rst +++ b/classes/class_imagetexture.rst @@ -114,7 +114,7 @@ Create a new ``ImageTexture`` from an :ref:`Image` with ``flags`` f - :ref:`Format` **get_format** **(** **)** const -Return the format of the ``ImageTexture``, one of :ref:`Format`. +Returns the format of the ``ImageTexture``, one of :ref:`Format`. .. _class_ImageTexture_method_load: diff --git a/classes/class_input.rst b/classes/class_input.rst index 63924b1b2..876d35af2 100644 --- a/classes/class_input.rst +++ b/classes/class_input.rst @@ -350,7 +350,7 @@ Returns mouse buttons as a bitmask. If multiple mouse buttons are pressed at the - :ref:`MouseMode` **get_mouse_mode** **(** **)** const -Return the mouse mode. See the constants for more information. +Returns the mouse mode. See the constants for more information. .. _class_Input_method_is_action_just_pressed: diff --git a/classes/class_itemlist.rst b/classes/class_itemlist.rst index ce6e15913..6d7502089 100644 --- a/classes/class_itemlist.rst +++ b/classes/class_itemlist.rst @@ -396,7 +396,7 @@ Given a position within the control return the item (if any) at that point. - :ref:`int` **get_item_count** **(** **)** const -Return count of items currently in the item list. +Returns count of items currently in the item list. .. _class_ItemList_method_get_item_custom_bg_color: @@ -428,13 +428,13 @@ Returns a :ref:`Color` modulating item's icon at the specified inde - :ref:`String` **get_item_text** **(** :ref:`int` idx **)** const -Return the text for specified item index. +Returns the text for specified item index. .. _class_ItemList_method_get_item_tooltip: - :ref:`String` **get_item_tooltip** **(** :ref:`int` idx **)** const -Return tooltip hint for specified item index. +Returns tooltip hint for specified item index. .. _class_ItemList_method_get_selected_items: diff --git a/classes/class_marshalls.rst b/classes/class_marshalls.rst index ef40d5ed4..4f9b07069 100644 --- a/classes/class_marshalls.rst +++ b/classes/class_marshalls.rst @@ -45,19 +45,19 @@ Method Descriptions - :ref:`PoolByteArray` **base64_to_raw** **(** :ref:`String` base64_str **)** -Return :ref:`PoolByteArray` of a given base64 encoded String. +Returns :ref:`PoolByteArray` of a given base64 encoded String. .. _class_Marshalls_method_base64_to_utf8: - :ref:`String` **base64_to_utf8** **(** :ref:`String` base64_str **)** -Return utf8 String of a given base64 encoded String. +Returns utf8 String of a given base64 encoded String. .. _class_Marshalls_method_base64_to_variant: - :ref:`Variant` **base64_to_variant** **(** :ref:`String` base64_str, :ref:`bool` allow_objects=false **)** -Return :ref:`Variant` of a given base64 encoded String. When ``allow_objects`` is ``true`` decoding objects is allowed. +Returns :ref:`Variant` of a given base64 encoded String. When ``allow_objects`` is ``true`` decoding objects is allowed. **WARNING:** Deserialized object can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats (remote code execution). @@ -65,17 +65,17 @@ Return :ref:`Variant` of a given base64 encoded String. When ``al - :ref:`String` **raw_to_base64** **(** :ref:`PoolByteArray` array **)** -Return base64 encoded String of a given :ref:`PoolByteArray`. +Returns base64 encoded String of a given :ref:`PoolByteArray`. .. _class_Marshalls_method_utf8_to_base64: - :ref:`String` **utf8_to_base64** **(** :ref:`String` utf8_str **)** -Return base64 encoded String of a given utf8 String. +Returns base64 encoded String of a given utf8 String. .. _class_Marshalls_method_variant_to_base64: - :ref:`String` **variant_to_base64** **(** :ref:`Variant` variant, :ref:`bool` full_objects=false **)** -Return base64 encoded String of a given :ref:`Variant`. When ``full_objects`` is ``true`` encoding objects is allowed (and can potentially include code). +Returns base64 encoded String of a given :ref:`Variant`. When ``full_objects`` is ``true`` encoding objects is allowed (and can potentially include code). diff --git a/classes/class_menubutton.rst b/classes/class_menubutton.rst index 2ccdb44fc..16701f758 100644 --- a/classes/class_menubutton.rst +++ b/classes/class_menubutton.rst @@ -95,7 +95,7 @@ Method Descriptions - :ref:`PopupMenu` **get_popup** **(** **)** const -Return the :ref:`PopupMenu` contained in this button. +Returns the :ref:`PopupMenu` contained in this button. .. _class_MenuButton_method_set_disable_shortcuts: diff --git a/classes/class_mesh.rst b/classes/class_mesh.rst index 30670bcbb..d5cbf336a 100644 --- a/classes/class_mesh.rst +++ b/classes/class_mesh.rst @@ -286,7 +286,7 @@ Returns all the vertices that make up the faces of the mesh. Each three vertices - :ref:`int` **get_surface_count** **(** **)** const -Return the amount of surfaces that the ``Mesh`` holds. +Returns the amount of surfaces that the ``Mesh`` holds. .. _class_Mesh_method_surface_get_arrays: @@ -304,5 +304,5 @@ Returns the blend shape arrays for the requested surface. - :ref:`Material` **surface_get_material** **(** :ref:`int` surf_idx **)** const -Return a :ref:`Material` in a given surface. Surface is rendered using this material. +Returns a :ref:`Material` in a given surface. Surface is rendered using this material. diff --git a/classes/class_meshlibrary.rst b/classes/class_meshlibrary.rst index 240054139..e49c43f2b 100644 --- a/classes/class_meshlibrary.rst +++ b/classes/class_meshlibrary.rst @@ -85,19 +85,19 @@ Create a new item in the library, supplied an id. - :ref:`PoolIntArray` **get_item_list** **(** **)** const -Return the list of items. +Returns the list of items. .. _class_MeshLibrary_method_get_item_mesh: - :ref:`Mesh` **get_item_mesh** **(** :ref:`int` id **)** const -Return the mesh of the item. +Returns the mesh of the item. .. _class_MeshLibrary_method_get_item_name: - :ref:`String` **get_item_name** **(** :ref:`int` id **)** const -Return the name of the item. +Returns the name of the item. .. _class_MeshLibrary_method_get_item_navmesh: diff --git a/classes/class_multimesh.rst b/classes/class_multimesh.rst index 9f475af25..250c64357 100644 --- a/classes/class_multimesh.rst +++ b/classes/class_multimesh.rst @@ -203,7 +203,7 @@ Method Descriptions - :ref:`AABB` **get_aabb** **(** **)** const -Return the visibility AABB. +Returns the visibility AABB. .. _class_MultiMesh_method_get_instance_color: @@ -215,19 +215,19 @@ Get the color of a specific instance. - :ref:`Color` **get_instance_custom_data** **(** :ref:`int` instance **)** const -Return the custom data that has been set for a specific instance. +Returns the custom data that has been set for a specific instance. .. _class_MultiMesh_method_get_instance_transform: - :ref:`Transform` **get_instance_transform** **(** :ref:`int` instance **)** const -Return the :ref:`Transform` of a specific instance. +Returns the :ref:`Transform` of a specific instance. .. _class_MultiMesh_method_get_instance_transform_2d: - :ref:`Transform2D` **get_instance_transform_2d** **(** :ref:`int` instance **)** const -Return the :ref:`Transform2D` of a specific instance. +Returns the :ref:`Transform2D` of a specific instance. .. _class_MultiMesh_method_set_as_bulk_array: diff --git a/classes/class_navigationmesh.rst b/classes/class_navigationmesh.rst index 011adedca..7583c2f49 100644 --- a/classes/class_navigationmesh.rst +++ b/classes/class_navigationmesh.rst @@ -46,6 +46,10 @@ Properties +---------------------------+-------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`filter/low_hanging_obstacles` | +---------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`geometry/collision_mask` | ++---------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`geometry/parsed_geometry_type` | ++---------------------------+-------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`polygon/verts_per_poly` | +---------------------------+-------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`region/merge_size` | @@ -58,21 +62,25 @@ Properties Methods ------- -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_polygon` **(** :ref:`PoolIntArray` polygon **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_polygons` **(** **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create_from_mesh` **(** :ref:`Mesh` mesh **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_polygon` **(** :ref:`int` idx **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_polygon_count` **(** **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`get_vertices` **(** **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vertices` **(** :ref:`PoolVector3Array` vertices **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_polygon` **(** :ref:`PoolIntArray` polygon **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_polygons` **(** **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`create_from_mesh` **(** :ref:`Mesh` mesh **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`get_polygon` **(** :ref:`int` idx **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_polygon_count` **(** **)** const | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`get_vertices` **(** **)** const | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_vertices` **(** :ref:`PoolVector3Array` vertices **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ Constants --------- @@ -83,12 +91,24 @@ Constants .. _class_NavigationMesh_constant_SAMPLE_PARTITION_LAYERS: +.. _class_NavigationMesh_constant_PARSED_GEOMETRY_MESH_INSTANCES: + +.. _class_NavigationMesh_constant_PARSED_GEOMETRY_STATIC_COLLIDERS: + +.. _class_NavigationMesh_constant_PARSED_GEOMETRY_BOTH: + - **SAMPLE_PARTITION_WATERSHED** = **0** - **SAMPLE_PARTITION_MONOTONE** = **1** - **SAMPLE_PARTITION_LAYERS** = **2** +- **PARSED_GEOMETRY_MESH_INSTANCES** = **0** + +- **PARSED_GEOMETRY_STATIC_COLLIDERS** = **1** + +- **PARSED_GEOMETRY_BOTH** = **2** + Property Descriptions --------------------- @@ -222,6 +242,26 @@ Property Descriptions | *Getter* | get_filter_low_hanging_obstacles() | +----------+-----------------------------------------+ +.. _class_NavigationMesh_property_geometry/collision_mask: + +- :ref:`int` **geometry/collision_mask** + ++----------+---------------------------+ +| *Setter* | set_collision_mask(value) | ++----------+---------------------------+ +| *Getter* | get_collision_mask() | ++----------+---------------------------+ + +.. _class_NavigationMesh_property_geometry/parsed_geometry_type: + +- :ref:`int` **geometry/parsed_geometry_type** + ++----------+---------------------------------+ +| *Setter* | set_parsed_geometry_type(value) | ++----------+---------------------------------+ +| *Getter* | get_parsed_geometry_type() | ++----------+---------------------------------+ + .. _class_NavigationMesh_property_polygon/verts_per_poly: - :ref:`float` **polygon/verts_per_poly** @@ -277,6 +317,10 @@ Method Descriptions - void **create_from_mesh** **(** :ref:`Mesh` mesh **)** +.. _class_NavigationMesh_method_get_collision_mask_bit: + +- :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const + .. _class_NavigationMesh_method_get_polygon: - :ref:`PoolIntArray` **get_polygon** **(** :ref:`int` idx **)** @@ -289,6 +333,10 @@ Method Descriptions - :ref:`PoolVector3Array` **get_vertices** **(** **)** const +.. _class_NavigationMesh_method_set_collision_mask_bit: + +- void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** + .. _class_NavigationMesh_method_set_vertices: - void **set_vertices** **(** :ref:`PoolVector3Array` vertices **)** diff --git a/classes/class_nodepath.rst b/classes/class_nodepath.rst index f289ff95e..a5cc144b4 100644 --- a/classes/class_nodepath.rst +++ b/classes/class_nodepath.rst @@ -91,11 +91,11 @@ Get the number of resource names in the path. - :ref:`bool` **is_absolute** **(** **)** -Return ``true`` if the node path is absolute (not relative). +Returns ``true`` if the node path is absolute (not relative). .. _class_NodePath_method_is_empty: - :ref:`bool` **is_empty** **(** **)** -Return ``true`` if the node path is empty. +Returns ``true`` if the node path is empty. diff --git a/classes/class_object.rst b/classes/class_object.rst index 895064aa4..00209406b 100644 --- a/classes/class_object.rst +++ b/classes/class_object.rst @@ -7,7 +7,7 @@ Object ====== -**Inherited By:** :ref:`ARVRPositionalTracker`, :ref:`ARVRServer`, :ref:`AudioServer`, :ref:`ClassDB`, :ref:`EditorFileSystemDirectory`, :ref:`EditorSelection`, :ref:`Engine`, :ref:`Geometry`, :ref:`GodotSharp`, :ref:`IP`, :ref:`Input`, :ref:`InputMap`, :ref:`JSON`, :ref:`JavaScript`, :ref:`MainLoop`, :ref:`Node`, :ref:`OS`, :ref:`Performance`, :ref:`Physics2DDirectBodyState`, :ref:`Physics2DDirectSpaceState`, :ref:`Physics2DServer`, :ref:`PhysicsDirectBodyState`, :ref:`PhysicsDirectSpaceState`, :ref:`PhysicsServer`, :ref:`ProjectSettings`, :ref:`Reference`, :ref:`ResourceLoader`, :ref:`ResourceSaver`, :ref:`TranslationServer`, :ref:`TreeItem`, :ref:`UndoRedo`, :ref:`VisualScriptEditor`, :ref:`VisualServer` +**Inherited By:** :ref:`ARVRPositionalTracker`, :ref:`ARVRServer`, :ref:`AudioServer`, :ref:`ClassDB`, :ref:`EditorFileSystemDirectory`, :ref:`EditorNavigationMeshGenerator`, :ref:`EditorSelection`, :ref:`Engine`, :ref:`Geometry`, :ref:`GodotSharp`, :ref:`IP`, :ref:`Input`, :ref:`InputMap`, :ref:`JSON`, :ref:`JavaScript`, :ref:`MainLoop`, :ref:`Node`, :ref:`OS`, :ref:`Performance`, :ref:`Physics2DDirectBodyState`, :ref:`Physics2DDirectSpaceState`, :ref:`Physics2DServer`, :ref:`PhysicsDirectBodyState`, :ref:`PhysicsDirectSpaceState`, :ref:`PhysicsServer`, :ref:`ProjectSettings`, :ref:`Reference`, :ref:`ResourceLoader`, :ref:`ResourceSaver`, :ref:`TranslationServer`, :ref:`TreeItem`, :ref:`UndoRedo`, :ref:`VisualScriptEditor`, :ref:`VisualServer` **Category:** Core diff --git a/classes/class_optionbutton.rst b/classes/class_optionbutton.rst index 4b35c6a78..8274438ad 100644 --- a/classes/class_optionbutton.rst +++ b/classes/class_optionbutton.rst @@ -163,25 +163,25 @@ Clear all the items in the ``OptionButton``. - :ref:`int` **get_item_count** **(** **)** const -Return the amount of items in the OptionButton. +Returns the amount of items in the OptionButton. .. _class_OptionButton_method_get_item_icon: - :ref:`Texture` **get_item_icon** **(** :ref:`int` idx **)** const -Return the icon of the item at index "idx". +Returns the icon of the item at index "idx". .. _class_OptionButton_method_get_item_id: - :ref:`int` **get_item_id** **(** :ref:`int` idx **)** const -Return the ID of the item at index ``idx``. +Returns the ID of the item at index ``idx``. .. _class_OptionButton_method_get_item_index: - :ref:`int` **get_item_index** **(** :ref:`int` id **)** const -Return the index of the item with the given ``id``. +Returns the index of the item with the given ``id``. .. _class_OptionButton_method_get_item_metadata: @@ -191,13 +191,13 @@ Return the index of the item with the given ``id``. - :ref:`String` **get_item_text** **(** :ref:`int` idx **)** const -Return the text of the item at index "idx". +Returns the text of the item at index "idx". .. _class_OptionButton_method_get_popup: - :ref:`PopupMenu` **get_popup** **(** **)** const -Return the :ref:`PopupMenu` contained in this button. +Returns the :ref:`PopupMenu` contained in this button. .. _class_OptionButton_method_get_selected_id: diff --git a/classes/class_os.rst b/classes/class_os.rst index 701a00111..e78b22ef9 100644 --- a/classes/class_os.rst +++ b/classes/class_os.rst @@ -54,189 +54,191 @@ Properties Methods ------- -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`alert` **(** :ref:`String` text, :ref:`String` title="Alert!" **)** | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_draw` **(** **)** const | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_use_threads` **(** **)** const | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`center_window` **(** **)** | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`close_midi_inputs` **(** **)** | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`delay_msec` **(** :ref:`int` msec **)** const | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`delay_usec` **(** :ref:`int` usec **)** const | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`dump_memory_to_file` **(** :ref:`String` file **)** | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`dump_resources_to_file` **(** :ref:`String` file **)** | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`execute` **(** :ref:`String` path, :ref:`PoolStringArray` arguments, :ref:`bool` blocking, :ref:`Array` output=[ ] **)** | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find_scancode_from_string` **(** :ref:`String` string **)** const | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_audio_driver_count` **(** **)** const | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_audio_driver_name` **(** :ref:`int` driver **)** const | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_cmdline_args` **(** **)** | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_connected_midi_inputs` **(** **)** | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`VideoDriver` | :ref:`get_current_video_driver` **(** **)** const | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_date` **(** :ref:`bool` utc=false **)** const | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_datetime` **(** :ref:`bool` utc=false **)** const | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_datetime_from_unix_time` **(** :ref:`int` unix_time_val **)** const | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_dynamic_memory_usage` **(** **)** const | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_environment` **(** :ref:`String` environment **)** const | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_executable_path` **(** **)** const | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_ime_selection` **(** **)** const | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_ime_text` **(** **)** const | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_latin_keyboard_variant` **(** **)** const | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_locale` **(** **)** const | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_model_name` **(** **)** const | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_name` **(** **)** const | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_power_percent_left` **(** **)** | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_power_seconds_left` **(** **)** | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PowerState` | :ref:`get_power_state` **(** **)** | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_process_id` **(** **)** const | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_processor_count` **(** **)** const | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_real_window_size` **(** **)** const | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_scancode_string` **(** :ref:`int` code **)** const | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_screen_count` **(** **)** const | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_screen_dpi` **(** :ref:`int` screen=-1 **)** const | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_screen_position` **(** :ref:`int` screen=-1 **)** const | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_screen_size` **(** :ref:`int` screen=-1 **)** const | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_splash_tick_msec` **(** **)** const | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_static_memory_peak_usage` **(** **)** const | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_static_memory_usage` **(** **)** const | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_system_dir` **(** :ref:`SystemDir` dir **)** const | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_system_time_msecs` **(** **)** const | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_system_time_secs` **(** **)** const | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_ticks_msec` **(** **)** const | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_ticks_usec` **(** **)** const | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_time` **(** :ref:`bool` utc=false **)** const | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_time_zone_info` **(** **)** const | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_unique_id` **(** **)** const | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_unix_time` **(** **)** const | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_unix_time_from_datetime` **(** :ref:`Dictionary` datetime **)** const | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_user_data_dir` **(** **)** const | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_video_driver_count` **(** **)** const | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_video_driver_name` **(** :ref:`VideoDriver` driver **)** const | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_virtual_keyboard_height` **(** **)** | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_window_safe_area` **(** **)** const | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_environment` **(** :ref:`String` environment **)** const | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_feature` **(** :ref:`String` tag_name **)** const | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_touchscreen_ui_hint` **(** **)** const | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_virtual_keyboard` **(** **)** const | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`hide_virtual_keyboard` **(** **)** | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_debug_build` **(** **)** const | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_ok_left_and_cancel_right` **(** **)** const | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_scancode_unicode` **(** :ref:`int` code **)** const | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_stdout_verbose` **(** **)** const | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_userfs_persistent` **(** **)** const | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_window_always_on_top` **(** **)** const | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`kill` **(** :ref:`int` pid **)** | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`move_window_to_foreground` **(** **)** | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`native_video_is_playing` **(** **)** | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`native_video_pause` **(** **)** | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`native_video_play` **(** :ref:`String` path, :ref:`float` volume, :ref:`String` audio_track, :ref:`String` subtitle_track **)** | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`native_video_stop` **(** **)** | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`native_video_unpause` **(** **)** | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`open_midi_inputs` **(** **)** | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`print_all_resources` **(** :ref:`String` tofile="" **)** | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`print_all_textures_by_size` **(** **)** | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`print_resources_by_type` **(** :ref:`PoolStringArray` types **)** | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`print_resources_in_use` **(** :ref:`bool` short=false **)** | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`request_attention` **(** **)** | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`request_permission` **(** :ref:`String` name **)** | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_icon` **(** :ref:`Image` icon **)** | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ime_active` **(** :ref:`bool` active **)** | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ime_position` **(** :ref:`Vector2` position **)** | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`set_thread_name` **(** :ref:`String` name **)** | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_file_access_save_and_swap` **(** :ref:`bool` enabled **)** | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_window_always_on_top` **(** :ref:`bool` enabled **)** | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_window_title` **(** :ref:`String` title **)** | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`shell_open` **(** :ref:`String` uri **)** | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`show_virtual_keyboard` **(** :ref:`String` existing_text="" **)** | -+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`alert` **(** :ref:`String` text, :ref:`String` title="Alert!" **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`can_draw` **(** **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`can_use_threads` **(** **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`center_window` **(** **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`close_midi_inputs` **(** **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`delay_msec` **(** :ref:`int` msec **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`delay_usec` **(** :ref:`int` usec **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`dump_memory_to_file` **(** :ref:`String` file **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`dump_resources_to_file` **(** :ref:`String` file **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`execute` **(** :ref:`String` path, :ref:`PoolStringArray` arguments, :ref:`bool` blocking, :ref:`Array` output=[ ], :ref:`bool` read_stderr=false **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`find_scancode_from_string` **(** :ref:`String` string **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_audio_driver_count` **(** **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_audio_driver_name` **(** :ref:`int` driver **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_cmdline_args` **(** **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_connected_midi_inputs` **(** **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`VideoDriver` | :ref:`get_current_video_driver` **(** **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_date` **(** :ref:`bool` utc=false **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_datetime` **(** :ref:`bool` utc=false **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_datetime_from_unix_time` **(** :ref:`int` unix_time_val **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_dynamic_memory_usage` **(** **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_environment` **(** :ref:`String` environment **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_executable_path` **(** **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_ime_selection` **(** **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_ime_text` **(** **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_latin_keyboard_variant` **(** **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_locale` **(** **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_model_name` **(** **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_name` **(** **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_power_percent_left` **(** **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_power_seconds_left` **(** **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PowerState` | :ref:`get_power_state` **(** **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_process_id` **(** **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_processor_count` **(** **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_real_window_size` **(** **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_scancode_string` **(** :ref:`int` code **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_screen_count` **(** **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_screen_dpi` **(** :ref:`int` screen=-1 **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_screen_position` **(** :ref:`int` screen=-1 **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_screen_size` **(** :ref:`int` screen=-1 **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_splash_tick_msec` **(** **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_static_memory_peak_usage` **(** **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_static_memory_usage` **(** **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_system_dir` **(** :ref:`SystemDir` dir **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_system_time_msecs` **(** **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_system_time_secs` **(** **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_ticks_msec` **(** **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_ticks_usec` **(** **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_time` **(** :ref:`bool` utc=false **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_time_zone_info` **(** **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_unique_id` **(** **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_unix_time` **(** **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_unix_time_from_datetime` **(** :ref:`Dictionary` datetime **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_user_data_dir` **(** **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_video_driver_count` **(** **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_video_driver_name` **(** :ref:`VideoDriver` driver **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_virtual_keyboard_height` **(** **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_window_safe_area` **(** **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_environment` **(** :ref:`String` environment **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_feature` **(** :ref:`String` tag_name **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_touchscreen_ui_hint` **(** **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_virtual_keyboard` **(** **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`hide_virtual_keyboard` **(** **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_debug_build` **(** **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_ok_left_and_cancel_right` **(** **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_scancode_unicode` **(** :ref:`int` code **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_stdout_verbose` **(** **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_userfs_persistent` **(** **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_window_always_on_top` **(** **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`kill` **(** :ref:`int` pid **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`move_window_to_foreground` **(** **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`native_video_is_playing` **(** **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`native_video_pause` **(** **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`native_video_play` **(** :ref:`String` path, :ref:`float` volume, :ref:`String` audio_track, :ref:`String` subtitle_track **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`native_video_stop` **(** **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`native_video_unpause` **(** **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`open_midi_inputs` **(** **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`print_all_resources` **(** :ref:`String` tofile="" **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`print_all_textures_by_size` **(** **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`print_resources_by_type` **(** :ref:`PoolStringArray` types **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`print_resources_in_use` **(** :ref:`bool` short=false **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`request_attention` **(** **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`request_permission` **(** :ref:`String` name **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_icon` **(** :ref:`Image` icon **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ime_active` **(** :ref:`bool` active **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ime_position` **(** :ref:`Vector2` position **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_native_icon` **(** :ref:`String` filename **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`set_thread_name` **(** :ref:`String` name **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_use_file_access_save_and_swap` **(** :ref:`bool` enabled **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_window_always_on_top` **(** :ref:`bool` enabled **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_window_title` **(** :ref:`String` title **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`shell_open` **(** :ref:`String` uri **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`show_virtual_keyboard` **(** :ref:`String` existing_text="" **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ @@ -678,7 +680,7 @@ At the end of the file is a statistic of all used Resource Types. .. _class_OS_method_execute: -- :ref:`int` **execute** **(** :ref:`String` path, :ref:`PoolStringArray` arguments, :ref:`bool` blocking, :ref:`Array` output=[ ] **)** +- :ref:`int` **execute** **(** :ref:`String` path, :ref:`PoolStringArray` arguments, :ref:`bool` blocking, :ref:`Array` output=[ ], :ref:`bool` read_stderr=false **)** Execute the file at the given path with the arguments passed as an array of strings. Platform path resolution will take place. The resolved file must exist and be executable. @@ -1179,7 +1181,9 @@ At the moment this function is only used by ``AudioDriverOpenSL`` to request per - void **set_icon** **(** :ref:`Image` icon **)** -Sets the game's icon. +Sets the game's icon using an :ref:`Image` resource. + +The same image is used for window caption, taskbar/dock and window selection dialog. Image is scaled as needed. .. _class_OS_method_set_ime_active: @@ -1193,6 +1197,16 @@ Sets whether IME input mode should be enabled. Sets position of IME suggestion list popup (in window coordinates). +.. _class_OS_method_set_native_icon: + +- void **set_native_icon** **(** :ref:`String` filename **)** + +Sets the game's icon using a multi-size platform-specific icon file (``*.ico`` on Windows and ``*.icns`` on macOS). + +Appropriate size sub-icons are used for window caption, taskbar/dock and window selection dialog. + +Note: This method is only implemented on macOS and Windows. + .. _class_OS_method_set_thread_name: - :ref:`Error` **set_thread_name** **(** :ref:`String` name **)** diff --git a/classes/class_packetpeer.rst b/classes/class_packetpeer.rst index 928c7a530..7789df59a 100644 --- a/classes/class_packetpeer.rst +++ b/classes/class_packetpeer.rst @@ -9,7 +9,7 @@ PacketPeer **Inherits:** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`NetworkedMultiplayerPeer`, :ref:`PacketPeerGDNative`, :ref:`PacketPeerStream`, :ref:`PacketPeerUDP`, :ref:`WebRTCPeer`, :ref:`WebSocketPeer` +**Inherited By:** :ref:`NetworkedMultiplayerPeer`, :ref:`PacketPeerGDNative`, :ref:`PacketPeerStream`, :ref:`PacketPeerUDP`, :ref:`WebRTCDataChannel`, :ref:`WebSocketPeer` **Category:** Core @@ -73,7 +73,7 @@ Method Descriptions - :ref:`int` **get_available_packet_count** **(** **)** const -Return the number of packets currently available in the ring-buffer. +Returns the number of packets currently available in the ring-buffer. .. _class_PacketPeer_method_get_packet: @@ -85,7 +85,7 @@ Get a raw packet. - :ref:`Error` **get_packet_error** **(** **)** const -Return the error state of the last packet received (via :ref:`get_packet` and :ref:`get_var`). +Returns the error state of the last packet received (via :ref:`get_packet` and :ref:`get_var`). .. _class_PacketPeer_method_get_var: diff --git a/classes/class_packetpeerudp.rst b/classes/class_packetpeerudp.rst index 6cad76ace..dcfb8211f 100644 --- a/classes/class_packetpeerudp.rst +++ b/classes/class_packetpeerudp.rst @@ -53,19 +53,19 @@ Close the UDP socket the ``PacketPeerUDP`` is currently listening on. - :ref:`String` **get_packet_ip** **(** **)** const -Return the IP of the remote peer that sent the last packet(that was received with :ref:`PacketPeer.get_packet` or :ref:`PacketPeer.get_var`). +Returns the IP of the remote peer that sent the last packet(that was received with :ref:`PacketPeer.get_packet` or :ref:`PacketPeer.get_var`). .. _class_PacketPeerUDP_method_get_packet_port: - :ref:`int` **get_packet_port** **(** **)** const -Return the port of the remote peer that sent the last packet(that was received with :ref:`PacketPeer.get_packet` or :ref:`PacketPeer.get_var`). +Returns the port of the remote peer that sent the last packet(that was received with :ref:`PacketPeer.get_packet` or :ref:`PacketPeer.get_var`). .. _class_PacketPeerUDP_method_is_listening: - :ref:`bool` **is_listening** **(** **)** const -Return whether this ``PacketPeerUDP`` is listening. +Returns whether this ``PacketPeerUDP`` is listening. .. _class_PacketPeerUDP_method_listen: diff --git a/classes/class_poolbytearray.rst b/classes/class_poolbytearray.rst index eb9aba510..4012ca764 100644 --- a/classes/class_poolbytearray.rst +++ b/classes/class_poolbytearray.rst @@ -141,13 +141,13 @@ Change the byte at the given index. - :ref:`String` **sha256_string** **(** **)** -Return SHA256 string of the PoolByteArray. +Returns SHA256 string of the PoolByteArray. .. _class_PoolByteArray_method_size: - :ref:`int` **size** **(** **)** -Return the size of the array. +Returns the size of the array. .. _class_PoolByteArray_method_subarray: diff --git a/classes/class_poolcolorarray.rst b/classes/class_poolcolorarray.rst index be7c9c316..f4d26c35f 100644 --- a/classes/class_poolcolorarray.rst +++ b/classes/class_poolcolorarray.rst @@ -105,5 +105,5 @@ Change the :ref:`Color` at the given index. - :ref:`int` **size** **(** **)** -Return the size of the array. +Returns the size of the array. diff --git a/classes/class_poolintarray.rst b/classes/class_poolintarray.rst index 01b8486bf..56a9ae586 100644 --- a/classes/class_poolintarray.rst +++ b/classes/class_poolintarray.rst @@ -105,5 +105,5 @@ Change the int at the given index. - :ref:`int` **size** **(** **)** -Return the array size. +Returns the array size. diff --git a/classes/class_poolrealarray.rst b/classes/class_poolrealarray.rst index 3dbdd76b6..d9d2e5cdb 100644 --- a/classes/class_poolrealarray.rst +++ b/classes/class_poolrealarray.rst @@ -105,5 +105,5 @@ Change the float at the given index. - :ref:`int` **size** **(** **)** -Return the size of the array. +Returns the size of the array. diff --git a/classes/class_poolstringarray.rst b/classes/class_poolstringarray.rst index 7231bc795..931743166 100644 --- a/classes/class_poolstringarray.rst +++ b/classes/class_poolstringarray.rst @@ -113,5 +113,5 @@ Change the :ref:`String` at the given index. - :ref:`int` **size** **(** **)** -Return the size of the array. +Returns the size of the array. diff --git a/classes/class_poolvector2array.rst b/classes/class_poolvector2array.rst index be06d8123..97db800c7 100644 --- a/classes/class_poolvector2array.rst +++ b/classes/class_poolvector2array.rst @@ -105,5 +105,5 @@ Change the :ref:`Vector2` at the given index. - :ref:`int` **size** **(** **)** -Return the size of the array. +Returns the size of the array. diff --git a/classes/class_poolvector3array.rst b/classes/class_poolvector3array.rst index 416eea819..54857774d 100644 --- a/classes/class_poolvector3array.rst +++ b/classes/class_poolvector3array.rst @@ -105,5 +105,5 @@ Change the :ref:`Vector3` at the given index. - :ref:`int` **size** **(** **)** -Return the size of the array. +Returns the size of the array. diff --git a/classes/class_popup.rst b/classes/class_popup.rst index 59ec904aa..c4fd29446 100644 --- a/classes/class_popup.rst +++ b/classes/class_popup.rst @@ -28,15 +28,17 @@ Properties Methods ------- -+------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`popup` **(** :ref:`Rect2` bounds=Rect2( 0, 0, 0, 0 ) **)** | -+------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`popup_centered` **(** :ref:`Vector2` size=Vector2( 0, 0 ) **)** | -+------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`popup_centered_minsize` **(** :ref:`Vector2` minsize=Vector2( 0, 0 ) **)** | -+------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`popup_centered_ratio` **(** :ref:`float` ratio=0.75 **)** | -+------+--------------------------------------------------------------------------------------------------------------------------------------------+ ++------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`popup` **(** :ref:`Rect2` bounds=Rect2( 0, 0, 0, 0 ) **)** | ++------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`popup_centered` **(** :ref:`Vector2` size=Vector2( 0, 0 ) **)** | ++------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`popup_centered_clamped` **(** :ref:`Vector2` size=Vector2( 0, 0 ), :ref:`float` fallback_ratio=0.75 **)** | ++------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`popup_centered_minsize` **(** :ref:`Vector2` minsize=Vector2( 0, 0 ) **)** | ++------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`popup_centered_ratio` **(** :ref:`float` ratio=0.75 **)** | ++------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -99,6 +101,12 @@ Popup (show the control in modal form). Popup (show the control in modal form) in the center of the screen relative to its current canvas transform, at the current size, or at a size determined by "size". +.. _class_Popup_method_popup_centered_clamped: + +- void **popup_centered_clamped** **(** :ref:`Vector2` size=Vector2( 0, 0 ), :ref:`float` fallback_ratio=0.75 **)** + +Popup (show the control in modal form) in the center of the screen relative to the current canvas transform, clamping the size to ``size``, then ensuring the popup is no larger than the viewport size multiplied by ``fallback_ratio``. + .. _class_Popup_method_popup_centered_minsize: - void **popup_centered_minsize** **(** :ref:`Vector2` minsize=Vector2( 0, 0 ) **)** diff --git a/classes/class_popupmenu.rst b/classes/class_popupmenu.rst index 1449edfec..81f943c7b 100644 --- a/classes/class_popupmenu.rst +++ b/classes/class_popupmenu.rst @@ -321,25 +321,25 @@ Clear the popup menu, in effect removing all items. - :ref:`int` **get_item_accelerator** **(** :ref:`int` idx **)** const -Return the accelerator of the item at index "idx". Accelerators are special combinations of keys that activate the item, no matter which control is focused. +Returns the accelerator of the item at index "idx". Accelerators are special combinations of keys that activate the item, no matter which control is focused. .. _class_PopupMenu_method_get_item_count: - :ref:`int` **get_item_count** **(** **)** const -Return the amount of items. +Returns the amount of items. .. _class_PopupMenu_method_get_item_icon: - :ref:`Texture` **get_item_icon** **(** :ref:`int` idx **)** const -Return the icon of the item at index "idx". +Returns the icon of the item at index "idx". .. _class_PopupMenu_method_get_item_id: - :ref:`int` **get_item_id** **(** :ref:`int` idx **)** const -Return the id of the item at index "idx". +Returns the id of the item at index "idx". .. _class_PopupMenu_method_get_item_index: @@ -351,7 +351,7 @@ Find and return the index of the item containing a given id. - :ref:`Variant` **get_item_metadata** **(** :ref:`int` idx **)** const -Return the metadata of an item, which might be of any type. You can set it with :ref:`set_item_metadata`, which provides a simple way of assigning context data to items. +Returns the metadata of an item, which might be of any type. You can set it with :ref:`set_item_metadata`, which provides a simple way of assigning context data to items. .. _class_PopupMenu_method_get_item_shortcut: @@ -361,13 +361,13 @@ Return the metadata of an item, which might be of any type. You can set it with - :ref:`String` **get_item_submenu** **(** :ref:`int` idx **)** const -Return the submenu name of the item at index "idx". +Returns the submenu name of the item at index "idx". .. _class_PopupMenu_method_get_item_text: - :ref:`String` **get_item_text** **(** :ref:`int` idx **)** const -Return the text of the item at index "idx". +Returns the text of the item at index "idx". .. _class_PopupMenu_method_get_item_tooltip: @@ -381,31 +381,31 @@ Return the text of the item at index "idx". - :ref:`bool` **is_item_checkable** **(** :ref:`int` idx **)** const -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. +Returns 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_method_is_item_checked: - :ref:`bool` **is_item_checked** **(** :ref:`int` idx **)** const -Return whether the item at index "idx" is checked. +Returns whether the item at index "idx" is checked. .. _class_PopupMenu_method_is_item_disabled: - :ref:`bool` **is_item_disabled** **(** :ref:`int` idx **)** const -Return whether the item at index "idx" is disabled. When it is disabled it can't be selected, or its action invoked. +Returns whether the item at index "idx" is disabled. When it is disabled it can't be selected, or its action invoked. .. _class_PopupMenu_method_is_item_radio_checkable: - :ref:`bool` **is_item_radio_checkable** **(** :ref:`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. +Returns 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_method_is_item_separator: - :ref:`bool` **is_item_separator** **(** :ref:`int` idx **)** const -Return whether the item is a separator. If it is, it would be displayed as a line. +Returns whether the item is a separator. If it is, it would be displayed as a line. .. _class_PopupMenu_method_is_item_shortcut_disabled: diff --git a/classes/class_projectsettings.rst b/classes/class_projectsettings.rst index c68f27a00..1301086f3 100644 --- a/classes/class_projectsettings.rst +++ b/classes/class_projectsettings.rst @@ -32,12 +32,16 @@ Properties +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`application/config/icon` | +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`application/config/macos_native_icon` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`application/config/name` | +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`application/config/project_settings_override` | +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`application/config/use_custom_user_dir` | +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`application/config/windows_native_icon` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`application/run/disable_stderr` | +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`application/run/disable_stdout` | @@ -628,6 +632,10 @@ The :ref:`application/config/use_custom_user_dir` **application/config/macos_native_icon** + .. _class_ProjectSettings_property_application/config/name: - :ref:`String` **application/config/name** @@ -646,6 +654,10 @@ Specifies a file to override project settings. For example: ``user://custom_sett If ``true``, the project will save user data to its own user directory (see :ref:`application/config/custom_user_dir_name`). This setting is only effective on desktop platforms. A name must be set in the :ref:`application/config/custom_user_dir_name` setting for this to take effect. If ``false``, the project will save user data to ``(OS user data directory)/Godot/app_userdata/(project name)``. +.. _class_ProjectSettings_property_application/config/windows_native_icon: + +- :ref:`String` **application/config/windows_native_icon** + .. _class_ProjectSettings_property_application/run/disable_stderr: - :ref:`bool` **application/run/disable_stderr** diff --git a/classes/class_quat.rst b/classes/class_quat.rst index eb7ff835c..70ff5a92b 100644 --- a/classes/class_quat.rst +++ b/classes/class_quat.rst @@ -151,7 +151,7 @@ Returns the dot product of two quaternions. - :ref:`Vector3` **get_euler** **(** **)** -Return Euler angles (in the YXZ convention: first Z, then X, and Y last) corresponding to the rotation represented by the unit quaternion. Returned vector contains the rotation angles in the format (X-angle, Y-angle, Z-angle). +Returns Euler angles (in the YXZ convention: first Z, then X, and Y last) corresponding to the rotation represented by the unit quaternion. Returned vector contains the rotation angles in the format (X-angle, Y-angle, Z-angle). .. _class_Quat_method_inverse: diff --git a/classes/class_raycast.rst b/classes/class_raycast.rst index d9b44de08..e95750c17 100644 --- a/classes/class_raycast.rst +++ b/classes/class_raycast.rst @@ -185,7 +185,7 @@ Use this method to update the collision information immediately instead of waiti - :ref:`Object` **get_collider** **(** **)** const -Return the first object that the ray intersects, or ``null`` if no object is intersecting the ray (i.e. :ref:`is_colliding` returns ``false``). +Returns the first object that the ray intersects, or ``null`` if no object is intersecting the ray (i.e. :ref:`is_colliding` returns ``false``). .. _class_RayCast_method_get_collider_shape: @@ -215,7 +215,7 @@ Returns the collision point at which the ray intersects the closest object. Note - :ref:`bool` **is_colliding** **(** **)** const -Return whether any object is intersecting with the ray's vector (considering the vector length). +Returns whether any object is intersecting with the ray's vector (considering the vector length). .. _class_RayCast_method_remove_exception: diff --git a/classes/class_raycast2d.rst b/classes/class_raycast2d.rst index 1be3acd82..f2a7f382d 100644 --- a/classes/class_raycast2d.rst +++ b/classes/class_raycast2d.rst @@ -183,7 +183,7 @@ Updates the collision information for the ray. Use this method to update the col - :ref:`Object` **get_collider** **(** **)** const -Return the first object that the ray intersects, or ``null`` if no object is intersecting the ray (i.e. :ref:`is_colliding` returns ``false``). +Returns the first object that the ray intersects, or ``null`` if no object is intersecting the ray (i.e. :ref:`is_colliding` returns ``false``). .. _class_RayCast2D_method_get_collider_shape: @@ -195,7 +195,7 @@ Returns the shape ID of the first object that the ray intersects, or ``0`` if no - :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const -Return an individual bit on the collision mask. +Returns an individual bit on the collision mask. .. _class_RayCast2D_method_get_collision_normal: @@ -213,7 +213,7 @@ Returns the collision point at which the ray intersects the closest object. Note - :ref:`bool` **is_colliding** **(** **)** const -Return whether any object is intersecting with the ray's vector (considering the vector length). +Returns whether any object is intersecting with the ray's vector (considering the vector length). .. _class_RayCast2D_method_remove_exception: diff --git a/classes/class_reference.rst b/classes/class_reference.rst index 29af28036..986459b24 100644 --- a/classes/class_reference.rst +++ b/classes/class_reference.rst @@ -9,7 +9,7 @@ Reference **Inherits:** :ref:`Object` -**Inherited By:** :ref:`ARVRInterface`, :ref:`AStar`, :ref:`AnimationTrackEditPlugin`, :ref:`AudioEffectInstance`, :ref:`AudioStreamPlayback`, :ref:`ConfigFile`, :ref:`Directory`, :ref:`EditorExportPlugin`, :ref:`EditorFeatureProfile`, :ref:`EditorImportPlugin`, :ref:`EditorInspectorPlugin`, :ref:`EditorResourceConversionPlugin`, :ref:`EditorResourcePreviewGenerator`, :ref:`EditorSceneImporter`, :ref:`EditorScenePostImport`, :ref:`EditorScript`, :ref:`EncodedObjectAsID`, :ref:`Expression`, :ref:`File`, :ref:`FuncRef`, :ref:`GDNative`, :ref:`GDScriptFunctionState`, :ref:`GDScriptNativeClass`, :ref:`HTTPClient`, :ref:`JSONParseResult`, :ref:`KinematicCollision`, :ref:`KinematicCollision2D`, :ref:`Marshalls`, :ref:`MeshDataTool`, :ref:`MultiplayerAPI`, :ref:`Mutex`, :ref:`PCKPacker`, :ref:`PackedDataContainerRef`, :ref:`PacketPeer`, :ref:`Physics2DShapeQueryParameters`, :ref:`Physics2DShapeQueryResult`, :ref:`Physics2DTestMotionResult`, :ref:`PhysicsShapeQueryParameters`, :ref:`PhysicsShapeQueryResult`, :ref:`RandomNumberGenerator`, :ref:`RegEx`, :ref:`RegExMatch`, :ref:`Resource`, :ref:`ResourceFormatLoader`, :ref:`ResourceFormatSaver`, :ref:`ResourceImporter`, :ref:`ResourceInteractiveLoader`, :ref:`SceneState`, :ref:`SceneTreeTimer`, :ref:`Semaphore`, :ref:`SpatialGizmo`, :ref:`SpatialVelocityTracker`, :ref:`StreamPeer`, :ref:`SurfaceTool`, :ref:`TCP_Server`, :ref:`Thread`, :ref:`TriangleMesh`, :ref:`UPNP`, :ref:`UPNPDevice`, :ref:`VisualScriptFunctionState`, :ref:`WeakRef`, :ref:`XMLParser` +**Inherited By:** :ref:`ARVRInterface`, :ref:`AStar`, :ref:`AnimationTrackEditPlugin`, :ref:`AudioEffectInstance`, :ref:`AudioStreamPlayback`, :ref:`ConfigFile`, :ref:`Directory`, :ref:`EditorExportPlugin`, :ref:`EditorFeatureProfile`, :ref:`EditorImportPlugin`, :ref:`EditorInspectorPlugin`, :ref:`EditorResourceConversionPlugin`, :ref:`EditorResourcePreviewGenerator`, :ref:`EditorSceneImporter`, :ref:`EditorScenePostImport`, :ref:`EditorScript`, :ref:`EncodedObjectAsID`, :ref:`Expression`, :ref:`File`, :ref:`FuncRef`, :ref:`GDNative`, :ref:`GDScriptFunctionState`, :ref:`GDScriptNativeClass`, :ref:`HTTPClient`, :ref:`JSONParseResult`, :ref:`KinematicCollision`, :ref:`KinematicCollision2D`, :ref:`Marshalls`, :ref:`MeshDataTool`, :ref:`MultiplayerAPI`, :ref:`Mutex`, :ref:`PCKPacker`, :ref:`PackedDataContainerRef`, :ref:`PacketPeer`, :ref:`Physics2DShapeQueryParameters`, :ref:`Physics2DShapeQueryResult`, :ref:`Physics2DTestMotionResult`, :ref:`PhysicsShapeQueryParameters`, :ref:`PhysicsShapeQueryResult`, :ref:`RandomNumberGenerator`, :ref:`RegEx`, :ref:`RegExMatch`, :ref:`Resource`, :ref:`ResourceFormatLoader`, :ref:`ResourceFormatSaver`, :ref:`ResourceImporter`, :ref:`ResourceInteractiveLoader`, :ref:`SceneState`, :ref:`SceneTreeTimer`, :ref:`Semaphore`, :ref:`SpatialGizmo`, :ref:`SpatialVelocityTracker`, :ref:`StreamPeer`, :ref:`SurfaceTool`, :ref:`TCP_Server`, :ref:`Thread`, :ref:`TriangleMesh`, :ref:`UPNP`, :ref:`UPNPDevice`, :ref:`VisualScriptFunctionState`, :ref:`WeakRef`, :ref:`WebRTCPeerConnection`, :ref:`XMLParser` **Category:** Core diff --git a/classes/class_resourceinteractiveloader.rst b/classes/class_resourceinteractiveloader.rst index 12a78099c..d0de78bd9 100644 --- a/classes/class_resourceinteractiveloader.rst +++ b/classes/class_resourceinteractiveloader.rst @@ -43,19 +43,19 @@ Method Descriptions - :ref:`Resource` **get_resource** **(** **)** -Return the loaded resource (only if loaded). Otherwise, returns null. +Returns the loaded resource (only if loaded). Otherwise, returns null. .. _class_ResourceInteractiveLoader_method_get_stage: - :ref:`int` **get_stage** **(** **)** const -Return the load stage. The total amount of stages can be queried with :ref:`get_stage_count` +Returns the load stage. The total amount of stages can be queried with :ref:`get_stage_count` .. _class_ResourceInteractiveLoader_method_get_stage_count: - :ref:`int` **get_stage_count** **(** **)** const -Return the total amount of stages (calls to :ref:`poll`) needed to completely load this resource. +Returns the total amount of stages (calls to :ref:`poll`) needed to completely load this resource. .. _class_ResourceInteractiveLoader_method_poll: diff --git a/classes/class_resourceloader.rst b/classes/class_resourceloader.rst index b6037f58e..1a2e79564 100644 --- a/classes/class_resourceloader.rst +++ b/classes/class_resourceloader.rst @@ -57,7 +57,7 @@ Method Descriptions - :ref:`PoolStringArray` **get_recognized_extensions_for_type** **(** :ref:`String` type **)** -Return the list of recognized extensions for a resource type. +Returns the list of recognized extensions for a resource type. .. _class_ResourceLoader_method_has: diff --git a/classes/class_rigidbody.rst b/classes/class_rigidbody.rst index c140c07c8..5fc7bd09a 100644 --- a/classes/class_rigidbody.rst +++ b/classes/class_rigidbody.rst @@ -500,7 +500,7 @@ Applies a torque impulse which will be affected by the body mass and shape. This - :ref:`Array` **get_colliding_bodies** **(** **)** const -Return a list of the bodies colliding with this one. By default, number of max contacts reported is at 0, see the :ref:`contacts_reported` property to increase it. Note that the result of this test is not immediate after moving objects. For performance, list of collisions is updated once per frame and before the physics step. Consider using signals instead. +Returns a list of the bodies colliding with this one. By default, number of max contacts reported is at 0, see the :ref:`contacts_reported` property to increase it. Note that the result of this test is not immediate after moving objects. For performance, list of collisions is updated once per frame and before the physics step. Consider using signals instead. .. _class_RigidBody_method_set_axis_velocity: diff --git a/classes/class_scenetree.rst b/classes/class_scenetree.rst index 2bf5678b7..c07593eaf 100644 --- a/classes/class_scenetree.rst +++ b/classes/class_scenetree.rst @@ -157,6 +157,10 @@ Emitted when a node's configuration changed. Only emitted in tool mode. Emitted whenever a node is removed from the SceneTree. +.. _class_SceneTree_signal_node_renamed: + +- **node_renamed** **(** :ref:`Node` node **)** + .. _class_SceneTree_signal_physics_frame: - **physics_frame** **(** **)** diff --git a/classes/class_shape2d.rst b/classes/class_shape2d.rst index 9a601b43f..dc4f005d2 100644 --- a/classes/class_shape2d.rst +++ b/classes/class_shape2d.rst @@ -84,7 +84,7 @@ This method needs the transformation matrix for this shape (``local_xform``), th - :ref:`bool` **collide_with_motion** **(** :ref:`Transform2D` local_xform, :ref:`Vector2` local_motion, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform, :ref:`Vector2` shape_motion **)** -Return whether this shape would collide with another, if a given movement was applied. +Returns whether this shape would collide with another, if a given movement was applied. This method needs the transformation matrix for this shape (``local_xform``), the movement to test on this shape (``local_motion``), the shape to check collisions with (``with_shape``), the transformation matrix of that shape (``shape_xform``), and the movement to test onto the other object (``shape_motion``). diff --git a/classes/class_skeleton.rst b/classes/class_skeleton.rst index e03796409..3e73a60a7 100644 --- a/classes/class_skeleton.rst +++ b/classes/class_skeleton.rst @@ -138,55 +138,55 @@ Clear all the bones in this skeleton. - :ref:`int` **find_bone** **(** :ref:`String` name **)** const -Return the bone index that matches "name" as its name. +Returns the bone index that matches "name" as its name. .. _class_Skeleton_method_get_bone_count: - :ref:`int` **get_bone_count** **(** **)** const -Return the amount of bones in the skeleton. +Returns the amount of bones in the skeleton. .. _class_Skeleton_method_get_bone_custom_pose: - :ref:`Transform` **get_bone_custom_pose** **(** :ref:`int` bone_idx **)** const -Return the custom pose of the specified bone. Custom pose is applied on top of the rest pose. +Returns the custom pose of the specified bone. Custom pose is applied on top of the rest pose. .. _class_Skeleton_method_get_bone_global_pose: - :ref:`Transform` **get_bone_global_pose** **(** :ref:`int` bone_idx **)** const -Return the overall transform of the specified bone, with respect to the skeleton. Being relative to the skeleton frame, this is not the actual "global" transform of the bone. +Returns the overall transform of the specified bone, with respect to the skeleton. Being relative to the skeleton frame, this is not the actual "global" transform of the bone. .. _class_Skeleton_method_get_bone_name: - :ref:`String` **get_bone_name** **(** :ref:`int` bone_idx **)** const -Return the name of the bone at index "index". +Returns the name of the bone at index "index". .. _class_Skeleton_method_get_bone_parent: - :ref:`int` **get_bone_parent** **(** :ref:`int` bone_idx **)** const -Return the bone index which is the parent of the bone at "bone_idx". If -1, then bone has no parent. Note that the parent bone returned will always be less than "bone_idx". +Returns the bone index which is the parent of the bone at "bone_idx". If -1, then bone has no parent. Note that the parent bone returned will always be less than "bone_idx". .. _class_Skeleton_method_get_bone_pose: - :ref:`Transform` **get_bone_pose** **(** :ref:`int` bone_idx **)** const -Return the pose transform of the specified bone. Pose is applied on top of the custom pose, which is applied on top the rest pose. +Returns the pose transform of the specified bone. Pose is applied on top of the custom pose, which is applied on top the rest pose. .. _class_Skeleton_method_get_bone_rest: - :ref:`Transform` **get_bone_rest** **(** :ref:`int` bone_idx **)** const -Return the rest transform for a bone "bone_idx". +Returns the rest transform for a bone "bone_idx". .. _class_Skeleton_method_get_bone_transform: - :ref:`Transform` **get_bone_transform** **(** :ref:`int` bone_idx **)** const -Return the combination of custom pose and pose. The returned transform is in skeleton's reference frame. +Returns the combination of custom pose and pose. The returned transform is in skeleton's reference frame. .. _class_Skeleton_method_get_bound_child_nodes_to_bone: @@ -244,7 +244,7 @@ Set the bone index "parent_idx" as the parent of the bone at "bone_idx". If -1, - void **set_bone_pose** **(** :ref:`int` bone_idx, :ref:`Transform` pose **)** -Return the pose transform for bone "bone_idx". +Returns the pose transform for bone "bone_idx". .. _class_Skeleton_method_set_bone_rest: diff --git a/classes/class_spatialmaterial.rst b/classes/class_spatialmaterial.rst index 6039a45a6..e5ba41596 100644 --- a/classes/class_spatialmaterial.rst +++ b/classes/class_spatialmaterial.rst @@ -112,6 +112,8 @@ Properties +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`flags_use_point_size` | +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`flags_use_shadow_to_opacity` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`flags_vertex_lighting` | +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`flags_world_triplanar` | @@ -458,6 +460,8 @@ enum **CullMode**: .. _class_SpatialMaterial_constant_FLAG_ENSURE_CORRECT_NORMALS: +.. _class_SpatialMaterial_constant_FLAG_USE_SHADOW_TO_OPACITY: + .. _class_SpatialMaterial_constant_FLAG_MAX: enum **Flags**: @@ -498,7 +502,9 @@ enum **Flags**: - **FLAG_ENSURE_CORRECT_NORMALS** = **16** -- **FLAG_MAX** = **18** +- **FLAG_USE_SHADOW_TO_OPACITY** = **18** + +- **FLAG_MAX** = **19** .. _enum_SpatialMaterial_DiffuseMode: @@ -1129,6 +1135,16 @@ If ``true``, the object is unaffected by lighting. Default value: ``false``. If ``true``, render point size can be changed. Note: this is only effective for objects whose geometry is point-based rather than triangle-based. See also :ref:`params_point_size`. +.. _class_SpatialMaterial_property_flags_use_shadow_to_opacity: + +- :ref:`bool` **flags_use_shadow_to_opacity** + ++----------+-----------------+ +| *Setter* | set_flag(value) | ++----------+-----------------+ +| *Getter* | get_flag() | ++----------+-----------------+ + .. _class_SpatialMaterial_property_flags_vertex_lighting: - :ref:`bool` **flags_vertex_lighting** diff --git a/classes/class_sprite.rst b/classes/class_sprite.rst index a7c5ef4f5..efc570673 100644 --- a/classes/class_sprite.rst +++ b/classes/class_sprite.rst @@ -171,7 +171,7 @@ The texture's drawing offset. | *Getter* | is_region() | +----------+-------------------+ -If ``true``, texture is cut from a larger atlas texture. See ``region_rect``. Default value: ``false``. +If ``true``, texture is cut from a larger atlas texture. See :ref:`region_rect`. Default value: ``false``. .. _class_Sprite_property_region_filter_clip: @@ -228,7 +228,14 @@ Method Descriptions - :ref:`Rect2` **get_rect** **(** **)** const -Returns a Rect2 representing the Sprite's boundary relative to its local coordinates. +Returns a :ref:`Rect2` representing the Sprite's boundary in local coordinates. Can be used to detect if the Sprite was clicked. Example: + +:: + + func _input(event): + if event is InputEventMouseButton and event.pressed and event.button_index == BUTTON_LEFT: + if get_rect().has_point(to_local(event.position)): + print("A click!") .. _class_Sprite_method_is_pixel_opaque: diff --git a/classes/class_streampeer.rst b/classes/class_streampeer.rst index 9cf9326f4..d414fe3fe 100644 --- a/classes/class_streampeer.rst +++ b/classes/class_streampeer.rst @@ -143,13 +143,13 @@ Get a signed byte from the stream. - :ref:`int` **get_available_bytes** **(** **)** const -Return the amount of bytes this ``StreamPeer`` has available. +Returns the amount of bytes this ``StreamPeer`` has available. .. _class_StreamPeer_method_get_data: - :ref:`Array` **get_data** **(** :ref:`int` bytes **)** -Return a chunk data with the received bytes. The amount of bytes to be received can be requested in the "bytes" argument. If not enough bytes are available, the function will block until the desired amount is received. This function returns two values, an Error code and a data array. +Returns a chunk data with the received bytes. The amount of bytes to be received can be requested in the "bytes" argument. If not enough bytes are available, the function will block until the desired amount is received. This function returns two values, an Error code and a data array. .. _class_StreamPeer_method_get_double: @@ -167,7 +167,7 @@ Get a single-precision float from the stream. - :ref:`Array` **get_partial_data** **(** :ref:`int` bytes **)** -Return a chunk data with the received bytes. The amount of bytes to be received can be requested in the "bytes" argument. If not enough bytes are available, the function will return how many were actually received. This function returns two values, an Error code, and a data array. +Returns a chunk data with the received bytes. The amount of bytes to be received can be requested in the "bytes" argument. If not enough bytes are available, the function will return how many were actually received. This function returns two values, an Error code, and a data array. .. _class_StreamPeer_method_get_string: diff --git a/classes/class_streampeerssl.rst b/classes/class_streampeerssl.rst index f8455e326..8a9a6b32e 100644 --- a/classes/class_streampeerssl.rst +++ b/classes/class_streampeerssl.rst @@ -111,7 +111,7 @@ Disconnect from host. - :ref:`Status` **get_status** **(** **)** const -Return the status of the connection, one of STATUS\_\* enum. +Returns the status of the connection, one of STATUS\_\* enum. .. _class_StreamPeerSSL_method_poll: diff --git a/classes/class_streampeertcp.rst b/classes/class_streampeertcp.rst index ac0fbbefe..f5855971f 100644 --- a/classes/class_streampeertcp.rst +++ b/classes/class_streampeertcp.rst @@ -82,19 +82,19 @@ Disconnect from host. - :ref:`String` **get_connected_host** **(** **)** const -Return the IP of this peer. +Returns the IP of this peer. .. _class_StreamPeerTCP_method_get_connected_port: - :ref:`int` **get_connected_port** **(** **)** const -Return the port of this peer. +Returns the port of this peer. .. _class_StreamPeerTCP_method_get_status: - :ref:`Status` **get_status** **(** **)** -Return the status of the connection, see :ref:`Status`. +Returns the status of the connection, see :ref:`Status`. .. _class_StreamPeerTCP_method_is_connected_to_host: diff --git a/classes/class_stylebox.rst b/classes/class_stylebox.rst index 2de58004f..12abfa25f 100644 --- a/classes/class_stylebox.rst +++ b/classes/class_stylebox.rst @@ -137,7 +137,7 @@ Method Descriptions - :ref:`float` **get_margin** **(** :ref:`Margin` margin **)** const -Return the content margin offset for the specified margin +Returns the content margin offset for the specified margin Positive values reduce size inwards, unlike :ref:`Control`'s margin values. @@ -145,13 +145,13 @@ Positive values reduce size inwards, unlike :ref:`Control`'s marg - :ref:`Vector2` **get_minimum_size** **(** **)** const -Return the minimum size that this stylebox can be shrunk to. +Returns the minimum size that this stylebox can be shrunk to. .. _class_StyleBox_method_get_offset: - :ref:`Vector2` **get_offset** **(** **)** const -Return the "offset" of a stylebox, this is a helper function, like writing ``Vector2(style.get_margin(MARGIN_LEFT), style.get_margin(MARGIN_TOP))``. +Returns the "offset" of a stylebox, this is a helper function, like writing ``Vector2(style.get_margin(MARGIN_LEFT), style.get_margin(MARGIN_TOP))``. .. _class_StyleBox_method_test_mask: diff --git a/classes/class_surfacetool.rst b/classes/class_surfacetool.rst index 83bda9620..2468d4f98 100644 --- a/classes/class_surfacetool.rst +++ b/classes/class_surfacetool.rst @@ -50,8 +50,12 @@ Methods +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`ArrayMesh` | :ref:`commit` **(** :ref:`ArrayMesh` existing=null, :ref:`int` flags=97280 **)** | +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`commit_to_arrays` **(** **)** | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`create_from` **(** :ref:`Mesh` existing, :ref:`int` surface **)** | +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`create_from_blend_shape` **(** :ref:`Mesh` existing, :ref:`int` surface, :ref:`String` blend_shape **)** | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`deindex` **(** **)** | +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`generate_normals` **(** :ref:`bool` flip=false **)** | @@ -177,12 +181,20 @@ Clear all information passed into the surface tool so far. Returns a constructed :ref:`ArrayMesh` from current information passed in. If an existing :ref:`ArrayMesh` is passed in as an argument, will add an extra surface to the existing :ref:`ArrayMesh`. +.. _class_SurfaceTool_method_commit_to_arrays: + +- :ref:`Array` **commit_to_arrays** **(** **)** + .. _class_SurfaceTool_method_create_from: - void **create_from** **(** :ref:`Mesh` existing, :ref:`int` surface **)** Creates a vertex array from an existing :ref:`Mesh`. +.. _class_SurfaceTool_method_create_from_blend_shape: + +- void **create_from_blend_shape** **(** :ref:`Mesh` existing, :ref:`int` surface, :ref:`String` blend_shape **)** + .. _class_SurfaceTool_method_deindex: - void **deindex** **(** **)** diff --git a/classes/class_tcp_server.rst b/classes/class_tcp_server.rst index 485968a3e..fa4a36d3b 100644 --- a/classes/class_tcp_server.rst +++ b/classes/class_tcp_server.rst @@ -41,7 +41,7 @@ Method Descriptions - :ref:`bool` **is_connection_available** **(** **)** const -Return ``true`` if a connection is available for taking. +Returns ``true`` if a connection is available for taking. .. _class_TCP_Server_method_listen: diff --git a/classes/class_textedit.rst b/classes/class_textedit.rst index 230198ab6..75864fa21 100644 --- a/classes/class_textedit.rst +++ b/classes/class_textedit.rst @@ -604,13 +604,13 @@ Copy the current selection. - :ref:`int` **cursor_get_column** **(** **)** const -Return the column the editing cursor is at. +Returns the column the editing cursor is at. .. _class_TextEdit_method_cursor_get_line: - :ref:`int` **cursor_get_line** **(** **)** const -Return the line the editing cursor is at. +Returns the line the editing cursor is at. .. _class_TextEdit_method_cursor_set_column: @@ -648,7 +648,7 @@ Folds the given line, if possible (see :ref:`can_fold` **get_breakpoints** **(** **)** const -Return an array containing the line number of each breakpoint. +Returns an array containing the line number of each breakpoint. .. _class_TextEdit_method_get_keyword_color: @@ -658,13 +658,13 @@ Return an array containing the line number of each breakpoint. - :ref:`String` **get_line** **(** :ref:`int` line **)** const -Return the text of a specific line. +Returns the text of a specific line. .. _class_TextEdit_method_get_line_count: - :ref:`int` **get_line_count** **(** **)** const -Return the amount of total lines in the text. +Returns the amount of total lines in the text. .. _class_TextEdit_method_get_menu: @@ -676,31 +676,31 @@ Returns the :ref:`PopupMenu` of this ``TextEdit``. By default, - :ref:`int` **get_selection_from_column** **(** **)** const -Return the selection begin column. +Returns the selection begin column. .. _class_TextEdit_method_get_selection_from_line: - :ref:`int` **get_selection_from_line** **(** **)** const -Return the selection begin line. +Returns the selection begin line. .. _class_TextEdit_method_get_selection_text: - :ref:`String` **get_selection_text** **(** **)** const -Return the text inside the selection. +Returns the text inside the selection. .. _class_TextEdit_method_get_selection_to_column: - :ref:`int` **get_selection_to_column** **(** **)** const -Return the selection end column. +Returns the selection end column. .. _class_TextEdit_method_get_selection_to_line: - :ref:`int` **get_selection_to_line** **(** **)** const -Return the selection end line. +Returns the selection end line. .. _class_TextEdit_method_get_word_under_cursor: @@ -730,7 +730,7 @@ Returns if the given line is folded. - :ref:`bool` **is_selection_active** **(** **)** const -Return ``true`` if the selection is active. +Returns ``true`` if the selection is active. .. _class_TextEdit_method_menu_option: diff --git a/classes/class_texture.rst b/classes/class_texture.rst index d9795ab15..594d5bcf9 100644 --- a/classes/class_texture.rst +++ b/classes/class_texture.rst @@ -132,19 +132,19 @@ Method Descriptions - :ref:`int` **get_height** **(** **)** const -Return the texture height. +Returns the texture height. .. _class_Texture_method_get_size: - :ref:`Vector2` **get_size** **(** **)** const -Return the texture size. +Returns the texture size. .. _class_Texture_method_get_width: - :ref:`int` **get_width** **(** **)** const -Return the texture width. +Returns the texture width. .. _class_Texture_method_has_alpha: diff --git a/classes/class_theme.rst b/classes/class_theme.rst index 479138b31..704207799 100644 --- a/classes/class_theme.rst +++ b/classes/class_theme.rst @@ -95,6 +95,11 @@ Theme for skinning controls. Controls can be skinned individually, but for compl Theme resources can be alternatively loaded by writing them in a .theme file, see docs for more info. +Tutorials +--------- + +- :doc:`../tutorials/gui/gui_skinning` + Property Descriptions --------------------- diff --git a/classes/class_tree.rst b/classes/class_tree.rst index bfbd54fad..6a278369c 100644 --- a/classes/class_tree.rst +++ b/classes/class_tree.rst @@ -196,6 +196,10 @@ Emitted when a column's title is pressed. Emitted when a cell with the ``CELL_MODE_CUSTOM`` is clicked to be edited. +.. _class_Tree_signal_empty_rmb: + +- **empty_rmb** **(** :ref:`Vector2` position **)** + .. _class_Tree_signal_empty_tree_rmb_selected: - **empty_tree_rmb_selected** **(** :ref:`Vector2` position **)** diff --git a/classes/class_vehiclewheel.rst b/classes/class_vehiclewheel.rst index 21318704d..c9cbc72f6 100644 --- a/classes/class_vehiclewheel.rst +++ b/classes/class_vehiclewheel.rst @@ -46,6 +46,8 @@ Properties Methods ------- ++---------------------------+---------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_rpm` **(** **)** const | +---------------------------+---------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_skidinfo` **(** **)** const | +---------------------------+---------------------------------------------------------------------------------+ @@ -197,6 +199,10 @@ This value effects the roll of your vehicle. If set to 0.0 for all wheels your v Method Descriptions ------------------- +.. _class_VehicleWheel_method_get_rpm: + +- :ref:`float` **get_rpm** **(** **)** const + .. _class_VehicleWheel_method_get_skidinfo: - :ref:`float` **get_skidinfo** **(** **)** const diff --git a/classes/class_viewport.rst b/classes/class_viewport.rst index 5085900a8..cd811b9f4 100644 --- a/classes/class_viewport.rst +++ b/classes/class_viewport.rst @@ -50,6 +50,8 @@ Properties +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`physics_object_picking` | +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`render_direct_to_screen` | ++---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`ClearMode` | :ref:`render_target_clear_mode` | +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`UpdateMode` | :ref:`render_target_update_mode` | @@ -515,6 +517,18 @@ If ``true``, the viewport will use :ref:`World` defined in ``world` If ``true``, the objects rendered by viewport become subjects of mouse picking process. Default value: ``false``. +.. _class_Viewport_property_render_direct_to_screen: + +- :ref:`bool` **render_direct_to_screen** + ++----------+----------------------------------------+ +| *Setter* | set_use_render_direct_to_screen(value) | ++----------+----------------------------------------+ +| *Getter* | is_using_render_direct_to_screen() | ++----------+----------------------------------------+ + +If ``true``, renders the Viewport directly to the screen instead of to the root viewport. Only available in GLES2. This is a low-level optimization and should not be used in most cases. If used, reading from the Viewport or from ``SCREEN_TEXTURE`` becomes unavailable. For more information see :ref:`VisualServer.viewport_set_render_direct_to_screen`. Default value: ``false``. + .. _class_Viewport_property_render_target_clear_mode: - :ref:`ClearMode` **render_target_clear_mode** diff --git a/classes/class_visualserver.rst b/classes/class_visualserver.rst index ed55004de..3d9d0f05a 100644 --- a/classes/class_visualserver.rst +++ b/classes/class_visualserver.rst @@ -718,6 +718,8 @@ Methods +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`viewport_set_parent_viewport` **(** :ref:`RID` viewport, :ref:`RID` parent_viewport **)** | +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_render_direct_to_screen` **(** :ref:`RID` viewport, :ref:`bool` enabled **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`viewport_set_scenario` **(** :ref:`RID` viewport, :ref:`RID` scenario **)** | +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`viewport_set_shadow_atlas_quadrant_subdivision` **(** :ref:`RID` viewport, :ref:`int` quadrant, :ref:`int` subdivision **)** | @@ -3378,7 +3380,17 @@ Sets a viewport's canvas. - void **viewport_attach_to_screen** **(** :ref:`RID` viewport, :ref:`Rect2` rect=Rect2( 0, 0, 0, 0 ), :ref:`int` screen=0 **)** -Attaches a viewport to a screen. +Copies viewport to a region of the screen specified by ``rect``. If Viewport.:ref:`Viewport.render_direct_to_screen` is ``true``, then viewport does not use a framebuffer and the contents of the viewport are rendered directly to screen. However, note that the root viewport is drawn last, therefore it will draw over the screen. Accordingly, you must set the root viewport to an area that does not cover the area that you have attached this viewport to. + +For example, you can set the root viewport to not render at all with the following code: + +:: + + func _ready(): + get_viewport().set_attach_to_screen_rect(Rect2()) + $Viewport.set_attach_to_screen_rect(Rect2(0, 0, 600, 600)) + +Using this can result in significant optimization, especially on lower-end devices. However, it comes at the cost of having to manage your viewports manually. For a further optimization see, :ref:`viewport_set_render_direct_to_screen`. .. _class_VisualServer_method_viewport_create: @@ -3488,6 +3500,12 @@ Sets the anti-aliasing mode. see :ref:`ViewportMSAA` viewport, :ref:`bool` enabled **)** + +If ``true``, render the contents of the viewport directly to screen. This allows a low-level optimization where you can skip drawing a viewport to the root viewport. While this optimization can result in a significant increase in speed (especially on older devices), it comes at a cost of usability. When this is enabled, you cannot read from the viewport or from the ``SCREEN_TEXTURE``. You also lose the benefit of certain window settings, such as the various stretch modes. Another consequence to be aware of is that in 2D the rendering happens in window coordinates, so if you have a viewport that is double the size of the window, and you set this, then only the portion that fits within the window will be drawn, no automatic scaling is possible, even if your game scene is significantly larger than the window size. + .. _class_VisualServer_method_viewport_set_scenario: - void **viewport_set_scenario** **(** :ref:`RID` viewport, :ref:`RID` scenario **)** diff --git a/classes/class_visualshader.rst b/classes/class_visualshader.rst index 32690c260..a61eb4c02 100644 --- a/classes/class_visualshader.rst +++ b/classes/class_visualshader.rst @@ -33,6 +33,8 @@ Methods +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`connect_nodes` **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** | +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`connect_nodes_forced` **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`disconnect_nodes` **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** | +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`VisualShaderNode` | :ref:`get_node` **(** :ref:`Type` type, :ref:`int` id **)** const | @@ -47,6 +49,8 @@ Methods +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_node_connection` **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** const | +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rebuild` **(** **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_node` **(** :ref:`Type` type, :ref:`int` id **)** | +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_mode` **(** :ref:`Mode` mode **)** | @@ -116,6 +120,10 @@ Method Descriptions - :ref:`Error` **connect_nodes** **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** +.. _class_VisualShader_method_connect_nodes_forced: + +- void **connect_nodes_forced** **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** + .. _class_VisualShader_method_disconnect_nodes: - void **disconnect_nodes** **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** @@ -144,6 +152,10 @@ Method Descriptions - :ref:`bool` **is_node_connection** **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** const +.. _class_VisualShader_method_rebuild: + +- void **rebuild** **(** **)** + .. _class_VisualShader_method_remove_node: - void **remove_node** **(** :ref:`Type` type, :ref:`int` id **)** diff --git a/classes/class_visualshadernode.rst b/classes/class_visualshadernode.rst index 1d124a13f..a08f725a4 100644 --- a/classes/class_visualshadernode.rst +++ b/classes/class_visualshadernode.rst @@ -9,7 +9,7 @@ VisualShaderNode **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`VisualShaderNodeBooleanConstant`, :ref:`VisualShaderNodeColorConstant`, :ref:`VisualShaderNodeColorFunc`, :ref:`VisualShaderNodeColorOp`, :ref:`VisualShaderNodeCubeMap`, :ref:`VisualShaderNodeCubeMapUniform`, :ref:`VisualShaderNodeDeterminant`, :ref:`VisualShaderNodeDotProduct`, :ref:`VisualShaderNodeFaceForward`, :ref:`VisualShaderNodeFresnel`, :ref:`VisualShaderNodeIf`, :ref:`VisualShaderNodeInput`, :ref:`VisualShaderNodeOuterProduct`, :ref:`VisualShaderNodeOutput`, :ref:`VisualShaderNodeScalarClamp`, :ref:`VisualShaderNodeScalarConstant`, :ref:`VisualShaderNodeScalarDerivativeFunc`, :ref:`VisualShaderNodeScalarFunc`, :ref:`VisualShaderNodeScalarInterp`, :ref:`VisualShaderNodeScalarOp`, :ref:`VisualShaderNodeScalarSmoothStep`, :ref:`VisualShaderNodeSwitch`, :ref:`VisualShaderNodeTexture`, :ref:`VisualShaderNodeTransformCompose`, :ref:`VisualShaderNodeTransformConstant`, :ref:`VisualShaderNodeTransformDecompose`, :ref:`VisualShaderNodeTransformFunc`, :ref:`VisualShaderNodeTransformMult`, :ref:`VisualShaderNodeTransformVecMult`, :ref:`VisualShaderNodeUniform`, :ref:`VisualShaderNodeVec3Constant`, :ref:`VisualShaderNodeVectorClamp`, :ref:`VisualShaderNodeVectorCompose`, :ref:`VisualShaderNodeVectorDecompose`, :ref:`VisualShaderNodeVectorDerivativeFunc`, :ref:`VisualShaderNodeVectorDistance`, :ref:`VisualShaderNodeVectorFunc`, :ref:`VisualShaderNodeVectorInterp`, :ref:`VisualShaderNodeVectorLen`, :ref:`VisualShaderNodeVectorOp`, :ref:`VisualShaderNodeVectorRefract`, :ref:`VisualShaderNodeVectorScalarSmoothStep`, :ref:`VisualShaderNodeVectorScalarStep`, :ref:`VisualShaderNodeVectorSmoothStep` +**Inherited By:** :ref:`VisualShaderNodeBooleanConstant`, :ref:`VisualShaderNodeColorConstant`, :ref:`VisualShaderNodeColorFunc`, :ref:`VisualShaderNodeColorOp`, :ref:`VisualShaderNodeCubeMap`, :ref:`VisualShaderNodeCubeMapUniform`, :ref:`VisualShaderNodeDeterminant`, :ref:`VisualShaderNodeDotProduct`, :ref:`VisualShaderNodeFaceForward`, :ref:`VisualShaderNodeFresnel`, :ref:`VisualShaderNodeGroupBase`, :ref:`VisualShaderNodeIf`, :ref:`VisualShaderNodeInput`, :ref:`VisualShaderNodeOuterProduct`, :ref:`VisualShaderNodeOutput`, :ref:`VisualShaderNodeScalarClamp`, :ref:`VisualShaderNodeScalarConstant`, :ref:`VisualShaderNodeScalarDerivativeFunc`, :ref:`VisualShaderNodeScalarFunc`, :ref:`VisualShaderNodeScalarInterp`, :ref:`VisualShaderNodeScalarOp`, :ref:`VisualShaderNodeScalarSmoothStep`, :ref:`VisualShaderNodeSwitch`, :ref:`VisualShaderNodeTexture`, :ref:`VisualShaderNodeTransformCompose`, :ref:`VisualShaderNodeTransformConstant`, :ref:`VisualShaderNodeTransformDecompose`, :ref:`VisualShaderNodeTransformFunc`, :ref:`VisualShaderNodeTransformMult`, :ref:`VisualShaderNodeTransformVecMult`, :ref:`VisualShaderNodeUniform`, :ref:`VisualShaderNodeVec3Constant`, :ref:`VisualShaderNodeVectorClamp`, :ref:`VisualShaderNodeVectorCompose`, :ref:`VisualShaderNodeVectorDecompose`, :ref:`VisualShaderNodeVectorDerivativeFunc`, :ref:`VisualShaderNodeVectorDistance`, :ref:`VisualShaderNodeVectorFunc`, :ref:`VisualShaderNodeVectorInterp`, :ref:`VisualShaderNodeVectorLen`, :ref:`VisualShaderNodeVectorOp`, :ref:`VisualShaderNodeVectorRefract`, :ref:`VisualShaderNodeVectorScalarSmoothStep`, :ref:`VisualShaderNodeVectorScalarStep`, :ref:`VisualShaderNodeVectorSmoothStep` **Category:** Core diff --git a/classes/class_visualshadernodeexpression.rst b/classes/class_visualshadernodeexpression.rst new file mode 100644 index 000000000..8eb7004b2 --- /dev/null +++ b/classes/class_visualshadernodeexpression.rst @@ -0,0 +1,52 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VisualShaderNodeExpression.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VisualShaderNodeExpression: + +VisualShaderNodeExpression +========================== + +**Inherits:** :ref:`VisualShaderNodeGroupBase` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Properties +---------- + ++-----------------------------+-------------------------------------------------------------------------+ +| :ref:`String` | :ref:`expression` | ++-----------------------------+-------------------------------------------------------------------------+ + +Methods +------- + ++------+-------------------------------------------------------------------------+ +| void | :ref:`build` **(** **)** | ++------+-------------------------------------------------------------------------+ + +Property Descriptions +--------------------- + +.. _class_VisualShaderNodeExpression_property_expression: + +- :ref:`String` **expression** + ++----------+-----------------------+ +| *Setter* | set_expression(value) | ++----------+-----------------------+ +| *Getter* | get_expression() | ++----------+-----------------------+ + +Method Descriptions +------------------- + +.. _class_VisualShaderNodeExpression_method_build: + +- void **build** **(** **)** + diff --git a/classes/class_visualshadernodegroupbase.rst b/classes/class_visualshadernodegroupbase.rst new file mode 100644 index 000000000..899661b2b --- /dev/null +++ b/classes/class_visualshadernodegroupbase.rst @@ -0,0 +1,172 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VisualShaderNodeGroupBase.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VisualShaderNodeGroupBase: + +VisualShaderNodeGroupBase +========================= + +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Inherited By:** :ref:`VisualShaderNodeExpression` + +**Category:** Core + +Brief Description +----------------- + + + +Methods +------- + ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_input_port` **(** :ref:`int` id, :ref:`int` type, :ref:`String` name **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_output_port` **(** :ref:`int` id, :ref:`int` type, :ref:`String` name **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_input_ports` **(** **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_output_ports` **(** **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Control` | :ref:`get_control` **(** :ref:`int` index **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_free_input_port_id` **(** **)** const | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_free_output_port_id` **(** **)** const | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_input_port_count` **(** **)** const | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_inputs` **(** **)** const | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_output_port_count` **(** **)** const | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_outputs` **(** **)** const | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_size` **(** **)** const | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_input_port` **(** :ref:`int` id **)** const | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_output_port` **(** :ref:`int` id **)** const | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_input_port` **(** :ref:`int` id **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_output_port` **(** :ref:`int` id **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_control` **(** :ref:`Control` control, :ref:`int` index **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_input_port_name` **(** :ref:`int` arg0, :ref:`String` arg1 **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_input_port_type` **(** :ref:`int` arg0, :ref:`int` arg1 **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_inputs` **(** :ref:`String` inputs **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_output_port_name` **(** :ref:`int` arg0, :ref:`String` arg1 **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_output_port_type` **(** :ref:`int` arg0, :ref:`int` arg1 **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_outputs` **(** :ref:`String` outputs **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_size` **(** :ref:`Vector2` size **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Method Descriptions +------------------- + +.. _class_VisualShaderNodeGroupBase_method_add_input_port: + +- void **add_input_port** **(** :ref:`int` id, :ref:`int` type, :ref:`String` name **)** + +.. _class_VisualShaderNodeGroupBase_method_add_output_port: + +- void **add_output_port** **(** :ref:`int` id, :ref:`int` type, :ref:`String` name **)** + +.. _class_VisualShaderNodeGroupBase_method_clear_input_ports: + +- void **clear_input_ports** **(** **)** + +.. _class_VisualShaderNodeGroupBase_method_clear_output_ports: + +- void **clear_output_ports** **(** **)** + +.. _class_VisualShaderNodeGroupBase_method_get_control: + +- :ref:`Control` **get_control** **(** :ref:`int` index **)** + +.. _class_VisualShaderNodeGroupBase_method_get_free_input_port_id: + +- :ref:`int` **get_free_input_port_id** **(** **)** const + +.. _class_VisualShaderNodeGroupBase_method_get_free_output_port_id: + +- :ref:`int` **get_free_output_port_id** **(** **)** const + +.. _class_VisualShaderNodeGroupBase_method_get_input_port_count: + +- :ref:`int` **get_input_port_count** **(** **)** const + +.. _class_VisualShaderNodeGroupBase_method_get_inputs: + +- :ref:`String` **get_inputs** **(** **)** const + +.. _class_VisualShaderNodeGroupBase_method_get_output_port_count: + +- :ref:`int` **get_output_port_count** **(** **)** const + +.. _class_VisualShaderNodeGroupBase_method_get_outputs: + +- :ref:`String` **get_outputs** **(** **)** const + +.. _class_VisualShaderNodeGroupBase_method_get_size: + +- :ref:`Vector2` **get_size** **(** **)** const + +.. _class_VisualShaderNodeGroupBase_method_has_input_port: + +- :ref:`bool` **has_input_port** **(** :ref:`int` id **)** const + +.. _class_VisualShaderNodeGroupBase_method_has_output_port: + +- :ref:`bool` **has_output_port** **(** :ref:`int` id **)** const + +.. _class_VisualShaderNodeGroupBase_method_remove_input_port: + +- void **remove_input_port** **(** :ref:`int` id **)** + +.. _class_VisualShaderNodeGroupBase_method_remove_output_port: + +- void **remove_output_port** **(** :ref:`int` id **)** + +.. _class_VisualShaderNodeGroupBase_method_set_control: + +- void **set_control** **(** :ref:`Control` control, :ref:`int` index **)** + +.. _class_VisualShaderNodeGroupBase_method_set_input_port_name: + +- void **set_input_port_name** **(** :ref:`int` arg0, :ref:`String` arg1 **)** + +.. _class_VisualShaderNodeGroupBase_method_set_input_port_type: + +- void **set_input_port_type** **(** :ref:`int` arg0, :ref:`int` arg1 **)** + +.. _class_VisualShaderNodeGroupBase_method_set_inputs: + +- void **set_inputs** **(** :ref:`String` inputs **)** + +.. _class_VisualShaderNodeGroupBase_method_set_output_port_name: + +- void **set_output_port_name** **(** :ref:`int` arg0, :ref:`String` arg1 **)** + +.. _class_VisualShaderNodeGroupBase_method_set_output_port_type: + +- void **set_output_port_type** **(** :ref:`int` arg0, :ref:`int` arg1 **)** + +.. _class_VisualShaderNodeGroupBase_method_set_outputs: + +- void **set_outputs** **(** :ref:`String` outputs **)** + +.. _class_VisualShaderNodeGroupBase_method_set_size: + +- void **set_size** **(** :ref:`Vector2` size **)** + diff --git a/classes/class_webrtcdatachannel.rst b/classes/class_webrtcdatachannel.rst new file mode 100644 index 000000000..e6dbbb0eb --- /dev/null +++ b/classes/class_webrtcdatachannel.rst @@ -0,0 +1,149 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the WebRTCDataChannel.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_WebRTCDataChannel: + +WebRTCDataChannel +================= + +**Inherits:** :ref:`PacketPeer` **<** :ref:`Reference` **<** :ref:`Object` + +**Inherited By:** :ref:`WebRTCDataChannelGDNative` + +**Category:** Core + +Brief Description +----------------- + + + +Properties +---------- + ++----------------------------------------------------+----------------------------------------------------------------+ +| :ref:`WriteMode` | :ref:`write_mode` | ++----------------------------------------------------+----------------------------------------------------------------+ + +Methods +------- + ++----------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ +| void | :ref:`close` **(** **)** | ++----------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_id` **(** **)** const | ++----------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_label` **(** **)** const | ++----------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_max_packet_life_time` **(** **)** const | ++----------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_max_retransmits` **(** **)** const | ++----------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_protocol` **(** **)** const | ++----------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`ChannelState` | :ref:`get_ready_state` **(** **)** const | ++----------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_negotiated` **(** **)** const | ++----------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_ordered` **(** **)** const | ++----------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`poll` **(** **)** | ++----------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`was_string_packet` **(** **)** const | ++----------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ + +Enumerations +------------ + +.. _enum_WebRTCDataChannel_WriteMode: + +.. _class_WebRTCDataChannel_constant_WRITE_MODE_TEXT: + +.. _class_WebRTCDataChannel_constant_WRITE_MODE_BINARY: + +enum **WriteMode**: + +- **WRITE_MODE_TEXT** = **0** + +- **WRITE_MODE_BINARY** = **1** + +.. _enum_WebRTCDataChannel_ChannelState: + +.. _class_WebRTCDataChannel_constant_STATE_CONNECTING: + +.. _class_WebRTCDataChannel_constant_STATE_OPEN: + +.. _class_WebRTCDataChannel_constant_STATE_CLOSING: + +.. _class_WebRTCDataChannel_constant_STATE_CLOSED: + +enum **ChannelState**: + +- **STATE_CONNECTING** = **0** + +- **STATE_OPEN** = **1** + +- **STATE_CLOSING** = **2** + +- **STATE_CLOSED** = **3** + +Property Descriptions +--------------------- + +.. _class_WebRTCDataChannel_property_write_mode: + +- :ref:`WriteMode` **write_mode** + ++----------+-----------------------+ +| *Setter* | set_write_mode(value) | ++----------+-----------------------+ +| *Getter* | get_write_mode() | ++----------+-----------------------+ + +Method Descriptions +------------------- + +.. _class_WebRTCDataChannel_method_close: + +- void **close** **(** **)** + +.. _class_WebRTCDataChannel_method_get_id: + +- :ref:`int` **get_id** **(** **)** const + +.. _class_WebRTCDataChannel_method_get_label: + +- :ref:`String` **get_label** **(** **)** const + +.. _class_WebRTCDataChannel_method_get_max_packet_life_time: + +- :ref:`int` **get_max_packet_life_time** **(** **)** const + +.. _class_WebRTCDataChannel_method_get_max_retransmits: + +- :ref:`int` **get_max_retransmits** **(** **)** const + +.. _class_WebRTCDataChannel_method_get_protocol: + +- :ref:`String` **get_protocol** **(** **)** const + +.. _class_WebRTCDataChannel_method_get_ready_state: + +- :ref:`ChannelState` **get_ready_state** **(** **)** const + +.. _class_WebRTCDataChannel_method_is_negotiated: + +- :ref:`bool` **is_negotiated** **(** **)** const + +.. _class_WebRTCDataChannel_method_is_ordered: + +- :ref:`bool` **is_ordered** **(** **)** const + +.. _class_WebRTCDataChannel_method_poll: + +- :ref:`Error` **poll** **(** **)** + +.. _class_WebRTCDataChannel_method_was_string_packet: + +- :ref:`bool` **was_string_packet** **(** **)** const + diff --git a/classes/class_webrtcdatachannelgdnative.rst b/classes/class_webrtcdatachannelgdnative.rst new file mode 100644 index 000000000..9d8b6458a --- /dev/null +++ b/classes/class_webrtcdatachannelgdnative.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the WebRTCDataChannelGDNative.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_WebRTCDataChannelGDNative: + +WebRTCDataChannelGDNative +========================= + +**Inherits:** :ref:`WebRTCDataChannel` **<** :ref:`PacketPeer` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_webrtcpeer.rst b/classes/class_webrtcpeer.rst deleted file mode 100644 index 51e466d98..000000000 --- a/classes/class_webrtcpeer.rst +++ /dev/null @@ -1,144 +0,0 @@ -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the WebRTCPeer.xml source instead. -.. The source is found in doc/classes or modules//doc_classes. - -.. _class_WebRTCPeer: - -WebRTCPeer -========== - -**Inherits:** :ref:`PacketPeer` **<** :ref:`Reference` **<** :ref:`Object` - -**Inherited By:** :ref:`WebRTCPeerGDNative` - -**Category:** Core - -Brief Description ------------------ - - - -Properties ----------- - -+---------------------------------------------+---------------------------------------------------------+ -| :ref:`WriteMode` | :ref:`write_mode` | -+---------------------------------------------+---------------------------------------------------------+ - -Methods -------- - -+---------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`add_ice_candidate` **(** :ref:`String` media, :ref:`int` index, :ref:`String` name **)** | -+---------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`create_offer` **(** **)** | -+---------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ConnectionState` | :ref:`get_connection_state` **(** **)** const | -+---------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`poll` **(** **)** | -+---------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`set_local_description` **(** :ref:`String` type, :ref:`String` sdp **)** | -+---------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`set_remote_description` **(** :ref:`String` type, :ref:`String` sdp **)** | -+---------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`was_string_packet` **(** **)** const | -+---------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Signals -------- - -.. _class_WebRTCPeer_signal_new_ice_candidate: - -- **new_ice_candidate** **(** :ref:`String` media, :ref:`int` index, :ref:`String` name **)** - -.. _class_WebRTCPeer_signal_offer_created: - -- **offer_created** **(** :ref:`String` type, :ref:`String` sdp **)** - -Enumerations ------------- - -.. _enum_WebRTCPeer_WriteMode: - -.. _class_WebRTCPeer_constant_WRITE_MODE_TEXT: - -.. _class_WebRTCPeer_constant_WRITE_MODE_BINARY: - -enum **WriteMode**: - -- **WRITE_MODE_TEXT** = **0** - -- **WRITE_MODE_BINARY** = **1** - -.. _enum_WebRTCPeer_ConnectionState: - -.. _class_WebRTCPeer_constant_STATE_NEW: - -.. _class_WebRTCPeer_constant_STATE_CONNECTING: - -.. _class_WebRTCPeer_constant_STATE_CONNECTED: - -.. _class_WebRTCPeer_constant_STATE_DISCONNECTED: - -.. _class_WebRTCPeer_constant_STATE_FAILED: - -.. _class_WebRTCPeer_constant_STATE_CLOSED: - -enum **ConnectionState**: - -- **STATE_NEW** = **0** - -- **STATE_CONNECTING** = **1** - -- **STATE_CONNECTED** = **2** - -- **STATE_DISCONNECTED** = **3** - -- **STATE_FAILED** = **4** - -- **STATE_CLOSED** = **5** - -Property Descriptions ---------------------- - -.. _class_WebRTCPeer_property_write_mode: - -- :ref:`WriteMode` **write_mode** - -+----------+-----------------------+ -| *Setter* | set_write_mode(value) | -+----------+-----------------------+ -| *Getter* | get_write_mode() | -+----------+-----------------------+ - -Method Descriptions -------------------- - -.. _class_WebRTCPeer_method_add_ice_candidate: - -- :ref:`Error` **add_ice_candidate** **(** :ref:`String` media, :ref:`int` index, :ref:`String` name **)** - -.. _class_WebRTCPeer_method_create_offer: - -- :ref:`Error` **create_offer** **(** **)** - -.. _class_WebRTCPeer_method_get_connection_state: - -- :ref:`ConnectionState` **get_connection_state** **(** **)** const - -.. _class_WebRTCPeer_method_poll: - -- :ref:`Error` **poll** **(** **)** - -.. _class_WebRTCPeer_method_set_local_description: - -- :ref:`Error` **set_local_description** **(** :ref:`String` type, :ref:`String` sdp **)** - -.. _class_WebRTCPeer_method_set_remote_description: - -- :ref:`Error` **set_remote_description** **(** :ref:`String` type, :ref:`String` sdp **)** - -.. _class_WebRTCPeer_method_was_string_packet: - -- :ref:`bool` **was_string_packet** **(** **)** const - diff --git a/classes/class_webrtcpeerconnection.rst b/classes/class_webrtcpeerconnection.rst new file mode 100644 index 000000000..5ddee2423 --- /dev/null +++ b/classes/class_webrtcpeerconnection.rst @@ -0,0 +1,128 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the WebRTCPeerConnection.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_WebRTCPeerConnection: + +WebRTCPeerConnection +==================== + +**Inherits:** :ref:`Reference` **<** :ref:`Object` + +**Inherited By:** :ref:`WebRTCPeerConnectionGDNative` + +**Category:** Core + +Brief Description +----------------- + + + +Methods +------- + ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`add_ice_candidate` **(** :ref:`String` media, :ref:`int` index, :ref:`String` name **)** | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`close` **(** **)** | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`WebRTCDataChannel` | :ref:`create_data_channel` **(** :ref:`String` label, :ref:`Dictionary` options={ } **)** | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`create_offer` **(** **)** | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ConnectionState` | :ref:`get_connection_state` **(** **)** const | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`initialize` **(** :ref:`Dictionary` configuration={ } **)** | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`poll` **(** **)** | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`set_local_description` **(** :ref:`String` type, :ref:`String` sdp **)** | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`set_remote_description` **(** :ref:`String` type, :ref:`String` sdp **)** | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Signals +------- + +.. _class_WebRTCPeerConnection_signal_data_channel_received: + +- **data_channel_received** **(** :ref:`Object` channel **)** + +.. _class_WebRTCPeerConnection_signal_ice_candidate_created: + +- **ice_candidate_created** **(** :ref:`String` media, :ref:`int` index, :ref:`String` name **)** + +.. _class_WebRTCPeerConnection_signal_session_description_created: + +- **session_description_created** **(** :ref:`String` type, :ref:`String` sdp **)** + +Enumerations +------------ + +.. _enum_WebRTCPeerConnection_ConnectionState: + +.. _class_WebRTCPeerConnection_constant_STATE_NEW: + +.. _class_WebRTCPeerConnection_constant_STATE_CONNECTING: + +.. _class_WebRTCPeerConnection_constant_STATE_CONNECTED: + +.. _class_WebRTCPeerConnection_constant_STATE_DISCONNECTED: + +.. _class_WebRTCPeerConnection_constant_STATE_FAILED: + +.. _class_WebRTCPeerConnection_constant_STATE_CLOSED: + +enum **ConnectionState**: + +- **STATE_NEW** = **0** + +- **STATE_CONNECTING** = **1** + +- **STATE_CONNECTED** = **2** + +- **STATE_DISCONNECTED** = **3** + +- **STATE_FAILED** = **4** + +- **STATE_CLOSED** = **5** + +Method Descriptions +------------------- + +.. _class_WebRTCPeerConnection_method_add_ice_candidate: + +- :ref:`Error` **add_ice_candidate** **(** :ref:`String` media, :ref:`int` index, :ref:`String` name **)** + +.. _class_WebRTCPeerConnection_method_close: + +- void **close** **(** **)** + +.. _class_WebRTCPeerConnection_method_create_data_channel: + +- :ref:`WebRTCDataChannel` **create_data_channel** **(** :ref:`String` label, :ref:`Dictionary` options={ } **)** + +.. _class_WebRTCPeerConnection_method_create_offer: + +- :ref:`Error` **create_offer** **(** **)** + +.. _class_WebRTCPeerConnection_method_get_connection_state: + +- :ref:`ConnectionState` **get_connection_state** **(** **)** const + +.. _class_WebRTCPeerConnection_method_initialize: + +- :ref:`Error` **initialize** **(** :ref:`Dictionary` configuration={ } **)** + +.. _class_WebRTCPeerConnection_method_poll: + +- :ref:`Error` **poll** **(** **)** + +.. _class_WebRTCPeerConnection_method_set_local_description: + +- :ref:`Error` **set_local_description** **(** :ref:`String` type, :ref:`String` sdp **)** + +.. _class_WebRTCPeerConnection_method_set_remote_description: + +- :ref:`Error` **set_remote_description** **(** :ref:`String` type, :ref:`String` sdp **)** + diff --git a/classes/class_webrtcpeerconnectiongdnative.rst b/classes/class_webrtcpeerconnectiongdnative.rst new file mode 100644 index 000000000..3178c6d94 --- /dev/null +++ b/classes/class_webrtcpeerconnectiongdnative.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the WebRTCPeerConnectionGDNative.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_WebRTCPeerConnectionGDNative: + +WebRTCPeerConnectionGDNative +============================ + +**Inherits:** :ref:`WebRTCPeerConnection` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_webrtcpeergdnative.rst b/classes/class_webrtcpeergdnative.rst deleted file mode 100644 index 24ec077d7..000000000 --- a/classes/class_webrtcpeergdnative.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the WebRTCPeerGDNative.xml source instead. -.. The source is found in doc/classes or modules//doc_classes. - -.. _class_WebRTCPeerGDNative: - -WebRTCPeerGDNative -================== - -**Inherits:** :ref:`WebRTCPeer` **<** :ref:`PacketPeer` **<** :ref:`Reference` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - - - diff --git a/classes/class_windowdialog.rst b/classes/class_windowdialog.rst index 464aaf631..dee4086c0 100644 --- a/classes/class_windowdialog.rst +++ b/classes/class_windowdialog.rst @@ -96,5 +96,5 @@ Method Descriptions - :ref:`TextureButton` **get_close_button** **(** **)** -Return the close :ref:`TextureButton`. +Returns the close :ref:`TextureButton`.