From f0024871b37fbf40bed45d0667a8c389465fb746 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Fri, 7 Apr 2017 22:09:37 +0200 Subject: [PATCH] classref: Sync with current 2.1 branch --- classes/class_astar.rst | 12 + classes/class_colorframe.rst | 38 +++ classes/class_control.rst | 8 +- classes/class_file.rst | 6 + classes/class_geometry.rst | 18 ++ classes/class_httpclient.rst | 6 - classes/class_httprequest.rst | 6 - classes/class_input.rst | 12 + classes/class_kinematicbody2d.rst | 64 ++--- classes/class_node.rst | 11 +- classes/class_packetpeerudp.rst | 42 ++-- classes/class_particles2d.rst | 12 + classes/class_physics2dserver.rst | 356 ++++++++++++++-------------- classes/class_richtextlabel.rst | 6 + classes/class_samplelibrary.rst | 18 ++ classes/class_scenetree.rst | 6 + classes/class_streampeertcp.rst | 6 - classes/class_tabcontainer.rst | 13 +- classes/class_tcp_server.rst | 30 +-- classes/class_texturebutton.rst | 36 +++ classes/class_textureframe.rst | 1 + classes/class_tilemap.rst | 6 + classes/class_touchscreenbutton.rst | 36 +++ 23 files changed, 486 insertions(+), 263 deletions(-) create mode 100644 classes/class_colorframe.rst diff --git a/classes/class_astar.rst b/classes/class_astar.rst index 8729c138a..be0100597 100644 --- a/classes/class_astar.rst +++ b/classes/class_astar.rst @@ -18,6 +18,10 @@ Brief Description Member Functions ---------------- ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_compute_cost` **(** :ref:`int` from_id, :ref:`int` to_id **)** virtual | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_estimate_cost` **(** :ref:`int` from_id, :ref:`int` to_id **)** virtual | +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_point` **(** :ref:`int` id, :ref:`Vector3` pos, :ref:`float` weight_scale=1 **)** | +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -49,6 +53,14 @@ Member Functions Member Function Description --------------------------- +.. _class_AStar__compute_cost: + +- void **_compute_cost** **(** :ref:`int` from_id, :ref:`int` to_id **)** virtual + +.. _class_AStar__estimate_cost: + +- void **_estimate_cost** **(** :ref:`int` from_id, :ref:`int` to_id **)** virtual + .. _class_AStar_add_point: - void **add_point** **(** :ref:`int` id, :ref:`Vector3` pos, :ref:`float` weight_scale=1 **)** diff --git a/classes/class_colorframe.rst b/classes/class_colorframe.rst new file mode 100644 index 000000000..4b230b969 --- /dev/null +++ b/classes/class_colorframe.rst @@ -0,0 +1,38 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. + +.. _class_ColorFrame: + +ColorFrame +========== + +**Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++----------------------------+--------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_frame_color` **(** **)** const | ++----------------------------+--------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_frame_color` **(** :ref:`Color` color **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------+ + +Member Function Description +--------------------------- + +.. _class_ColorFrame_get_frame_color: + +- :ref:`Color` **get_frame_color** **(** **)** const + +.. _class_ColorFrame_set_frame_color: + +- void **set_frame_color** **(** :ref:`Color` color **)** + + diff --git a/classes/class_control.rst b/classes/class_control.rst index 1b4e0a2d1..306a6fe7d 100644 --- a/classes/class_control.rst +++ b/classes/class_control.rst @@ -8,7 +8,7 @@ Control **Inherits:** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`Label`, :ref:`Tabs`, :ref:`TextureFrame`, :ref:`ButtonArray`, :ref:`VideoPlayer`, :ref:`LineEdit`, :ref:`Container`, :ref:`ReferenceFrame`, :ref:`Patch9Frame`, :ref:`TextEdit`, :ref:`BaseButton`, :ref:`Popup`, :ref:`Tree`, :ref:`Separator`, :ref:`Panel`, :ref:`TabContainer`, :ref:`Range`, :ref:`RichTextLabel`, :ref:`GraphEdit`, :ref:`ItemList` +**Inherited By:** :ref:`Label`, :ref:`Tabs`, :ref:`TextureFrame`, :ref:`ButtonArray`, :ref:`VideoPlayer`, :ref:`LineEdit`, :ref:`ColorFrame`, :ref:`Container`, :ref:`ReferenceFrame`, :ref:`Patch9Frame`, :ref:`TextEdit`, :ref:`BaseButton`, :ref:`Popup`, :ref:`Tree`, :ref:`Separator`, :ref:`Panel`, :ref:`TabContainer`, :ref:`Range`, :ref:`RichTextLabel`, :ref:`GraphEdit`, :ref:`ItemList` **Category:** Core @@ -133,6 +133,8 @@ Member Functions +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_icon_override` **(** :ref:`String` name **)** const | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`has_point` **(** :ref:`Vector2` point **)** virtual | ++----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_stylebox` **(** :ref:`String` name, :ref:`String` type="" **)** const | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_stylebox_override` **(** :ref:`String` name **)** const | @@ -551,6 +553,10 @@ Return whether the Control is the current focused control (see :ref:`set_focus_m - :ref:`bool` **has_icon_override** **(** :ref:`String` name **)** const +.. _class_Control_has_point: + +- void **has_point** **(** :ref:`Vector2` point **)** virtual + .. _class_Control_has_stylebox: - :ref:`bool` **has_stylebox** **(** :ref:`String` name, :ref:`String` type="" **)** const diff --git a/classes/class_file.rst b/classes/class_file.rst index 1dcc1bc90..841ea8efe 100644 --- a/classes/class_file.rst +++ b/classes/class_file.rst @@ -53,6 +53,8 @@ Member Functions +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_md5` **(** :ref:`String` path **)** const | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_modified_time` **(** :ref:`String` file **)** const | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_pascal_string` **(** **)** | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_pos` **(** **)** const | @@ -237,6 +239,10 @@ Get the next line of the file as a :ref:`String`. Return a md5 String representing the file at the given path or an empty :ref:`String` on failure. +.. _class_File_get_modified_time: + +- :ref:`int` **get_modified_time** **(** :ref:`String` file **)** const + .. _class_File_get_pascal_string: - :ref:`String` **get_pascal_string** **(** **)** diff --git a/classes/class_geometry.rst b/classes/class_geometry.rst index 75313157a..7bc8305b3 100644 --- a/classes/class_geometry.rst +++ b/classes/class_geometry.rst @@ -27,6 +27,12 @@ Member Functions +------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :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:`Vector3Array` | :ref:`get_closest_points_between_segments` **(** :ref:`Vector3` p1, :ref:`Vector3` p2, :ref:`Vector3` q1, :ref:`Vector3` q2 **)** | +------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2Array` | :ref:`get_closest_points_between_segments_2d` **(** :ref:`Vector2` p1, :ref:`Vector2` q1, :ref:`Vector2` p2, :ref:`Vector2` q2 **)** | @@ -73,6 +79,18 @@ Member Function Description - :ref:`Vector3` **get_closest_point_to_segment** **(** :ref:`Vector3` point, :ref:`Vector3` s1, :ref:`Vector3` s2 **)** +.. _class_Geometry_get_closest_point_to_segment_2d: + +- :ref:`Vector2` **get_closest_point_to_segment_2d** **(** :ref:`Vector2` point, :ref:`Vector2` s1, :ref:`Vector2` s2 **)** + +.. _class_Geometry_get_closest_point_to_segment_uncapped: + +- :ref:`Vector3` **get_closest_point_to_segment_uncapped** **(** :ref:`Vector3` point, :ref:`Vector3` s1, :ref:`Vector3` s2 **)** + +.. _class_Geometry_get_closest_point_to_segment_uncapped_2d: + +- :ref:`Vector2` **get_closest_point_to_segment_uncapped_2d** **(** :ref:`Vector2` point, :ref:`Vector2` s1, :ref:`Vector2` s2 **)** + .. _class_Geometry_get_closest_points_between_segments: - :ref:`Vector3Array` **get_closest_points_between_segments** **(** :ref:`Vector3` p1, :ref:`Vector3` p2, :ref:`Vector3` q1, :ref:`Vector3` q2 **)** diff --git a/classes/class_httpclient.rst b/classes/class_httpclient.rst index 6f42ec8d4..7b970b613 100644 --- a/classes/class_httpclient.rst +++ b/classes/class_httpclient.rst @@ -59,8 +59,6 @@ Member Functions +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_connection` **(** :ref:`StreamPeer` connection **)** | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ip_type` **(** :ref:`int` ip_type **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_read_chunk_size` **(** :ref:`int` bytes **)** | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -295,10 +293,6 @@ If set to true, execution will block until all data is read from the response. Set connection to use, for this client. -.. _class_HTTPClient_set_ip_type: - -- void **set_ip_type** **(** :ref:`int` ip_type **)** - .. _class_HTTPClient_set_read_chunk_size: - void **set_read_chunk_size** **(** :ref:`int` bytes **)** diff --git a/classes/class_httprequest.rst b/classes/class_httprequest.rst index 07038426d..1ee364e19 100644 --- a/classes/class_httprequest.rst +++ b/classes/class_httprequest.rst @@ -41,8 +41,6 @@ Member Functions +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_download_file` **(** :ref:`String` path **)** | +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ip_type` **(** :ref:`int` ip_type **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_max_redirects` **(** :ref:`int` amount **)** | +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_use_threads` **(** :ref:`bool` enable **)** | @@ -149,10 +147,6 @@ Set the response body size limit. Set the file to download into. Outputs the response body into the file. -.. _class_HTTPRequest_set_ip_type: - -- void **set_ip_type** **(** :ref:`int` ip_type **)** - .. _class_HTTPRequest_set_max_redirects: - void **set_max_redirects** **(** :ref:`int` amount **)** diff --git a/classes/class_input.rst b/classes/class_input.rst index f5f77cfb2..70d1cda9f 100644 --- a/classes/class_input.rst +++ b/classes/class_input.rst @@ -31,6 +31,8 @@ Member Functions +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`get_connected_joysticks` **(** **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_gravity` **(** **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_gyroscope` **(** **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_joy_axis` **(** :ref:`int` device, :ref:`int` axis **)** | @@ -69,6 +71,8 @@ Member Functions +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_mouse_button_pressed` **(** :ref:`int` button **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`parse_input_event` **(** :ref:`InputEvent` event **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_joy_mapping` **(** :ref:`String` guid **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_custom_mouse_cursor` **(** :ref:`Texture` image, :ref:`Vector2` hotspot=Vector2(0, 0) **)** | @@ -132,6 +136,10 @@ If the device has an accelerometer, this will return the movement. Returns an :ref:`Array` containing the device IDs of all currently connected joysticks. +.. _class_Input_get_gravity: + +- :ref:`Vector3` **get_gravity** **(** **)** + .. _class_Input_get_gyroscope: - :ref:`Vector3` **get_gyroscope** **(** **)** @@ -238,6 +246,10 @@ Returns true or false depending on whether the key is pressed or not. You can pa Returns true or false depending on whether mouse button is pressed or not. You can pass BUTTON\_\*, which are pre-defined constants listed in :ref:`@Global Scope`. +.. _class_Input_parse_input_event: + +- void **parse_input_event** **(** :ref:`InputEvent` event **)** + .. _class_Input_remove_joy_mapping: - void **remove_joy_mapping** **(** :ref:`String` guid **)** diff --git a/classes/class_kinematicbody2d.rst b/classes/class_kinematicbody2d.rst index 34b507fb8..b12d0a3cf 100644 --- a/classes/class_kinematicbody2d.rst +++ b/classes/class_kinematicbody2d.rst @@ -18,35 +18,37 @@ Kinematic body 2D node. Member Functions ---------------- -+--------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_collider` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_collider_metadata` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collider_shape` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_collider_velocity` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_collision_margin` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_collision_normal` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_collision_pos` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_travel` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_colliding` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`move` **(** :ref:`Vector2` rel_vec **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`move_to` **(** :ref:`Vector2` position **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`revert_motion` **(** **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_margin` **(** :ref:`float` pixels **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`test_move` **(** :ref:`Vector2` rel_vec **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_collider` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_collider_metadata` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collider_shape` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_collider_velocity` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_collision_margin` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_collision_normal` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_collision_pos` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_travel` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_colliding` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`move` **(** :ref:`Vector2` rel_vec **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`move_to` **(** :ref:`Vector2` position **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`revert_motion` **(** **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_margin` **(** :ref:`float` pixels **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`test_move` **(** :ref:`Vector2` rel_vec **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`test_move_from` **(** :ref:`Matrix32` from, :ref:`Vector2` rel_vec **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -144,4 +146,8 @@ Set the collision margin for this object. A collision margin is an amount (in pi Return true if there would be a collision if the body moved in the given direction. +.. _class_KinematicBody2D_test_move_from: + +- :ref:`bool` **test_move_from** **(** :ref:`Matrix32` from, :ref:`Vector2` rel_vec **)** + diff --git a/classes/class_node.rst b/classes/class_node.rst index 5bc366864..95473e849 100644 --- a/classes/class_node.rst +++ b/classes/class_node.rst @@ -43,7 +43,7 @@ Member Functions +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`can_process` **(** **)** const | +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`duplicate` **(** :ref:`bool` use_instancing=false **)** const | +| :ref:`Node` | :ref:`duplicate` **(** :ref:`bool` use_instancing=false, :ref:`int` flags=7 **)** const | +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Node` | :ref:`find_node` **(** :ref:`String` mask, :ref:`bool` recursive=true, :ref:`bool` owned=true **)** const | +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -180,6 +180,9 @@ Numeric Constants - **PAUSE_MODE_INHERIT** = **0** - **PAUSE_MODE_STOP** = **1** - **PAUSE_MODE_PROCESS** = **2** +- **DUPLICATE_SIGNALS** = **1** +- **DUPLICATE_GROUPS** = **2** +- **DUPLICATE_SCRIPTS** = **4** Description ----------- @@ -295,9 +298,11 @@ Return true if the node can process, i.e. whether its pause mode allows processi .. _class_Node_duplicate: -- :ref:`Node` **duplicate** **(** :ref:`bool` use_instancing=false **)** const +- :ref:`Node` **duplicate** **(** :ref:`bool` use_instancing=false, :ref:`int` flags=7 **)** const -Duplicate the node, returning a new :ref:`Node`. If ``use_instancing`` is true, the duplicated node will be a new instance of the original :ref:`PackedScene`, if not it will be an independent node. The duplicated node has the same group assignments and signals as the original one. +Duplicate the node, returning a new :ref:`Node`. If ``use_instancing`` is true, the duplicated node will be a new instance of the original :ref:`PackedScene`, if not it will be an independent node. + +The flags are used to define what attributes (groups, signals, scripts) should be duplicated, as specified by the DUPLICATE\_\* constants. The default value is all of them. .. _class_Node_find_node: diff --git a/classes/class_packetpeerudp.rst b/classes/class_packetpeerudp.rst index f06f5ac06..c341677a5 100644 --- a/classes/class_packetpeerudp.rst +++ b/classes/class_packetpeerudp.rst @@ -18,23 +18,21 @@ UDP packet peer. Member Functions ---------------- -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`close` **(** **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_packet_ip` **(** **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_packet_port` **(** **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_listening` **(** **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| Error | :ref:`listen` **(** :ref:`int` port, :ref:`int` recv_buf_size=65536 **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ip_type` **(** :ref:`int` ip_type **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`set_send_address` **(** :ref:`String` host, :ref:`int` port **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| Error | :ref:`wait` **(** **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`close` **(** **)** | ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_packet_ip` **(** **)** const | ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_packet_port` **(** **)** const | ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_listening` **(** **)** const | ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Error | :ref:`listen` **(** :ref:`int` port, :ref:`String` bind_address="*", :ref:`int` recv_buf_size=65536 **)** | ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`set_send_address` **(** :ref:`String` host, :ref:`int` port **)** | ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Error | :ref:`wait` **(** **)** | ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -70,13 +68,15 @@ Return whether this :ref:`PacketPeerUDP` is listening. .. _class_PacketPeerUDP_listen: -- Error **listen** **(** :ref:`int` port, :ref:`int` recv_buf_size=65536 **)** +- Error **listen** **(** :ref:`int` port, :ref:`String` bind_address="*", :ref:`int` recv_buf_size=65536 **)** -Make this :ref:`PacketPeerUDP` listen on the "port" with a buffer size "recv_buf_size". Listens on all available addresses. +Make this :ref:`PacketPeerUDP` listen on the "port" binding to "bind_address" with a buffer size "recv_buf_size". -.. _class_PacketPeerUDP_set_ip_type: +If "bind_address" is set as "\*" (default), the peer will listen on all available addresses (both IPv4 and IPv6). -- void **set_ip_type** **(** :ref:`int` ip_type **)** +If "bind_address" is set as "0.0.0.0" (for IPv4) or "::" (for IPv6), the peer will listen on all available addresses matching that IP type. + +If "bind_address" is set to any valid address (e.g. "192.168.1.101", "::1", etc), the peer will only listen on the interface with that addresses (or fail if no interface with the given address exists). .. _class_PacketPeerUDP_set_send_address: diff --git a/classes/class_particles2d.rst b/classes/class_particles2d.rst index 36d9383d0..2e1a9e38b 100644 --- a/classes/class_particles2d.rst +++ b/classes/class_particles2d.rst @@ -51,6 +51,8 @@ Member Functions +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_pre_process_time` **(** **)** const | +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_process_mode` **(** **)** const | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_randomness` **(** :ref:`int` param **)** const | +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Texture` | :ref:`get_texture` **(** **)** const | @@ -109,6 +111,8 @@ Member Functions +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_pre_process_time` **(** :ref:`float` time **)** | +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_process_mode` **(** :ref:`int` mode **)** | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_randomness` **(** :ref:`int` param, :ref:`float` value **)** | +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Texture` | :ref:`set_texture` **(** :ref:`Object` texture **)** | @@ -230,6 +234,10 @@ Returns the value of the specified emitter parameter - :ref:`float` **get_pre_process_time** **(** **)** const +.. _class_Particles2D_get_process_mode: + +- :ref:`int` **get_process_mode** **(** **)** const + .. _class_Particles2D_get_randomness: - :ref:`float` **get_randomness** **(** :ref:`int` param **)** const @@ -372,6 +380,10 @@ Sets the value of the specified emitter parameter (see the constants secction fo - void **set_pre_process_time** **(** :ref:`float` time **)** +.. _class_Particles2D_set_process_mode: + +- void **set_process_mode** **(** :ref:`int` mode **)** + .. _class_Particles2D_set_randomness: - void **set_randomness** **(** :ref:`int` param, :ref:`float` value **)** diff --git a/classes/class_physics2dserver.rst b/classes/class_physics2dserver.rst index 0ee027c5b..24839238a 100644 --- a/classes/class_physics2dserver.rst +++ b/classes/class_physics2dserver.rst @@ -20,181 +20,183 @@ Physics 2D Server. Member Functions ---------------- -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_add_shape` **(** :ref:`RID` area, :ref:`RID` shape, :ref:`Matrix32` transform=((1, 0), (0, 1), (0, 0)) **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_attach_object_instance_ID` **(** :ref:`RID` area, :ref:`int` id **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_clear_shapes` **(** :ref:`RID` area **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`area_create` **(** **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`area_get_object_instance_ID` **(** :ref:`RID` area **)** const | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_get_param` **(** :ref:`RID` area, :ref:`int` param **)** const | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`area_get_shape` **(** :ref:`RID` area, :ref:`int` shape_idx **)** const | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`area_get_shape_count` **(** :ref:`RID` area **)** const | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Matrix32` | :ref:`area_get_shape_transform` **(** :ref:`RID` area, :ref:`int` shape_idx **)** const | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`area_get_space` **(** :ref:`RID` area **)** const | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`area_get_space_override_mode` **(** :ref:`RID` area **)** const | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Matrix32` | :ref:`area_get_transform` **(** :ref:`RID` area **)** const | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_remove_shape` **(** :ref:`RID` area, :ref:`int` shape_idx **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_collision_mask` **(** :ref:`RID` area, :ref:`int` mask **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_layer_mask` **(** :ref:`RID` area, :ref:`int` mask **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_monitor_callback` **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`String` method **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_param` **(** :ref:`RID` area, :ref:`int` param, :ref:`Variant` value **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_shape` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`RID` shape **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_shape_transform` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`Matrix32` transform **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_space` **(** :ref:`RID` area, :ref:`RID` space **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_space_override_mode` **(** :ref:`RID` area, :ref:`int` mode **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_transform` **(** :ref:`RID` area, :ref:`Matrix32` transform **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_add_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_add_force` **(** :ref:`RID` body, :ref:`Vector2` offset, :ref:`Vector2` force **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_add_shape` **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Matrix32` transform=((1, 0), (0, 1), (0, 0)) **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_apply_impulse` **(** :ref:`RID` body, :ref:`Vector2` pos, :ref:`Vector2` impulse **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_attach_object_instance_ID` **(** :ref:`RID` body, :ref:`int` id **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_clear_shapes` **(** :ref:`RID` body **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`body_create` **(** :ref:`int` mode=2, :ref:`bool` init_sleeping=false **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_collision_mask` **(** :ref:`RID` body **)** const | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_continuous_collision_detection_mode` **(** :ref:`RID` body **)** const | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_layer_mask` **(** :ref:`RID` body **)** const | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_max_contacts_reported` **(** :ref:`RID` body **)** const | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_mode` **(** :ref:`RID` body **)** const | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_object_instance_ID` **(** :ref:`RID` body **)** const | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`body_get_one_way_collision_direction` **(** :ref:`RID` body **)** const | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`body_get_one_way_collision_max_depth` **(** :ref:`RID` body **)** const | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`body_get_param` **(** :ref:`RID` body, :ref:`int` param **)** const | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`body_get_shape` **(** :ref:`RID` body, :ref:`int` shape_idx **)** const | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_shape_count` **(** :ref:`RID` body **)** const | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_get_shape_metadata` **(** :ref:`RID` body, :ref:`int` shape_idx **)** const | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Matrix32` | :ref:`body_get_shape_transform` **(** :ref:`RID` body, :ref:`int` shape_idx **)** const | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`body_get_space` **(** :ref:`RID` body **)** const | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_get_state` **(** :ref:`RID` body, :ref:`int` state **)** const | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`body_is_omitting_force_integration` **(** :ref:`RID` body **)** const | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`body_is_shape_set_as_trigger` **(** :ref:`RID` body, :ref:`int` shape_idx **)** const | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_remove_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_remove_shape` **(** :ref:`RID` body, :ref:`int` shape_idx **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_axis_velocity` **(** :ref:`RID` body, :ref:`Vector2` axis_velocity **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_collision_mask` **(** :ref:`RID` body, :ref:`int` mask **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_continuous_collision_detection_mode` **(** :ref:`RID` body, :ref:`int` mode **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_force_integration_callback` **(** :ref:`RID` body, :ref:`Object` receiver, :ref:`String` method, :ref:`Variant` userdata=NULL **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_layer_mask` **(** :ref:`RID` body, :ref:`int` mask **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_max_contacts_reported` **(** :ref:`RID` body, :ref:`int` amount **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_mode` **(** :ref:`RID` body, :ref:`int` mode **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_omit_force_integration` **(** :ref:`RID` body, :ref:`bool` enable **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_one_way_collision_direction` **(** :ref:`RID` body, :ref:`Vector2` normal **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_one_way_collision_max_depth` **(** :ref:`RID` body, :ref:`float` depth **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_param` **(** :ref:`RID` body, :ref:`int` param, :ref:`float` value **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_shape` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`RID` shape **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_shape_as_trigger` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`bool` enable **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_shape_metadata` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`Variant` metadata **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_shape_transform` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`Matrix32` transform **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_space` **(** :ref:`RID` body, :ref:`RID` space **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_state` **(** :ref:`RID` body, :ref:`int` state, :ref:`Variant` value **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`body_test_motion` **(** :ref:`RID` body, :ref:`Vector2` motion, :ref:`float` margin=0.08, :ref:`Physics2DTestMotionResult` result=NULL **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`damped_spring_joint_create` **(** :ref:`Vector2` anchor_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a, :ref:`RID` body_b=RID() **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`damped_string_joint_get_param` **(** :ref:`RID` joint, :ref:`int` param **)** const | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`damped_string_joint_set_param` **(** :ref:`RID` joint, :ref:`int` param, :ref:`float` value **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`free_rid` **(** :ref:`RID` rid **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_process_info` **(** :ref:`int` process_info **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`groove_joint_create` **(** :ref:`Vector2` groove1_a, :ref:`Vector2` groove2_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a=RID(), :ref:`RID` body_b=RID() **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`joint_get_param` **(** :ref:`RID` joint, :ref:`int` param **)** const | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`joint_get_type` **(** :ref:`RID` joint **)** const | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`joint_set_param` **(** :ref:`RID` joint, :ref:`int` param, :ref:`float` value **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`pin_joint_create` **(** :ref:`Vector2` anchor, :ref:`RID` body_a, :ref:`RID` body_b=RID() **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_active` **(** :ref:`bool` active **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`shape_create` **(** :ref:`int` type **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shape_get_data` **(** :ref:`RID` shape **)** const | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`shape_get_type` **(** :ref:`RID` shape **)** const | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shape_set_data` **(** :ref:`RID` shape, :ref:`Variant` data **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`space_create` **(** **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Physics2DDirectSpaceState` | :ref:`space_get_direct_state` **(** :ref:`RID` space **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`space_get_param` **(** :ref:`RID` space, :ref:`int` param **)** const | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`space_is_active` **(** :ref:`RID` space **)** const | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`space_set_active` **(** :ref:`RID` space, :ref:`bool` active **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`space_set_param` **(** :ref:`RID` space, :ref:`int` param, :ref:`float` value **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_add_shape` **(** :ref:`RID` area, :ref:`RID` shape, :ref:`Matrix32` transform=((1, 0), (0, 1), (0, 0)) **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_attach_object_instance_ID` **(** :ref:`RID` area, :ref:`int` id **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_clear_shapes` **(** :ref:`RID` area **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`area_create` **(** **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`area_get_object_instance_ID` **(** :ref:`RID` area **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_get_param` **(** :ref:`RID` area, :ref:`int` param **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`area_get_shape` **(** :ref:`RID` area, :ref:`int` shape_idx **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`area_get_shape_count` **(** :ref:`RID` area **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Matrix32` | :ref:`area_get_shape_transform` **(** :ref:`RID` area, :ref:`int` shape_idx **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`area_get_space` **(** :ref:`RID` area **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`area_get_space_override_mode` **(** :ref:`RID` area **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Matrix32` | :ref:`area_get_transform` **(** :ref:`RID` area **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_remove_shape` **(** :ref:`RID` area, :ref:`int` shape_idx **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_collision_mask` **(** :ref:`RID` area, :ref:`int` mask **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_layer_mask` **(** :ref:`RID` area, :ref:`int` mask **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_monitor_callback` **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`String` method **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_param` **(** :ref:`RID` area, :ref:`int` param, :ref:`Variant` value **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_shape` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`RID` shape **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_shape_transform` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`Matrix32` transform **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_space` **(** :ref:`RID` area, :ref:`RID` space **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_space_override_mode` **(** :ref:`RID` area, :ref:`int` mode **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_transform` **(** :ref:`RID` area, :ref:`Matrix32` transform **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_add_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_add_force` **(** :ref:`RID` body, :ref:`Vector2` offset, :ref:`Vector2` force **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_add_shape` **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Matrix32` transform=((1, 0), (0, 1), (0, 0)) **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_apply_impulse` **(** :ref:`RID` body, :ref:`Vector2` pos, :ref:`Vector2` impulse **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_attach_object_instance_ID` **(** :ref:`RID` body, :ref:`int` id **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_clear_shapes` **(** :ref:`RID` body **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`body_create` **(** :ref:`int` mode=2, :ref:`bool` init_sleeping=false **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`body_get_collision_mask` **(** :ref:`RID` body **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`body_get_continuous_collision_detection_mode` **(** :ref:`RID` body **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`body_get_layer_mask` **(** :ref:`RID` body **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`body_get_max_contacts_reported` **(** :ref:`RID` body **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`body_get_mode` **(** :ref:`RID` body **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`body_get_object_instance_ID` **(** :ref:`RID` body **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`body_get_one_way_collision_direction` **(** :ref:`RID` body **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`body_get_one_way_collision_max_depth` **(** :ref:`RID` body **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`body_get_param` **(** :ref:`RID` body, :ref:`int` param **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`body_get_shape` **(** :ref:`RID` body, :ref:`int` shape_idx **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`body_get_shape_count` **(** :ref:`RID` body **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_get_shape_metadata` **(** :ref:`RID` body, :ref:`int` shape_idx **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Matrix32` | :ref:`body_get_shape_transform` **(** :ref:`RID` body, :ref:`int` shape_idx **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`body_get_space` **(** :ref:`RID` body **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_get_state` **(** :ref:`RID` body, :ref:`int` state **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`body_is_omitting_force_integration` **(** :ref:`RID` body **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`body_is_shape_set_as_trigger` **(** :ref:`RID` body, :ref:`int` shape_idx **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_remove_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_remove_shape` **(** :ref:`RID` body, :ref:`int` shape_idx **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_axis_velocity` **(** :ref:`RID` body, :ref:`Vector2` axis_velocity **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_collision_mask` **(** :ref:`RID` body, :ref:`int` mask **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_continuous_collision_detection_mode` **(** :ref:`RID` body, :ref:`int` mode **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_force_integration_callback` **(** :ref:`RID` body, :ref:`Object` receiver, :ref:`String` method, :ref:`Variant` userdata=NULL **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_layer_mask` **(** :ref:`RID` body, :ref:`int` mask **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_max_contacts_reported` **(** :ref:`RID` body, :ref:`int` amount **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_mode` **(** :ref:`RID` body, :ref:`int` mode **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_omit_force_integration` **(** :ref:`RID` body, :ref:`bool` enable **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_one_way_collision_direction` **(** :ref:`RID` body, :ref:`Vector2` normal **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_one_way_collision_max_depth` **(** :ref:`RID` body, :ref:`float` depth **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_param` **(** :ref:`RID` body, :ref:`int` param, :ref:`float` value **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_shape` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`RID` shape **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_shape_as_trigger` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`bool` enable **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_shape_metadata` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`Variant` metadata **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_shape_transform` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`Matrix32` transform **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_space` **(** :ref:`RID` body, :ref:`RID` space **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_state` **(** :ref:`RID` body, :ref:`int` state, :ref:`Variant` value **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`body_test_motion` **(** :ref:`RID` body, :ref:`Vector2` motion, :ref:`float` margin=0.08, :ref:`Physics2DTestMotionResult` result=NULL **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`body_test_motion_from` **(** :ref:`RID` body, :ref:`Matrix32` from, :ref:`Vector2` motion, :ref:`float` margin=0.08, :ref:`Physics2DTestMotionResult` result=NULL **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`damped_spring_joint_create` **(** :ref:`Vector2` anchor_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a, :ref:`RID` body_b=RID() **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`damped_string_joint_get_param` **(** :ref:`RID` joint, :ref:`int` param **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`damped_string_joint_set_param` **(** :ref:`RID` joint, :ref:`int` param, :ref:`float` value **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`free_rid` **(** :ref:`RID` rid **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_process_info` **(** :ref:`int` process_info **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`groove_joint_create` **(** :ref:`Vector2` groove1_a, :ref:`Vector2` groove2_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a=RID(), :ref:`RID` body_b=RID() **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`joint_get_param` **(** :ref:`RID` joint, :ref:`int` param **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`joint_get_type` **(** :ref:`RID` joint **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`joint_set_param` **(** :ref:`RID` joint, :ref:`int` param, :ref:`float` value **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`pin_joint_create` **(** :ref:`Vector2` anchor, :ref:`RID` body_a, :ref:`RID` body_b=RID() **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_active` **(** :ref:`bool` active **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`shape_create` **(** :ref:`int` type **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shape_get_data` **(** :ref:`RID` shape **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`shape_get_type` **(** :ref:`RID` shape **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shape_set_data` **(** :ref:`RID` shape, :ref:`Variant` data **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`space_create` **(** **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Physics2DDirectSpaceState` | :ref:`space_get_direct_state` **(** :ref:`RID` space **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`space_get_param` **(** :ref:`RID` space, :ref:`int` param **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`space_is_active` **(** :ref:`RID` space **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`space_set_active` **(** :ref:`RID` space, :ref:`bool` active **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`space_set_param` **(** :ref:`RID` space, :ref:`int` param, :ref:`float` value **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -675,6 +677,10 @@ Set a body state (see BODY_STATE\* constants). Return whether a body can move in a given direction. Apart from the boolean return value, a :ref:`Physics2DTestMotionResult` can be passed to return additional information in. +.. _class_Physics2DServer_body_test_motion_from: + +- :ref:`bool` **body_test_motion_from** **(** :ref:`RID` body, :ref:`Matrix32` from, :ref:`Vector2` motion, :ref:`float` margin=0.08, :ref:`Physics2DTestMotionResult` result=NULL **)** + .. _class_Physics2DServer_damped_spring_joint_create: - :ref:`RID` **damped_spring_joint_create** **(** :ref:`Vector2` anchor_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a, :ref:`RID` body_b=RID() **)** diff --git a/classes/class_richtextlabel.rst b/classes/class_richtextlabel.rst index edd1ff2cb..5f7a14d9f 100644 --- a/classes/class_richtextlabel.rst +++ b/classes/class_richtextlabel.rst @@ -73,6 +73,8 @@ Member Functions +------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`push_underline` **(** **)** | +------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`remove_line` **(** :ref:`int` arg0 **)** | ++------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`scroll_to_line` **(** :ref:`int` line **)** | +------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_bbcode` **(** :ref:`String` text **)** | @@ -241,6 +243,10 @@ Return true if selecting the text inside this richtext is allowed. - void **push_underline** **(** **)** +.. _class_RichTextLabel_remove_line: + +- :ref:`bool` **remove_line** **(** :ref:`int` arg0 **)** + .. _class_RichTextLabel_scroll_to_line: - void **scroll_to_line** **(** :ref:`int` line **)** diff --git a/classes/class_samplelibrary.rst b/classes/class_samplelibrary.rst index 2f4333566..e152b799e 100644 --- a/classes/class_samplelibrary.rst +++ b/classes/class_samplelibrary.rst @@ -31,10 +31,14 @@ Member Functions +------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`sample_get_pitch_scale` **(** :ref:`String` name **)** const | +------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`sample_get_priority` **(** :ref:`String` name **)** const | ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`sample_get_volume_db` **(** :ref:`String` name **)** const | +------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`sample_set_pitch_scale` **(** :ref:`String` name, :ref:`float` pitch **)** | +------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`sample_set_priority` **(** :ref:`String` name, :ref:`int` priority **)** | ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`sample_set_volume_db` **(** :ref:`String` name, :ref:`float` db **)** | +------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -43,6 +47,8 @@ Description Library that contains a collection of :ref:`Sample`, each identified by a text ID. This is used as a data container for the majority of the SamplePlayer classes and derivatives. +Sample players will never yield an active (currently playing) voice for a new playback request when there are no inactive voices available if the priority of the sample requested to be played is lower than that of every currently played samples. + Member Function Description --------------------------- @@ -80,6 +86,12 @@ Remove the sample matching the given text ID. Return the pitch scale for the given sample. +.. _class_SampleLibrary_sample_get_priority: + +- :ref:`int` **sample_get_priority** **(** :ref:`String` name **)** const + +Return the priority for the given sample. + .. _class_SampleLibrary_sample_get_volume_db: - :ref:`float` **sample_get_volume_db** **(** :ref:`String` name **)** const @@ -92,6 +104,12 @@ Return the volume (in dB) for the given sample. Set the pitch scale for the given sample. +.. _class_SampleLibrary_sample_set_priority: + +- void **sample_set_priority** **(** :ref:`String` name, :ref:`int` priority **)** + +Set the priority for the given sample. + .. _class_SampleLibrary_sample_set_volume_db: - void **sample_set_volume_db** **(** :ref:`String` name, :ref:`float` db **)** diff --git a/classes/class_scenetree.rst b/classes/class_scenetree.rst index ba16c06c3..5fe24fed1 100644 --- a/classes/class_scenetree.rst +++ b/classes/class_scenetree.rst @@ -45,6 +45,8 @@ Member Functions +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_editor_hint` **(** **)** const | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_input_handled` **(** **)** | ++----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_paused` **(** **)** const | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`notify_group` **(** :ref:`int` call_flags, :ref:`String` group, :ref:`int` notification **)** | @@ -157,6 +159,10 @@ Member Function Description - :ref:`bool` **is_editor_hint** **(** **)** const +.. _class_SceneTree_is_input_handled: + +- :ref:`bool` **is_input_handled** **(** **)** + .. _class_SceneTree_is_paused: - :ref:`bool` **is_paused** **(** **)** const diff --git a/classes/class_streampeertcp.rst b/classes/class_streampeertcp.rst index a9c4ee036..469894533 100644 --- a/classes/class_streampeertcp.rst +++ b/classes/class_streampeertcp.rst @@ -31,8 +31,6 @@ Member Functions +------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_connected` **(** **)** const | +------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ip_type` **(** :ref:`int` ip_type **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -86,8 +84,4 @@ Return the status of the connection, one of STATUS\_\* enum. Return whether this peer is connected. Returns true while connecting and connected. -.. _class_StreamPeerTCP_set_ip_type: - -- void **set_ip_type** **(** :ref:`int` ip_type **)** - diff --git a/classes/class_tabcontainer.rst b/classes/class_tabcontainer.rst index 782259683..3d85222e4 100644 --- a/classes/class_tabcontainer.rst +++ b/classes/class_tabcontainer.rst @@ -27,6 +27,8 @@ Member Functions +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Popup` | :ref:`get_popup` **(** **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_previous_tab` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_tab_align` **(** **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Control` | :ref:`get_tab_control` **(** :ref:`int` idx **)** const | @@ -55,6 +57,7 @@ Signals - **pre_popup_pressed** **(** **)** - **tab_changed** **(** :ref:`int` tab **)** +- **tab_selected** **(** :ref:`int` tab **)** Description ----------- @@ -76,16 +79,24 @@ Return whether the tabs should be visible or hidden. - :ref:`int` **get_current_tab** **(** **)** const -Return the current tab that is being showed. +Return the current tab index that is being shown. .. _class_TabContainer_get_current_tab_control: - :ref:`Control` **get_current_tab_control** **(** **)** const +Return the current tab control that is being shown. + .. _class_TabContainer_get_popup: - :ref:`Popup` **get_popup** **(** **)** const +.. _class_TabContainer_get_previous_tab: + +- :ref:`int` **get_previous_tab** **(** **)** const + +Return the previous tab index that was being shown. + .. _class_TabContainer_get_tab_align: - :ref:`int` **get_tab_align** **(** **)** const diff --git a/classes/class_tcp_server.rst b/classes/class_tcp_server.rst index 5c91b0b35..16d723bda 100644 --- a/classes/class_tcp_server.rst +++ b/classes/class_tcp_server.rst @@ -18,17 +18,15 @@ TCP Server. Member Functions ---------------- -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_connection_available` **(** **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`listen` **(** :ref:`int` port, :ref:`StringArray` accepted_hosts=StringArray([]) **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ip_type` **(** :ref:`int` ip_type **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`stop` **(** **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`take_connection` **(** **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_connection_available` **(** **)** const | ++------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`listen` **(** :ref:`int` port, :ref:`String` bind_address="*" **)** | ++------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`stop` **(** **)** | ++------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`take_connection` **(** **)** | ++------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -46,13 +44,15 @@ Return true if a connection is available for taking. .. _class_TCP_Server_listen: -- :ref:`int` **listen** **(** :ref:`int` port, :ref:`StringArray` accepted_hosts=StringArray([]) **)** +- :ref:`int` **listen** **(** :ref:`int` port, :ref:`String` bind_address="*" **)** -Listen on a port using protocol, alternatively give a white-list of accepted hosts. +Listen on the "port" binding to "bind_address". -.. _class_TCP_Server_set_ip_type: +If "bind_address" is set as "\*" (default), the server will listen on all available addresses (both IPv4 and IPv6). -- void **set_ip_type** **(** :ref:`int` ip_type **)** +If "bind_address" is set as "0.0.0.0" (for IPv4) or "::" (for IPv6), the server will listen on all available addresses matching that IP type. + +If "bind_address" is set to any valid address (e.g. "192.168.1.101", "::1", etc), the server will only listen on the interface with that addresses (or fail if no interface with the given address exists). .. _class_TCP_Server_stop: diff --git a/classes/class_texturebutton.rst b/classes/class_texturebutton.rst index 25d4cdf82..21c593380 100644 --- a/classes/class_texturebutton.rst +++ b/classes/class_texturebutton.rst @@ -33,6 +33,10 @@ Member Functions +--------------------------------+---------------------------------------------------------------------------------------------------------------------------+ | :ref:`Texture` | :ref:`get_pressed_texture` **(** **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_resize_mode` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_stretch_mode` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_texture_scale` **(** **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_click_mask` **(** :ref:`BitMap` mask **)** | @@ -49,9 +53,25 @@ Member Functions +--------------------------------+---------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_pressed_texture` **(** :ref:`Texture` texture **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_resize_mode` **(** :ref:`int` p_mode **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_stretch_mode` **(** :ref:`int` p_mode **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_texture_scale` **(** :ref:`Vector2` scale **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +Numeric Constants +----------------- + +- **STRETCH_SCALE_ON_EXPAND** = **0** +- **STRETCH_SCALE** = **1** +- **STRETCH_TILE** = **2** +- **STRETCH_KEEP** = **3** +- **STRETCH_KEEP_CENTERED** = **4** +- **STRETCH_KEEP_ASPECT** = **5** +- **STRETCH_KEEP_ASPECT_CENTERED** = **6** +- **STRETCH_KEEP_ASPECT_COVERED** = **7** + Description ----------- @@ -90,6 +110,14 @@ Member Function Description - :ref:`Texture` **get_pressed_texture** **(** **)** const +.. _class_TextureButton_get_resize_mode: + +- :ref:`int` **get_resize_mode** **(** **)** const + +.. _class_TextureButton_get_stretch_mode: + +- :ref:`int` **get_stretch_mode** **(** **)** const + .. _class_TextureButton_get_texture_scale: - :ref:`Vector2` **get_texture_scale** **(** **)** const @@ -122,6 +150,14 @@ Member Function Description - void **set_pressed_texture** **(** :ref:`Texture` texture **)** +.. _class_TextureButton_set_resize_mode: + +- void **set_resize_mode** **(** :ref:`int` p_mode **)** + +.. _class_TextureButton_set_stretch_mode: + +- void **set_stretch_mode** **(** :ref:`int` p_mode **)** + .. _class_TextureButton_set_texture_scale: - void **set_texture_scale** **(** :ref:`Vector2` scale **)** diff --git a/classes/class_textureframe.rst b/classes/class_textureframe.rst index 7c28cab23..c9124e3a8 100644 --- a/classes/class_textureframe.rst +++ b/classes/class_textureframe.rst @@ -46,6 +46,7 @@ Numeric Constants - **STRETCH_KEEP_CENTERED** = **4** - **STRETCH_KEEP_ASPECT** = **5** - **STRETCH_KEEP_ASPECT_CENTERED** = **6** +- **STRETCH_KEEP_ASPECT_COVERED** = **7** Description ----------- diff --git a/classes/class_tilemap.rst b/classes/class_tilemap.rst index c1b2ec370..4791fb2ea 100644 --- a/classes/class_tilemap.rst +++ b/classes/class_tilemap.rst @@ -57,6 +57,8 @@ Member Functions +----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`get_used_cells` **(** **)** const | +----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_used_rect` **(** **)** | ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_cell_transposed` **(** :ref:`int` x, :ref:`int` y **)** const | +----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_cell_x_flipped` **(** :ref:`int` x, :ref:`int` y **)** const | @@ -247,6 +249,10 @@ Return the current tileset. Return an array of all cells containing a tile from the tileset (i.e. a tile index different from -1). +.. _class_TileMap_get_used_rect: + +- :ref:`Rect2` **get_used_rect** **(** **)** + .. _class_TileMap_is_cell_transposed: - :ref:`bool` **is_cell_transposed** **(** :ref:`int` x, :ref:`int` y **)** const diff --git a/classes/class_touchscreenbutton.rst b/classes/class_touchscreenbutton.rst index 4044f5058..87a6b2520 100644 --- a/classes/class_touchscreenbutton.rst +++ b/classes/class_touchscreenbutton.rst @@ -23,6 +23,8 @@ Member Functions +------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Object` | :ref:`get_bitmask` **(** **)** const | +------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_shape` **(** **)** const | ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Object` | :ref:`get_texture` **(** **)** const | +------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Object` | :ref:`get_texture_pressed` **(** **)** const | @@ -33,12 +35,22 @@ Member Functions +------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_pressed` **(** **)** const | +------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_shape_centered` **(** **)** const | ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_shape_visible` **(** **)** const | ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_action` **(** :ref:`String` action **)** | +------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_bitmask` **(** :ref:`Object` bitmask **)** | +------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_passby_press` **(** :ref:`bool` enabled **)** | +------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shape` **(** :ref:`Object` shape **)** | ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shape_centered` **(** :ref:`bool` bool **)** | ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shape_visible` **(** :ref:`bool` bool **)** | ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_texture` **(** :ref:`Object` texture **)** | +------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_texture_pressed` **(** :ref:`Object` texture_pressed **)** | @@ -63,6 +75,10 @@ Member Function Description - :ref:`Object` **get_bitmask** **(** **)** const +.. _class_TouchScreenButton_get_shape: + +- :ref:`Object` **get_shape** **(** **)** const + .. _class_TouchScreenButton_get_texture: - :ref:`Object` **get_texture** **(** **)** const @@ -83,6 +99,14 @@ Member Function Description - :ref:`bool` **is_pressed** **(** **)** const +.. _class_TouchScreenButton_is_shape_centered: + +- :ref:`bool` **is_shape_centered** **(** **)** const + +.. _class_TouchScreenButton_is_shape_visible: + +- :ref:`bool` **is_shape_visible** **(** **)** const + .. _class_TouchScreenButton_set_action: - void **set_action** **(** :ref:`String` action **)** @@ -95,6 +119,18 @@ Member Function Description - void **set_passby_press** **(** :ref:`bool` enabled **)** +.. _class_TouchScreenButton_set_shape: + +- void **set_shape** **(** :ref:`Object` shape **)** + +.. _class_TouchScreenButton_set_shape_centered: + +- void **set_shape_centered** **(** :ref:`bool` bool **)** + +.. _class_TouchScreenButton_set_shape_visible: + +- void **set_shape_visible** **(** :ref:`bool` bool **)** + .. _class_TouchScreenButton_set_texture: - void **set_texture** **(** :ref:`Object` texture **)**