diff --git a/classes/class_acceptdialog.rst b/classes/class_acceptdialog.rst index 14afd27d1..1867378fb 100644 --- a/classes/class_acceptdialog.rst +++ b/classes/class_acceptdialog.rst @@ -20,25 +20,25 @@ Base dialog for user notification. Member Functions ---------------- -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Button` | :ref:`add_button` **(** :ref:`String` text, :ref:`bool` right=false, :ref:`String` action=null **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Button` | :ref:`add_cancel` **(** :ref:`String` name **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_hide_on_ok` **(** **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Label` | :ref:`get_label` **(** **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Button` | :ref:`get_ok` **(** **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_text` **(** **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`register_text_enter` **(** :ref:`Node` line_edit **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_hide_on_ok` **(** :ref:`bool` enabled **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_text` **(** :ref:`String` text **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Button` | :ref:`add_button` **(** :ref:`String` text, :ref:`bool` right=false, :ref:`String` action="" **)** | ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Button` | :ref:`add_cancel` **(** :ref:`String` name **)** | ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_hide_on_ok` **(** **)** const | ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Label` | :ref:`get_label` **(** **)** | ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Button` | :ref:`get_ok` **(** **)** | ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_text` **(** **)** const | ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`register_text_enter` **(** :ref:`Node` line_edit **)** | ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_hide_on_ok` **(** :ref:`bool` enabled **)** | ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_text` **(** :ref:`String` text **)** | ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -66,7 +66,7 @@ Member Function Description .. _class_AcceptDialog_add_button: -- :ref:`Button` **add_button** **(** :ref:`String` text, :ref:`bool` right=false, :ref:`String` action=null **)** +- :ref:`Button` **add_button** **(** :ref:`String` text, :ref:`bool` right=false, :ref:`String` action="" **)** Add custom button to the dialog and return the created button. diff --git a/classes/class_animation.rst b/classes/class_animation.rst index 93046e224..92f02176c 100644 --- a/classes/class_animation.rst +++ b/classes/class_animation.rst @@ -19,7 +19,7 @@ Member Functions ---------------- +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`add_track` **(** :ref:`int` type, :ref:`int` at_pos=null **)** | +| :ref:`int` | :ref:`add_track` **(** :ref:`int` type, :ref:`int` at_pos=-1 **)** | +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** **)** | +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -47,7 +47,7 @@ Member Functions +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_step` **(** :ref:`float` size_sec **)** | +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`track_find_key` **(** :ref:`int` idx, :ref:`float` time, :ref:`bool` exact=null **)** const | +| :ref:`int` | :ref:`track_find_key` **(** :ref:`int` idx, :ref:`float` time, :ref:`bool` exact=false **)** const | +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`track_get_interpolation_loop_wrap` **(** :ref:`int` idx **)** const | +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -65,7 +65,7 @@ Member Functions +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`track_get_type` **(** :ref:`int` idx **)** const | +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_insert_key` **(** :ref:`int` idx, :ref:`float` time, :ref:`Variant` key, :ref:`float` transition=null **)** | +| void | :ref:`track_insert_key` **(** :ref:`int` idx, :ref:`float` time, :ref:`Variant` key, :ref:`float` transition=1 **)** | +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`track_is_imported` **(** :ref:`int` idx **)** const | +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -125,7 +125,7 @@ Member Function Description .. _class_Animation_add_track: -- :ref:`int` **add_track** **(** :ref:`int` type, :ref:`int` at_pos=null **)** +- :ref:`int` **add_track** **(** :ref:`int` type, :ref:`int` at_pos=-1 **)** Add a track to the Animation. The track type must be specified as any of the values in the TYPE\_\* enumeration. @@ -209,7 +209,7 @@ Set the animation step value. .. _class_Animation_track_find_key: -- :ref:`int` **track_find_key** **(** :ref:`int` idx, :ref:`float` time, :ref:`bool` exact=null **)** const +- :ref:`int` **track_find_key** **(** :ref:`int` idx, :ref:`float` time, :ref:`bool` exact=false **)** const Find the key index by time in a given track. Optionally, only find it if the exact time is given. @@ -261,7 +261,7 @@ Get the type of a track. .. _class_Animation_track_insert_key: -- void **track_insert_key** **(** :ref:`int` idx, :ref:`float` time, :ref:`Variant` key, :ref:`float` transition=null **)** +- void **track_insert_key** **(** :ref:`int` idx, :ref:`float` time, :ref:`Variant` key, :ref:`float` transition=1 **)** Insert a generic key in a given track. diff --git a/classes/class_animationplayer.rst b/classes/class_animationplayer.rst index b95be41a5..7505d0263 100644 --- a/classes/class_animationplayer.rst +++ b/classes/class_animationplayer.rst @@ -63,9 +63,9 @@ Member Functions +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_playing` **(** **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`play` **(** :ref:`String` name=false, :ref:`float` custom_blend=1.0, :ref:`float` custom_speed=-1, :ref:`bool` from_end="" **)** | +| void | :ref:`play` **(** :ref:`String` name="", :ref:`float` custom_blend=-1, :ref:`float` custom_speed=1.0, :ref:`bool` from_end=false **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`play_backwards` **(** :ref:`String` name=-1, :ref:`float` custom_blend="" **)** | +| void | :ref:`play_backwards` **(** :ref:`String` name="", :ref:`float` custom_blend=-1 **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`queue` **(** :ref:`String` name **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -73,7 +73,7 @@ Member Functions +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`rename_animation` **(** :ref:`String` name, :ref:`String` newname **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`seek` **(** :ref:`float` pos_sec, :ref:`bool` update=null **)** | +| void | :ref:`seek` **(** :ref:`float` pos_sec, :ref:`bool` update=false **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_active` **(** :ref:`bool` active **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -260,13 +260,13 @@ Return whether an animation is playing. .. _class_AnimationPlayer_play: -- void **play** **(** :ref:`String` name=false, :ref:`float` custom_blend=1.0, :ref:`float` custom_speed=-1, :ref:`bool` from_end="" **)** +- void **play** **(** :ref:`String` name="", :ref:`float` custom_blend=-1, :ref:`float` custom_speed=1.0, :ref:`bool` from_end=false **)** Play a given animation by the animation name. Custom speed and blend times can be set. If custom speed is negative (-1), 'from_end' being true can play the animation backwards. .. _class_AnimationPlayer_play_backwards: -- void **play_backwards** **(** :ref:`String` name=-1, :ref:`float` custom_blend="" **)** +- void **play_backwards** **(** :ref:`String` name="", :ref:`float` custom_blend=-1 **)** Play a given animation by the animation name in reverse. @@ -290,7 +290,7 @@ Rename an existing animation. .. _class_AnimationPlayer_seek: -- void **seek** **(** :ref:`float` pos_sec, :ref:`bool` update=null **)** +- void **seek** **(** :ref:`float` pos_sec, :ref:`bool` update=false **)** Seek the animation to a given position in time (in seconds). If 'update' is true, the animation will be updated too, otherwise it will be updated at process time. diff --git a/classes/class_array.rst b/classes/class_array.rst index 6f6c5e99a..1a73a44bf 100644 --- a/classes/class_array.rst +++ b/classes/class_array.rst @@ -271,6 +271,6 @@ Sort the array using natural order. - void **sort_custom** **(** :ref:`Object` obj, :ref:`String` func **)** -Sort the array using a custom method. The arguments are an object that holds the method and the name of such method. The custom method receives two arguments (a pair of elements from the array) and must return true if the first argument is less than the second, and return false otherwise. +Sort the array using a custom method. The arguments are an object that holds the method and the name of such method. The custom method receives two arguments (a pair of elements from the array) and must return true if the first argument is less than the second, and return false otherwise. Note: you cannot randomize the return value as the heapsort algorithm expects a deterministic result. Doing so will result in unexpected behavior. diff --git a/classes/class_arraymesh.rst b/classes/class_arraymesh.rst index ee6cf7ae0..7d2a3a013 100644 --- a/classes/class_arraymesh.rst +++ b/classes/class_arraymesh.rst @@ -18,49 +18,49 @@ Brief Description Member Functions ---------------- -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_blend_shape` **(** :ref:`String` name **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_surface_from_arrays` **(** :ref:`int` primitive, :ref:`Array` arrays, :ref:`Array` blend_shapes=null, :ref:`int` compress_flags=null **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`center_geometry` **(** **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_blend_shapes` **(** **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_blend_shape_count` **(** **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_blend_shape_mode` **(** **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_blend_shape_name` **(** :ref:`int` index **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect3` | :ref:`get_custom_aabb` **(** **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_surface_count` **(** **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`regen_normalmaps` **(** **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_blend_shape_mode` **(** :ref:`int` mode **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_aabb` **(** :ref:`Rect3` aabb **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`surface_get_array_index_len` **(** :ref:`int` surf_idx **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`surface_get_array_len` **(** :ref:`int` surf_idx **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`surface_get_format` **(** :ref:`int` surf_idx **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Material` | :ref:`surface_get_material` **(** :ref:`int` surf_idx **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`surface_get_name` **(** :ref:`int` surf_idx **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`surface_get_primitive_type` **(** :ref:`int` surf_idx **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`surface_remove` **(** :ref:`int` surf_idx **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`surface_set_material` **(** :ref:`int` surf_idx, :ref:`Material` material **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`surface_set_name` **(** :ref:`int` surf_idx, :ref:`String` name **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_blend_shape` **(** :ref:`String` name **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_surface_from_arrays` **(** :ref:`int` primitive, :ref:`Array` arrays, :ref:`Array` blend_shapes=[ ], :ref:`int` compress_flags=97792 **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`center_geometry` **(** **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_blend_shapes` **(** **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_blend_shape_count` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_blend_shape_mode` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_blend_shape_name` **(** :ref:`int` index **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect3` | :ref:`get_custom_aabb` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_surface_count` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`regen_normalmaps` **(** **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_blend_shape_mode` **(** :ref:`int` mode **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_custom_aabb` **(** :ref:`Rect3` aabb **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`surface_get_array_index_len` **(** :ref:`int` surf_idx **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`surface_get_array_len` **(** :ref:`int` surf_idx **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`surface_get_format` **(** :ref:`int` surf_idx **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Material` | :ref:`surface_get_material` **(** :ref:`int` surf_idx **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`surface_get_name` **(** :ref:`int` surf_idx **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`surface_get_primitive_type` **(** :ref:`int` surf_idx **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`surface_remove` **(** :ref:`int` surf_idx **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`surface_set_material` **(** :ref:`int` surf_idx, :ref:`Material` material **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`surface_set_name` **(** :ref:`int` surf_idx, :ref:`String` name **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -96,7 +96,7 @@ Member Function Description .. _class_ArrayMesh_add_surface_from_arrays: -- void **add_surface_from_arrays** **(** :ref:`int` primitive, :ref:`Array` arrays, :ref:`Array` blend_shapes=null, :ref:`int` compress_flags=null **)** +- void **add_surface_from_arrays** **(** :ref:`int` primitive, :ref:`Array` arrays, :ref:`Array` blend_shapes=[ ], :ref:`int` compress_flags=97792 **)** Create a new surface (:ref:`get_surface_count` that will become surf_idx for this. diff --git a/classes/class_astar.rst b/classes/class_astar.rst index 975c6d87b..c2d549b9a 100644 --- a/classes/class_astar.rst +++ b/classes/class_astar.rst @@ -23,13 +23,13 @@ Member Functions +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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=null **)** | +| void | :ref:`add_point` **(** :ref:`int` id, :ref:`Vector3` pos, :ref:`float` weight_scale=1.0 **)** | +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`are_points_connected` **(** :ref:`int` id, :ref:`int` to_id **)** const | +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** **)** | +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`connect_points` **(** :ref:`int` id, :ref:`int` to_id, :ref:`bool` bidirectional=null **)** | +| void | :ref:`connect_points` **(** :ref:`int` id, :ref:`int` to_id, :ref:`bool` bidirectional=true **)** | +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`disconnect_points` **(** :ref:`int` id, :ref:`int` to_id **)** | +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -72,7 +72,7 @@ Member Function Description .. _class_AStar_add_point: -- void **add_point** **(** :ref:`int` id, :ref:`Vector3` pos, :ref:`float` weight_scale=null **)** +- void **add_point** **(** :ref:`int` id, :ref:`Vector3` pos, :ref:`float` weight_scale=1.0 **)** Add a new point at the given position ``pos`` with the given identifier ``id``. The ``weight_scale`` has to be 1 or larger. @@ -90,7 +90,7 @@ Clear all the points and segments from AStar instance. .. _class_AStar_connect_points: -- void **connect_points** **(** :ref:`int` id, :ref:`int` to_id, :ref:`bool` bidirectional=null **)** +- void **connect_points** **(** :ref:`int` id, :ref:`int` to_id, :ref:`bool` bidirectional=true **)** Create a segment between points ``id`` and ``to_id``. diff --git a/classes/class_audioserver.rst b/classes/class_audioserver.rst index b7ea6778f..0e6c010c2 100644 --- a/classes/class_audioserver.rst +++ b/classes/class_audioserver.rst @@ -21,7 +21,7 @@ Member Functions +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_bus` **(** :ref:`int` at_pos=-1 **)** | +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_bus_effect` **(** :ref:`int` bus_idx, :ref:`AudioEffect` effect, :ref:`int` at_pos=null **)** | +| void | :ref:`add_bus_effect` **(** :ref:`int` bus_idx, :ref:`AudioEffect` effect, :ref:`int` at_pos=-1 **)** | +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`AudioBusLayout` | :ref:`generate_bus_layout` **(** **)** const | +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -105,7 +105,7 @@ Member Function Description .. _class_AudioServer_add_bus_effect: -- void **add_bus_effect** **(** :ref:`int` bus_idx, :ref:`AudioEffect` effect, :ref:`int` at_pos=null **)** +- void **add_bus_effect** **(** :ref:`int` bus_idx, :ref:`AudioEffect` effect, :ref:`int` at_pos=-1 **)** .. _class_AudioServer_generate_bus_layout: diff --git a/classes/class_bitmapfont.rst b/classes/class_bitmapfont.rst index 13d74b421..ab97a9abb 100644 --- a/classes/class_bitmapfont.rst +++ b/classes/class_bitmapfont.rst @@ -18,35 +18,35 @@ Brief Description Member Functions ---------------- -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_char` **(** :ref:`int` character, :ref:`int` texture, :ref:`Rect2` rect, :ref:`Vector2` align=null, :ref:`float` advance=null **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_kerning_pair` **(** :ref:`int` char_a, :ref:`int` char_b, :ref:`int` kerning **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_texture` **(** :ref:`Texture` texture **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`create_from_fnt` **(** :ref:`String` path **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_char_size` **(** :ref:`int` char, :ref:`int` next=null **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`BitmapFont` | :ref:`get_fallback` **(** **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_kerning_pair` **(** :ref:`int` char_a, :ref:`int` char_b **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_texture` **(** :ref:`int` idx **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_texture_count` **(** **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ascent` **(** :ref:`float` px **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_distance_field_hint` **(** :ref:`bool` enable **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fallback` **(** :ref:`BitmapFont` fallback **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_height` **(** :ref:`float` px **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_char` **(** :ref:`int` character, :ref:`int` texture, :ref:`Rect2` rect, :ref:`Vector2` align=Vector2( 0, 0 ), :ref:`float` advance=-1 **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_kerning_pair` **(** :ref:`int` char_a, :ref:`int` char_b, :ref:`int` kerning **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_texture` **(** :ref:`Texture` texture **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`create_from_fnt` **(** :ref:`String` path **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_char_size` **(** :ref:`int` char, :ref:`int` next=0 **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`BitmapFont` | :ref:`get_fallback` **(** **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_kerning_pair` **(** :ref:`int` char_a, :ref:`int` char_b **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_texture` **(** :ref:`int` idx **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_texture_count` **(** **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ascent` **(** :ref:`float` px **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_distance_field_hint` **(** :ref:`bool` enable **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fallback` **(** :ref:`BitmapFont` fallback **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_height` **(** :ref:`float` px **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -64,7 +64,7 @@ Member Function Description .. _class_BitmapFont_add_char: -- void **add_char** **(** :ref:`int` character, :ref:`int` texture, :ref:`Rect2` rect, :ref:`Vector2` align=null, :ref:`float` advance=null **)** +- void **add_char** **(** :ref:`int` character, :ref:`int` texture, :ref:`Rect2` rect, :ref:`Vector2` align=Vector2( 0, 0 ), :ref:`float` advance=-1 **)** Add a character to the font, where *character* is the unicode value, *texture* is the texture index, *rect* is the region in the texture (in pixels!), *align* is the (optional) alignment for the character and *advance* is the (optional) advance. @@ -92,7 +92,7 @@ Clear all the font data. .. _class_BitmapFont_get_char_size: -- :ref:`Vector2` **get_char_size** **(** :ref:`int` char, :ref:`int` next=null **)** const +- :ref:`Vector2` **get_char_size** **(** :ref:`int` char, :ref:`int` next=0 **)** const Return the size of a character, optionally taking kerning into account if the next character is provided. diff --git a/classes/class_canvasitem.rst b/classes/class_canvasitem.rst index e3e2b6fcf..7dad17a3b 100644 --- a/classes/class_canvasitem.rst +++ b/classes/class_canvasitem.rst @@ -20,127 +20,127 @@ Base class of anything 2D. Member Functions ---------------- -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_draw` **(** **)** virtual | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`draw_char` **(** :ref:`Font` font, :ref:`Vector2` pos, :ref:`String` char, :ref:`String` next, :ref:`Color` modulate=null **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_circle` **(** :ref:`Vector2` pos, :ref:`float` radius, :ref:`Color` color **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_colored_polygon` **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`PoolVector2Array` uvs=null, :ref:`Texture` texture=PoolVector2Array( ), :ref:`Texture` normal_map=null, :ref:`bool` antialiased=null **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_line` **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=null, :ref:`bool` antialiased=null **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_polygon` **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs=null, :ref:`Texture` texture=PoolVector2Array( ), :ref:`Texture` normal_map=null, :ref:`bool` antialiased=null **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_polyline` **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`float` width=null, :ref:`bool` antialiased=null **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_polyline_colors` **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`float` width=null, :ref:`bool` antialiased=null **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_primitive` **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs, :ref:`Texture` texture=null, :ref:`float` width=null, :ref:`Texture` normal_map=null **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_rect` **(** :ref:`Rect2` rect, :ref:`Color` color, :ref:`bool` filled=null **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_set_transform` **(** :ref:`Vector2` pos, :ref:`float` rot, :ref:`Vector2` scale **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_set_transform_matrix` **(** :ref:`Transform2D` xform **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_string` **(** :ref:`Font` font, :ref:`Vector2` pos, :ref:`String` text, :ref:`Color` modulate=null, :ref:`int` clip_w=null **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_style_box` **(** :ref:`StyleBox` style_box, :ref:`Rect2` rect **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_texture` **(** :ref:`Texture` texture, :ref:`Vector2` pos, :ref:`Color` modulate=null, :ref:`Texture` normal_map=null **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_texture_rect` **(** :ref:`Texture` texture, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate=null, :ref:`bool` transpose=null, :ref:`Texture` normal_map=null **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_texture_rect_region` **(** :ref:`Texture` texture, :ref:`Rect2` rect, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=null, :ref:`Texture` normal_map=null, :ref:`bool` clip_uv=null **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`edit_get_state` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`edit_rotate` **(** :ref:`float` degrees **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`edit_set_rect` **(** :ref:`Rect2` rect **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`edit_set_state` **(** :ref:`Variant` state **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_canvas` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_canvas_item` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_canvas_transform` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_global_mouse_position` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_global_transform` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_global_transform_with_canvas` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_item_and_children_rect` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_item_rect` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_light_mask` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_local_mouse_pos` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Material` | :ref:`get_material` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_modulate` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_self_modulate` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_transform` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_use_parent_material` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_viewport_rect` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_viewport_transform` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`World2D` | :ref:`get_world_2d` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`hide` **(** **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_draw_behind_parent_enabled` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_local_transform_notification_enabled` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_set_as_toplevel` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_transform_notification_enabled` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_visible` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_visible_in_tree` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`make_canvas_pos_local` **(** :ref:`Vector2` screen_point **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`InputEvent` | :ref:`make_input_local` **(** :ref:`InputEvent` event **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_as_toplevel` **(** :ref:`bool` enable **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_draw_behind_parent` **(** :ref:`bool` enable **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_light_mask` **(** :ref:`int` light_mask **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_material` **(** :ref:`Material` material **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_modulate` **(** :ref:`Color` modulate **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_notify_local_transform` **(** :ref:`bool` enable **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_notify_transform` **(** :ref:`bool` enable **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_self_modulate` **(** :ref:`Color` self_modulate **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_parent_material` **(** :ref:`bool` enable **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_visible` **(** :ref:`bool` visible **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`show` **(** **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`update` **(** **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_draw` **(** **)** virtual | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`draw_char` **(** :ref:`Font` font, :ref:`Vector2` pos, :ref:`String` char, :ref:`String` next, :ref:`Color` modulate=Color( 1, 1, 1, 1 ) **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_circle` **(** :ref:`Vector2` pos, :ref:`float` radius, :ref:`Color` color **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_colored_polygon` **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`Texture` texture=null, :ref:`Texture` normal_map=null, :ref:`bool` antialiased=false **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_line` **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_polygon` **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`Texture` texture=null, :ref:`Texture` normal_map=null, :ref:`bool` antialiased=false **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_polyline` **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_polyline_colors` **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_primitive` **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs, :ref:`Texture` texture=null, :ref:`float` width=1.0, :ref:`Texture` normal_map=null **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_rect` **(** :ref:`Rect2` rect, :ref:`Color` color, :ref:`bool` filled=true **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_set_transform` **(** :ref:`Vector2` pos, :ref:`float` rot, :ref:`Vector2` scale **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_set_transform_matrix` **(** :ref:`Transform2D` xform **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_string` **(** :ref:`Font` font, :ref:`Vector2` pos, :ref:`String` text, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`int` clip_w=-1 **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_style_box` **(** :ref:`StyleBox` style_box, :ref:`Rect2` rect **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_texture` **(** :ref:`Texture` texture, :ref:`Vector2` pos, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`Texture` normal_map=null **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_texture_rect` **(** :ref:`Texture` texture, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_texture_rect_region` **(** :ref:`Texture` texture, :ref:`Rect2` rect, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null, :ref:`bool` clip_uv=true **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`edit_get_state` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`edit_rotate` **(** :ref:`float` degrees **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`edit_set_rect` **(** :ref:`Rect2` rect **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`edit_set_state` **(** :ref:`Variant` state **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_canvas` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_canvas_item` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_canvas_transform` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_global_mouse_position` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_global_transform` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_global_transform_with_canvas` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_item_and_children_rect` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_item_rect` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_light_mask` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_local_mouse_pos` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Material` | :ref:`get_material` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_modulate` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_self_modulate` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_transform` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_use_parent_material` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_viewport_rect` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_viewport_transform` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`World2D` | :ref:`get_world_2d` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`hide` **(** **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_draw_behind_parent_enabled` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_local_transform_notification_enabled` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_set_as_toplevel` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_transform_notification_enabled` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_visible` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_visible_in_tree` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`make_canvas_pos_local` **(** :ref:`Vector2` screen_point **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`InputEvent` | :ref:`make_input_local` **(** :ref:`InputEvent` event **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_as_toplevel` **(** :ref:`bool` enable **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_draw_behind_parent` **(** :ref:`bool` enable **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_light_mask` **(** :ref:`int` light_mask **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_material` **(** :ref:`Material` material **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_modulate` **(** :ref:`Color` modulate **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_notify_local_transform` **(** :ref:`bool` enable **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_notify_transform` **(** :ref:`bool` enable **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_self_modulate` **(** :ref:`Color` self_modulate **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_use_parent_material` **(** :ref:`bool` enable **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_visible` **(** :ref:`bool` visible **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`show` **(** **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`update` **(** **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -208,7 +208,7 @@ Called (if exists) to draw the canvas item. .. _class_CanvasItem_draw_char: -- :ref:`float` **draw_char** **(** :ref:`Font` font, :ref:`Vector2` pos, :ref:`String` char, :ref:`String` next, :ref:`Color` modulate=null **)** +- :ref:`float` **draw_char** **(** :ref:`Font` font, :ref:`Vector2` pos, :ref:`String` char, :ref:`String` next, :ref:`Color` modulate=Color( 1, 1, 1, 1 ) **)** Draw a string character using a custom font. Returns the advance, depending on the char width and kerning with an optional next char. @@ -220,39 +220,39 @@ Draw a colored circle. .. _class_CanvasItem_draw_colored_polygon: -- void **draw_colored_polygon** **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`PoolVector2Array` uvs=null, :ref:`Texture` texture=PoolVector2Array( ), :ref:`Texture` normal_map=null, :ref:`bool` antialiased=null **)** +- void **draw_colored_polygon** **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`Texture` texture=null, :ref:`Texture` normal_map=null, :ref:`bool` antialiased=false **)** Draw a colored polygon of any amount of points, convex or concave. .. _class_CanvasItem_draw_line: -- void **draw_line** **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=null, :ref:`bool` antialiased=null **)** +- void **draw_line** **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** Draw a line from a 2D point to another, with a given color and width. It can be optionally antialiased. .. _class_CanvasItem_draw_polygon: -- void **draw_polygon** **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs=null, :ref:`Texture` texture=PoolVector2Array( ), :ref:`Texture` normal_map=null, :ref:`bool` antialiased=null **)** +- void **draw_polygon** **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`Texture` texture=null, :ref:`Texture` normal_map=null, :ref:`bool` antialiased=false **)** Draw a polygon of any amount of points, convex or concave. .. _class_CanvasItem_draw_polyline: -- void **draw_polyline** **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`float` width=null, :ref:`bool` antialiased=null **)** +- void **draw_polyline** **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** .. _class_CanvasItem_draw_polyline_colors: -- void **draw_polyline_colors** **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`float` width=null, :ref:`bool` antialiased=null **)** +- void **draw_polyline_colors** **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** .. _class_CanvasItem_draw_primitive: -- void **draw_primitive** **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs, :ref:`Texture` texture=null, :ref:`float` width=null, :ref:`Texture` normal_map=null **)** +- void **draw_primitive** **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs, :ref:`Texture` texture=null, :ref:`float` width=1.0, :ref:`Texture` normal_map=null **)** Draw a custom primitive, 1 point for a point, 2 points for a line, 3 points for a triangle and 4 points for a quad. .. _class_CanvasItem_draw_rect: -- void **draw_rect** **(** :ref:`Rect2` rect, :ref:`Color` color, :ref:`bool` filled=null **)** +- void **draw_rect** **(** :ref:`Rect2` rect, :ref:`Color` color, :ref:`bool` filled=true **)** Draw a colored rectangle. @@ -268,7 +268,7 @@ Set a custom transform for drawing. Anything drawn afterwards will be transforme .. _class_CanvasItem_draw_string: -- void **draw_string** **(** :ref:`Font` font, :ref:`Vector2` pos, :ref:`String` text, :ref:`Color` modulate=null, :ref:`int` clip_w=null **)** +- void **draw_string** **(** :ref:`Font` font, :ref:`Vector2` pos, :ref:`String` text, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`int` clip_w=-1 **)** Draw a string using a custom font. @@ -280,19 +280,19 @@ Draw a styled rectangle. .. _class_CanvasItem_draw_texture: -- void **draw_texture** **(** :ref:`Texture` texture, :ref:`Vector2` pos, :ref:`Color` modulate=null, :ref:`Texture` normal_map=null **)** +- void **draw_texture** **(** :ref:`Texture` texture, :ref:`Vector2` pos, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`Texture` normal_map=null **)** Draw a texture at a given position. .. _class_CanvasItem_draw_texture_rect: -- void **draw_texture_rect** **(** :ref:`Texture` texture, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate=null, :ref:`bool` transpose=null, :ref:`Texture` normal_map=null **)** +- void **draw_texture_rect** **(** :ref:`Texture` texture, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null **)** Draw a textured rectangle at a given position, optionally modulated by a color. Transpose swaps the x and y coordinates when reading the texture. .. _class_CanvasItem_draw_texture_rect_region: -- void **draw_texture_rect_region** **(** :ref:`Texture` texture, :ref:`Rect2` rect, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=null, :ref:`Texture` normal_map=null, :ref:`bool` clip_uv=null **)** +- void **draw_texture_rect_region** **(** :ref:`Texture` texture, :ref:`Rect2` rect, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null, :ref:`bool` clip_uv=true **)** Draw a textured rectangle region at a given position, optionally modulated by a color. Transpose swaps the x and y coordinates when reading the texture. diff --git a/classes/class_classdb.rst b/classes/class_classdb.rst index bdc1a8594..d93bd8676 100644 --- a/classes/class_classdb.rst +++ b/classes/class_classdb.rst @@ -18,47 +18,47 @@ Brief Description Member Functions ---------------- -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_instance` **(** :ref:`String` class **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`class_exists` **(** :ref:`String` class **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`class_get_category` **(** :ref:`String` class **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`class_get_integer_constant` **(** :ref:`String` class, :ref:`String` name **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`class_get_integer_constant_list` **(** :ref:`String` class, :ref:`bool` no_inheritance=null **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`class_get_method_list` **(** :ref:`String` class, :ref:`bool` no_inheritance=null **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`class_get_property` **(** :ref:`Object` object, :ref:`String` property **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`class_get_property_list` **(** :ref:`String` class, :ref:`bool` no_inheritance=null **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`class_get_signal` **(** :ref:`String` class, :ref:`String` signal **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`class_get_signal_list` **(** :ref:`String` class, :ref:`bool` no_inheritance=null **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`class_has_integer_constant` **(** :ref:`String` class, :ref:`String` name **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`class_has_method` **(** :ref:`String` class, :ref:`String` method, :ref:`bool` no_inheritance=null **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`class_has_signal` **(** :ref:`String` class, :ref:`String` signal **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`class_set_property` **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` value **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_class_list` **(** **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_inheriters_from_class` **(** :ref:`String` class **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_parent_class` **(** :ref:`String` class **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`instance` **(** :ref:`String` class **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_class_enabled` **(** :ref:`String` class **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_parent_class` **(** :ref:`String` class, :ref:`String` inherits **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`can_instance` **(** :ref:`String` class **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`class_exists` **(** :ref:`String` class **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`class_get_category` **(** :ref:`String` class **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`class_get_integer_constant` **(** :ref:`String` class, :ref:`String` name **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`class_get_integer_constant_list` **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`class_get_method_list` **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`class_get_property` **(** :ref:`Object` object, :ref:`String` property **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`class_get_property_list` **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`class_get_signal` **(** :ref:`String` class, :ref:`String` signal **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`class_get_signal_list` **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`class_has_integer_constant` **(** :ref:`String` class, :ref:`String` name **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`class_has_method` **(** :ref:`String` class, :ref:`String` method, :ref:`bool` no_inheritance=false **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`class_has_signal` **(** :ref:`String` class, :ref:`String` signal **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`class_set_property` **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` value **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_class_list` **(** **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_inheriters_from_class` **(** :ref:`String` class **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_parent_class` **(** :ref:`String` class **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`instance` **(** :ref:`String` class **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_class_enabled` **(** :ref:`String` class **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_parent_class` **(** :ref:`String` class, :ref:`String` inherits **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Function Description --------------------------- @@ -81,11 +81,11 @@ Member Function Description .. _class_ClassDB_class_get_integer_constant_list: -- :ref:`PoolStringArray` **class_get_integer_constant_list** **(** :ref:`String` class, :ref:`bool` no_inheritance=null **)** const +- :ref:`PoolStringArray` **class_get_integer_constant_list** **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const .. _class_ClassDB_class_get_method_list: -- :ref:`Array` **class_get_method_list** **(** :ref:`String` class, :ref:`bool` no_inheritance=null **)** const +- :ref:`Array` **class_get_method_list** **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const .. _class_ClassDB_class_get_property: @@ -93,7 +93,7 @@ Member Function Description .. _class_ClassDB_class_get_property_list: -- :ref:`Array` **class_get_property_list** **(** :ref:`String` class, :ref:`bool` no_inheritance=null **)** const +- :ref:`Array` **class_get_property_list** **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const .. _class_ClassDB_class_get_signal: @@ -101,7 +101,7 @@ Member Function Description .. _class_ClassDB_class_get_signal_list: -- :ref:`Array` **class_get_signal_list** **(** :ref:`String` class, :ref:`bool` no_inheritance=null **)** const +- :ref:`Array` **class_get_signal_list** **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const .. _class_ClassDB_class_has_integer_constant: @@ -109,7 +109,7 @@ Member Function Description .. _class_ClassDB_class_has_method: -- :ref:`bool` **class_has_method** **(** :ref:`String` class, :ref:`String` method, :ref:`bool` no_inheritance=null **)** const +- :ref:`bool` **class_has_method** **(** :ref:`String` class, :ref:`String` method, :ref:`bool` no_inheritance=false **)** const .. _class_ClassDB_class_has_signal: diff --git a/classes/class_control.rst b/classes/class_control.rst index 91c05dcd9..b734e6e6b 100644 --- a/classes/class_control.rst +++ b/classes/class_control.rst @@ -20,201 +20,201 @@ Control is the base node for all the GUI components. Member Functions ---------------- -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`_get_minimum_size` **(** **)** virtual | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_gui_input` **(** :ref:`InputEvent` event **)** virtual | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`accept_event` **(** **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_color_override` **(** :ref:`String` name, :ref:`Color` color **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_constant_override` **(** :ref:`String` name, :ref:`int` constant **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_font_override` **(** :ref:`String` name, :ref:`Font` font **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_icon_override` **(** :ref:`String` name, :ref:`Texture` texture **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_shader_override` **(** :ref:`String` name, :ref:`Shader` shader **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_style_override` **(** :ref:`String` name, :ref:`StyleBox` stylebox **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_drop_data` **(** :ref:`Vector2` pos, :ref:`Variant` data **)** virtual | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`drop_data` **(** :ref:`Vector2` pos, :ref:`Variant` data **)** virtual | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`force_drag` **(** :ref:`Variant` data, :ref:`Control` preview **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_anchor` **(** :ref:`int` margin **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_begin` **(** **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_color` **(** :ref:`String` name, :ref:`String` type=null **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_combined_minimum_size` **(** **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_constant` **(** :ref:`String` name, :ref:`String` type=null **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_cursor_shape` **(** :ref:`Vector2` pos=Vector2( 0, 0 ) **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_custom_minimum_size` **(** **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_default_cursor_shape` **(** **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_drag_data` **(** :ref:`Vector2` pos **)** virtual | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_end` **(** **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_focus_mode` **(** **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_focus_neighbour` **(** :ref:`int` margin **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Control` | :ref:`get_focus_owner` **(** **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Font` | :ref:`get_font` **(** :ref:`String` name, :ref:`String` type=null **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_global_position` **(** **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_global_rect` **(** **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_h_grow_direction` **(** **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_h_size_flags` **(** **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_icon` **(** :ref:`String` name, :ref:`String` type=null **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_margin` **(** :ref:`int` margin **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_minimum_size` **(** **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_mouse_filter` **(** **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_parent_area_size` **(** **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Control` | :ref:`get_parent_control` **(** **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_pivot_offset` **(** **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_position` **(** **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_rect` **(** **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_rotation` **(** **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_rotation_deg` **(** **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_scale` **(** **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_size` **(** **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_stretch_ratio` **(** **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`get_stylebox` **(** :ref:`String` name, :ref:`String` type=null **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Theme` | :ref:`get_theme` **(** **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_tooltip` **(** :ref:`Vector2` atpos=Vector2( 0, 0 ) **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_v_grow_direction` **(** **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_v_size_flags` **(** **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`grab_click_focus` **(** **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`grab_focus` **(** **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_color` **(** :ref:`String` name, :ref:`String` type=null **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_color_override` **(** :ref:`String` name **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_constant` **(** :ref:`String` name, :ref:`String` type=null **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_constant_override` **(** :ref:`String` name **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_focus` **(** **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_font` **(** :ref:`String` name, :ref:`String` type=null **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_font_override` **(** :ref:`String` name **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_icon` **(** :ref:`String` name, :ref:`String` type=null **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_icon_override` **(** :ref:`String` name **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_point` **(** :ref:`Vector2` point **)** virtual | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_stylebox` **(** :ref:`String` name, :ref:`String` type=null **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_stylebox_override` **(** :ref:`String` name **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_clipping_contents` **(** **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`minimum_size_changed` **(** **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`release_focus` **(** **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_anchor` **(** :ref:`int` margin, :ref:`float` anchor, :ref:`bool` keep_margin=null, :ref:`bool` push_opposite_anchor=null **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_anchor_and_margin` **(** :ref:`int` margin, :ref:`float` anchor, :ref:`float` offset, :ref:`bool` push_opposite_anchor=null **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_anchors_preset` **(** :ref:`int` preset, :ref:`bool` keep_margin=null **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_area_as_parent_rect` **(** :ref:`int` margin=0 **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_begin` **(** :ref:`Vector2` pos **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_clip_contents` **(** :ref:`bool` enable **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_minimum_size` **(** :ref:`Vector2` size **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_default_cursor_shape` **(** :ref:`int` shape **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_drag_forwarding` **(** :ref:`Control` target **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_drag_preview` **(** :ref:`Control` control **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_end` **(** :ref:`Vector2` pos **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_focus_mode` **(** :ref:`int` mode **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_focus_neighbour` **(** :ref:`int` margin, :ref:`NodePath` neighbour **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_global_position` **(** :ref:`Vector2` pos **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_h_grow_direction` **(** :ref:`int` direction **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_h_size_flags` **(** :ref:`int` flags **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_margin` **(** :ref:`int` margin, :ref:`float` offset **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_mouse_filter` **(** :ref:`int` filter **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pivot_offset` **(** :ref:`Vector2` pivot_offset **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_position` **(** :ref:`Vector2` pos **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rotation` **(** :ref:`float` radians **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rotation_deg` **(** :ref:`float` degrees **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_scale` **(** :ref:`Vector2` scale **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_size` **(** :ref:`Vector2` size **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_stretch_ratio` **(** :ref:`float` ratio **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_theme` **(** :ref:`Theme` theme **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tooltip` **(** :ref:`String` tooltip **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_v_grow_direction` **(** :ref:`int` direction **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_v_size_flags` **(** :ref:`int` flags **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`show_modal` **(** :ref:`bool` exclusive=false **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`warp_mouse` **(** :ref:`Vector2` to_pos **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`_get_minimum_size` **(** **)** virtual | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_gui_input` **(** :ref:`InputEvent` event **)** virtual | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`accept_event` **(** **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_color_override` **(** :ref:`String` name, :ref:`Color` color **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_constant_override` **(** :ref:`String` name, :ref:`int` constant **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_font_override` **(** :ref:`String` name, :ref:`Font` font **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_icon_override` **(** :ref:`String` name, :ref:`Texture` texture **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_shader_override` **(** :ref:`String` name, :ref:`Shader` shader **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_style_override` **(** :ref:`String` name, :ref:`StyleBox` stylebox **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`can_drop_data` **(** :ref:`Vector2` pos, :ref:`Variant` data **)** virtual | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`drop_data` **(** :ref:`Vector2` pos, :ref:`Variant` data **)** virtual | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`force_drag` **(** :ref:`Variant` data, :ref:`Control` preview **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_anchor` **(** :ref:`int` margin **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_begin` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_color` **(** :ref:`String` name, :ref:`String` type="" **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_combined_minimum_size` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_constant` **(** :ref:`String` name, :ref:`String` type="" **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_cursor_shape` **(** :ref:`Vector2` pos=Vector2( 0, 0 ) **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_custom_minimum_size` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_default_cursor_shape` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_drag_data` **(** :ref:`Vector2` pos **)** virtual | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_end` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_focus_mode` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_focus_neighbour` **(** :ref:`int` margin **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Control` | :ref:`get_focus_owner` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Font` | :ref:`get_font` **(** :ref:`String` name, :ref:`String` type="" **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_global_position` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_global_rect` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_h_grow_direction` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_h_size_flags` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_icon` **(** :ref:`String` name, :ref:`String` type="" **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_margin` **(** :ref:`int` margin **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_minimum_size` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_mouse_filter` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_parent_area_size` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Control` | :ref:`get_parent_control` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_pivot_offset` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_position` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_rect` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_rotation` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_rotation_deg` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_scale` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_size` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_stretch_ratio` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`StyleBox` | :ref:`get_stylebox` **(** :ref:`String` name, :ref:`String` type="" **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Theme` | :ref:`get_theme` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_tooltip` **(** :ref:`Vector2` atpos=Vector2( 0, 0 ) **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_v_grow_direction` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_v_size_flags` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`grab_click_focus` **(** **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`grab_focus` **(** **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_color` **(** :ref:`String` name, :ref:`String` type="" **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_color_override` **(** :ref:`String` name **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_constant` **(** :ref:`String` name, :ref:`String` type="" **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_constant_override` **(** :ref:`String` name **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_focus` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_font` **(** :ref:`String` name, :ref:`String` type="" **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_font_override` **(** :ref:`String` name **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_icon` **(** :ref:`String` name, :ref:`String` type="" **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_icon_override` **(** :ref:`String` name **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :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 | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_clipping_contents` **(** **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`minimum_size_changed` **(** **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`release_focus` **(** **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_anchor` **(** :ref:`int` margin, :ref:`float` anchor, :ref:`bool` keep_margin=false, :ref:`bool` push_opposite_anchor=true **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_anchor_and_margin` **(** :ref:`int` margin, :ref:`float` anchor, :ref:`float` offset, :ref:`bool` push_opposite_anchor=false **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_anchors_preset` **(** :ref:`int` preset, :ref:`bool` keep_margin=false **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_area_as_parent_rect` **(** :ref:`int` margin=0 **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_begin` **(** :ref:`Vector2` pos **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_clip_contents` **(** :ref:`bool` enable **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_custom_minimum_size` **(** :ref:`Vector2` size **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_default_cursor_shape` **(** :ref:`int` shape **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_drag_forwarding` **(** :ref:`Control` target **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_drag_preview` **(** :ref:`Control` control **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_end` **(** :ref:`Vector2` pos **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_focus_mode` **(** :ref:`int` mode **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_focus_neighbour` **(** :ref:`int` margin, :ref:`NodePath` neighbour **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_global_position` **(** :ref:`Vector2` pos **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_h_grow_direction` **(** :ref:`int` direction **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_h_size_flags` **(** :ref:`int` flags **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_margin` **(** :ref:`int` margin, :ref:`float` offset **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_mouse_filter` **(** :ref:`int` filter **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_pivot_offset` **(** :ref:`Vector2` pivot_offset **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_position` **(** :ref:`Vector2` pos **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_rotation` **(** :ref:`float` radians **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_rotation_deg` **(** :ref:`float` degrees **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_scale` **(** :ref:`Vector2` scale **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_size` **(** :ref:`Vector2` size **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_stretch_ratio` **(** :ref:`float` ratio **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_theme` **(** :ref:`Theme` theme **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tooltip` **(** :ref:`String` tooltip **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_v_grow_direction` **(** :ref:`int` direction **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_v_size_flags` **(** :ref:`int` flags **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`show_modal` **(** :ref:`bool` exclusive=false **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`warp_mouse` **(** :ref:`Vector2` to_pos **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -425,7 +425,7 @@ Return the anchor type (ANCHOR_BEGIN, ANCHOR_END, ANCHOR_RATIO) for a given marg .. _class_Control_get_color: -- :ref:`Color` **get_color** **(** :ref:`String` name, :ref:`String` type=null **)** const +- :ref:`Color` **get_color** **(** :ref:`String` name, :ref:`String` type="" **)** const .. _class_Control_get_combined_minimum_size: @@ -433,7 +433,7 @@ Return the anchor type (ANCHOR_BEGIN, ANCHOR_END, ANCHOR_RATIO) for a given marg .. _class_Control_get_constant: -- :ref:`int` **get_constant** **(** :ref:`String` name, :ref:`String` type=null **)** const +- :ref:`int` **get_constant** **(** :ref:`String` name, :ref:`String` type="" **)** const .. _class_Control_get_cursor_shape: @@ -481,7 +481,7 @@ Return which control is owning the keyboard focus, or null if no one. .. _class_Control_get_font: -- :ref:`Font` **get_font** **(** :ref:`String` name, :ref:`String` type=null **)** const +- :ref:`Font` **get_font** **(** :ref:`String` name, :ref:`String` type="" **)** const .. _class_Control_get_global_position: @@ -507,7 +507,7 @@ Hint for containers, return horizontal positioning flags. .. _class_Control_get_icon: -- :ref:`Texture` **get_icon** **(** :ref:`String` name, :ref:`String` type=null **)** const +- :ref:`Texture` **get_icon** **(** :ref:`String` name, :ref:`String` type="" **)** const .. _class_Control_get_margin: @@ -581,7 +581,7 @@ Hint for containers, return the stretch ratio. This value is relative to other s .. _class_Control_get_stylebox: -- :ref:`StyleBox` **get_stylebox** **(** :ref:`String` name, :ref:`String` type=null **)** const +- :ref:`StyleBox` **get_stylebox** **(** :ref:`String` name, :ref:`String` type="" **)** const .. _class_Control_get_theme: @@ -617,7 +617,7 @@ Steal the focus from another control and become the focused control (see :ref:`s .. _class_Control_has_color: -- :ref:`bool` **has_color** **(** :ref:`String` name, :ref:`String` type=null **)** const +- :ref:`bool` **has_color** **(** :ref:`String` name, :ref:`String` type="" **)** const .. _class_Control_has_color_override: @@ -625,7 +625,7 @@ Steal the focus from another control and become the focused control (see :ref:`s .. _class_Control_has_constant: -- :ref:`bool` **has_constant** **(** :ref:`String` name, :ref:`String` type=null **)** const +- :ref:`bool` **has_constant** **(** :ref:`String` name, :ref:`String` type="" **)** const .. _class_Control_has_constant_override: @@ -639,7 +639,7 @@ Return whether the Control is the current focused control (see :ref:`set_focus_m .. _class_Control_has_font: -- :ref:`bool` **has_font** **(** :ref:`String` name, :ref:`String` type=null **)** const +- :ref:`bool` **has_font** **(** :ref:`String` name, :ref:`String` type="" **)** const .. _class_Control_has_font_override: @@ -647,7 +647,7 @@ Return whether the Control is the current focused control (see :ref:`set_focus_m .. _class_Control_has_icon: -- :ref:`bool` **has_icon** **(** :ref:`String` name, :ref:`String` type=null **)** const +- :ref:`bool` **has_icon** **(** :ref:`String` name, :ref:`String` type="" **)** const .. _class_Control_has_icon_override: @@ -659,7 +659,7 @@ Return whether the Control is the current focused control (see :ref:`set_focus_m .. _class_Control_has_stylebox: -- :ref:`bool` **has_stylebox** **(** :ref:`String` name, :ref:`String` type=null **)** const +- :ref:`bool` **has_stylebox** **(** :ref:`String` name, :ref:`String` type="" **)** const .. _class_Control_has_stylebox_override: @@ -681,15 +681,15 @@ Give up the focus, no other control will be able to receive keyboard input. .. _class_Control_set_anchor: -- void **set_anchor** **(** :ref:`int` margin, :ref:`float` anchor, :ref:`bool` keep_margin=null, :ref:`bool` push_opposite_anchor=null **)** +- void **set_anchor** **(** :ref:`int` margin, :ref:`float` anchor, :ref:`bool` keep_margin=false, :ref:`bool` push_opposite_anchor=true **)** .. _class_Control_set_anchor_and_margin: -- void **set_anchor_and_margin** **(** :ref:`int` margin, :ref:`float` anchor, :ref:`float` offset, :ref:`bool` push_opposite_anchor=null **)** +- void **set_anchor_and_margin** **(** :ref:`int` margin, :ref:`float` anchor, :ref:`float` offset, :ref:`bool` push_opposite_anchor=false **)** .. _class_Control_set_anchors_preset: -- void **set_anchors_preset** **(** :ref:`int` preset, :ref:`bool` keep_margin=null **)** +- void **set_anchors_preset** **(** :ref:`int` preset, :ref:`bool` keep_margin=false **)** .. _class_Control_set_area_as_parent_rect: diff --git a/classes/class_curve.rst b/classes/class_curve.rst index 064c4b9f8..22211b5fc 100644 --- a/classes/class_curve.rst +++ b/classes/class_curve.rst @@ -18,55 +18,55 @@ Brief Description Member Functions ---------------- -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`add_point` **(** :ref:`Vector2` pos, :ref:`float` left_tangent=0, :ref:`float` right_tangent=0, :ref:`int` left_mode=0, :ref:`int` right_mode=null **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`bake` **(** **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clean_dupes` **(** **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_points` **(** **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_bake_resolution` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_max_value` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_min_value` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_point_left_mode` **(** :ref:`int` index **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_point_left_tangent` **(** :ref:`int` index **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_point_pos` **(** :ref:`int` index **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_point_right_mode` **(** :ref:`int` index **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_point_right_tangent` **(** :ref:`int` index **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`interpolate` **(** :ref:`float` offset **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`interpolate_baked` **(** :ref:`float` offset **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_point` **(** :ref:`int` index **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bake_resolution` **(** :ref:`int` resolution **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_max_value` **(** :ref:`float` max **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_min_value` **(** :ref:`float` min **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_left_mode` **(** :ref:`int` index, :ref:`int` mode **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_left_tangent` **(** :ref:`int` index, :ref:`float` tangent **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_offset` **(** :ref:`int` index, :ref:`float` offset **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_right_mode` **(** :ref:`int` index, :ref:`int` mode **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_right_tangent` **(** :ref:`int` index, :ref:`float` tangent **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_value` **(** :ref:`int` index, :ref:`float` y **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`add_point` **(** :ref:`Vector2` pos, :ref:`float` left_tangent=0, :ref:`float` right_tangent=0, :ref:`int` left_mode=0, :ref:`int` right_mode=0 **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`bake` **(** **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clean_dupes` **(** **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_points` **(** **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_bake_resolution` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_max_value` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_min_value` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_point_left_mode` **(** :ref:`int` index **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_point_left_tangent` **(** :ref:`int` index **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_point_pos` **(** :ref:`int` index **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_point_right_mode` **(** :ref:`int` index **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_point_right_tangent` **(** :ref:`int` index **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`interpolate` **(** :ref:`float` offset **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`interpolate_baked` **(** :ref:`float` offset **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_point` **(** :ref:`int` index **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bake_resolution` **(** :ref:`int` resolution **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_max_value` **(** :ref:`float` max **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_min_value` **(** :ref:`float` min **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_left_mode` **(** :ref:`int` index, :ref:`int` mode **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_left_tangent` **(** :ref:`int` index, :ref:`float` tangent **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_offset` **(** :ref:`int` index, :ref:`float` offset **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_right_mode` **(** :ref:`int` index, :ref:`int` mode **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_right_tangent` **(** :ref:`int` index, :ref:`float` tangent **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_value` **(** :ref:`int` index, :ref:`float` y **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -86,7 +86,7 @@ Member Function Description .. _class_Curve_add_point: -- :ref:`int` **add_point** **(** :ref:`Vector2` pos, :ref:`float` left_tangent=0, :ref:`float` right_tangent=0, :ref:`int` left_mode=0, :ref:`int` right_mode=null **)** +- :ref:`int` **add_point** **(** :ref:`Vector2` pos, :ref:`float` left_tangent=0, :ref:`float` right_tangent=0, :ref:`int` left_mode=0, :ref:`int` right_mode=0 **)** .. _class_Curve_bake: diff --git a/classes/class_curve2d.rst b/classes/class_curve2d.rst index 43f5c3947..a5facbdfb 100644 --- a/classes/class_curve2d.rst +++ b/classes/class_curve2d.rst @@ -18,43 +18,43 @@ Describes a Bezier curve in 2D space. Member Functions ---------------- -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_point` **(** :ref:`Vector2` pos, :ref:`Vector2` in=Vector2( 0, 0 ), :ref:`Vector2` out=Vector2( 0, 0 ), :ref:`int` atpos=null **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_points` **(** **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_bake_interval` **(** **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_baked_length` **(** **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`get_baked_points` **(** **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_point_count` **(** **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_point_in` **(** :ref:`int` idx **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_point_out` **(** :ref:`int` idx **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_point_pos` **(** :ref:`int` idx **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`interpolate` **(** :ref:`int` idx, :ref:`float` t **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`interpolate_baked` **(** :ref:`float` offset, :ref:`bool` cubic=null **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`interpolatef` **(** :ref:`float` fofs **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_point` **(** :ref:`int` idx **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bake_interval` **(** :ref:`float` distance **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_in` **(** :ref:`int` idx, :ref:`Vector2` pos **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_out` **(** :ref:`int` idx, :ref:`Vector2` pos **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_pos` **(** :ref:`int` idx, :ref:`Vector2` pos **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`tessellate` **(** :ref:`int` max_stages=4, :ref:`float` tolerance_degrees=5 **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_point` **(** :ref:`Vector2` pos, :ref:`Vector2` in=Vector2( 0, 0 ), :ref:`Vector2` out=Vector2( 0, 0 ), :ref:`int` atpos=-1 **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_points` **(** **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_bake_interval` **(** **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_baked_length` **(** **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`get_baked_points` **(** **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_point_count` **(** **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_point_in` **(** :ref:`int` idx **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_point_out` **(** :ref:`int` idx **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_point_pos` **(** :ref:`int` idx **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`interpolate` **(** :ref:`int` idx, :ref:`float` t **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`interpolate_baked` **(** :ref:`float` offset, :ref:`bool` cubic=false **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`interpolatef` **(** :ref:`float` fofs **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_point` **(** :ref:`int` idx **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bake_interval` **(** :ref:`float` distance **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_in` **(** :ref:`int` idx, :ref:`Vector2` pos **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_out` **(** :ref:`int` idx, :ref:`Vector2` pos **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_pos` **(** :ref:`int` idx, :ref:`Vector2` pos **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`tessellate` **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -74,7 +74,7 @@ Member Function Description .. _class_Curve2D_add_point: -- void **add_point** **(** :ref:`Vector2` pos, :ref:`Vector2` in=Vector2( 0, 0 ), :ref:`Vector2` out=Vector2( 0, 0 ), :ref:`int` atpos=null **)** +- void **add_point** **(** :ref:`Vector2` pos, :ref:`Vector2` in=Vector2( 0, 0 ), :ref:`Vector2` out=Vector2( 0, 0 ), :ref:`int` atpos=-1 **)** Adds a point to a curve, at position "pos", with control points "in" and "out". @@ -136,7 +136,7 @@ If "idx" is out of bounds it is truncated to the first or last vertex, and "t" i .. _class_Curve2D_interpolate_baked: -- :ref:`Vector2` **interpolate_baked** **(** :ref:`float` offset, :ref:`bool` cubic=null **)** const +- :ref:`Vector2` **interpolate_baked** **(** :ref:`float` offset, :ref:`bool` cubic=false **)** const Returns a point within the curve at position "offset", where "offset" is measured as a pixel distance along the curve. @@ -182,7 +182,7 @@ Sets the position for the vertex "idx". If the index is out of bounds, the funct .. _class_Curve2D_tessellate: -- :ref:`PoolVector2Array` **tessellate** **(** :ref:`int` max_stages=4, :ref:`float` tolerance_degrees=5 **)** const +- :ref:`PoolVector2Array` **tessellate** **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** const Returns a list of points along the curve, with a curvature controlled point density. That is, the curvier parts will have more points than the straighter parts. diff --git a/classes/class_curve3d.rst b/classes/class_curve3d.rst index 24b0c959c..8d69abd68 100644 --- a/classes/class_curve3d.rst +++ b/classes/class_curve3d.rst @@ -18,49 +18,49 @@ Describes a Bezier curve in 3D space. Member Functions ---------------- -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_point` **(** :ref:`Vector3` pos, :ref:`Vector3` in=Vector3( 0, 0, 0 ), :ref:`Vector3` out=Vector3( 0, 0, 0 ), :ref:`int` atpos=null **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_points` **(** **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_bake_interval` **(** **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_baked_length` **(** **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`get_baked_points` **(** **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolRealArray` | :ref:`get_baked_tilts` **(** **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_point_count` **(** **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_point_in` **(** :ref:`int` idx **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_point_out` **(** :ref:`int` idx **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_point_pos` **(** :ref:`int` idx **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_point_tilt` **(** :ref:`int` idx **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`interpolate` **(** :ref:`int` idx, :ref:`float` t **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`interpolate_baked` **(** :ref:`float` offset, :ref:`bool` cubic=null **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`interpolatef` **(** :ref:`float` fofs **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_point` **(** :ref:`int` idx **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bake_interval` **(** :ref:`float` distance **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_in` **(** :ref:`int` idx, :ref:`Vector3` pos **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_out` **(** :ref:`int` idx, :ref:`Vector3` pos **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_pos` **(** :ref:`int` idx, :ref:`Vector3` pos **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_tilt` **(** :ref:`int` idx, :ref:`float` tilt **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`tessellate` **(** :ref:`int` max_stages=4, :ref:`float` tolerance_degrees=5 **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_point` **(** :ref:`Vector3` pos, :ref:`Vector3` in=Vector3( 0, 0, 0 ), :ref:`Vector3` out=Vector3( 0, 0, 0 ), :ref:`int` atpos=-1 **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_points` **(** **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_bake_interval` **(** **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_baked_length` **(** **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`get_baked_points` **(** **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolRealArray` | :ref:`get_baked_tilts` **(** **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_point_count` **(** **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_point_in` **(** :ref:`int` idx **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_point_out` **(** :ref:`int` idx **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_point_pos` **(** :ref:`int` idx **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_point_tilt` **(** :ref:`int` idx **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`interpolate` **(** :ref:`int` idx, :ref:`float` t **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`interpolate_baked` **(** :ref:`float` offset, :ref:`bool` cubic=false **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`interpolatef` **(** :ref:`float` fofs **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_point` **(** :ref:`int` idx **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bake_interval` **(** :ref:`float` distance **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_in` **(** :ref:`int` idx, :ref:`Vector3` pos **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_out` **(** :ref:`int` idx, :ref:`Vector3` pos **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_pos` **(** :ref:`int` idx, :ref:`Vector3` pos **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_tilt` **(** :ref:`int` idx, :ref:`float` tilt **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`tessellate` **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -80,7 +80,7 @@ Member Function Description .. _class_Curve3D_add_point: -- void **add_point** **(** :ref:`Vector3` pos, :ref:`Vector3` in=Vector3( 0, 0, 0 ), :ref:`Vector3` out=Vector3( 0, 0, 0 ), :ref:`int` atpos=null **)** +- void **add_point** **(** :ref:`Vector3` pos, :ref:`Vector3` in=Vector3( 0, 0, 0 ), :ref:`Vector3` out=Vector3( 0, 0, 0 ), :ref:`int` atpos=-1 **)** Adds a point to a curve, at position "pos", with control points "in" and "out". @@ -154,7 +154,7 @@ If "idx" is out of bounds it is truncated to the first or last vertex, and "t" i .. _class_Curve3D_interpolate_baked: -- :ref:`Vector3` **interpolate_baked** **(** :ref:`float` offset, :ref:`bool` cubic=null **)** const +- :ref:`Vector3` **interpolate_baked** **(** :ref:`float` offset, :ref:`bool` cubic=false **)** const Returns a point within the curve at position "offset", where "offset" is measured as a distance in 3D units along the curve. @@ -208,7 +208,7 @@ The tilt controls the rotation along the look-at axis an object traveling the pa .. _class_Curve3D_tessellate: -- :ref:`PoolVector3Array` **tessellate** **(** :ref:`int` max_stages=4, :ref:`float` tolerance_degrees=5 **)** const +- :ref:`PoolVector3Array` **tessellate** **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** const Returns a list of points along the curve, with a curvature controlled point density. That is, the curvier parts will have more points than the straighter parts. diff --git a/classes/class_editorinterface.rst b/classes/class_editorinterface.rst index a9d1658c9..b3e6fd5e6 100644 --- a/classes/class_editorinterface.rst +++ b/classes/class_editorinterface.rst @@ -18,39 +18,39 @@ Brief Description Member Functions ---------------- -+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`edit_resource` **(** :ref:`Resource` resource **)** | -+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Control` | :ref:`get_base_control` **(** **)** | -+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`get_edited_scene_root` **(** **)** | -+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`EditorSettings` | :ref:`get_editor_settings` **(** **)** | -+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Control` | :ref:`get_editor_viewport` **(** **)** | -+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_open_scenes` **(** **)** const | -+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`EditorFileSystem` | :ref:`get_resource_filesystem` **(** **)** | -+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`EditorResourcePreview` | :ref:`get_resource_previewer` **(** **)** | -+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ScriptEditor` | :ref:`get_script_editor` **(** **)** | -+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`EditorSelection` | :ref:`get_selection` **(** **)** | -+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`inspect_object` **(** :ref:`Object` object, :ref:`String` for_property=null **)** | -+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`make_mesh_previews` **(** :ref:`Array` arg0, :ref:`int` arg1 **)** | -+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`open_scene_from_path` **(** :ref:`String` scene_filepath **)** | -+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reload_scene_from_path` **(** :ref:`String` scene_filepath **)** | -+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`save_scene` **(** **)** | -+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`save_scene_as` **(** :ref:`String` path, :ref:`bool` with_preview=null **)** | -+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`edit_resource` **(** :ref:`Resource` resource **)** | ++------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Control` | :ref:`get_base_control` **(** **)** | ++------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`get_edited_scene_root` **(** **)** | ++------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`EditorSettings` | :ref:`get_editor_settings` **(** **)** | ++------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Control` | :ref:`get_editor_viewport` **(** **)** | ++------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_open_scenes` **(** **)** const | ++------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`EditorFileSystem` | :ref:`get_resource_filesystem` **(** **)** | ++------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`EditorResourcePreview` | :ref:`get_resource_previewer` **(** **)** | ++------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ScriptEditor` | :ref:`get_script_editor` **(** **)** | ++------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`EditorSelection` | :ref:`get_selection` **(** **)** | ++------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`inspect_object` **(** :ref:`Object` object, :ref:`String` for_property="" **)** | ++------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`make_mesh_previews` **(** :ref:`Array` arg0, :ref:`int` arg1 **)** | ++------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`open_scene_from_path` **(** :ref:`String` scene_filepath **)** | ++------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reload_scene_from_path` **(** :ref:`String` scene_filepath **)** | ++------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`save_scene` **(** **)** | ++------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`save_scene_as` **(** :ref:`String` path, :ref:`bool` with_preview=true **)** | ++------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Function Description --------------------------- @@ -97,7 +97,7 @@ Member Function Description .. _class_EditorInterface_inspect_object: -- void **inspect_object** **(** :ref:`Object` object, :ref:`String` for_property=null **)** +- void **inspect_object** **(** :ref:`Object` object, :ref:`String` for_property="" **)** .. _class_EditorInterface_make_mesh_previews: @@ -117,6 +117,6 @@ Member Function Description .. _class_EditorInterface_save_scene_as: -- void **save_scene_as** **(** :ref:`String` path, :ref:`bool` with_preview=null **)** +- void **save_scene_as** **(** :ref:`String` path, :ref:`bool` with_preview=true **)** diff --git a/classes/class_editorspatialgizmo.rst b/classes/class_editorspatialgizmo.rst index caafb91a9..0d455cddb 100644 --- a/classes/class_editorspatialgizmo.rst +++ b/classes/class_editorspatialgizmo.rst @@ -18,33 +18,33 @@ Custom gizmo for editing Spatial objects. Member Functions ---------------- -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_collision_segments` **(** :ref:`PoolVector3Array` segments **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_collision_triangles` **(** :ref:`TriangleMesh` triangles **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_handles` **(** :ref:`PoolVector3Array` handles, :ref:`bool` billboard=false, :ref:`bool` secondary=null **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_lines` **(** :ref:`PoolVector3Array` lines, :ref:`Material` material, :ref:`bool` billboard=null **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_mesh` **(** :ref:`ArrayMesh` mesh, :ref:`bool` billboard=false, :ref:`RID` skeleton=null **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_unscaled_billboard` **(** :ref:`Material` material, :ref:`float` default_scale=null **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`commit_handle` **(** :ref:`int` index, :ref:`Variant` restore, :ref:`bool` cancel=false **)** virtual | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_handle_name` **(** :ref:`int` index **)** virtual | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_handle_value` **(** :ref:`int` index **)** virtual | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`redraw` **(** **)** virtual | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_handle` **(** :ref:`int` index, :ref:`Camera` camera, :ref:`Vector2` point **)** virtual | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_spatial_node` **(** :ref:`Node` node **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_collision_segments` **(** :ref:`PoolVector3Array` segments **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_collision_triangles` **(** :ref:`TriangleMesh` triangles **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_handles` **(** :ref:`PoolVector3Array` handles, :ref:`bool` billboard=false, :ref:`bool` secondary=false **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_lines` **(** :ref:`PoolVector3Array` lines, :ref:`Material` material, :ref:`bool` billboard=false **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_mesh` **(** :ref:`ArrayMesh` mesh, :ref:`bool` billboard=false, :ref:`RID` skeleton **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_unscaled_billboard` **(** :ref:`Material` material, :ref:`float` default_scale=1 **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`commit_handle` **(** :ref:`int` index, :ref:`Variant` restore, :ref:`bool` cancel=false **)** virtual | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_handle_name` **(** :ref:`int` index **)** virtual | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_handle_value` **(** :ref:`int` index **)** virtual | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`redraw` **(** **)** virtual | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_handle` **(** :ref:`int` index, :ref:`Camera` camera, :ref:`Vector2` point **)** virtual | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_spatial_node` **(** :ref:`Node` node **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -66,7 +66,7 @@ Add collision triangles to the gizmo for picking. A :ref:`TriangleMesh` handles, :ref:`bool` billboard=false, :ref:`bool` secondary=null **)** +- void **add_handles** **(** :ref:`PoolVector3Array` handles, :ref:`bool` billboard=false, :ref:`bool` secondary=false **)** Add a list of handles (points) which can be used to deform the object being edited. @@ -74,17 +74,17 @@ There are virtual functions which will be called upon editing of these handles. .. _class_EditorSpatialGizmo_add_lines: -- void **add_lines** **(** :ref:`PoolVector3Array` lines, :ref:`Material` material, :ref:`bool` billboard=null **)** +- void **add_lines** **(** :ref:`PoolVector3Array` lines, :ref:`Material` material, :ref:`bool` billboard=false **)** Add lines to the gizmo (as sets of 2 points), with a given material. The lines are used for visualizing the gizmo. Call this function during :ref:`redraw`. .. _class_EditorSpatialGizmo_add_mesh: -- void **add_mesh** **(** :ref:`ArrayMesh` mesh, :ref:`bool` billboard=false, :ref:`RID` skeleton=null **)** +- void **add_mesh** **(** :ref:`ArrayMesh` mesh, :ref:`bool` billboard=false, :ref:`RID` skeleton **)** .. _class_EditorSpatialGizmo_add_unscaled_billboard: -- void **add_unscaled_billboard** **(** :ref:`Material` material, :ref:`float` default_scale=null **)** +- void **add_unscaled_billboard** **(** :ref:`Material` material, :ref:`float` default_scale=1 **)** Add an unscaled billboard for visualization. Call this function during :ref:`redraw`. diff --git a/classes/class_file.rst b/classes/class_file.rst index 00de21426..35b2df13f 100644 --- a/classes/class_file.rst +++ b/classes/class_file.rst @@ -69,7 +69,7 @@ Member Functions +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`open` **(** :ref:`String` path, :ref:`int` flags **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`open_compressed` **(** :ref:`String` path, :ref:`int` mode_flags, :ref:`int` compression_mode=null **)** | +| :ref:`int` | :ref:`open_compressed` **(** :ref:`String` path, :ref:`int` mode_flags, :ref:`int` compression_mode=0 **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`open_encrypted` **(** :ref:`String` path, :ref:`int` mode_flags, :ref:`PoolByteArray` key **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -293,7 +293,7 @@ Open the file for writing or reading, depending on the flags. .. _class_File_open_compressed: -- :ref:`int` **open_compressed** **(** :ref:`String` path, :ref:`int` mode_flags, :ref:`int` compression_mode=null **)** +- :ref:`int` **open_compressed** **(** :ref:`String` path, :ref:`int` mode_flags, :ref:`int` compression_mode=0 **)** Open a compressed file for reading or writing. The compression_mode can be set as one of the COMPRESSION\_\* constants. diff --git a/classes/class_font.rst b/classes/class_font.rst index a8e08fa60..7724c35bb 100644 --- a/classes/class_font.rst +++ b/classes/class_font.rst @@ -20,23 +20,23 @@ Internationalized font and text drawing support. Member Functions ---------------- -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw` **(** :ref:`RID` canvas_item, :ref:`Vector2` pos, :ref:`String` string, :ref:`Color` modulate=null, :ref:`int` clip_w=null **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`draw_char` **(** :ref:`RID` canvas_item, :ref:`Vector2` pos, :ref:`int` char, :ref:`int` next=null, :ref:`Color` modulate=null **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_ascent` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_descent` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_height` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_string_size` **(** :ref:`String` string **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_distance_field_hint` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`update_changes` **(** **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw` **(** :ref:`RID` canvas_item, :ref:`Vector2` pos, :ref:`String` string, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`int` clip_w=-1 **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`draw_char` **(** :ref:`RID` canvas_item, :ref:`Vector2` pos, :ref:`int` char, :ref:`int` next=-1, :ref:`Color` modulate=Color( 1, 1, 1, 1 ) **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_ascent` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_descent` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_height` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_string_size` **(** :ref:`String` string **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_distance_field_hint` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`update_changes` **(** **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -48,13 +48,13 @@ Member Function Description .. _class_Font_draw: -- void **draw** **(** :ref:`RID` canvas_item, :ref:`Vector2` pos, :ref:`String` string, :ref:`Color` modulate=null, :ref:`int` clip_w=null **)** const +- void **draw** **(** :ref:`RID` canvas_item, :ref:`Vector2` pos, :ref:`String` string, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`int` clip_w=-1 **)** const Draw "string" into a canvas item using the font at a given "pos" position, with "modulate" color, and optionally clipping the width. "pos" specifies the baseline, not the top. To draw from the top, *ascent* must be added to the Y axis. .. _class_Font_draw_char: -- :ref:`float` **draw_char** **(** :ref:`RID` canvas_item, :ref:`Vector2` pos, :ref:`int` char, :ref:`int` next=null, :ref:`Color` modulate=null **)** const +- :ref:`float` **draw_char** **(** :ref:`RID` canvas_item, :ref:`Vector2` pos, :ref:`int` char, :ref:`int` next=-1, :ref:`Color` modulate=Color( 1, 1, 1, 1 ) **)** const Draw character "char" into a canvas item using the font at a given "pos" position, with "modulate" color, and optionally kerning if "next" is passed. clipping the width. "pos" specifies the baseline, not the top. To draw from the top, *ascent* must be added to the Y axis. The width used by the character is returned, making this function useful for drawing strings character by character. diff --git a/classes/class_gdnativelibrary.rst b/classes/class_gdnativelibrary.rst index 6c4b2b7e1..264ad8f15 100644 --- a/classes/class_gdnativelibrary.rst +++ b/classes/class_gdnativelibrary.rst @@ -21,8 +21,17 @@ Member Functions +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_library_path` **(** :ref:`String` platform **)** const | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_singleton_gdnative` **(** **)** const | ++------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_library_path` **(** :ref:`String` platform, :ref:`String` path **)** | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_singleton_gdnative` **(** :ref:`bool` singleton **)** | ++------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`bool` **singleton_gdnative** Member Function Description --------------------------- @@ -31,8 +40,16 @@ Member Function Description - :ref:`String` **get_library_path** **(** :ref:`String` platform **)** const +.. _class_GDNativeLibrary_is_singleton_gdnative: + +- :ref:`bool` **is_singleton_gdnative** **(** **)** const + .. _class_GDNativeLibrary_set_library_path: - void **set_library_path** **(** :ref:`String` platform, :ref:`String` path **)** +.. _class_GDNativeLibrary_set_singleton_gdnative: + +- void **set_singleton_gdnative** **(** :ref:`bool` singleton **)** + diff --git a/classes/class_geometry.rst b/classes/class_geometry.rst index 77f5c3d48..4f5382cc6 100644 --- a/classes/class_geometry.rst +++ b/classes/class_geometry.rst @@ -21,9 +21,9 @@ Member Functions +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`build_box_planes` **(** :ref:`Vector3` extents **)** | +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`build_capsule_planes` **(** :ref:`float` radius, :ref:`float` height, :ref:`int` sides, :ref:`int` lats, :ref:`int` axis=null **)** | +| :ref:`Array` | :ref:`build_capsule_planes` **(** :ref:`float` radius, :ref:`float` height, :ref:`int` sides, :ref:`int` lats, :ref:`int` axis=2 **)** | +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`build_cylinder_planes` **(** :ref:`float` radius, :ref:`float` height, :ref:`int` sides, :ref:`int` axis=null **)** | +| :ref:`Array` | :ref:`build_cylinder_planes` **(** :ref:`float` radius, :ref:`float` height, :ref:`int` sides, :ref:`int` axis=2 **)** | +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_closest_point_to_segment` **(** :ref:`Vector3` point, :ref:`Vector3` s1, :ref:`Vector3` s2 **)** | +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -69,11 +69,11 @@ Member Function Description .. _class_Geometry_build_capsule_planes: -- :ref:`Array` **build_capsule_planes** **(** :ref:`float` radius, :ref:`float` height, :ref:`int` sides, :ref:`int` lats, :ref:`int` axis=null **)** +- :ref:`Array` **build_capsule_planes** **(** :ref:`float` radius, :ref:`float` height, :ref:`int` sides, :ref:`int` lats, :ref:`int` axis=2 **)** .. _class_Geometry_build_cylinder_planes: -- :ref:`Array` **build_cylinder_planes** **(** :ref:`float` radius, :ref:`float` height, :ref:`int` sides, :ref:`int` axis=null **)** +- :ref:`Array` **build_cylinder_planes** **(** :ref:`float` radius, :ref:`float` height, :ref:`int` sides, :ref:`int` axis=2 **)** .. _class_Geometry_get_closest_point_to_segment: diff --git a/classes/class_giprobe.rst b/classes/class_giprobe.rst index 7f086f4e6..5f10ab6fc 100644 --- a/classes/class_giprobe.rst +++ b/classes/class_giprobe.rst @@ -19,7 +19,7 @@ Member Functions ---------------- +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`bake` **(** :ref:`Node` from_node=false, :ref:`bool` create_visual_debug=null **)** | +| void | :ref:`bake` **(** :ref:`Node` from_node=null, :ref:`bool` create_visual_debug=false **)** | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`debug_bake` **(** **)** | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ @@ -91,7 +91,7 @@ Member Function Description .. _class_GIProbe_bake: -- void **bake** **(** :ref:`Node` from_node=false, :ref:`bool` create_visual_debug=null **)** +- void **bake** **(** :ref:`Node` from_node=null, :ref:`bool` create_visual_debug=false **)** .. _class_GIProbe_debug_bake: diff --git a/classes/class_graphnode.rst b/classes/class_graphnode.rst index b30e9cf6b..7b920fb46 100644 --- a/classes/class_graphnode.rst +++ b/classes/class_graphnode.rst @@ -57,7 +57,7 @@ Member Functions +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_comment` **(** **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_resizeable` **(** **)** const | +| :ref:`bool` | :ref:`is_resizable` **(** **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_selected` **(** **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -71,7 +71,7 @@ Member Functions +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_overlay` **(** :ref:`int` overlay **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_resizeable` **(** :ref:`bool` resizeable **)** | +| void | :ref:`set_resizable` **(** :ref:`bool` resizable **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_selected` **(** :ref:`bool` selected **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -102,7 +102,7 @@ Signal sent when the GraphNode is requested to be displayed over other ones. Hap Member Variables ---------------- -- :ref:`bool` **resizeable** +- :ref:`bool` **resizable** - :ref:`bool` **show_close** - :ref:`String` **title** @@ -231,9 +231,9 @@ Returns true if the close button is shown. False otherwise. - :ref:`bool` **is_comment** **(** **)** const -.. _class_GraphNode_is_resizeable: +.. _class_GraphNode_is_resizable: -- :ref:`bool` **is_resizeable** **(** **)** const +- :ref:`bool` **is_resizable** **(** **)** const .. _class_GraphNode_is_selected: @@ -265,9 +265,9 @@ Set the offset of the GraphNode. - void **set_overlay** **(** :ref:`int` overlay **)** -.. _class_GraphNode_set_resizeable: +.. _class_GraphNode_set_resizable: -- void **set_resizeable** **(** :ref:`bool` resizeable **)** +- void **set_resizable** **(** :ref:`bool` resizable **)** .. _class_GraphNode_set_selected: diff --git a/classes/class_gridmap.rst b/classes/class_gridmap.rst index 8c87aebe9..f4300b26a 100644 --- a/classes/class_gridmap.rst +++ b/classes/class_gridmap.rst @@ -18,45 +18,45 @@ Brief Description Member Functions ---------------- -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_cell_item` **(** :ref:`int` x, :ref:`int` y, :ref:`int` z **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_cell_item_orientation` **(** :ref:`int` x, :ref:`int` y, :ref:`int` z **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_cell_size` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_center_x` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_center_y` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_center_z` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_meshes` **(** **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_octant_size` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`MeshLibrary` | :ref:`get_theme` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`resource_changed` **(** :ref:`Resource` resource **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cell_item` **(** :ref:`int` x, :ref:`int` y, :ref:`int` z, :ref:`int` item, :ref:`int` orientation=null **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cell_size` **(** :ref:`Vector3` size **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_center_x` **(** :ref:`bool` enable **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_center_y` **(** :ref:`bool` enable **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_center_z` **(** :ref:`bool` enable **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_clip` **(** :ref:`bool` enabled, :ref:`bool` clipabove=0, :ref:`int` floor=true, :ref:`int` axis=null **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_octant_size` **(** :ref:`int` size **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_theme` **(** :ref:`MeshLibrary` theme **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_cell_item` **(** :ref:`int` x, :ref:`int` y, :ref:`int` z **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_cell_item_orientation` **(** :ref:`int` x, :ref:`int` y, :ref:`int` z **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_cell_size` **(** **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_center_x` **(** **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_center_y` **(** **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_center_z` **(** **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_meshes` **(** **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_octant_size` **(** **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`MeshLibrary` | :ref:`get_theme` **(** **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`resource_changed` **(** :ref:`Resource` resource **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_cell_item` **(** :ref:`int` x, :ref:`int` y, :ref:`int` z, :ref:`int` item, :ref:`int` orientation=0 **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_cell_size` **(** :ref:`Vector3` size **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_center_x` **(** :ref:`bool` enable **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_center_y` **(** :ref:`bool` enable **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_center_z` **(** :ref:`bool` enable **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_clip` **(** :ref:`bool` enabled, :ref:`bool` clipabove=true, :ref:`int` floor=0, :ref:`int` axis=0 **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_octant_size` **(** :ref:`int` size **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_theme` **(** :ref:`MeshLibrary` theme **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -112,7 +112,7 @@ Member Function Description .. _class_GridMap_set_cell_item: -- void **set_cell_item** **(** :ref:`int` x, :ref:`int` y, :ref:`int` z, :ref:`int` item, :ref:`int` orientation=null **)** +- void **set_cell_item** **(** :ref:`int` x, :ref:`int` y, :ref:`int` z, :ref:`int` item, :ref:`int` orientation=0 **)** .. _class_GridMap_set_cell_size: @@ -132,7 +132,7 @@ Member Function Description .. _class_GridMap_set_clip: -- void **set_clip** **(** :ref:`bool` enabled, :ref:`bool` clipabove=0, :ref:`int` floor=true, :ref:`int` axis=null **)** +- void **set_clip** **(** :ref:`bool` enabled, :ref:`bool` clipabove=true, :ref:`int` floor=0, :ref:`int` axis=0 **)** .. _class_GridMap_set_octant_size: diff --git a/classes/class_httpclient.rst b/classes/class_httpclient.rst index d4a1e7fea..0b8603f14 100644 --- a/classes/class_httpclient.rst +++ b/classes/class_httpclient.rst @@ -21,7 +21,7 @@ Member Functions +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`close` **(** **)** | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`connect_to_host` **(** :ref:`String` host, :ref:`int` port, :ref:`bool` use_ssl=null, :ref:`bool` verify_host=null **)** | +| :ref:`int` | :ref:`connect_to_host` **(** :ref:`String` host, :ref:`int` port, :ref:`bool` use_ssl=false, :ref:`bool` verify_host=true **)** | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`StreamPeer` | :ref:`get_connection` **(** **)** const | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -47,7 +47,7 @@ Member Functions +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolByteArray` | :ref:`read_response_body_chunk` **(** **)** | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`request` **(** :ref:`int` method, :ref:`String` url, :ref:`PoolStringArray` headers, :ref:`String` body=null **)** | +| :ref:`int` | :ref:`request` **(** :ref:`int` method, :ref:`String` url, :ref:`PoolStringArray` headers, :ref:`String` body="" **)** | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`request_raw` **(** :ref:`int` method, :ref:`String` url, :ref:`PoolStringArray` headers, :ref:`PoolByteArray` body **)** | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -152,7 +152,7 @@ Cloces the current connection, allows for reusal of :ref:`HTTPClient` **connect_to_host** **(** :ref:`String` host, :ref:`int` port, :ref:`bool` use_ssl=null, :ref:`bool` verify_host=null **)** +- :ref:`int` **connect_to_host** **(** :ref:`String` host, :ref:`int` port, :ref:`bool` use_ssl=false, :ref:`bool` verify_host=true **)** Connect to a host. This needs to be done before any requests are sent. @@ -244,7 +244,7 @@ Reads one chunk from the response. .. _class_HTTPClient_request: -- :ref:`int` **request** **(** :ref:`int` method, :ref:`String` url, :ref:`PoolStringArray` headers, :ref:`String` body=null **)** +- :ref:`int` **request** **(** :ref:`int` method, :ref:`String` url, :ref:`PoolStringArray` headers, :ref:`String` body="" **)** Sends a request to the connected host. The url is what is normally behind the hostname, i.e. in ``http://somehost.com/index.php``, url would be "index.php". diff --git a/classes/class_httprequest.rst b/classes/class_httprequest.rst index e662fcc01..df4423edd 100644 --- a/classes/class_httprequest.rst +++ b/classes/class_httprequest.rst @@ -18,33 +18,33 @@ A Node with the ability to send HTTP requests. Member Functions ---------------- -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`cancel_request` **(** **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_body_size` **(** **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_body_size_limit` **(** **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_download_file` **(** **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_downloaded_bytes` **(** **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_http_client_status` **(** **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_max_redirects` **(** **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_using_threads` **(** **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`request` **(** :ref:`String` url, :ref:`PoolStringArray` custom_headers=0, :ref:`bool` ssl_validate_domain=true, :ref:`int` method=PoolStringArray( ), :ref:`String` request_data=null **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_body_size_limit` **(** :ref:`int` bytes **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_download_file` **(** :ref:`String` path **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_max_redirects` **(** :ref:`int` amount **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_threads` **(** :ref:`bool` enable **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`cancel_request` **(** **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_body_size` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_body_size_limit` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_download_file` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_downloaded_bytes` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_http_client_status` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_max_redirects` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_using_threads` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`request` **(** :ref:`String` url, :ref:`PoolStringArray` custom_headers=PoolStringArray( ), :ref:`bool` ssl_validate_domain=true, :ref:`int` method=0, :ref:`String` request_data="" **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_body_size_limit` **(** :ref:`int` bytes **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_download_file` **(** :ref:`String` path **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_max_redirects` **(** :ref:`int` amount **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_use_threads` **(** :ref:`bool` enable **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -136,7 +136,7 @@ Whether this request is using threads. .. _class_HTTPRequest_request: -- :ref:`int` **request** **(** :ref:`String` url, :ref:`PoolStringArray` custom_headers=0, :ref:`bool` ssl_validate_domain=true, :ref:`int` method=PoolStringArray( ), :ref:`String` request_data=null **)** +- :ref:`int` **request** **(** :ref:`String` url, :ref:`PoolStringArray` custom_headers=PoolStringArray( ), :ref:`bool` ssl_validate_domain=true, :ref:`int` method=0, :ref:`String` request_data="" **)** .. _class_HTTPRequest_set_body_size_limit: diff --git a/classes/class_image.rst b/classes/class_image.rst index bbdf8ad62..78a25e8cd 100644 --- a/classes/class_image.rst +++ b/classes/class_image.rst @@ -91,7 +91,7 @@ Member Functions +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`premultiply_alpha` **(** **)** | +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`resize` **(** :ref:`int` width, :ref:`int` height, :ref:`int` interpolation=null **)** | +| void | :ref:`resize` **(** :ref:`int` width, :ref:`int` height, :ref:`int` interpolation=1 **)** | +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`resize_to_po2` **(** :ref:`bool` square=false **)** | +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -347,7 +347,7 @@ Load an :ref:`Image`. .. _class_Image_resize: -- void **resize** **(** :ref:`int` width, :ref:`int` height, :ref:`int` interpolation=null **)** +- void **resize** **(** :ref:`int` width, :ref:`int` height, :ref:`int` interpolation=1 **)** .. _class_Image_resize_to_po2: diff --git a/classes/class_imagetexture.rst b/classes/class_imagetexture.rst index 81dab75d4..fcb8230e4 100644 --- a/classes/class_imagetexture.rst +++ b/classes/class_imagetexture.rst @@ -18,27 +18,27 @@ A :ref:`Texture` based on an :ref:`Image`. Member Functions ---------------- -+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create` **(** :ref:`int` width, :ref:`int` height, :ref:`int` format, :ref:`int` flags=null **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create_from_image` **(** :ref:`Image` image, :ref:`int` flags=null **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_format` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_lossy_storage_quality` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_storage` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`load` **(** :ref:`String` path **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_data` **(** :ref:`Image` image **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_lossy_storage_quality` **(** :ref:`float` quality **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_size_override` **(** :ref:`Vector2` size **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_storage` **(** :ref:`int` mode **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`create` **(** :ref:`int` width, :ref:`int` height, :ref:`int` format, :ref:`int` flags=7 **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`create_from_image` **(** :ref:`Image` image, :ref:`int` flags=7 **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_format` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_lossy_storage_quality` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_storage` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`load` **(** :ref:`String` path **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_data` **(** :ref:`Image` image **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_lossy_storage_quality` **(** :ref:`float` quality **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_size_override` **(** :ref:`Vector2` size **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_storage` **(** :ref:`int` mode **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -57,7 +57,7 @@ Member Function Description .. _class_ImageTexture_create: -- void **create** **(** :ref:`int` width, :ref:`int` height, :ref:`int` format, :ref:`int` flags=null **)** +- void **create** **(** :ref:`int` width, :ref:`int` height, :ref:`int` format, :ref:`int` flags=7 **)** Create a new :ref:`ImageTexture` with "width" and "height". @@ -67,7 +67,7 @@ Create a new :ref:`ImageTexture` with "width" and "height". .. _class_ImageTexture_create_from_image: -- void **create_from_image** **(** :ref:`Image` image, :ref:`int` flags=null **)** +- void **create_from_image** **(** :ref:`Image` image, :ref:`int` flags=7 **)** Create a new :ref:`ImageTexture` from an :ref:`Image` with "flags" from :ref:`Texture`.FLAG\_\*. diff --git a/classes/class_immediategeometry.rst b/classes/class_immediategeometry.rst index 08d94d36a..a2be7ce2e 100644 --- a/classes/class_immediategeometry.rst +++ b/classes/class_immediategeometry.rst @@ -19,7 +19,7 @@ Member Functions ---------------- +-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_sphere` **(** :ref:`int` lats, :ref:`int` lons, :ref:`float` radius, :ref:`bool` add_uv=null **)** | +| void | :ref:`add_sphere` **(** :ref:`int` lats, :ref:`int` lons, :ref:`float` radius, :ref:`bool` add_uv=true **)** | +-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_vertex` **(** :ref:`Vector3` pos **)** | +-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -45,7 +45,7 @@ Member Function Description .. _class_ImmediateGeometry_add_sphere: -- void **add_sphere** **(** :ref:`int` lats, :ref:`int` lons, :ref:`float` radius, :ref:`bool` add_uv=null **)** +- void **add_sphere** **(** :ref:`int` lats, :ref:`int` lons, :ref:`float` radius, :ref:`bool` add_uv=true **)** Simple helper to draw a uvsphere, with given latitudes, longitude and radius. diff --git a/classes/class_input.rst b/classes/class_input.rst index 2fd982270..d14a2ecc0 100644 --- a/classes/class_input.rst +++ b/classes/class_input.rst @@ -20,75 +20,75 @@ A Singleton that deals with inputs. Member Functions ---------------- -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`action_press` **(** :ref:`String` action **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`action_release` **(** :ref:`String` action **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_joy_mapping` **(** :ref:`String` mapping, :ref:`bool` update_existing=null **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_accelerometer` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_connected_joypads` **(** **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_gravity` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_gyroscope` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_joy_axis` **(** :ref:`int` device, :ref:`int` axis **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_joy_axis_index_from_string` **(** :ref:`String` axis **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_joy_axis_string` **(** :ref:`int` axis_index **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_joy_button_index_from_string` **(** :ref:`String` button **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_joy_button_string` **(** :ref:`int` button_index **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_joy_guid` **(** :ref:`int` device **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_joy_name` **(** :ref:`int` device **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_joy_vibration_duration` **(** :ref:`int` device **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_joy_vibration_strength` **(** :ref:`int` device **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_last_mouse_speed` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_magnetometer` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_mouse_button_mask` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_mouse_mode` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action_just_pressed` **(** :ref:`String` action **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action_just_released` **(** :ref:`String` action **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action_pressed` **(** :ref:`String` action **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_joy_button_pressed` **(** :ref:`int` device, :ref:`int` button **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_joy_known` **(** :ref:`int` device **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_key_pressed` **(** :ref:`int` scancode **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_mouse_button_pressed` **(** :ref:`int` button **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`parse_input_event` **(** :ref:`InputEvent` event **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_joy_mapping` **(** :ref:`String` guid **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_mouse_cursor` **(** :ref:`Resource` image, :ref:`Vector2` hotspot=null **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_mouse_mode` **(** :ref:`int` mode **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`start_joy_vibration` **(** :ref:`int` device, :ref:`float` weak_magnitude, :ref:`float` strong_magnitude, :ref:`float` duration=null **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`stop_joy_vibration` **(** :ref:`int` device **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`warp_mouse_pos` **(** :ref:`Vector2` to **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`action_press` **(** :ref:`String` action **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`action_release` **(** :ref:`String` action **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_joy_mapping` **(** :ref:`String` mapping, :ref:`bool` update_existing=false **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_accelerometer` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_connected_joypads` **(** **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_gravity` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_gyroscope` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_joy_axis` **(** :ref:`int` device, :ref:`int` axis **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_joy_axis_index_from_string` **(** :ref:`String` axis **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_joy_axis_string` **(** :ref:`int` axis_index **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_joy_button_index_from_string` **(** :ref:`String` button **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_joy_button_string` **(** :ref:`int` button_index **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_joy_guid` **(** :ref:`int` device **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_joy_name` **(** :ref:`int` device **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_joy_vibration_duration` **(** :ref:`int` device **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_joy_vibration_strength` **(** :ref:`int` device **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_last_mouse_speed` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_magnetometer` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_mouse_button_mask` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_mouse_mode` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_action_just_pressed` **(** :ref:`String` action **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_action_just_released` **(** :ref:`String` action **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_action_pressed` **(** :ref:`String` action **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_joy_button_pressed` **(** :ref:`int` device, :ref:`int` button **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_joy_known` **(** :ref:`int` device **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_key_pressed` **(** :ref:`int` scancode **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_mouse_button_pressed` **(** :ref:`int` button **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`parse_input_event` **(** :ref:`InputEvent` event **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_joy_mapping` **(** :ref:`String` guid **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_custom_mouse_cursor` **(** :ref:`Resource` image, :ref:`Vector2` hotspot=Vector2( 0, 0 ) **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_mouse_mode` **(** :ref:`int` mode **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`start_joy_vibration` **(** :ref:`int` device, :ref:`float` weak_magnitude, :ref:`float` strong_magnitude, :ref:`float` duration=0 **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`stop_joy_vibration` **(** :ref:`int` device **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`warp_mouse_pos` **(** :ref:`Vector2` to **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -127,7 +127,7 @@ If the specified action is already pressed, this will release it. .. _class_Input_add_joy_mapping: -- void **add_joy_mapping** **(** :ref:`String` mapping, :ref:`bool` update_existing=null **)** +- void **add_joy_mapping** **(** :ref:`String` mapping, :ref:`bool` update_existing=false **)** Add a new mapping entry (in SDL2 format) to the mapping database. Optionally update already connected devices. @@ -273,7 +273,7 @@ Removes all mappings from the internal db that match the given uid. .. _class_Input_set_custom_mouse_cursor: -- void **set_custom_mouse_cursor** **(** :ref:`Resource` image, :ref:`Vector2` hotspot=null **)** +- void **set_custom_mouse_cursor** **(** :ref:`Resource` image, :ref:`Vector2` hotspot=Vector2( 0, 0 ) **)** .. _class_Input_set_mouse_mode: @@ -283,7 +283,7 @@ Set the mouse mode. See the constants for more information. .. _class_Input_start_joy_vibration: -- void **start_joy_vibration** **(** :ref:`int` device, :ref:`float` weak_magnitude, :ref:`float` strong_magnitude, :ref:`float` duration=null **)** +- void **start_joy_vibration** **(** :ref:`int` device, :ref:`float` weak_magnitude, :ref:`float` strong_magnitude, :ref:`float` duration=0 **)** Starts to vibrate the joypad. Joypads usually come with two rumble motors, a strong and a weak one. weak_magnitude is the strength of the weak motor (between 0 and 1) and strong_magnitude is the strength of the strong motor (between 0 and 1). duration is the duration of the effect in seconds (a duration of 0 will try to play the vibration indefinitely). diff --git a/classes/class_inputevent.rst b/classes/class_inputevent.rst index c3be33399..fed85fc8f 100644 --- a/classes/class_inputevent.rst +++ b/classes/class_inputevent.rst @@ -20,35 +20,35 @@ Brief Description Member Functions ---------------- -+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`action_match` **(** :ref:`InputEvent` event **)** const | -+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`as_text` **(** **)** const | -+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_device` **(** **)** const | -+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_id` **(** **)** const | -+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action` **(** :ref:`String` action **)** const | -+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action_pressed` **(** :ref:`String` action **)** const | -+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action_released` **(** :ref:`String` action **)** const | -+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action_type` **(** **)** const | -+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_echo` **(** **)** const | -+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_pressed` **(** **)** const | -+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_device` **(** :ref:`int` device **)** | -+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_id` **(** :ref:`int` id **)** | -+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`shortcut_match` **(** :ref:`InputEvent` event **)** const | -+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`InputEvent` | :ref:`xformed_by` **(** :ref:`Transform2D` xform, :ref:`Vector2` local_ofs=null **)** const | -+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`action_match` **(** :ref:`InputEvent` event **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`as_text` **(** **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_device` **(** **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_id` **(** **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_action` **(** :ref:`String` action **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_action_pressed` **(** :ref:`String` action **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_action_released` **(** :ref:`String` action **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_action_type` **(** **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_echo` **(** **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_pressed` **(** **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_device` **(** :ref:`int` device **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_id` **(** :ref:`int` id **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`shortcut_match` **(** :ref:`InputEvent` event **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`InputEvent` | :ref:`xformed_by` **(** :ref:`Transform2D` xform, :ref:`Vector2` local_ofs=Vector2( 0, 0 ) **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -122,6 +122,6 @@ Return if this input event is pressed. Not relevant for the event types MOUSE_MO .. _class_InputEvent_xformed_by: -- :ref:`InputEvent` **xformed_by** **(** :ref:`Transform2D` xform, :ref:`Vector2` local_ofs=null **)** const +- :ref:`InputEvent` **xformed_by** **(** :ref:`Transform2D` xform, :ref:`Vector2` local_ofs=Vector2( 0, 0 ) **)** const diff --git a/classes/class_ip.rst b/classes/class_ip.rst index 7e09e7e88..b172e5edd 100644 --- a/classes/class_ip.rst +++ b/classes/class_ip.rst @@ -20,21 +20,21 @@ IP Protocol support functions. Member Functions ---------------- -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_cache` **(** :ref:`String` hostname="" **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`erase_resolve_item` **(** :ref:`int` id **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_local_addresses` **(** **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_resolve_item_address` **(** :ref:`int` id **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_resolve_item_status` **(** :ref:`int` id **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`resolve_hostname` **(** :ref:`String` host, :ref:`int` ip_type=null **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`resolve_hostname_queue_item` **(** :ref:`String` host, :ref:`int` ip_type=null **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_cache` **(** :ref:`String` hostname="" **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`erase_resolve_item` **(** :ref:`int` id **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_local_addresses` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_resolve_item_address` **(** :ref:`int` id **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_resolve_item_status` **(** :ref:`int` id **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`resolve_hostname` **(** :ref:`String` host, :ref:`int` ip_type=3 **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`resolve_hostname_queue_item` **(** :ref:`String` host, :ref:`int` ip_type=3 **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -86,13 +86,13 @@ Return the status of hostname queued for resolving, given its queue ID. Returned .. _class_IP_resolve_hostname: -- :ref:`String` **resolve_hostname** **(** :ref:`String` host, :ref:`int` ip_type=null **)** +- :ref:`String` **resolve_hostname** **(** :ref:`String` host, :ref:`int` ip_type=3 **)** Resolve a given hostname, blocking. Resolved hostname is returned as an IPv4 or IPv6 depending on "ip_type". .. _class_IP_resolve_hostname_queue_item: -- :ref:`int` **resolve_hostname_queue_item** **(** :ref:`String` host, :ref:`int` ip_type=null **)** +- :ref:`int` **resolve_hostname_queue_item** **(** :ref:`String` host, :ref:`int` ip_type=3 **)** Create a queue item for resolving a given hostname to an IPv4 or IPv6 depending on "ip_type". The queue ID is returned, or RESOLVER_INVALID_ID on error. diff --git a/classes/class_itemlist.rst b/classes/class_itemlist.rst index 87ed17129..18fcd5b61 100644 --- a/classes/class_itemlist.rst +++ b/classes/class_itemlist.rst @@ -19,9 +19,9 @@ Member Functions ---------------- +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_icon_item` **(** :ref:`Texture` icon, :ref:`bool` selectable=null **)** | +| void | :ref:`add_icon_item` **(** :ref:`Texture` icon, :ref:`bool` selectable=true **)** | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_item` **(** :ref:`String` text, :ref:`Texture` icon=null, :ref:`bool` selectable=null **)** | +| void | :ref:`add_item` **(** :ref:`String` text, :ref:`Texture` icon=null, :ref:`bool` selectable=true **)** | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** **)** | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -37,7 +37,7 @@ Member Functions +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_icon_scale` **(** **)** const | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_item_at_pos` **(** :ref:`Vector2` pos, :ref:`bool` exact=null **)** const | +| :ref:`int` | :ref:`get_item_at_pos` **(** :ref:`Vector2` pos, :ref:`bool` exact=false **)** const | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_item_count` **(** **)** const | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -77,7 +77,7 @@ Member Functions +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_item` **(** :ref:`int` idx **)** | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`select` **(** :ref:`int` idx, :ref:`bool` single=null **)** | +| void | :ref:`select` **(** :ref:`int` idx, :ref:`bool` single=true **)** | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_allow_rmb_select` **(** :ref:`bool` allow **)** | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -180,13 +180,13 @@ Member Function Description .. _class_ItemList_add_icon_item: -- void **add_icon_item** **(** :ref:`Texture` icon, :ref:`bool` selectable=null **)** +- void **add_icon_item** **(** :ref:`Texture` icon, :ref:`bool` selectable=true **)** Adds an item to the item list with no text, only an icon. .. _class_ItemList_add_item: -- void **add_item** **(** :ref:`String` text, :ref:`Texture` icon=null, :ref:`bool` selectable=null **)** +- void **add_item** **(** :ref:`String` text, :ref:`Texture` icon=null, :ref:`bool` selectable=true **)** Adds an item to the item list with specified text. Specify an icon of null for a list item with no icon. @@ -230,7 +230,7 @@ If column size has been fixed to a value, return that value. .. _class_ItemList_get_item_at_pos: -- :ref:`int` **get_item_at_pos** **(** :ref:`Vector2` pos, :ref:`bool` exact=null **)** const +- :ref:`int` **get_item_at_pos** **(** :ref:`Vector2` pos, :ref:`bool` exact=false **)** const Given a position within the control return the item (if any) at that point. @@ -338,7 +338,7 @@ Remove item at specified index from the list. .. _class_ItemList_select: -- void **select** **(** :ref:`int` idx, :ref:`bool` single=null **)** +- void **select** **(** :ref:`int` idx, :ref:`bool` single=true **)** Select the item at the specified index. diff --git a/classes/class_kinematicbody.rst b/classes/class_kinematicbody.rst index 01eb4f07a..e40f4d7a1 100644 --- a/classes/class_kinematicbody.rst +++ b/classes/class_kinematicbody.rst @@ -18,49 +18,29 @@ Kinematic body 3D node. Member Functions ---------------- -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_collision_collider` **(** :ref:`int` collision **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_collider_id` **(** :ref:`int` collision **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_collision_collider_metadata` **(** :ref:`int` collision **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_collision_collider_shape` **(** :ref:`int` collision **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_collider_shape_index` **(** :ref:`int` collision **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_collision_collider_velocity` **(** :ref:`int` collision **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_count` **(** **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_collision_local_shape` **(** :ref:`int` collision **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_collision_normal` **(** :ref:`int` collision **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_collision_position` **(** :ref:`int` collision **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_collision_remainder` **(** :ref:`int` collision **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_collision_travel` **(** :ref:`int` collision **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_floor_velocity` **(** **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_safe_margin` **(** **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_on_ceiling` **(** **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_on_floor` **(** **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_on_wall` **(** **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`move` **(** :ref:`Vector3` rel_vec **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`move_and_slide` **(** :ref:`Vector3` linear_velocity, :ref:`Vector3` floor_normal=4, :ref:`float` slope_stop_min_velocity=0.05, :ref:`int` max_bounces=Vector3( 0, 0, 0 ), :ref:`float` floor_max_angle=null **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_safe_margin` **(** :ref:`float` pixels **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`test_move` **(** :ref:`Transform` from, :ref:`Vector3` rel_vec **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_floor_velocity` **(** **)** const | ++------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_safe_margin` **(** **)** const | ++------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`KinematicCollision` | :ref:`get_slide_collision` **(** :ref:`int` slide_idx **)** | ++------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_slide_count` **(** **)** const | ++------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_on_ceiling` **(** **)** const | ++------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_on_floor` **(** **)** const | ++------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_on_wall` **(** **)** const | ++------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`KinematicCollision` | :ref:`move_and_collide` **(** :ref:`Vector3` rel_vec **)** | ++------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`move_and_slide` **(** :ref:`Vector3` linear_velocity, :ref:`Vector3` floor_normal=Vector3( 0, 0, 0 ), :ref:`float` slope_stop_min_velocity=0.05, :ref:`int` max_slides=4, :ref:`float` floor_max_angle=0.785398 **)** | ++------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_safe_margin` **(** :ref:`float` pixels **)** | ++------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`test_move` **(** :ref:`Transform` from, :ref:`Vector3` rel_vec **)** | ++------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -79,54 +59,6 @@ Kinematic Characters: KinematicBody also has an api for moving objects (the :ref Member Function Description --------------------------- -.. _class_KinematicBody_get_collision_collider: - -- :ref:`Object` **get_collision_collider** **(** :ref:`int` collision **)** const - -.. _class_KinematicBody_get_collision_collider_id: - -- :ref:`int` **get_collision_collider_id** **(** :ref:`int` collision **)** const - -.. _class_KinematicBody_get_collision_collider_metadata: - -- :ref:`Variant` **get_collision_collider_metadata** **(** :ref:`int` collision **)** const - -.. _class_KinematicBody_get_collision_collider_shape: - -- :ref:`Object` **get_collision_collider_shape** **(** :ref:`int` collision **)** const - -.. _class_KinematicBody_get_collision_collider_shape_index: - -- :ref:`int` **get_collision_collider_shape_index** **(** :ref:`int` collision **)** const - -.. _class_KinematicBody_get_collision_collider_velocity: - -- :ref:`Vector3` **get_collision_collider_velocity** **(** :ref:`int` collision **)** const - -.. _class_KinematicBody_get_collision_count: - -- :ref:`int` **get_collision_count** **(** **)** const - -.. _class_KinematicBody_get_collision_local_shape: - -- :ref:`Object` **get_collision_local_shape** **(** :ref:`int` collision **)** const - -.. _class_KinematicBody_get_collision_normal: - -- :ref:`Vector3` **get_collision_normal** **(** :ref:`int` collision **)** const - -.. _class_KinematicBody_get_collision_position: - -- :ref:`Vector3` **get_collision_position** **(** :ref:`int` collision **)** const - -.. _class_KinematicBody_get_collision_remainder: - -- :ref:`Vector3` **get_collision_remainder** **(** :ref:`int` collision **)** const - -.. _class_KinematicBody_get_collision_travel: - -- :ref:`Vector3` **get_collision_travel** **(** :ref:`int` collision **)** const - .. _class_KinematicBody_get_floor_velocity: - :ref:`Vector3` **get_floor_velocity** **(** **)** const @@ -135,6 +67,14 @@ Member Function Description - :ref:`float` **get_safe_margin** **(** **)** const +.. _class_KinematicBody_get_slide_collision: + +- :ref:`KinematicCollision` **get_slide_collision** **(** :ref:`int` slide_idx **)** + +.. _class_KinematicBody_get_slide_count: + +- :ref:`int` **get_slide_count** **(** **)** const + .. _class_KinematicBody_is_on_ceiling: - :ref:`bool` **is_on_ceiling** **(** **)** const @@ -147,33 +87,13 @@ Member Function Description - :ref:`bool` **is_on_wall** **(** **)** const -.. _class_KinematicBody_move: +.. _class_KinematicBody_move_and_collide: -- :ref:`Dictionary` **move** **(** :ref:`Vector3` rel_vec **)** - -Move the body in the given direction, stopping if there is an obstacle. If as a result of a movement there will be any collision then informations about this collision will be in returned dictionary. Dictionary will contains those keys: - -- "position" - collision position - -- "normal" - collision normal - -- "local_shape" - id of this kinematic body shape that took part in a collision - -- "travel" - traveled movement before being stopped - -- "remainder" - remaining movement before being stopped - -- "collider_id" - id of the collider, it can be used when dealing with :ref:`PhysicsServer` - -- "collider" - colliding body - -- "collider_shape_index" - index of the colliding shape, inside collider body "collider_metadata" - -If the body did not intersect anything, then an empty dictionary (dir.empty()==true) is returned instead. Please note that this method is less user friendly than :ref:`move_and_slide`. If you don't want to program each edge case manually, then it's recommended to use :ref:`move_and_slide` instead. +- :ref:`KinematicCollision` **move_and_collide** **(** :ref:`Vector3` rel_vec **)** .. _class_KinematicBody_move_and_slide: -- :ref:`Vector3` **move_and_slide** **(** :ref:`Vector3` linear_velocity, :ref:`Vector3` floor_normal=4, :ref:`float` slope_stop_min_velocity=0.05, :ref:`int` max_bounces=Vector3( 0, 0, 0 ), :ref:`float` floor_max_angle=null **)** +- :ref:`Vector3` **move_and_slide** **(** :ref:`Vector3` linear_velocity, :ref:`Vector3` floor_normal=Vector3( 0, 0, 0 ), :ref:`float` slope_stop_min_velocity=0.05, :ref:`int` max_slides=4, :ref:`float` floor_max_angle=0.785398 **)** .. _class_KinematicBody_set_safe_margin: diff --git a/classes/class_kinematicbody2d.rst b/classes/class_kinematicbody2d.rst index 8ec1999f2..e5a8f249f 100644 --- a/classes/class_kinematicbody2d.rst +++ b/classes/class_kinematicbody2d.rst @@ -18,49 +18,49 @@ Kinematic body 2D node. Member Functions ---------------- -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_collision_collider` **(** :ref:`int` collision **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_collider_id` **(** :ref:`int` collision **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_collision_collider_metadata` **(** :ref:`int` collision **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_collision_collider_shape` **(** :ref:`int` collision **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_collider_shape_index` **(** :ref:`int` collision **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_collision_collider_velocity` **(** :ref:`int` collision **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_count` **(** **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_collision_local_shape` **(** :ref:`int` collision **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_collision_normal` **(** :ref:`int` collision **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_collision_position` **(** :ref:`int` collision **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_collision_remainder` **(** :ref:`int` collision **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_collision_travel` **(** :ref:`int` collision **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_floor_velocity` **(** **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_safe_margin` **(** **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_on_ceiling` **(** **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_on_floor` **(** **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_on_wall` **(** **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`move` **(** :ref:`Vector2` rel_vec **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`move_and_slide` **(** :ref:`Vector2` linear_velocity, :ref:`Vector2` floor_normal=4, :ref:`float` slope_stop_min_velocity=5, :ref:`int` max_bounces=Vector2( 0, 0 ), :ref:`float` floor_max_angle=null **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_safe_margin` **(** :ref:`float` pixels **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`test_move` **(** :ref:`Transform2D` from, :ref:`Vector2` rel_vec **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_collision_collider` **(** :ref:`int` collision **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collision_collider_id` **(** :ref:`int` collision **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_collision_collider_metadata` **(** :ref:`int` collision **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_collision_collider_shape` **(** :ref:`int` collision **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collision_collider_shape_index` **(** :ref:`int` collision **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_collision_collider_velocity` **(** :ref:`int` collision **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collision_count` **(** **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_collision_local_shape` **(** :ref:`int` collision **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_collision_normal` **(** :ref:`int` collision **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_collision_position` **(** :ref:`int` collision **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_collision_remainder` **(** :ref:`int` collision **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_collision_travel` **(** :ref:`int` collision **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_floor_velocity` **(** **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_safe_margin` **(** **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_on_ceiling` **(** **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_on_floor` **(** **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_on_wall` **(** **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`move` **(** :ref:`Vector2` rel_vec **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`move_and_slide` **(** :ref:`Vector2` linear_velocity, :ref:`Vector2` floor_normal=Vector2( 0, 0 ), :ref:`float` slope_stop_min_velocity=5, :ref:`int` max_bounces=4, :ref:`float` floor_max_angle=0.785398 **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_safe_margin` **(** :ref:`float` pixels **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`test_move` **(** :ref:`Transform2D` from, :ref:`Vector2` rel_vec **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -175,7 +175,7 @@ If the body did not intersect anything, then an empty dictionary (dir.empty()==t .. _class_KinematicBody2D_move_and_slide: -- :ref:`Vector2` **move_and_slide** **(** :ref:`Vector2` linear_velocity, :ref:`Vector2` floor_normal=4, :ref:`float` slope_stop_min_velocity=5, :ref:`int` max_bounces=Vector2( 0, 0 ), :ref:`float` floor_max_angle=null **)** +- :ref:`Vector2` **move_and_slide** **(** :ref:`Vector2` linear_velocity, :ref:`Vector2` floor_normal=Vector2( 0, 0 ), :ref:`float` slope_stop_min_velocity=5, :ref:`int` max_bounces=4, :ref:`float` floor_max_angle=0.785398 **)** .. _class_KinematicBody2D_set_safe_margin: diff --git a/classes/class_kinematiccollision.rst b/classes/class_kinematiccollision.rst new file mode 100644 index 000000000..1f3a22287 --- /dev/null +++ b/classes/class_kinematiccollision.rst @@ -0,0 +1,107 @@ +.. 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_KinematicCollision: + +KinematicCollision +================== + +**Inherits:** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++--------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_collider` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collider_id` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_collider_metadata` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_collider_shape` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collider_shape_index` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_collider_velocity` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_local_shape` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_normal` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_position` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_remainder` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_travel` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`Object` **collider** +- :ref:`int` **collider_id** +- :ref:`Variant` **collider_metadata** +- :ref:`Object` **collider_shape** +- :ref:`int` **collider_shape_index** +- :ref:`Vector3` **collider_velocity** +- :ref:`Object` **local_shape** +- :ref:`Vector3` **normal** +- :ref:`Vector3` **position** +- :ref:`Vector3` **remainder** +- :ref:`Vector3` **travel** + +Member Function Description +--------------------------- + +.. _class_KinematicCollision_get_collider: + +- :ref:`Object` **get_collider** **(** **)** const + +.. _class_KinematicCollision_get_collider_id: + +- :ref:`int` **get_collider_id** **(** **)** const + +.. _class_KinematicCollision_get_collider_metadata: + +- :ref:`Variant` **get_collider_metadata** **(** **)** const + +.. _class_KinematicCollision_get_collider_shape: + +- :ref:`Object` **get_collider_shape** **(** **)** const + +.. _class_KinematicCollision_get_collider_shape_index: + +- :ref:`int` **get_collider_shape_index** **(** **)** const + +.. _class_KinematicCollision_get_collider_velocity: + +- :ref:`Vector3` **get_collider_velocity** **(** **)** const + +.. _class_KinematicCollision_get_local_shape: + +- :ref:`Object` **get_local_shape** **(** **)** const + +.. _class_KinematicCollision_get_normal: + +- :ref:`Vector3` **get_normal** **(** **)** const + +.. _class_KinematicCollision_get_position: + +- :ref:`Vector3` **get_position** **(** **)** const + +.. _class_KinematicCollision_get_remainder: + +- :ref:`Vector3` **get_remainder** **(** **)** const + +.. _class_KinematicCollision_get_travel: + +- :ref:`Vector3` **get_travel** **(** **)** const + + diff --git a/classes/class_lineedit.rst b/classes/class_lineedit.rst index 67eefb714..95f076496 100644 --- a/classes/class_lineedit.rst +++ b/classes/class_lineedit.rst @@ -53,7 +53,7 @@ Member Functions +------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`menu_option` **(** :ref:`int` option **)** | +------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`select` **(** :ref:`int` from=-1, :ref:`int` to=0 **)** | +| void | :ref:`select` **(** :ref:`int` from=0, :ref:`int` to=-1 **)** | +------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`select_all` **(** **)** | +------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ @@ -216,7 +216,7 @@ Return the *secret* status of the :ref:`LineEdit` (see :ref:`set .. _class_LineEdit_select: -- void **select** **(** :ref:`int` from=-1, :ref:`int` to=0 **)** +- void **select** **(** :ref:`int` from=0, :ref:`int` to=-1 **)** .. _class_LineEdit_select_all: diff --git a/classes/class_meshlibrary.rst b/classes/class_meshlibrary.rst index 3ba24d210..511e55787 100644 --- a/classes/class_meshlibrary.rst +++ b/classes/class_meshlibrary.rst @@ -23,6 +23,8 @@ Member Functions +----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`create_item` **(** :ref:`int` id **)** | +----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`find_item_by_name` **(** :ref:`String` name **)** const | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolIntArray` | :ref:`get_item_list` **(** **)** const | +----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Mesh` | :ref:`get_item_mesh` **(** :ref:`int` id **)** const | @@ -70,6 +72,10 @@ Clear the library. Create a new item in the library, supplied an id. +.. _class_MeshLibrary_find_item_by_name: + +- :ref:`int` **find_item_by_name** **(** :ref:`String` name **)** const + .. _class_MeshLibrary_get_item_list: - :ref:`PoolIntArray` **get_item_list** **(** **)** const diff --git a/classes/class_navigation.rst b/classes/class_navigation.rst index e2434d847..c9f19d0ab 100644 --- a/classes/class_navigation.rst +++ b/classes/class_navigation.rst @@ -18,27 +18,27 @@ Brief Description Member Functions ---------------- -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_closest_point` **(** :ref:`Vector3` to_point **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_closest_point_normal` **(** :ref:`Vector3` to_point **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_closest_point_owner` **(** :ref:`Vector3` to_point **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_closest_point_to_segment` **(** :ref:`Vector3` start, :ref:`Vector3` end, :ref:`bool` use_collision=null **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`get_simple_path` **(** :ref:`Vector3` start, :ref:`Vector3` end, :ref:`bool` optimize=null **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_up_vector` **(** **)** const | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`navmesh_create` **(** :ref:`NavigationMesh` mesh, :ref:`Transform` xform, :ref:`Object` owner=null **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`navmesh_remove` **(** :ref:`int` id **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`navmesh_set_transform` **(** :ref:`int` id, :ref:`Transform` xform **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_up_vector` **(** :ref:`Vector3` up **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_closest_point` **(** :ref:`Vector3` to_point **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_closest_point_normal` **(** :ref:`Vector3` to_point **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_closest_point_owner` **(** :ref:`Vector3` to_point **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_closest_point_to_segment` **(** :ref:`Vector3` start, :ref:`Vector3` end, :ref:`bool` use_collision=false **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`get_simple_path` **(** :ref:`Vector3` start, :ref:`Vector3` end, :ref:`bool` optimize=true **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_up_vector` **(** **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`navmesh_create` **(** :ref:`NavigationMesh` mesh, :ref:`Transform` xform, :ref:`Object` owner=null **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`navmesh_remove` **(** :ref:`int` id **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`navmesh_set_transform` **(** :ref:`int` id, :ref:`Transform` xform **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_up_vector` **(** :ref:`Vector3` up **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -62,11 +62,11 @@ Member Function Description .. _class_Navigation_get_closest_point_to_segment: -- :ref:`Vector3` **get_closest_point_to_segment** **(** :ref:`Vector3` start, :ref:`Vector3` end, :ref:`bool` use_collision=null **)** +- :ref:`Vector3` **get_closest_point_to_segment** **(** :ref:`Vector3` start, :ref:`Vector3` end, :ref:`bool` use_collision=false **)** .. _class_Navigation_get_simple_path: -- :ref:`PoolVector3Array` **get_simple_path** **(** :ref:`Vector3` start, :ref:`Vector3` end, :ref:`bool` optimize=null **)** +- :ref:`PoolVector3Array` **get_simple_path** **(** :ref:`Vector3` start, :ref:`Vector3` end, :ref:`bool` optimize=true **)** .. _class_Navigation_get_up_vector: diff --git a/classes/class_navigation2d.rst b/classes/class_navigation2d.rst index 08d90df6d..2095e71ee 100644 --- a/classes/class_navigation2d.rst +++ b/classes/class_navigation2d.rst @@ -23,7 +23,7 @@ Member Functions +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Object` | :ref:`get_closest_point_owner` **(** :ref:`Vector2` to_point **)** | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`get_simple_path` **(** :ref:`Vector2` start, :ref:`Vector2` end, :ref:`bool` optimize=null **)** | +| :ref:`PoolVector2Array` | :ref:`get_simple_path` **(** :ref:`Vector2` start, :ref:`Vector2` end, :ref:`bool` optimize=true **)** | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`navpoly_create` **(** :ref:`NavigationPolygon` mesh, :ref:`Transform2D` xform, :ref:`Object` owner=null **)** | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -45,7 +45,7 @@ Member Function Description .. _class_Navigation2D_get_simple_path: -- :ref:`PoolVector2Array` **get_simple_path** **(** :ref:`Vector2` start, :ref:`Vector2` end, :ref:`bool` optimize=null **)** +- :ref:`PoolVector2Array` **get_simple_path** **(** :ref:`Vector2` start, :ref:`Vector2` end, :ref:`bool` optimize=true **)** .. _class_Navigation2D_navpoly_create: diff --git a/classes/class_networkedmultiplayerenet.rst b/classes/class_networkedmultiplayerenet.rst index 0bb0bce45..f99a1a23c 100644 --- a/classes/class_networkedmultiplayerenet.rst +++ b/classes/class_networkedmultiplayerenet.rst @@ -18,19 +18,19 @@ PacketPeer implementation using the ENet library. Member Functions ---------------- -+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`close_connection` **(** **)** | -+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`create_client` **(** :ref:`String` ip, :ref:`int` port, :ref:`int` in_bandwidth=null, :ref:`int` out_bandwidth=null **)** | -+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`create_server` **(** :ref:`int` port, :ref:`int` max_clients=0, :ref:`int` in_bandwidth=32, :ref:`int` out_bandwidth=null **)** | -+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_compression_mode` **(** **)** const | -+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bind_ip` **(** :ref:`String` ip **)** | -+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_compression_mode` **(** :ref:`int` mode **)** | -+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`close_connection` **(** **)** | ++------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`create_client` **(** :ref:`String` ip, :ref:`int` port, :ref:`int` in_bandwidth=0, :ref:`int` out_bandwidth=0 **)** | ++------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`create_server` **(** :ref:`int` port, :ref:`int` max_clients=32, :ref:`int` in_bandwidth=0, :ref:`int` out_bandwidth=0 **)** | ++------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_compression_mode` **(** **)** const | ++------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bind_ip` **(** :ref:`String` ip **)** | ++------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_compression_mode` **(** :ref:`int` mode **)** | ++------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -55,11 +55,11 @@ Member Function Description .. _class_NetworkedMultiplayerENet_create_client: -- :ref:`int` **create_client** **(** :ref:`String` ip, :ref:`int` port, :ref:`int` in_bandwidth=null, :ref:`int` out_bandwidth=null **)** +- :ref:`int` **create_client** **(** :ref:`String` ip, :ref:`int` port, :ref:`int` in_bandwidth=0, :ref:`int` out_bandwidth=0 **)** .. _class_NetworkedMultiplayerENet_create_server: -- :ref:`int` **create_server** **(** :ref:`int` port, :ref:`int` max_clients=0, :ref:`int` in_bandwidth=32, :ref:`int` out_bandwidth=null **)** +- :ref:`int` **create_server** **(** :ref:`int` port, :ref:`int` max_clients=32, :ref:`int` in_bandwidth=0, :ref:`int` out_bandwidth=0 **)** .. _class_NetworkedMultiplayerENet_get_compression_mode: diff --git a/classes/class_node.rst b/classes/class_node.rst index 626a41b9c..cb2882e63 100644 --- a/classes/class_node.rst +++ b/classes/class_node.rst @@ -20,177 +20,177 @@ Base class for all the *scene* elements. Member Functions ---------------- -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_enter_tree` **(** **)** virtual | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_exit_tree` **(** **)** virtual | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_fixed_process` **(** :ref:`float` delta **)** virtual | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_input` **(** :ref:`InputEvent` event **)** virtual | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_process` **(** :ref:`float` delta **)** virtual | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_ready` **(** **)** virtual | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_unhandled_input` **(** :ref:`InputEvent` event **)** virtual | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_unhandled_key_input` **(** :ref:`InputEventKey` event **)** virtual | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_child` **(** :ref:`Node` node, :ref:`bool` legible_unique_name=null **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_to_group` **(** :ref:`String` group, :ref:`bool` persistent=null **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_process` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`duplicate` **(** :ref:`int` flags=15 **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`find_node` **(** :ref:`String` mask, :ref:`bool` recursive=true, :ref:`bool` owned=null **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`get_child` **(** :ref:`int` idx **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_child_count` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_children` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_filename` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_fixed_process_delta_time` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_groups` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_index` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_name` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_network_master` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`get_node` **(** :ref:`NodePath` path **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_node_and_resource` **(** :ref:`NodePath` path **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`get_owner` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`get_parent` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_path` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_path_to` **(** :ref:`Node` node **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_pause_mode` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_position_in_parent` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_process_delta_time` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_scene_instance_load_placeholder` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`SceneTree` | :ref:`get_tree` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Viewport` | :ref:`get_viewport` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_node` **(** :ref:`NodePath` path **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_node_and_resource` **(** :ref:`NodePath` path **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_a_parent_of` **(** :ref:`Node` node **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_displayed_folded` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_fixed_processing` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_fixed_processing_internal` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_greater_than` **(** :ref:`Node` node **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_in_group` **(** :ref:`String` group **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_inside_tree` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_network_master` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_processing` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_processing_input` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_processing_internal` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_processing_unhandled_input` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_processing_unhandled_key_input` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`move_child` **(** :ref:`Node` child_node, :ref:`int` to_pos **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`print_stray_nodes` **(** **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`print_tree` **(** **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`propagate_call` **(** :ref:`String` method, :ref:`Array` args=[ ], :ref:`bool` parent_first=null **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`propagate_notification` **(** :ref:`int` what **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`queue_free` **(** **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`raise` **(** **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_and_skip` **(** **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_child` **(** :ref:`Node` node **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_from_group` **(** :ref:`String` group **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`replace_by` **(** :ref:`Node` node, :ref:`bool` keep_data=null **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`request_ready` **(** **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`rpc` **(** :ref:`String` method **)** vararg | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rpc_config` **(** :ref:`String` method, :ref:`int` mode **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`rpc_id` **(** :ref:`int` peer_id, :ref:`String` method **)** vararg | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`rpc_unreliable` **(** :ref:`String` method **)** vararg | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`rpc_unreliable_id` **(** :ref:`int` peer_id, :ref:`String` method **)** vararg | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rset` **(** :ref:`String` property, :ref:`Variant` value **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rset_config` **(** :ref:`String` property, :ref:`int` mode **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rset_id` **(** :ref:`int` peer_id, :ref:`String` property, :ref:`Variant` value **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rset_unreliable` **(** :ref:`String` property, :ref:`Variant` value **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rset_unreliable_id` **(** :ref:`int` peer_id, :ref:`String` property, :ref:`Variant` value **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_display_folded` **(** :ref:`bool` fold **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_filename` **(** :ref:`String` filename **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fixed_process` **(** :ref:`bool` enable **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fixed_process_internal` **(** :ref:`bool` enable **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_name` **(** :ref:`String` name **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_network_master` **(** :ref:`int` id, :ref:`bool` recursive=null **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_owner` **(** :ref:`Node` owner **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pause_mode` **(** :ref:`int` mode **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_process` **(** :ref:`bool` enable **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_process_input` **(** :ref:`bool` enable **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_process_internal` **(** :ref:`bool` enable **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_process_unhandled_input` **(** :ref:`bool` enable **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_process_unhandled_key_input` **(** :ref:`bool` enable **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_scene_instance_load_placeholder` **(** :ref:`bool` load_placeholder **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_enter_tree` **(** **)** virtual | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_exit_tree` **(** **)** virtual | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_fixed_process` **(** :ref:`float` delta **)** virtual | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_input` **(** :ref:`InputEvent` event **)** virtual | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_process` **(** :ref:`float` delta **)** virtual | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_ready` **(** **)** virtual | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_unhandled_input` **(** :ref:`InputEvent` event **)** virtual | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_unhandled_key_input` **(** :ref:`InputEventKey` event **)** virtual | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_child` **(** :ref:`Node` node, :ref:`bool` legible_unique_name=false **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_to_group` **(** :ref:`String` group, :ref:`bool` persistent=false **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`can_process` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`duplicate` **(** :ref:`int` flags=15 **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`find_node` **(** :ref:`String` mask, :ref:`bool` recursive=true, :ref:`bool` owned=true **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`get_child` **(** :ref:`int` idx **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_child_count` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_children` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_filename` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_fixed_process_delta_time` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_groups` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_index` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_name` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_network_master` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`get_node` **(** :ref:`NodePath` path **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_node_and_resource` **(** :ref:`NodePath` path **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`get_owner` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`get_parent` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_path` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_path_to` **(** :ref:`Node` node **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_pause_mode` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_position_in_parent` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_process_delta_time` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_scene_instance_load_placeholder` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`SceneTree` | :ref:`get_tree` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Viewport` | :ref:`get_viewport` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_node` **(** :ref:`NodePath` path **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_node_and_resource` **(** :ref:`NodePath` path **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_a_parent_of` **(** :ref:`Node` node **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_displayed_folded` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_fixed_processing` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_fixed_processing_internal` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_greater_than` **(** :ref:`Node` node **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_in_group` **(** :ref:`String` group **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_inside_tree` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_network_master` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_processing` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_processing_input` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_processing_internal` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_processing_unhandled_input` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_processing_unhandled_key_input` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`move_child` **(** :ref:`Node` child_node, :ref:`int` to_pos **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`print_stray_nodes` **(** **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`print_tree` **(** **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`propagate_call` **(** :ref:`String` method, :ref:`Array` args=[ ], :ref:`bool` parent_first=false **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`propagate_notification` **(** :ref:`int` what **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`queue_free` **(** **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`raise` **(** **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_and_skip` **(** **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_child` **(** :ref:`Node` node **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_from_group` **(** :ref:`String` group **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`replace_by` **(** :ref:`Node` node, :ref:`bool` keep_data=false **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`request_ready` **(** **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`rpc` **(** :ref:`String` method **)** vararg | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rpc_config` **(** :ref:`String` method, :ref:`int` mode **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`rpc_id` **(** :ref:`int` peer_id, :ref:`String` method **)** vararg | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`rpc_unreliable` **(** :ref:`String` method **)** vararg | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`rpc_unreliable_id` **(** :ref:`int` peer_id, :ref:`String` method **)** vararg | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rset` **(** :ref:`String` property, :ref:`Variant` value **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rset_config` **(** :ref:`String` property, :ref:`int` mode **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rset_id` **(** :ref:`int` peer_id, :ref:`String` property, :ref:`Variant` value **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rset_unreliable` **(** :ref:`String` property, :ref:`Variant` value **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rset_unreliable_id` **(** :ref:`int` peer_id, :ref:`String` property, :ref:`Variant` value **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_display_folded` **(** :ref:`bool` fold **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_filename` **(** :ref:`String` filename **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fixed_process` **(** :ref:`bool` enable **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fixed_process_internal` **(** :ref:`bool` enable **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_name` **(** :ref:`String` name **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_network_master` **(** :ref:`int` id, :ref:`bool` recursive=true **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_owner` **(** :ref:`Node` owner **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_pause_mode` **(** :ref:`int` mode **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_process` **(** :ref:`bool` enable **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_process_input` **(** :ref:`bool` enable **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_process_internal` **(** :ref:`bool` enable **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_process_unhandled_input` **(** :ref:`bool` enable **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_process_unhandled_key_input` **(** :ref:`bool` enable **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_scene_instance_load_placeholder` **(** :ref:`bool` load_placeholder **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -325,7 +325,7 @@ Corresponds to the NOTIFICATION_READY notification in :ref:`Object._notification .. _class_Node_add_child: -- void **add_child** **(** :ref:`Node` node, :ref:`bool` legible_unique_name=null **)** +- void **add_child** **(** :ref:`Node` node, :ref:`bool` legible_unique_name=false **)** Add a child :ref:`Node`. Nodes can have as many children as they want, but every child must have a unique name. Children nodes are automatically deleted when the parent node is deleted, so deleting a whole scene is performed by deleting its topmost node. @@ -333,7 +333,7 @@ The optional boolean argument enforces creating child nodes with human-readable .. _class_Node_add_to_group: -- void **add_to_group** **(** :ref:`String` group, :ref:`bool` persistent=null **)** +- void **add_to_group** **(** :ref:`String` group, :ref:`bool` persistent=false **)** Add a node to a group. Groups are helpers to name and organize a subset of nodes, like for example "enemies" or "collectables". A :ref:`Node` can be in any number of groups. Nodes can be assigned a group at any time, but will not be added to it until they are inside the scene tree (see :ref:`is_inside_tree`). @@ -353,7 +353,7 @@ You can fine-tune the behavior using the ``flags``, which are based on the DUPLI .. _class_Node_find_node: -- :ref:`Node` **find_node** **(** :ref:`String` mask, :ref:`bool` recursive=true, :ref:`bool` owned=null **)** const +- :ref:`Node` **find_node** **(** :ref:`String` mask, :ref:`bool` recursive=true, :ref:`bool` owned=true **)** const Find a descendant of this node whose name matches ``mask`` as in :ref:`String.match` (i.e. case sensitive, but '\*' matches zero or more characters and '?' matches any single character except '.'). Note that it does not match against the full path, just against individual node names. @@ -583,7 +583,7 @@ Print the scene to stdout. Used mainly for debugging purposes. .. _class_Node_propagate_call: -- void **propagate_call** **(** :ref:`String` method, :ref:`Array` args=[ ], :ref:`bool` parent_first=null **)** +- void **propagate_call** **(** :ref:`String` method, :ref:`Array` args=[ ], :ref:`bool` parent_first=false **)** Calls the method (if present) with the arguments given in "args" on this Node and recursively on all children. If the parent_first argument is true then the method will be called on the current :ref:`Node` first, then on all children. If it is false then the children will get called first. @@ -623,7 +623,7 @@ Remove a node from a group. .. _class_Node_replace_by: -- void **replace_by** **(** :ref:`Node` node, :ref:`bool` keep_data=null **)** +- void **replace_by** **(** :ref:`Node` node, :ref:`bool` keep_data=false **)** Replace a node in a scene by a given one. Subscriptions that pass through this node will be lost. @@ -719,7 +719,7 @@ Set the name of the :ref:`Node`. Name must be unique within parent, .. _class_Node_set_network_master: -- void **set_network_master** **(** :ref:`int` id, :ref:`bool` recursive=null **)** +- void **set_network_master** **(** :ref:`int` id, :ref:`bool` recursive=true **)** .. _class_Node_set_owner: diff --git a/classes/class_node2d.rst b/classes/class_node2d.rst index 28836d5de..51915dd8a 100644 --- a/classes/class_node2d.rst +++ b/classes/class_node2d.rst @@ -53,9 +53,9 @@ Member Functions +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`look_at` **(** :ref:`Vector2` point **)** | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`move_local_x` **(** :ref:`float` delta, :ref:`bool` scaled=null **)** | +| void | :ref:`move_local_x` **(** :ref:`float` delta, :ref:`bool` scaled=false **)** | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`move_local_y` **(** :ref:`float` delta, :ref:`bool` scaled=null **)** | +| void | :ref:`move_local_y` **(** :ref:`float` delta, :ref:`bool` scaled=false **)** | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`rotate` **(** :ref:`float` radians **)** | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ @@ -212,13 +212,13 @@ Rotate the 2d node so it points at 'point' position. .. _class_Node2D_move_local_x: -- void **move_local_x** **(** :ref:`float` delta, :ref:`bool` scaled=null **)** +- void **move_local_x** **(** :ref:`float` delta, :ref:`bool` scaled=false **)** Apply a local translation on X axis to the 2D node according to the 'delta' of the process. If 'scaled' is false, the movement is normalized. .. _class_Node2D_move_local_y: -- void **move_local_y** **(** :ref:`float` delta, :ref:`bool` scaled=null **)** +- void **move_local_y** **(** :ref:`float` delta, :ref:`bool` scaled=false **)** Apply a local translation on Y axis to the 2D node according to the 'delta' of the process. If 'scaled' is false, the movement is normalized. diff --git a/classes/class_object.rst b/classes/class_object.rst index d3336abe9..90ff84861 100644 --- a/classes/class_object.rst +++ b/classes/class_object.rst @@ -18,87 +18,87 @@ Base class for all non built-in types. Member Functions ---------------- -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_get` **(** :ref:`String` property **)** virtual | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`_get_property_list` **(** **)** virtual | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_init` **(** **)** virtual | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_notification` **(** :ref:`int` what **)** virtual | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`_set` **(** :ref:`String` property, :ref:`Variant` value **)** virtual | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_user_signal` **(** :ref:`String` signal, :ref:`Array` arguments=null **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`call` **(** :ref:`String` method **)** vararg | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`call_deferred` **(** :ref:`String` method **)** vararg | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`callv` **(** :ref:`String` method, :ref:`Array` arg_array **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_translate_messages` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`connect` **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method, :ref:`Array` binds=null, :ref:`int` flags=null **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`disconnect` **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`emit_signal` **(** :ref:`String` signal **)** vararg | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`free` **(** **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get` **(** :ref:`String` property **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_class` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_incoming_connections` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_instance_id` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_meta` **(** :ref:`String` name **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_meta_list` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_method_list` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_property_list` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Reference` | :ref:`get_script` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_signal_connection_list` **(** :ref:`String` signal **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_signal_list` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_meta` **(** :ref:`String` name **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_method` **(** :ref:`String` method **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_user_signal` **(** :ref:`String` signal **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_blocking_signals` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_class` **(** :ref:`String` type **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_connected` **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_queued_for_deletion` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`notification` **(** :ref:`int` what, :ref:`bool` reversed=null **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`property_list_changed_notify` **(** **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set` **(** :ref:`String` property, :ref:`Variant` value **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_block_signals` **(** :ref:`bool` enable **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_message_translation` **(** :ref:`bool` enable **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_meta` **(** :ref:`String` name, :ref:`Variant` value **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_script` **(** :ref:`Reference` script **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`tr` **(** :ref:`String` message **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_get` **(** :ref:`String` property **)** virtual | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`_get_property_list` **(** **)** virtual | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_init` **(** **)** virtual | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_notification` **(** :ref:`int` what **)** virtual | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`_set` **(** :ref:`String` property, :ref:`Variant` value **)** virtual | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_user_signal` **(** :ref:`String` signal, :ref:`Array` arguments=[ ] **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`call` **(** :ref:`String` method **)** vararg | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`call_deferred` **(** :ref:`String` method **)** vararg | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`callv` **(** :ref:`String` method, :ref:`Array` arg_array **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`can_translate_messages` **(** **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`connect` **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method, :ref:`Array` binds=[ ], :ref:`int` flags=0 **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`disconnect` **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`emit_signal` **(** :ref:`String` signal **)** vararg | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`free` **(** **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get` **(** :ref:`String` property **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_class` **(** **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_incoming_connections` **(** **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_instance_id` **(** **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_meta` **(** :ref:`String` name **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_meta_list` **(** **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_method_list` **(** **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_property_list` **(** **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Reference` | :ref:`get_script` **(** **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_signal_connection_list` **(** :ref:`String` signal **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_signal_list` **(** **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_meta` **(** :ref:`String` name **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_method` **(** :ref:`String` method **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_user_signal` **(** :ref:`String` signal **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_blocking_signals` **(** **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_class` **(** :ref:`String` type **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_connected` **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_queued_for_deletion` **(** **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`notification` **(** :ref:`int` what, :ref:`bool` reversed=false **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`property_list_changed_notify` **(** **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set` **(** :ref:`String` property, :ref:`Variant` value **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_block_signals` **(** :ref:`bool` enable **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_message_translation` **(** :ref:`bool` enable **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_meta` **(** :ref:`String` name, :ref:`Variant` value **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_script` **(** :ref:`Reference` script **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`tr` **(** :ref:`String` message **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -160,7 +160,7 @@ Set a property. Return true if the property was found. .. _class_Object_add_user_signal: -- void **add_user_signal** **(** :ref:`String` signal, :ref:`Array` arguments=null **)** +- void **add_user_signal** **(** :ref:`String` signal, :ref:`Array` arguments=[ ] **)** Add a user signal (can be added anytime). Arguments are optional, but can be added as an array of dictionaries, each containing "name" and "type" (from :ref:`@Global Scope` TYPE\_\*). @@ -184,7 +184,7 @@ Return true if this object can translate strings. .. _class_Object_connect: -- :ref:`int` **connect** **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method, :ref:`Array` binds=null, :ref:`int` flags=null **)** +- :ref:`int` **connect** **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method, :ref:`Array` binds=[ ], :ref:`int` flags=0 **)** Connect a signal to a method at a target (member function). Binds are optional and are passed as extra arguments to the call. Flags specify optional deferred or one shot connections, see enum CONNECT\_\*. A signal can only be connected once to a method, and it will throw an error if already connected. If you want to avoid this, use :ref:`is_connected` to check. @@ -310,7 +310,7 @@ Return true if a connection exists for a given signal and target/method. .. _class_Object_notification: -- void **notification** **(** :ref:`int` what, :ref:`bool` reversed=null **)** +- void **notification** **(** :ref:`int` what, :ref:`bool` reversed=false **)** Notify the object of something. diff --git a/classes/class_optionbutton.rst b/classes/class_optionbutton.rst index 465efc6b4..00d4b716b 100644 --- a/classes/class_optionbutton.rst +++ b/classes/class_optionbutton.rst @@ -21,7 +21,7 @@ Member Functions +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_icon_item` **(** :ref:`Texture` texture, :ref:`String` label, :ref:`int` id **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_item` **(** :ref:`String` label, :ref:`int` id=null **)** | +| void | :ref:`add_item` **(** :ref:`String` label, :ref:`int` id=-1 **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_separator` **(** **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -89,7 +89,7 @@ Add an item, with a "texture" icon, text "label" and (optionally) id. If no "id" .. _class_OptionButton_add_item: -- void **add_item** **(** :ref:`String` label, :ref:`int` id=null **)** +- void **add_item** **(** :ref:`String` label, :ref:`int` id=-1 **)** Add an item, with text "label" and (optionally) id. If no "id" is passed, "id" becomes the item index. New items are appended at the end. diff --git a/classes/class_os.rst b/classes/class_os.rst index ef05a951b..0d5fae519 100644 --- a/classes/class_os.rst +++ b/classes/class_os.rst @@ -19,7 +19,7 @@ Member Functions ---------------- +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`alert` **(** :ref:`String` text, :ref:`String` title=null **)** | +| void | :ref:`alert` **(** :ref:`String` text, :ref:`String` title="Alert!" **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`can_draw` **(** **)** const | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -33,7 +33,7 @@ Member Functions +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`dump_resources_to_file` **(** :ref:`String` file **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`execute` **(** :ref:`String` path, :ref:`PoolStringArray` arguments, :ref:`bool` blocking, :ref:`Array` output=null **)** | +| :ref:`int` | :ref:`execute` **(** :ref:`String` path, :ref:`PoolStringArray` arguments, :ref:`bool` blocking, :ref:`Array` output=[ ] **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`find_scancode_from_string` **(** :ref:`String` string **)** const | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -265,7 +265,7 @@ Member Function Description .. _class_OS_alert: -- void **alert** **(** :ref:`String` text, :ref:`String` title=null **)** +- void **alert** **(** :ref:`String` text, :ref:`String` title="Alert!" **)** Displays a modal dialog box utilizing the host OS. @@ -313,7 +313,7 @@ At the end of the file is a statistic of all used Resource Types. .. _class_OS_execute: -- :ref:`int` **execute** **(** :ref:`String` path, :ref:`PoolStringArray` arguments, :ref:`bool` blocking, :ref:`Array` output=null **)** +- :ref:`int` **execute** **(** :ref:`String` path, :ref:`PoolStringArray` arguments, :ref:`bool` blocking, :ref:`Array` output=[ ] **)** Execute the binary file in given path, optionally blocking until it returns. A process ID is returned. diff --git a/classes/class_packetpeerudp.rst b/classes/class_packetpeerudp.rst index 3daf2a72a..ae4aad678 100644 --- a/classes/class_packetpeerudp.rst +++ b/classes/class_packetpeerudp.rst @@ -18,21 +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 | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`listen` **(** :ref:`int` port, :ref:`String` bind_address="*", :ref:`int` recv_buf_size=null **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`set_dest_address` **(** :ref:`String` host, :ref:`int` port **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :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 | ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`listen` **(** :ref:`int` port, :ref:`String` bind_address="*", :ref:`int` recv_buf_size=65536 **)** | ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`set_dest_address` **(** :ref:`String` host, :ref:`int` port **)** | ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`wait` **(** **)** | ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -68,7 +68,7 @@ Return whether this :ref:`PacketPeerUDP` is listening. .. _class_PacketPeerUDP_listen: -- :ref:`int` **listen** **(** :ref:`int` port, :ref:`String` bind_address="*", :ref:`int` recv_buf_size=null **)** +- :ref:`int` **listen** **(** :ref:`int` port, :ref:`String` bind_address="*", :ref:`int` recv_buf_size=65536 **)** Make this :ref:`PacketPeerUDP` listen on the "port" binding to "bind_address" with a buffer size "recv_buf_size". diff --git a/classes/class_physics2ddirectspacestate.rst b/classes/class_physics2ddirectspacestate.rst index 1278be7c0..fa689d1d7 100644 --- a/classes/class_physics2ddirectspacestate.rst +++ b/classes/class_physics2ddirectspacestate.rst @@ -18,19 +18,19 @@ Direct access object to a space in the :ref:`Physics2DServer` | :ref:`cast_motion` **(** :ref:`Physics2DShapeQueryParameters` shape **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`collide_shape` **(** :ref:`Physics2DShapeQueryParameters` shape, :ref:`int` max_results=null **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_rest_info` **(** :ref:`Physics2DShapeQueryParameters` shape **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`intersect_point` **(** :ref:`Vector2` point, :ref:`int` max_results=2147483647, :ref:`Array` exclude=[ ], :ref:`int` collision_layer=32, :ref:`int` type_mask=null **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`intersect_ray` **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Array` exclude=[ ], :ref:`int` collision_layer=null, :ref:`int` type_mask=null **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`intersect_shape` **(** :ref:`Physics2DShapeQueryParameters` shape, :ref:`int` max_results=null **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`cast_motion` **(** :ref:`Physics2DShapeQueryParameters` shape **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`collide_shape` **(** :ref:`Physics2DShapeQueryParameters` shape, :ref:`int` max_results=32 **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_rest_info` **(** :ref:`Physics2DShapeQueryParameters` shape **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`intersect_point` **(** :ref:`Vector2` point, :ref:`int` max_results=32, :ref:`Array` exclude=[ ], :ref:`int` collision_layer=2147483647, :ref:`int` type_mask=15 **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`intersect_ray` **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Array` exclude=[ ], :ref:`int` collision_layer=2147483647, :ref:`int` type_mask=15 **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`intersect_shape` **(** :ref:`Physics2DShapeQueryParameters` shape, :ref:`int` max_results=32 **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -60,7 +60,7 @@ If the shape can not move, the array will be empty. .. _class_Physics2DDirectSpaceState_collide_shape: -- :ref:`Array` **collide_shape** **(** :ref:`Physics2DShapeQueryParameters` shape, :ref:`int` max_results=null **)** +- :ref:`Array` **collide_shape** **(** :ref:`Physics2DShapeQueryParameters` shape, :ref:`int` max_results=32 **)** Check the intersections of a shape, given through a :ref:`Physics2DShapeQueryParameters` object, against the space. The resulting array contains a list of points where the shape intersects another. Like with :ref:`intersect_shape`, the number of returned results can be limited to save processing time. @@ -90,7 +90,7 @@ If the shape did not intersect anything, then an empty dictionary (dir.empty()== .. _class_Physics2DDirectSpaceState_intersect_point: -- :ref:`Array` **intersect_point** **(** :ref:`Vector2` point, :ref:`int` max_results=2147483647, :ref:`Array` exclude=[ ], :ref:`int` collision_layer=32, :ref:`int` type_mask=null **)** +- :ref:`Array` **intersect_point** **(** :ref:`Vector2` point, :ref:`int` max_results=32, :ref:`Array` exclude=[ ], :ref:`int` collision_layer=2147483647, :ref:`int` type_mask=15 **)** Check whether a point is inside any shape. The shapes the point is inside of are returned in an array containing dictionaries with the following fields: @@ -108,7 +108,7 @@ Additionally, the method can take an array of objects or :ref:`RID`\ .. _class_Physics2DDirectSpaceState_intersect_ray: -- :ref:`Dictionary` **intersect_ray** **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Array` exclude=[ ], :ref:`int` collision_layer=null, :ref:`int` type_mask=null **)** +- :ref:`Dictionary` **intersect_ray** **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Array` exclude=[ ], :ref:`int` collision_layer=2147483647, :ref:`int` type_mask=15 **)** Intersect a ray in a given space. The returned object is a dictionary with the following fields: @@ -132,7 +132,7 @@ Additionally, the method can take an array of objects or :ref:`RID`\ .. _class_Physics2DDirectSpaceState_intersect_shape: -- :ref:`Array` **intersect_shape** **(** :ref:`Physics2DShapeQueryParameters` shape, :ref:`int` max_results=null **)** +- :ref:`Array` **intersect_shape** **(** :ref:`Physics2DShapeQueryParameters` shape, :ref:`int` max_results=32 **)** Check the intersections of a shape, given through a :ref:`Physics2DShapeQueryParameters` object, against the space. The intersected shapes are returned in an array containing dictionaries with the following fields: diff --git a/classes/class_physics2dserver.rst b/classes/class_physics2dserver.rst index 1fc6a2da2..606519c3f 100644 --- a/classes/class_physics2dserver.rst +++ b/classes/class_physics2dserver.rst @@ -21,7 +21,7 @@ Member Functions ---------------- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_add_shape` **(** :ref:`RID` area, :ref:`RID` shape, :ref:`Transform2D` transform=null **)** | +| void | :ref:`area_add_shape` **(** :ref:`RID` area, :ref:`RID` shape, :ref:`Transform2D` transform=Transform2D( 1, 0, 0, 1, 0, 0 ) **)** | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`area_attach_object_instance_id` **(** :ref:`RID` area, :ref:`int` id **)** | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -71,7 +71,7 @@ Member Functions +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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:`Transform2D` transform=null **)** | +| void | :ref:`body_add_shape` **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Transform2D` transform=Transform2D( 1, 0, 0, 1, 0, 0 ) **)** | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`body_apply_impulse` **(** :ref:`RID` body, :ref:`Vector2` pos, :ref:`Vector2` impulse **)** | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -79,7 +79,7 @@ Member Functions +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`body_clear_shapes` **(** :ref:`RID` body **)** | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`body_create` **(** :ref:`int` mode=false, :ref:`bool` init_sleeping=2 **)** | +| :ref:`RID` | :ref:`body_create` **(** :ref:`int` mode=2, :ref:`bool` init_sleeping=false **)** | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`body_get_collision_layer` **(** :ref:`RID` body **)** const | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -145,9 +145,9 @@ Member Functions +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`body_set_state` **(** :ref:`RID` body, :ref:`int` state, :ref:`Variant` value **)** | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`body_test_motion` **(** :ref:`RID` body, :ref:`Transform2D` from, :ref:`Vector2` motion, :ref:`float` margin=null, :ref:`Physics2DTestMotionResult` result=null **)** | +| :ref:`bool` | :ref:`body_test_motion` **(** :ref:`RID` body, :ref:`Transform2D` 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=null **)** | +| :ref:`RID` | :ref:`damped_spring_joint_create` **(** :ref:`Vector2` anchor_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a, :ref:`RID` body_b **)** | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`damped_string_joint_get_param` **(** :ref:`RID` joint, :ref:`int` param **)** const | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -157,7 +157,7 @@ Member Functions +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :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=null, :ref:`RID` body_b=null **)** | +| :ref:`RID` | :ref:`groove_joint_create` **(** :ref:`Vector2` groove1_a, :ref:`Vector2` groove2_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a, :ref:`RID` body_b **)** | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`joint_get_param` **(** :ref:`RID` joint, :ref:`int` param **)** const | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -165,7 +165,7 @@ Member Functions +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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=null **)** | +| :ref:`RID` | :ref:`pin_joint_create` **(** :ref:`Vector2` anchor, :ref:`RID` body_a, :ref:`RID` body_b **)** | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_active` **(** :ref:`bool` active **)** | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -263,7 +263,7 @@ Member Function Description .. _class_Physics2DServer_area_add_shape: -- void **area_add_shape** **(** :ref:`RID` area, :ref:`RID` shape, :ref:`Transform2D` transform=null **)** +- void **area_add_shape** **(** :ref:`RID` area, :ref:`RID` shape, :ref:`Transform2D` transform=Transform2D( 1, 0, 0, 1, 0, 0 ) **)** Add a shape to the area, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index. @@ -421,7 +421,7 @@ Add a positioned force to the applied force and torque. As with :ref:`body_apply .. _class_Physics2DServer_body_add_shape: -- void **body_add_shape** **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Transform2D` transform=null **)** +- void **body_add_shape** **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Transform2D` transform=Transform2D( 1, 0, 0, 1, 0, 0 ) **)** Add a shape to the body, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index. @@ -445,7 +445,7 @@ Remove all shapes from a body. .. _class_Physics2DServer_body_create: -- :ref:`RID` **body_create** **(** :ref:`int` mode=false, :ref:`bool` init_sleeping=2 **)** +- :ref:`RID` **body_create** **(** :ref:`int` mode=2, :ref:`bool` init_sleeping=false **)** Create a physics body. The first parameter can be any value from constants BODY_MODE\*, for the type of body created. Additionally, the body can be created in sleeping state to save processing time. @@ -641,13 +641,13 @@ Set a body state (see BODY_STATE\* constants). .. _class_Physics2DServer_body_test_motion: -- :ref:`bool` **body_test_motion** **(** :ref:`RID` body, :ref:`Transform2D` from, :ref:`Vector2` motion, :ref:`float` margin=null, :ref:`Physics2DTestMotionResult` result=null **)** +- :ref:`bool` **body_test_motion** **(** :ref:`RID` body, :ref:`Transform2D` from, :ref:`Vector2` motion, :ref:`float` margin=0.08, :ref:`Physics2DTestMotionResult` result=null **)** Return whether a body can move from a given point in a given direction. Apart from the boolean return value, a :ref:`Physics2DTestMotionResult` can be passed to return additional information in. .. _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=null **)** +- :ref:`RID` **damped_spring_joint_create** **(** :ref:`Vector2` anchor_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a, :ref:`RID` body_b **)** Create a damped spring joint between two bodies. If not specified, the second body is assumed to be the joint itself. @@ -677,7 +677,7 @@ Return information about the current state of the 2D physics engine. The states .. _class_Physics2DServer_groove_joint_create: -- :ref:`RID` **groove_joint_create** **(** :ref:`Vector2` groove1_a, :ref:`Vector2` groove2_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a=null, :ref:`RID` body_b=null **)** +- :ref:`RID` **groove_joint_create** **(** :ref:`Vector2` groove1_a, :ref:`Vector2` groove2_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a, :ref:`RID` body_b **)** Create a groove joint between two bodies. If not specified, the bodyies are assumed to be the joint itself. @@ -701,7 +701,7 @@ Set a joint parameter. Parameters are explained in the JOINT_PARAM\* constants. .. _class_Physics2DServer_pin_joint_create: -- :ref:`RID` **pin_joint_create** **(** :ref:`Vector2` anchor, :ref:`RID` body_a, :ref:`RID` body_b=null **)** +- :ref:`RID` **pin_joint_create** **(** :ref:`Vector2` anchor, :ref:`RID` body_a, :ref:`RID` body_b **)** Create a pin joint between two bodies. If not specified, the second body is assumed to be the joint itself. diff --git a/classes/class_physicsdirectspacestate.rst b/classes/class_physicsdirectspacestate.rst index 73c8dd6dc..f80cb393e 100644 --- a/classes/class_physicsdirectspacestate.rst +++ b/classes/class_physicsdirectspacestate.rst @@ -18,17 +18,17 @@ Brief Description Member Functions ---------------- -+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`cast_motion` **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`Vector3` motion **)** | -+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`collide_shape` **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`int` max_results=null **)** | -+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_rest_info` **(** :ref:`PhysicsShapeQueryParameters` shape **)** | -+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`intersect_ray` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Array` exclude=[ ], :ref:`int` collision_layer=null, :ref:`int` type_mask=null **)** | -+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`intersect_shape` **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`int` max_results=null **)** | -+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`cast_motion` **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`Vector3` motion **)** | ++--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`collide_shape` **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`int` max_results=32 **)** | ++--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_rest_info` **(** :ref:`PhysicsShapeQueryParameters` shape **)** | ++--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`intersect_ray` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Array` exclude=[ ], :ref:`int` collision_layer=2147483647, :ref:`int` type_mask=15 **)** | ++--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`intersect_shape` **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`int` max_results=32 **)** | ++--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -49,7 +49,7 @@ Member Function Description .. _class_PhysicsDirectSpaceState_collide_shape: -- :ref:`Array` **collide_shape** **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`int` max_results=null **)** +- :ref:`Array` **collide_shape** **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`int` max_results=32 **)** .. _class_PhysicsDirectSpaceState_get_rest_info: @@ -57,10 +57,10 @@ Member Function Description .. _class_PhysicsDirectSpaceState_intersect_ray: -- :ref:`Dictionary` **intersect_ray** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Array` exclude=[ ], :ref:`int` collision_layer=null, :ref:`int` type_mask=null **)** +- :ref:`Dictionary` **intersect_ray** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Array` exclude=[ ], :ref:`int` collision_layer=2147483647, :ref:`int` type_mask=15 **)** .. _class_PhysicsDirectSpaceState_intersect_shape: -- :ref:`Array` **intersect_shape** **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`int` max_results=null **)** +- :ref:`Array` **intersect_shape** **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`int` max_results=32 **)** diff --git a/classes/class_physicsserver.rst b/classes/class_physicsserver.rst index 0905041fd..91423da44 100644 --- a/classes/class_physicsserver.rst +++ b/classes/class_physicsserver.rst @@ -21,7 +21,7 @@ Member Functions ---------------- +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_add_shape` **(** :ref:`RID` area, :ref:`RID` shape, :ref:`Transform` transform=null **)** | +| void | :ref:`area_add_shape` **(** :ref:`RID` area, :ref:`RID` shape, :ref:`Transform` transform=Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ) **)** | +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`area_attach_object_instance_id` **(** :ref:`RID` area, :ref:`int` id **)** | +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -71,7 +71,7 @@ Member Functions +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`body_add_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** | +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_add_shape` **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Transform` transform=null **)** | +| void | :ref:`body_add_shape` **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Transform` transform=Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ) **)** | +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`body_apply_impulse` **(** :ref:`RID` body, :ref:`Vector3` pos, :ref:`Vector3` impulse **)** | +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -81,7 +81,7 @@ Member Functions +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`body_clear_shapes` **(** :ref:`RID` body **)** | +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`body_create` **(** :ref:`int` mode=false, :ref:`bool` init_sleeping=2 **)** | +| :ref:`RID` | :ref:`body_create` **(** :ref:`int` mode=2, :ref:`bool` init_sleeping=false **)** | +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`body_get_axis_lock` **(** :ref:`RID` body **)** const | +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -341,7 +341,7 @@ Member Function Description .. _class_PhysicsServer_area_add_shape: -- void **area_add_shape** **(** :ref:`RID` area, :ref:`RID` shape, :ref:`Transform` transform=null **)** +- void **area_add_shape** **(** :ref:`RID` area, :ref:`RID` shape, :ref:`Transform` transform=Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ) **)** .. _class_PhysicsServer_area_attach_object_instance_id: @@ -441,7 +441,7 @@ Member Function Description .. _class_PhysicsServer_body_add_shape: -- void **body_add_shape** **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Transform` transform=null **)** +- void **body_add_shape** **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Transform` transform=Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ) **)** .. _class_PhysicsServer_body_apply_impulse: @@ -461,7 +461,7 @@ Member Function Description .. _class_PhysicsServer_body_create: -- :ref:`RID` **body_create** **(** :ref:`int` mode=false, :ref:`bool` init_sleeping=2 **)** +- :ref:`RID` **body_create** **(** :ref:`int` mode=2, :ref:`bool` init_sleeping=false **)** .. _class_PhysicsServer_body_get_axis_lock: diff --git a/classes/class_popupmenu.rst b/classes/class_popupmenu.rst index 34eeecf58..bf0a62fe2 100644 --- a/classes/class_popupmenu.rst +++ b/classes/class_popupmenu.rst @@ -18,93 +18,93 @@ PopupMenu displays a list of options. Member Functions ---------------- -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_check_item` **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=null **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_check_shortcut` **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=null **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_icon_check_item` **(** :ref:`Texture` texture, :ref:`String` label, :ref:`int` id=null, :ref:`int` accel=null **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_icon_check_shortcut` **(** :ref:`Texture` texture, :ref:`ShortCut` shortcut, :ref:`int` id=null, :ref:`bool` global=null **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_icon_item` **(** :ref:`Texture` texture, :ref:`String` label, :ref:`int` id=null, :ref:`int` accel=null **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_icon_shortcut` **(** :ref:`Texture` texture, :ref:`ShortCut` shortcut, :ref:`int` id=null, :ref:`bool` global=null **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_item` **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=null **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_separator` **(** **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_shortcut` **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=null **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_submenu_item` **(** :ref:`String` label, :ref:`String` submenu, :ref:`int` id=null **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_item_accelerator` **(** :ref:`int` idx **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_item_count` **(** **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_item_icon` **(** :ref:`int` idx **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_item_id` **(** :ref:`int` idx **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_item_index` **(** :ref:`int` id **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_item_metadata` **(** :ref:`int` idx **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ShortCut` | :ref:`get_item_shortcut` **(** :ref:`int` idx **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_item_submenu` **(** :ref:`int` idx **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_item_text` **(** :ref:`int` idx **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_item_tooltip` **(** :ref:`int` idx **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_hide_on_checkable_item_selection` **(** **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_hide_on_item_selection` **(** **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_item_checkable` **(** :ref:`int` idx **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_item_checked` **(** :ref:`int` idx **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_item_disabled` **(** :ref:`int` idx **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_item_separator` **(** :ref:`int` idx **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_item` **(** :ref:`int` idx **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_hide_on_checkable_item_selection` **(** :ref:`bool` enable **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_hide_on_item_selection` **(** :ref:`bool` enable **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_accelerator` **(** :ref:`int` idx, :ref:`int` accel **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_as_checkable` **(** :ref:`int` idx, :ref:`bool` enable **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_as_separator` **(** :ref:`int` idx, :ref:`bool` enable **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_checked` **(** :ref:`int` idx, :ref:`bool` checked **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_disabled` **(** :ref:`int` idx, :ref:`bool` disabled **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_icon` **(** :ref:`int` idx, :ref:`Texture` icon **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_id` **(** :ref:`int` idx, :ref:`int` id **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_metadata` **(** :ref:`int` idx, :ref:`Variant` metadata **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_shortcut` **(** :ref:`int` idx, :ref:`ShortCut` shortcut, :ref:`bool` global=null **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_submenu` **(** :ref:`int` idx, :ref:`String` submenu **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_text` **(** :ref:`int` idx, :ref:`String` text **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_tooltip` **(** :ref:`int` idx, :ref:`String` tooltip **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`toggle_item_checked` **(** :ref:`int` idx **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_check_item` **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_check_shortcut` **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_icon_check_item` **(** :ref:`Texture` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_icon_check_shortcut` **(** :ref:`Texture` texture, :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_icon_item` **(** :ref:`Texture` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_icon_shortcut` **(** :ref:`Texture` texture, :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_item` **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_separator` **(** **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_shortcut` **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_submenu_item` **(** :ref:`String` label, :ref:`String` submenu, :ref:`int` id=-1 **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_item_accelerator` **(** :ref:`int` idx **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_item_count` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_item_icon` **(** :ref:`int` idx **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_item_id` **(** :ref:`int` idx **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_item_index` **(** :ref:`int` id **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_item_metadata` **(** :ref:`int` idx **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ShortCut` | :ref:`get_item_shortcut` **(** :ref:`int` idx **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_item_submenu` **(** :ref:`int` idx **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_item_text` **(** :ref:`int` idx **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_item_tooltip` **(** :ref:`int` idx **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_hide_on_checkable_item_selection` **(** **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_hide_on_item_selection` **(** **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_item_checkable` **(** :ref:`int` idx **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_item_checked` **(** :ref:`int` idx **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_item_disabled` **(** :ref:`int` idx **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_item_separator` **(** :ref:`int` idx **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_item` **(** :ref:`int` idx **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_hide_on_checkable_item_selection` **(** :ref:`bool` enable **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_hide_on_item_selection` **(** :ref:`bool` enable **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_accelerator` **(** :ref:`int` idx, :ref:`int` accel **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_as_checkable` **(** :ref:`int` idx, :ref:`bool` enable **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_as_separator` **(** :ref:`int` idx, :ref:`bool` enable **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_checked` **(** :ref:`int` idx, :ref:`bool` checked **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_disabled` **(** :ref:`int` idx, :ref:`bool` disabled **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_icon` **(** :ref:`int` idx, :ref:`Texture` icon **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_id` **(** :ref:`int` idx, :ref:`int` id **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_metadata` **(** :ref:`int` idx, :ref:`Variant` metadata **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_shortcut` **(** :ref:`int` idx, :ref:`ShortCut` shortcut, :ref:`bool` global=false **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_submenu` **(** :ref:`int` idx, :ref:`String` submenu **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_text` **(** :ref:`int` idx, :ref:`String` text **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_tooltip` **(** :ref:`int` idx, :ref:`String` tooltip **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`toggle_item_checked` **(** :ref:`int` idx **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -133,17 +133,17 @@ Member Function Description .. _class_PopupMenu_add_check_item: -- void **add_check_item** **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=null **)** +- void **add_check_item** **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** Add a new checkable item with text "label". An id can optionally be provided, as well as an accelerator. If no id is provided, one will be created from the index. Note that checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. .. _class_PopupMenu_add_check_shortcut: -- void **add_check_shortcut** **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=null **)** +- void **add_check_shortcut** **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** .. _class_PopupMenu_add_icon_check_item: -- void **add_icon_check_item** **(** :ref:`Texture` texture, :ref:`String` label, :ref:`int` id=null, :ref:`int` accel=null **)** +- void **add_icon_check_item** **(** :ref:`Texture` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** Add a new checkable item with text "label" and icon "texture". An id can optionally be provided, as well as an accelerator. If no id is provided, one will be @@ -151,21 +151,21 @@ created from the index. Note that checkable items just display a checkmark, but .. _class_PopupMenu_add_icon_check_shortcut: -- void **add_icon_check_shortcut** **(** :ref:`Texture` texture, :ref:`ShortCut` shortcut, :ref:`int` id=null, :ref:`bool` global=null **)** +- void **add_icon_check_shortcut** **(** :ref:`Texture` texture, :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** .. _class_PopupMenu_add_icon_item: -- void **add_icon_item** **(** :ref:`Texture` texture, :ref:`String` label, :ref:`int` id=null, :ref:`int` accel=null **)** +- void **add_icon_item** **(** :ref:`Texture` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** Add a new item with text "label" and icon "texture". An id can optionally be provided, as well as an accelerator keybinding. If no id is provided, one will be created from the index. .. _class_PopupMenu_add_icon_shortcut: -- void **add_icon_shortcut** **(** :ref:`Texture` texture, :ref:`ShortCut` shortcut, :ref:`int` id=null, :ref:`bool` global=null **)** +- void **add_icon_shortcut** **(** :ref:`Texture` texture, :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** .. _class_PopupMenu_add_item: -- void **add_item** **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=null **)** +- void **add_item** **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** Add a new item with text "label". An id can optionally be provided, as well as an accelerator keybinding. If no id is provided, one will be created from the index. @@ -177,11 +177,11 @@ Add a separator between items. Separators also occupy an index. .. _class_PopupMenu_add_shortcut: -- void **add_shortcut** **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=null **)** +- void **add_shortcut** **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** .. _class_PopupMenu_add_submenu_item: -- void **add_submenu_item** **(** :ref:`String` label, :ref:`String` submenu, :ref:`int` id=null **)** +- void **add_submenu_item** **(** :ref:`String` label, :ref:`String` submenu, :ref:`int` id=-1 **)** Adds an item with a submenu. The submenu is the name of a child PopupMenu node that would be shown when the item is clicked. An id can optionally be provided, but if is isn't provided, one will be created from the index. @@ -349,7 +349,7 @@ Sets the metadata of an item, which might be of any type. You can later get it w .. _class_PopupMenu_set_item_shortcut: -- void **set_item_shortcut** **(** :ref:`int` idx, :ref:`ShortCut` shortcut, :ref:`bool` global=null **)** +- void **set_item_shortcut** **(** :ref:`int` idx, :ref:`ShortCut` shortcut, :ref:`bool` global=false **)** .. _class_PopupMenu_set_item_submenu: diff --git a/classes/class_reference.rst b/classes/class_reference.rst index 88625bc8f..c3f0bc131 100644 --- a/classes/class_reference.rst +++ b/classes/class_reference.rst @@ -8,7 +8,7 @@ Reference **Inherits:** :ref:`Object` -**Inherited By:** :ref:`RegExMatch`, :ref:`EncodedObjectAsID`, :ref:`SurfaceTool`, :ref:`SpatialGizmo`, :ref:`TriangleMesh`, :ref:`PhysicsShapeQueryResult`, :ref:`Physics2DTestMotionResult`, :ref:`FuncRef`, :ref:`Marshalls`, :ref:`File`, :ref:`TCP_Server`, :ref:`Physics2DShapeQueryResult`, :ref:`ConfigFile`, :ref:`StreamPeer`, :ref:`HTTPClient`, :ref:`AudioStreamPlayback`, :ref:`VisualScriptFunctionState`, :ref:`GDFunctionState`, :ref:`SpatialVelocityTracker`, :ref:`EditorResourcePreviewGenerator`, :ref:`Physics2DShapeQueryParameters`, :ref:`ARVRInterface`, :ref:`EditorScript`, :ref:`Mutex`, :ref:`PacketPeer`, :ref:`Semaphore`, :ref:`XMLParser`, :ref:`EditorImportPlugin`, :ref:`Directory`, :ref:`AStar`, :ref:`SceneState`, :ref:`GDNativeClass`, :ref:`RegEx`, :ref:`PCKPacker`, :ref:`MeshDataTool`, :ref:`WeakRef`, :ref:`ResourceImporter`, :ref:`Resource`, :ref:`SceneTreeTimer`, :ref:`Thread`, :ref:`PackedDataContainerRef`, :ref:`ResourceInteractiveLoader`, :ref:`GDNative`, :ref:`PhysicsShapeQueryParameters` +**Inherited By:** :ref:`RegExMatch`, :ref:`EncodedObjectAsID`, :ref:`SurfaceTool`, :ref:`SpatialGizmo`, :ref:`TriangleMesh`, :ref:`PhysicsShapeQueryResult`, :ref:`Physics2DTestMotionResult`, :ref:`FuncRef`, :ref:`Marshalls`, :ref:`File`, :ref:`TCP_Server`, :ref:`Physics2DShapeQueryResult`, :ref:`ConfigFile`, :ref:`StreamPeer`, :ref:`HTTPClient`, :ref:`AudioStreamPlayback`, :ref:`VisualScriptFunctionState`, :ref:`KinematicCollision`, :ref:`GDFunctionState`, :ref:`SpatialVelocityTracker`, :ref:`EditorResourcePreviewGenerator`, :ref:`Physics2DShapeQueryParameters`, :ref:`ARVRInterface`, :ref:`EditorScript`, :ref:`Mutex`, :ref:`PacketPeer`, :ref:`Semaphore`, :ref:`XMLParser`, :ref:`EditorImportPlugin`, :ref:`Directory`, :ref:`AStar`, :ref:`SceneState`, :ref:`GDNativeClass`, :ref:`RegEx`, :ref:`PCKPacker`, :ref:`MeshDataTool`, :ref:`WeakRef`, :ref:`ResourceImporter`, :ref:`Resource`, :ref:`SceneTreeTimer`, :ref:`Thread`, :ref:`PackedDataContainerRef`, :ref:`ResourceInteractiveLoader`, :ref:`GDNative`, :ref:`PhysicsShapeQueryParameters` **Category:** Core diff --git a/classes/class_regex.rst b/classes/class_regex.rst index 8bad8f01f..7573cf0b7 100644 --- a/classes/class_regex.rst +++ b/classes/class_regex.rst @@ -18,23 +18,23 @@ Simple regular expression matcher. Member Functions ---------------- -+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`compile` **(** :ref:`String` pattern **)** | -+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_group_count` **(** **)** const | -+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_names` **(** **)** const | -+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_pattern` **(** **)** const | -+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_valid` **(** **)** const | -+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RegExMatch` | :ref:`search` **(** :ref:`String` subject, :ref:`int` offset=0, :ref:`int` end=null **)** const | -+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`sub` **(** :ref:`String` subject, :ref:`String` replacement, :ref:`bool` all=false, :ref:`int` offset=null, :ref:`int` end=null **)** const | -+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`compile` **(** :ref:`String` pattern **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_group_count` **(** **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_names` **(** **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_pattern` **(** **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_valid` **(** **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RegExMatch` | :ref:`search` **(** :ref:`String` subject, :ref:`int` offset=0, :ref:`int` end=-1 **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`sub` **(** :ref:`String` subject, :ref:`String` replacement, :ref:`bool` all=false, :ref:`int` offset=0, :ref:`int` end=-1 **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -128,13 +128,13 @@ Returns whether this object has a valid regular expression assigned. .. _class_RegEx_search: -- :ref:`RegExMatch` **search** **(** :ref:`String` subject, :ref:`int` offset=0, :ref:`int` end=null **)** const +- :ref:`RegExMatch` **search** **(** :ref:`String` subject, :ref:`int` offset=0, :ref:`int` end=-1 **)** const Searches the text for the compiled pattern. Returns a :ref:`RegExMatch` container of the first matching reult if found, otherwise null. The region to search within can be specified without modifying where the start and end anchor would be. .. _class_RegEx_sub: -- :ref:`String` **sub** **(** :ref:`String` subject, :ref:`String` replacement, :ref:`bool` all=false, :ref:`int` offset=null, :ref:`int` end=null **)** const +- :ref:`String` **sub** **(** :ref:`String` subject, :ref:`String` replacement, :ref:`bool` all=false, :ref:`int` offset=0, :ref:`int` end=-1 **)** const Searches the text for the compiled pattern and replaces it with the specified string. Escapes and backreferences such as ``\1`` and ``\g`` expanded and resolved. By default only the first instance is replaced but it can be changed for all instances (global replacement). The region to search within can be specified without modifying where the start and end anchor would be. diff --git a/classes/class_resourceloader.rst b/classes/class_resourceloader.rst index 738d37346..98f4c2efd 100644 --- a/classes/class_resourceloader.rst +++ b/classes/class_resourceloader.rst @@ -18,19 +18,19 @@ Resource Loader. Member Functions ---------------- -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_dependencies` **(** :ref:`String` path **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_recognized_extensions_for_type` **(** :ref:`String` type **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has` **(** :ref:`String` path **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Resource` | :ref:`load` **(** :ref:`String` path, :ref:`String` type_hint="", :ref:`bool` p_no_cache=null **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ResourceInteractiveLoader` | :ref:`load_interactive` **(** :ref:`String` path, :ref:`String` type_hint=null **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_abort_on_missing_resources` **(** :ref:`bool` abort **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_dependencies` **(** :ref:`String` path **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_recognized_extensions_for_type` **(** :ref:`String` type **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has` **(** :ref:`String` path **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Resource` | :ref:`load` **(** :ref:`String` path, :ref:`String` type_hint="", :ref:`bool` p_no_cache=false **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ResourceInteractiveLoader` | :ref:`load_interactive` **(** :ref:`String` path, :ref:`String` type_hint="" **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_abort_on_missing_resources` **(** :ref:`bool` abort **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -56,11 +56,11 @@ Return the list of recognized extensions for a resource type. .. _class_ResourceLoader_load: -- :ref:`Resource` **load** **(** :ref:`String` path, :ref:`String` type_hint="", :ref:`bool` p_no_cache=null **)** +- :ref:`Resource` **load** **(** :ref:`String` path, :ref:`String` type_hint="", :ref:`bool` p_no_cache=false **)** .. _class_ResourceLoader_load_interactive: -- :ref:`ResourceInteractiveLoader` **load_interactive** **(** :ref:`String` path, :ref:`String` type_hint=null **)** +- :ref:`ResourceInteractiveLoader` **load_interactive** **(** :ref:`String` path, :ref:`String` type_hint="" **)** Load a resource interactively, the returned object allows to load with high granularity. diff --git a/classes/class_resourcesaver.rst b/classes/class_resourcesaver.rst index 13f47192d..7810602c5 100644 --- a/classes/class_resourcesaver.rst +++ b/classes/class_resourcesaver.rst @@ -18,11 +18,11 @@ Resource Saving Interface. Member Functions ---------------- -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_recognized_extensions` **(** :ref:`Resource` type **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`save` **(** :ref:`String` path, :ref:`Resource` resource, :ref:`int` flags=null **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_recognized_extensions` **(** :ref:`Resource` type **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`save` **(** :ref:`String` path, :ref:`Resource` resource, :ref:`int` flags=0 **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -50,7 +50,7 @@ Return the list of extensions available for saving a resource of a given type. .. _class_ResourceSaver_save: -- :ref:`int` **save** **(** :ref:`String` path, :ref:`Resource` resource, :ref:`int` flags=null **)** +- :ref:`int` **save** **(** :ref:`String` path, :ref:`Resource` resource, :ref:`int` flags=0 **)** Save a resource to disk, to a given path. diff --git a/classes/class_scenestate.rst b/classes/class_scenestate.rst index dd3b0aa73..e047f5370 100644 --- a/classes/class_scenestate.rst +++ b/classes/class_scenestate.rst @@ -45,7 +45,7 @@ Member Functions +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`NodePath` | :ref:`get_node_owner_path` **(** :ref:`int` idx **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_node_path` **(** :ref:`int` idx, :ref:`bool` for_parent=null **)** const | +| :ref:`NodePath` | :ref:`get_node_path` **(** :ref:`int` idx, :ref:`bool` for_parent=false **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_node_property_count` **(** :ref:`int` idx **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -122,7 +122,7 @@ Member Function Description .. _class_SceneState_get_node_path: -- :ref:`NodePath` **get_node_path** **(** :ref:`int` idx, :ref:`bool` for_parent=null **)** const +- :ref:`NodePath` **get_node_path** **(** :ref:`int` idx, :ref:`bool` for_parent=false **)** const .. _class_SceneState_get_node_property_count: diff --git a/classes/class_scenetree.rst b/classes/class_scenetree.rst index 7cf89a94a..e64741176 100644 --- a/classes/class_scenetree.rst +++ b/classes/class_scenetree.rst @@ -27,7 +27,7 @@ Member Functions +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`change_scene_to` **(** :ref:`PackedScene` packed_scene **)** | +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`SceneTreeTimer` | :ref:`create_timer` **(** :ref:`float` time_sec, :ref:`bool` pause_mode_process=null **)** | +| :ref:`SceneTreeTimer` | :ref:`create_timer` **(** :ref:`float` time_sec, :ref:`bool` pause_mode_process=true **)** | +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Node` | :ref:`get_current_scene` **(** **)** const | +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -95,7 +95,7 @@ Member Functions +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_refuse_new_network_connections` **(** :ref:`bool` refuse **)** | +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_screen_stretch` **(** :ref:`int` mode, :ref:`int` aspect, :ref:`Vector2` minsize, :ref:`int` shrink=null **)** | +| void | :ref:`set_screen_stretch` **(** :ref:`int` mode, :ref:`int` aspect, :ref:`Vector2` minsize, :ref:`int` shrink=1 **)** | +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals @@ -150,7 +150,7 @@ Member Function Description .. _class_SceneTree_create_timer: -- :ref:`SceneTreeTimer` **create_timer** **(** :ref:`float` time_sec, :ref:`bool` pause_mode_process=null **)** +- :ref:`SceneTreeTimer` **create_timer** **(** :ref:`float` time_sec, :ref:`bool` pause_mode_process=true **)** .. _class_SceneTree_get_current_scene: @@ -292,6 +292,6 @@ Set the peer object to handle the RPC system (effectively enabling networking). .. _class_SceneTree_set_screen_stretch: -- void **set_screen_stretch** **(** :ref:`int` mode, :ref:`int` aspect, :ref:`Vector2` minsize, :ref:`int` shrink=null **)** +- void **set_screen_stretch** **(** :ref:`int` mode, :ref:`int` aspect, :ref:`Vector2` minsize, :ref:`int` shrink=1 **)** diff --git a/classes/class_spatialmaterial.rst b/classes/class_spatialmaterial.rst index 3fe94484e..8e07af4fb 100644 --- a/classes/class_spatialmaterial.rst +++ b/classes/class_spatialmaterial.rst @@ -97,6 +97,8 @@ Member Functions +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Texture` | :ref:`get_texture` **(** :ref:`int` param **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_transmission` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_uv1_offset` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_uv1_scale` **(** **)** const | @@ -195,6 +197,8 @@ Member Functions +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_texture` **(** :ref:`int` param, :ref:`Texture` texture **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_transmission` **(** :ref:`Color` transmission **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_uv1_offset` **(** :ref:`Vector3` offset **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_uv1_scale` **(** :ref:`Vector3` scale **)** | @@ -246,6 +250,7 @@ Member Variables - :ref:`bool` **flags_unshaded** - :ref:`bool` **flags_use_point_size** - :ref:`bool` **flags_vertex_lighting** +- :ref:`bool` **flags_world_triplanar** - :ref:`float` **metallic** - :ref:`float` **metallic_specular** - :ref:`Texture` **metallic_texture** @@ -282,6 +287,9 @@ Member Variables - :ref:`bool` **subsurf_scatter_enabled** - :ref:`float` **subsurf_scatter_strength** - :ref:`Texture` **subsurf_scatter_texture** +- :ref:`Color` **transmission** +- :ref:`bool` **transmission_enabled** +- :ref:`Texture` **transmission_texture** - :ref:`Vector3` **uv1_offset** - :ref:`Vector3` **uv1_scale** - :ref:`bool` **uv1_triplanar** @@ -307,11 +315,12 @@ Numeric Constants - **TEXTURE_AMBIENT_OCCLUSION** = **8** - **TEXTURE_DEPTH** = **9** - **TEXTURE_SUBSURFACE_SCATTERING** = **10** -- **TEXTURE_REFRACTION** = **11** -- **TEXTURE_DETAIL_MASK** = **12** -- **TEXTURE_DETAIL_ALBEDO** = **13** -- **TEXTURE_DETAIL_NORMAL** = **14** -- **TEXTURE_MAX** = **15** +- **TEXTURE_TRANSMISSION** = **11** +- **TEXTURE_REFRACTION** = **12** +- **TEXTURE_DETAIL_MASK** = **13** +- **TEXTURE_DETAIL_ALBEDO** = **14** +- **TEXTURE_DETAIL_NORMAL** = **15** +- **TEXTURE_MAX** = **16** - **DETAIL_UV_1** = **0** - **DETAIL_UV_2** = **1** - **FEATURE_TRANSPARENT** = **0** @@ -323,9 +332,10 @@ Numeric Constants - **FEATURE_AMBIENT_OCCLUSION** = **6** - **FEATURE_DEPTH_MAPPING** = **7** - **FEATURE_SUBSURACE_SCATTERING** = **8** -- **FEATURE_REFRACTION** = **9** -- **FEATURE_DETAIL** = **10** -- **FEATURE_MAX** = **11** +- **FEATURE_TRANSMISSION** = **9** +- **FEATURE_REFRACTION** = **10** +- **FEATURE_DETAIL** = **11** +- **FEATURE_MAX** = **12** - **BLEND_MODE_MIX** = **0** - **BLEND_MODE_ADD** = **1** - **BLEND_MODE_SUB** = **2** @@ -346,11 +356,12 @@ Numeric Constants - **FLAG_FIXED_SIZE** = **6** - **FLAG_UV1_USE_TRIPLANAR** = **7** - **FLAG_UV2_USE_TRIPLANAR** = **8** -- **FLAG_AO_ON_UV2** = **9** -- **FLAG_USE_ALPHA_SCISSOR** = **10** -- **FLAG_MAX** = **11** +- **FLAG_AO_ON_UV2** = **10** +- **FLAG_USE_ALPHA_SCISSOR** = **11** +- **FLAG_TRIPLANAR_USE_WORLD** = **9** +- **FLAG_MAX** = **12** - **DIFFUSE_LAMBERT** = **0** -- **DIFFUSE_HALF_LAMBERT** = **1** +- **DIFFUSE_LAMBERT_WRAP** = **1** - **DIFFUSE_OREN_NAYAR** = **2** - **DIFFUSE_BURLEY** = **3** - **DIFFUSE_TOON** = **4** @@ -528,6 +539,10 @@ Member Function Description - :ref:`Texture` **get_texture** **(** :ref:`int` param **)** const +.. _class_SpatialMaterial_get_transmission: + +- :ref:`Color` **get_transmission** **(** **)** const + .. _class_SpatialMaterial_get_uv1_offset: - :ref:`Vector3` **get_uv1_offset** **(** **)** const @@ -724,6 +739,10 @@ Member Function Description - void **set_texture** **(** :ref:`int` param, :ref:`Texture` texture **)** +.. _class_SpatialMaterial_set_transmission: + +- void **set_transmission** **(** :ref:`Color` transmission **)** + .. _class_SpatialMaterial_set_uv1_offset: - void **set_uv1_offset** **(** :ref:`Vector3` offset **)** diff --git a/classes/class_spriteframes.rst b/classes/class_spriteframes.rst index 7d5ee5cde..a36863149 100644 --- a/classes/class_spriteframes.rst +++ b/classes/class_spriteframes.rst @@ -18,37 +18,37 @@ Sprite frame library for AnimatedSprite. Member Functions ---------------- -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_animation` **(** :ref:`String` anim **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_frame` **(** :ref:`String` anim, :ref:`Texture` frame, :ref:`int` atpos=null **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** :ref:`String` anim **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_all` **(** **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_animation_loop` **(** :ref:`String` anim **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_animation_speed` **(** :ref:`String` anim **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_frame` **(** :ref:`String` anim, :ref:`int` idx **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_frame_count` **(** :ref:`String` anim **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_animation` **(** :ref:`String` anim **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_animation` **(** :ref:`String` anim **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_frame` **(** :ref:`String` anim, :ref:`int` idx **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rename_animation` **(** :ref:`String` anim, :ref:`String` newname **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_animation_loop` **(** :ref:`String` anim, :ref:`bool` loop **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_animation_speed` **(** :ref:`String` anim, :ref:`float` speed **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_frame` **(** :ref:`String` anim, :ref:`int` idx, :ref:`Texture` txt **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_animation` **(** :ref:`String` anim **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_frame` **(** :ref:`String` anim, :ref:`Texture` frame, :ref:`int` atpos=-1 **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** :ref:`String` anim **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_all` **(** **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_animation_loop` **(** :ref:`String` anim **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_animation_speed` **(** :ref:`String` anim **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_frame` **(** :ref:`String` anim, :ref:`int` idx **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_frame_count` **(** :ref:`String` anim **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_animation` **(** :ref:`String` anim **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_animation` **(** :ref:`String` anim **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_frame` **(** :ref:`String` anim, :ref:`int` idx **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rename_animation` **(** :ref:`String` anim, :ref:`String` newname **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_animation_loop` **(** :ref:`String` anim, :ref:`bool` loop **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_animation_speed` **(** :ref:`String` anim, :ref:`float` speed **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_frame` **(** :ref:`String` anim, :ref:`int` idx, :ref:`Texture` txt **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -70,7 +70,7 @@ Member Function Description .. _class_SpriteFrames_add_frame: -- void **add_frame** **(** :ref:`String` anim, :ref:`Texture` frame, :ref:`int` atpos=null **)** +- void **add_frame** **(** :ref:`String` anim, :ref:`Texture` frame, :ref:`int` atpos=-1 **)** .. _class_SpriteFrames_clear: diff --git a/classes/class_streampeerssl.rst b/classes/class_streampeerssl.rst index bf7f1e2c4..0661db1a6 100644 --- a/classes/class_streampeerssl.rst +++ b/classes/class_streampeerssl.rst @@ -18,15 +18,15 @@ SSL Stream peer. Member Functions ---------------- -+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`accept_stream` **(** :ref:`StreamPeer` stream **)** | -+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`connect_to_stream` **(** :ref:`StreamPeer` stream, :ref:`bool` validate_certs=false, :ref:`String` for_hostname=null **)** | -+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`disconnect_from_stream` **(** **)** | -+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_status` **(** **)** const | -+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`accept_stream` **(** :ref:`StreamPeer` stream **)** | ++------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`connect_to_stream` **(** :ref:`StreamPeer` stream, :ref:`bool` validate_certs=false, :ref:`String` for_hostname="" **)** | ++------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`disconnect_from_stream` **(** **)** | ++------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_status` **(** **)** const | ++------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -50,7 +50,7 @@ Member Function Description .. _class_StreamPeerSSL_connect_to_stream: -- :ref:`int` **connect_to_stream** **(** :ref:`StreamPeer` stream, :ref:`bool` validate_certs=false, :ref:`String` for_hostname=null **)** +- :ref:`int` **connect_to_stream** **(** :ref:`StreamPeer` stream, :ref:`bool` validate_certs=false, :ref:`String` for_hostname="" **)** Connect to a peer using an underlying :ref:`StreamPeer` "stream", when "validate_certs" is true, :ref:`StreamPeerSSL` will validate that the certificate presented by the peer matches the "for_hostname". diff --git a/classes/class_styleboxflat.rst b/classes/class_styleboxflat.rst index c84cb6cd4..1ca6739c1 100644 --- a/classes/class_styleboxflat.rst +++ b/classes/class_styleboxflat.rst @@ -13,7 +13,7 @@ StyleBoxFlat Brief Description ----------------- -Stylebox of a single color. +Customizable Stylebox with a given set of parameters. (no texture required) Member Functions ---------------- @@ -83,32 +83,59 @@ Member Functions Member Variables ---------------- -- :ref:`bool` **anti_aliasing** -- :ref:`int` **anti_aliasing_size** -- :ref:`Color` **bg_color** -- :ref:`bool` **border_blend** -- :ref:`Color` **border_color** -- :ref:`int` **border_width_bottom** -- :ref:`int` **border_width_left** -- :ref:`int` **border_width_right** -- :ref:`int` **border_width_top** -- :ref:`int` **corner_detail** -- :ref:`int` **corner_radius_bottom_left** -- :ref:`int` **corner_radius_bottom_right** -- :ref:`int` **corner_radius_top_left** -- :ref:`int` **corner_radius_top_right** -- :ref:`bool` **draw_center** -- :ref:`float` **expand_margin_bottom** -- :ref:`float` **expand_margin_left** -- :ref:`float` **expand_margin_right** -- :ref:`float` **expand_margin_top** -- :ref:`Color` **shadow_color** -- :ref:`int` **shadow_size** +- :ref:`bool` **anti_aliasing** - Anti Aliasing draws a small ring around edges. This ring fades to transparent. As a result edges look much smoother. This is only noticable when using rounded corners. +- :ref:`int` **anti_aliasing_size** - This changes the size of the faded ring. Higher values can be used to achieve a "blurry" effect. +- :ref:`Color` **bg_color** - The background color of the stylebox. +- :ref:`bool` **border_blend** - When set to true, the border will fade into the background color. +- :ref:`Color` **border_color** - Sets the color of the border. +- :ref:`int` **border_width_bottom** - Border width for the bottom border. +- :ref:`int` **border_width_left** - Border width for the left border. +- :ref:`int` **border_width_right** - Border width for the right border. +- :ref:`int` **border_width_top** - Border width for the top border. +- :ref:`int` **corner_detail** - This sets the amount of vertices used for each corner. Higher values result in rounder corners but take more processing power to compute. When choosing a value you should take the corner radius ([method set_corner_radius]) into account. + For corner radius smaller than 10: 4-5 should be enough + For corner radius smaller than 30: 8-12 should be enough ... +- :ref:`int` **corner_radius_bottom_left** - The corner radius of the bottom left corner. When set to 0 the corner is not rounded. +- :ref:`int` **corner_radius_bottom_right** - The corner radius of the bottom right corner. When set to 0 the corner is not rounded. +- :ref:`int` **corner_radius_top_left** - The corner radius of the top left corner. When set to 0 the corner is not rounded. +- :ref:`int` **corner_radius_top_right** - The corner radius of the top right corner. When set to 0 the corner is not rounded. +- :ref:`bool` **draw_center** - Toggels drawing of the inner part of the stylebox. +- :ref:`float` **expand_margin_bottom** - Expands the stylebox outside of the control rect on the bottom edge. Useful in combination with border_width_bottom. To draw a border outside the control rect. +- :ref:`float` **expand_margin_left** - Expands the stylebox outside of the control rect on the left edge. Useful in combination with border_width_left. To draw a border outside the control rect. +- :ref:`float` **expand_margin_right** - Expands the stylebox outside of the control rect on the right edge. Useful in combination with border_width_right. To draw a border outside the control rect. +- :ref:`float` **expand_margin_top** - Expands the stylebox outside of the control rect on the top edge. Useful in combination with border_width_top. To draw a border outside the control rect. +- :ref:`Color` **shadow_color** - The color of the shadow. (This has no effect when shadow_size < 1) +- :ref:`int` **shadow_size** - The shadow size in pixels. Description ----------- -Stylebox of a single color. Displays the stylebox of a single color, alternatively a border with light/dark colors can be assigned. +This stylebox can be used to achieve all kinds of looks without the need of a texture. Those properties are customizable: + + - Color + + - Border width (individual width for each border) + + - Rounded corners (individual radius for each corner) + + - Shadow + + About corner radius: + + Setting corner radius to high values is allowed. As soon as corners would overlap the stylebox will switch to a relative system. Example: + +:: + + height = 30 + corner_radius_top_left = 50 + corner_raidus_bottom_left = 100 + +The relative system now would take the 1:2 ratio of the two left corners to calculate the actual corner width. Both corners added will **never** be more than the height. Result: + +:: + + corner_radius_top_left: 10 + corner_raidus_bottom_left: 20 Member Function Description --------------------------- diff --git a/classes/class_surfacetool.rst b/classes/class_surfacetool.rst index a584a7af1..b4110a087 100644 --- a/classes/class_surfacetool.rst +++ b/classes/class_surfacetool.rst @@ -33,7 +33,7 @@ Member Functions +------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_to_format` **(** :ref:`int` flags **)** | +------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_triangle_fan` **(** :ref:`PoolVector3Array` vertexes, :ref:`PoolVector2Array` uvs=PoolVector3Array( ), :ref:`PoolColorArray` colors=PoolVector2Array( ), :ref:`PoolVector2Array` uv2s=PoolColorArray( ), :ref:`PoolVector3Array` normals=PoolVector2Array( ), :ref:`Array` tangents=null **)** | +| void | :ref:`add_triangle_fan` **(** :ref:`PoolVector3Array` vertexes, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`PoolColorArray` colors=PoolColorArray( ), :ref:`PoolVector2Array` uv2s=PoolVector2Array( ), :ref:`PoolVector3Array` normals=PoolVector3Array( ), :ref:`Array` tangents=[ ] **)** | +------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_uv` **(** :ref:`Vector2` uv **)** | +------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -126,7 +126,7 @@ Specify a Tangent for the next Vertex to use. .. _class_SurfaceTool_add_triangle_fan: -- void **add_triangle_fan** **(** :ref:`PoolVector3Array` vertexes, :ref:`PoolVector2Array` uvs=PoolVector3Array( ), :ref:`PoolColorArray` colors=PoolVector2Array( ), :ref:`PoolVector2Array` uv2s=PoolColorArray( ), :ref:`PoolVector3Array` normals=PoolVector2Array( ), :ref:`Array` tangents=null **)** +- void **add_triangle_fan** **(** :ref:`PoolVector3Array` vertexes, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`PoolColorArray` colors=PoolColorArray( ), :ref:`PoolVector2Array` uv2s=PoolVector2Array( ), :ref:`PoolVector3Array` normals=PoolVector3Array( ), :ref:`Array` tangents=[ ] **)** Insert a triangle fan made of array data into :ref:`Mesh` being constructed. diff --git a/classes/class_tabs.rst b/classes/class_tabs.rst index e6f6e2c58..a1ad94499 100644 --- a/classes/class_tabs.rst +++ b/classes/class_tabs.rst @@ -19,7 +19,7 @@ Member Functions ---------------- +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_tab` **(** :ref:`String` title=null, :ref:`Texture` icon="" **)** | +| void | :ref:`add_tab` **(** :ref:`String` title="", :ref:`Texture` icon=null **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`ensure_tab_visible` **(** :ref:`int` idx **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ @@ -94,7 +94,7 @@ Member Function Description .. _class_Tabs_add_tab: -- void **add_tab** **(** :ref:`String` title=null, :ref:`Texture` icon="" **)** +- void **add_tab** **(** :ref:`String` title="", :ref:`Texture` icon=null **)** .. _class_Tabs_ensure_tab_visible: diff --git a/classes/class_tcp_server.rst b/classes/class_tcp_server.rst index 6e160cad0..8ea4c2367 100644 --- a/classes/class_tcp_server.rst +++ b/classes/class_tcp_server.rst @@ -18,15 +18,15 @@ TCP Server. Member Functions ---------------- -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_connection_available` **(** **)** const | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`listen` **(** :ref:`int` port, :ref:`String` bind_address=null **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`stop` **(** **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`StreamPeerTCP` | :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:`StreamPeerTCP` | :ref:`take_connection` **(** **)** | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -44,7 +44,7 @@ Return true if a connection is available for taking. .. _class_TCP_Server_listen: -- :ref:`int` **listen** **(** :ref:`int` port, :ref:`String` bind_address=null **)** +- :ref:`int` **listen** **(** :ref:`int` port, :ref:`String` bind_address="*" **)** Listen on the "port" binding to "bind_address". diff --git a/classes/class_textedit.rst b/classes/class_textedit.rst index 17ad6fe4d..334f47cdd 100644 --- a/classes/class_textedit.rst +++ b/classes/class_textedit.rst @@ -18,105 +18,105 @@ Multiline text editing control. Member Functions ---------------- -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_color_region` **(** :ref:`String` begin_key, :ref:`String` end_key, :ref:`Color` color, :ref:`bool` line_only=null **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_keyword_color` **(** :ref:`String` keyword, :ref:`Color` color **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_colors` **(** **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_undo_history` **(** **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`copy` **(** **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`cursor_get_blink_enabled` **(** **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`cursor_get_blink_speed` **(** **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`cursor_get_column` **(** **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`cursor_get_line` **(** **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`cursor_is_block_mode` **(** **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`cursor_set_blink_enabled` **(** :ref:`bool` enable **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`cursor_set_blink_speed` **(** :ref:`float` blink_speed **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`cursor_set_block_mode` **(** :ref:`bool` enable **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`cursor_set_column` **(** :ref:`int` column, :ref:`bool` adjust_viewport=null **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`cursor_set_line` **(** :ref:`int` line, :ref:`bool` adjust_viewport=null **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`cut` **(** **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_line` **(** :ref:`int` line **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_line_count` **(** **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PopupMenu` | :ref:`get_menu` **(** **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_selection_from_column` **(** **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_selection_from_line` **(** **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_selection_text` **(** **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_selection_to_column` **(** **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_selection_to_line` **(** **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_text` **(** **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_v_scroll_speed` **(** **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_word_under_cursor` **(** **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`insert_text_at_cursor` **(** :ref:`String` text **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_highlight_all_occurrences_enabled` **(** **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_selection_active` **(** **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_show_line_numbers_enabled` **(** **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_smooth_scroll_enabled` **(** **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_syntax_coloring_enabled` **(** **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`menu_option` **(** :ref:`int` option **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`paste` **(** **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`redo` **(** **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`search` **(** :ref:`String` key, :ref:`int` flags, :ref:`int` from_line, :ref:`int` from_column **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`select` **(** :ref:`int` from_line, :ref:`int` from_column, :ref:`int` to_line, :ref:`int` to_column **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`select_all` **(** **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_highlight_all_occurrences` **(** :ref:`bool` enable **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_max_chars` **(** :ref:`int` amount **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_readonly` **(** :ref:`bool` enable **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_show_line_numbers` **(** :ref:`bool` enable **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_smooth_scroll_enable` **(** :ref:`bool` enable **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_syntax_coloring` **(** :ref:`bool` enable **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_text` **(** :ref:`String` text **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_v_scroll_speed` **(** :ref:`float` speed **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_wrap` **(** :ref:`bool` enable **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`undo` **(** **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_color_region` **(** :ref:`String` begin_key, :ref:`String` end_key, :ref:`Color` color, :ref:`bool` line_only=false **)** | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_keyword_color` **(** :ref:`String` keyword, :ref:`Color` color **)** | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_colors` **(** **)** | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_undo_history` **(** **)** | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`copy` **(** **)** | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`cursor_get_blink_enabled` **(** **)** const | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`cursor_get_blink_speed` **(** **)** const | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`cursor_get_column` **(** **)** const | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`cursor_get_line` **(** **)** const | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`cursor_is_block_mode` **(** **)** const | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`cursor_set_blink_enabled` **(** :ref:`bool` enable **)** | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`cursor_set_blink_speed` **(** :ref:`float` blink_speed **)** | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`cursor_set_block_mode` **(** :ref:`bool` enable **)** | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`cursor_set_column` **(** :ref:`int` column, :ref:`bool` adjust_viewport=true **)** | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`cursor_set_line` **(** :ref:`int` line, :ref:`bool` adjust_viewport=true **)** | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`cut` **(** **)** | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_line` **(** :ref:`int` line **)** const | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_line_count` **(** **)** const | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PopupMenu` | :ref:`get_menu` **(** **)** const | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_selection_from_column` **(** **)** const | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_selection_from_line` **(** **)** const | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_selection_text` **(** **)** const | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_selection_to_column` **(** **)** const | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_selection_to_line` **(** **)** const | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_text` **(** **)** | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_v_scroll_speed` **(** **)** const | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_word_under_cursor` **(** **)** const | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`insert_text_at_cursor` **(** :ref:`String` text **)** | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_highlight_all_occurrences_enabled` **(** **)** const | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_selection_active` **(** **)** const | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_show_line_numbers_enabled` **(** **)** const | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_smooth_scroll_enabled` **(** **)** const | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_syntax_coloring_enabled` **(** **)** const | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`menu_option` **(** :ref:`int` option **)** | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`paste` **(** **)** | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`redo` **(** **)** | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`search` **(** :ref:`String` key, :ref:`int` flags, :ref:`int` from_line, :ref:`int` from_column **)** const | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`select` **(** :ref:`int` from_line, :ref:`int` from_column, :ref:`int` to_line, :ref:`int` to_column **)** | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`select_all` **(** **)** | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_highlight_all_occurrences` **(** :ref:`bool` enable **)** | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_max_chars` **(** :ref:`int` amount **)** | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_readonly` **(** :ref:`bool` enable **)** | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_show_line_numbers` **(** :ref:`bool` enable **)** | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_smooth_scroll_enable` **(** :ref:`bool` enable **)** | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_syntax_coloring` **(** :ref:`bool` enable **)** | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_text` **(** :ref:`String` text **)** | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_v_scroll_speed` **(** :ref:`float` speed **)** | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_wrap` **(** :ref:`bool` enable **)** | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`undo` **(** **)** | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -169,7 +169,7 @@ Member Function Description .. _class_TextEdit_add_color_region: -- void **add_color_region** **(** :ref:`String` begin_key, :ref:`String` end_key, :ref:`Color` color, :ref:`bool` line_only=null **)** +- void **add_color_region** **(** :ref:`String` begin_key, :ref:`String` end_key, :ref:`Color` color, :ref:`bool` line_only=false **)** Add color region (given the delimiters) and its colors. @@ -247,11 +247,11 @@ Set the text editor caret to block mode. .. _class_TextEdit_cursor_set_column: -- void **cursor_set_column** **(** :ref:`int` column, :ref:`bool` adjust_viewport=null **)** +- void **cursor_set_column** **(** :ref:`int` column, :ref:`bool` adjust_viewport=true **)** .. _class_TextEdit_cursor_set_line: -- void **cursor_set_line** **(** :ref:`int` line, :ref:`bool` adjust_viewport=null **)** +- void **cursor_set_line** **(** :ref:`int` line, :ref:`bool` adjust_viewport=true **)** .. _class_TextEdit_cut: diff --git a/classes/class_texture.rst b/classes/class_texture.rst index b61f7da3e..3db05ca21 100644 --- a/classes/class_texture.rst +++ b/classes/class_texture.rst @@ -20,27 +20,27 @@ Texture for 2D and 3D. Member Functions ---------------- -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw` **(** :ref:`RID` canvas_item, :ref:`Vector2` pos, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=null, :ref:`Texture` normal_map=null **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_rect` **(** :ref:`RID` canvas_item, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate=null, :ref:`bool` transpose=null, :ref:`Texture` normal_map=null **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_rect_region` **(** :ref:`RID` canvas_item, :ref:`Rect2` rect, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=null, :ref:`Texture` normal_map=null, :ref:`bool` clip_uv=null **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Image` | :ref:`get_data` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_flags` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_height` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_size` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_width` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_alpha` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_flags` **(** :ref:`int` flags **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw` **(** :ref:`RID` canvas_item, :ref:`Vector2` pos, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_rect` **(** :ref:`RID` canvas_item, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_rect_region` **(** :ref:`RID` canvas_item, :ref:`Rect2` rect, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null, :ref:`bool` clip_uv=true **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Image` | :ref:`get_data` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_flags` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_height` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_size` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_width` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_alpha` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_flags` **(** :ref:`int` flags **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -64,15 +64,15 @@ Member Function Description .. _class_Texture_draw: -- void **draw** **(** :ref:`RID` canvas_item, :ref:`Vector2` pos, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=null, :ref:`Texture` normal_map=null **)** const +- void **draw** **(** :ref:`RID` canvas_item, :ref:`Vector2` pos, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null **)** const .. _class_Texture_draw_rect: -- void **draw_rect** **(** :ref:`RID` canvas_item, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate=null, :ref:`bool` transpose=null, :ref:`Texture` normal_map=null **)** const +- void **draw_rect** **(** :ref:`RID` canvas_item, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null **)** const .. _class_Texture_draw_rect_region: -- void **draw_rect_region** **(** :ref:`RID` canvas_item, :ref:`Rect2` rect, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=null, :ref:`Texture` normal_map=null, :ref:`bool` clip_uv=null **)** const +- void **draw_rect_region** **(** :ref:`RID` canvas_item, :ref:`Rect2` rect, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null, :ref:`bool` clip_uv=true **)** const .. _class_Texture_get_data: diff --git a/classes/class_thread.rst b/classes/class_thread.rst index d1a5538b2..f13cd3dd3 100644 --- a/classes/class_thread.rst +++ b/classes/class_thread.rst @@ -18,15 +18,15 @@ A unit of execution in a process. Member Functions ---------------- -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_id` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_active` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`start` **(** :ref:`Object` instance, :ref:`String` method, :ref:`Variant` userdata=null, :ref:`int` priority=null **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`wait_to_finish` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_id` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_active` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`start` **(** :ref:`Object` instance, :ref:`String` method, :ref:`Variant` userdata=null, :ref:`int` priority=1 **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`wait_to_finish` **(** **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -57,7 +57,7 @@ Whether this thread is currently active, an active Thread cannot start work on a .. _class_Thread_start: -- :ref:`int` **start** **(** :ref:`Object` instance, :ref:`String` method, :ref:`Variant` userdata=null, :ref:`int` priority=null **)** +- :ref:`int` **start** **(** :ref:`Object` instance, :ref:`String` method, :ref:`Variant` userdata=null, :ref:`int` priority=1 **)** Start a new :ref:`Thread`, it will run "method" on object "instance" using "userdata" as an argument and running with "priority", one of PRIORITY\_\* enum. diff --git a/classes/class_tilemap.rst b/classes/class_tilemap.rst index 4f12997f3..698d7d8b5 100644 --- a/classes/class_tilemap.rst +++ b/classes/class_tilemap.rst @@ -18,105 +18,105 @@ Node for 2D tile-based games. Member Functions ---------------- -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_cell` **(** :ref:`int` x, :ref:`int` y **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_cell_size` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_cellv` **(** :ref:`Vector2` pos **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_center_x` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_center_y` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_collision_bounce` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_collision_friction` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_layer` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_mask` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_use_kinematic` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_custom_transform` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_half_offset` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_mode` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_occluder_light_mask` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_quadrant_size` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_tile_origin` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TileSet` | :ref:`get_tileset` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_used_cells` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_used_cells_by_id` **(** :ref:`int` id **)** 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 | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_cell_y_flipped` **(** :ref:`int` x, :ref:`int` y **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_y_sort_mode_enabled` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`map_to_world` **(** :ref:`Vector2` mappos, :ref:`bool` ignore_half_ofs=null **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cell` **(** :ref:`int` x, :ref:`int` y, :ref:`int` tile, :ref:`bool` flip_x=null, :ref:`bool` flip_y=null, :ref:`bool` transpose=null **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cell_size` **(** :ref:`Vector2` size **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cellv` **(** :ref:`Vector2` pos, :ref:`int` tile, :ref:`bool` flip_x=false, :ref:`bool` flip_y=null, :ref:`bool` transpose=null **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_center_x` **(** :ref:`bool` enable **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_center_y` **(** :ref:`bool` enable **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_bounce` **(** :ref:`float` value **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_friction` **(** :ref:`float` value **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_layer` **(** :ref:`int` layer **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_mask` **(** :ref:`int` mask **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_use_kinematic` **(** :ref:`bool` use_kinematic **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_transform` **(** :ref:`Transform2D` custom_transform **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_half_offset` **(** :ref:`int` half_offset **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_mode` **(** :ref:`int` mode **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_occluder_light_mask` **(** :ref:`int` mask **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_quadrant_size` **(** :ref:`int` size **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tile_origin` **(** :ref:`int` origin **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tileset` **(** :ref:`TileSet` tileset **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_y_sort_mode` **(** :ref:`bool` enable **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`world_to_map` **(** :ref:`Vector2` worldpos **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_cell` **(** :ref:`int` x, :ref:`int` y **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_cell_size` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_cellv` **(** :ref:`Vector2` pos **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_center_x` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_center_y` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_collision_bounce` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_collision_friction` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collision_layer` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collision_mask` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_collision_use_kinematic` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_custom_transform` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_half_offset` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_mode` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_occluder_light_mask` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_quadrant_size` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_tile_origin` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TileSet` | :ref:`get_tileset` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_used_cells` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_used_cells_by_id` **(** :ref:`int` id **)** 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 | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_cell_y_flipped` **(** :ref:`int` x, :ref:`int` y **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_y_sort_mode_enabled` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`map_to_world` **(** :ref:`Vector2` mappos, :ref:`bool` ignore_half_ofs=false **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_cell` **(** :ref:`int` x, :ref:`int` y, :ref:`int` tile, :ref:`bool` flip_x=false, :ref:`bool` flip_y=false, :ref:`bool` transpose=false **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_cell_size` **(** :ref:`Vector2` size **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_cellv` **(** :ref:`Vector2` pos, :ref:`int` tile, :ref:`bool` flip_x=false, :ref:`bool` flip_y=false, :ref:`bool` transpose=false **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_center_x` **(** :ref:`bool` enable **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_center_y` **(** :ref:`bool` enable **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_bounce` **(** :ref:`float` value **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_friction` **(** :ref:`float` value **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_layer` **(** :ref:`int` layer **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_mask` **(** :ref:`int` mask **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_use_kinematic` **(** :ref:`bool` use_kinematic **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_custom_transform` **(** :ref:`Transform2D` custom_transform **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_half_offset` **(** :ref:`int` half_offset **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_mode` **(** :ref:`int` mode **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_occluder_light_mask` **(** :ref:`int` mask **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_quadrant_size` **(** :ref:`int` size **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tile_origin` **(** :ref:`int` origin **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tileset` **(** :ref:`TileSet` tileset **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_y_sort_mode` **(** :ref:`bool` enable **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`world_to_map` **(** :ref:`Vector2` worldpos **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -322,7 +322,7 @@ Return the Y sort mode. .. _class_TileMap_map_to_world: -- :ref:`Vector2` **map_to_world** **(** :ref:`Vector2` mappos, :ref:`bool` ignore_half_ofs=null **)** const +- :ref:`Vector2` **map_to_world** **(** :ref:`Vector2` mappos, :ref:`bool` ignore_half_ofs=false **)** const Return the absolute world position corresponding to the tilemap (grid-based) coordinates given as an argument. @@ -330,7 +330,7 @@ Optionally, the tilemap's potential half offset can be ignored. .. _class_TileMap_set_cell: -- void **set_cell** **(** :ref:`int` x, :ref:`int` y, :ref:`int` tile, :ref:`bool` flip_x=null, :ref:`bool` flip_y=null, :ref:`bool` transpose=null **)** +- void **set_cell** **(** :ref:`int` x, :ref:`int` y, :ref:`int` tile, :ref:`bool` flip_x=false, :ref:`bool` flip_y=false, :ref:`bool` transpose=false **)** Set the tile index for the cell referenced by its grid-based X and Y coordinates. @@ -346,7 +346,7 @@ Set the cell size. .. _class_TileMap_set_cellv: -- void **set_cellv** **(** :ref:`Vector2` pos, :ref:`int` tile, :ref:`bool` flip_x=false, :ref:`bool` flip_y=null, :ref:`bool` transpose=null **)** +- void **set_cellv** **(** :ref:`Vector2` pos, :ref:`int` tile, :ref:`bool` flip_x=false, :ref:`bool` flip_y=false, :ref:`bool` transpose=false **)** Set the tile index for the cell referenced by a Vector2 of grid-based coordinates. diff --git a/classes/class_tileset.rst b/classes/class_tileset.rst index 0deb3ce93..af4e12516 100644 --- a/classes/class_tileset.rst +++ b/classes/class_tileset.rst @@ -18,79 +18,79 @@ Tile library for tilemaps. Member Functions ---------------- -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create_tile` **(** :ref:`int` id **)** | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find_tile_by_name` **(** :ref:`String` name **)** const | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_last_unused_tile_id` **(** **)** const | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_tiles_ids` **(** **)** const | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_tile` **(** :ref:`int` id **)** | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_add_shape` **(** :ref:`int` id, :ref:`Shape2D` shape, :ref:`Transform2D` shape_transform, :ref:`bool` one_way=null **)** | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`OccluderPolygon2D` | :ref:`tile_get_light_occluder` **(** :ref:`int` id **)** const | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ShaderMaterial` | :ref:`tile_get_material` **(** :ref:`int` id **)** const | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`tile_get_name` **(** :ref:`int` id **)** const | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NavigationPolygon` | :ref:`tile_get_navigation_polygon` **(** :ref:`int` id **)** const | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`tile_get_navigation_polygon_offset` **(** :ref:`int` id **)** const | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`tile_get_normal_map` **(** :ref:`int` id **)** const | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`tile_get_occluder_offset` **(** :ref:`int` id **)** const | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`tile_get_region` **(** :ref:`int` id **)** const | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Shape2D` | :ref:`tile_get_shape` **(** :ref:`int` id, :ref:`int` shape_id **)** const | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`tile_get_shape_count` **(** :ref:`int` id **)** const | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`tile_get_shape_one_way` **(** :ref:`int` id, :ref:`int` shape_id **)** const | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`tile_get_shape_transform` **(** :ref:`int` id, :ref:`int` shape_id **)** const | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`tile_get_shapes` **(** :ref:`int` id **)** const | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`tile_get_texture` **(** :ref:`int` id **)** const | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`tile_get_texture_offset` **(** :ref:`int` id **)** const | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_light_occluder` **(** :ref:`int` id, :ref:`OccluderPolygon2D` light_occluder **)** | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_material` **(** :ref:`int` id, :ref:`ShaderMaterial` material **)** | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_name` **(** :ref:`int` id, :ref:`String` name **)** | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_navigation_polygon` **(** :ref:`int` id, :ref:`NavigationPolygon` navigation_polygon **)** | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_navigation_polygon_offset` **(** :ref:`int` id, :ref:`Vector2` navigation_polygon_offset **)** | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_normal_map` **(** :ref:`int` id, :ref:`Texture` normal_map **)** | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_occluder_offset` **(** :ref:`int` id, :ref:`Vector2` occluder_offset **)** | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_region` **(** :ref:`int` id, :ref:`Rect2` region **)** | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_shape` **(** :ref:`int` id, :ref:`int` shape_id, :ref:`Shape2D` shape **)** | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_shape_one_way` **(** :ref:`int` id, :ref:`int` shape_id, :ref:`bool` one_way **)** | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_shape_transform` **(** :ref:`int` id, :ref:`int` shape_id, :ref:`Transform2D` shape_transform **)** | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_shapes` **(** :ref:`int` id, :ref:`Array` shapes **)** | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_texture` **(** :ref:`int` id, :ref:`Texture` texture **)** | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_texture_offset` **(** :ref:`int` id, :ref:`Vector2` texture_offset **)** | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`create_tile` **(** :ref:`int` id **)** | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`find_tile_by_name` **(** :ref:`String` name **)** const | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_last_unused_tile_id` **(** **)** const | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_tiles_ids` **(** **)** const | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_tile` **(** :ref:`int` id **)** | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_add_shape` **(** :ref:`int` id, :ref:`Shape2D` shape, :ref:`Transform2D` shape_transform, :ref:`bool` one_way=false **)** | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`OccluderPolygon2D` | :ref:`tile_get_light_occluder` **(** :ref:`int` id **)** const | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ShaderMaterial` | :ref:`tile_get_material` **(** :ref:`int` id **)** const | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`tile_get_name` **(** :ref:`int` id **)** const | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NavigationPolygon` | :ref:`tile_get_navigation_polygon` **(** :ref:`int` id **)** const | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`tile_get_navigation_polygon_offset` **(** :ref:`int` id **)** const | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`tile_get_normal_map` **(** :ref:`int` id **)** const | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`tile_get_occluder_offset` **(** :ref:`int` id **)** const | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`tile_get_region` **(** :ref:`int` id **)** const | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Shape2D` | :ref:`tile_get_shape` **(** :ref:`int` id, :ref:`int` shape_id **)** const | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`tile_get_shape_count` **(** :ref:`int` id **)** const | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`tile_get_shape_one_way` **(** :ref:`int` id, :ref:`int` shape_id **)** const | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`tile_get_shape_transform` **(** :ref:`int` id, :ref:`int` shape_id **)** const | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`tile_get_shapes` **(** :ref:`int` id **)** const | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`tile_get_texture` **(** :ref:`int` id **)** const | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`tile_get_texture_offset` **(** :ref:`int` id **)** const | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_light_occluder` **(** :ref:`int` id, :ref:`OccluderPolygon2D` light_occluder **)** | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_material` **(** :ref:`int` id, :ref:`ShaderMaterial` material **)** | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_name` **(** :ref:`int` id, :ref:`String` name **)** | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_navigation_polygon` **(** :ref:`int` id, :ref:`NavigationPolygon` navigation_polygon **)** | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_navigation_polygon_offset` **(** :ref:`int` id, :ref:`Vector2` navigation_polygon_offset **)** | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_normal_map` **(** :ref:`int` id, :ref:`Texture` normal_map **)** | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_occluder_offset` **(** :ref:`int` id, :ref:`Vector2` occluder_offset **)** | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_region` **(** :ref:`int` id, :ref:`Rect2` region **)** | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_shape` **(** :ref:`int` id, :ref:`int` shape_id, :ref:`Shape2D` shape **)** | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_shape_one_way` **(** :ref:`int` id, :ref:`int` shape_id, :ref:`bool` one_way **)** | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_shape_transform` **(** :ref:`int` id, :ref:`int` shape_id, :ref:`Transform2D` shape_transform **)** | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_shapes` **(** :ref:`int` id, :ref:`Array` shapes **)** | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_texture` **(** :ref:`int` id, :ref:`Texture` texture **)** | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_texture_offset` **(** :ref:`int` id, :ref:`Vector2` texture_offset **)** | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -140,7 +140,7 @@ Remove the tile referenced by the given ID. .. _class_TileSet_tile_add_shape: -- void **tile_add_shape** **(** :ref:`int` id, :ref:`Shape2D` shape, :ref:`Transform2D` shape_transform, :ref:`bool` one_way=null **)** +- void **tile_add_shape** **(** :ref:`int` id, :ref:`Shape2D` shape, :ref:`Transform2D` shape_transform, :ref:`bool` one_way=false **)** .. _class_TileSet_tile_get_light_occluder: diff --git a/classes/class_tree.rst b/classes/class_tree.rst index 4d9fc8978..77d05efb4 100644 --- a/classes/class_tree.rst +++ b/classes/class_tree.rst @@ -18,75 +18,75 @@ Control to show a tree of items. Member Functions ---------------- -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`are_column_titles_visible` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`create_item` **(** :ref:`Object` parent=null **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`ensure_cursor_is_visible` **(** **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_allow_reselect` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_allow_rmb_select` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_column_at_pos` **(** :ref:`Vector2` pos **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_column_title` **(** :ref:`int` column **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_column_width` **(** :ref:`int` column **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_columns` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_custom_popup_rect` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_drop_mode_flags` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_edited` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_edited_column` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_item_area_rect` **(** :ref:`Object` item, :ref:`int` column=null **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_item_at_pos` **(** :ref:`Vector2` pos **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_next_selected` **(** :ref:`Object` from **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_pressed_button` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_root` **(** **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_scroll` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_selected` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_selected_column` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_folding_hidden` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_allow_reselect` **(** :ref:`bool` allow **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_allow_rmb_select` **(** :ref:`bool` allow **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_column_expand` **(** :ref:`int` column, :ref:`bool` expand **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_column_min_width` **(** :ref:`int` column, :ref:`int` min_width **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_column_title` **(** :ref:`int` column, :ref:`String` title **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_column_titles_visible` **(** :ref:`bool` visible **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_columns` **(** :ref:`int` amount **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_drop_mode_flags` **(** :ref:`int` flags **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_hide_folding` **(** :ref:`bool` hide **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_hide_root` **(** :ref:`bool` enable **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_select_mode` **(** :ref:`int` mode **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`are_column_titles_visible` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`create_item` **(** :ref:`Object` parent=null **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`ensure_cursor_is_visible` **(** **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_allow_reselect` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_allow_rmb_select` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_column_at_pos` **(** :ref:`Vector2` pos **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_column_title` **(** :ref:`int` column **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_column_width` **(** :ref:`int` column **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_columns` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_custom_popup_rect` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_drop_mode_flags` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeItem` | :ref:`get_edited` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_edited_column` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_item_area_rect` **(** :ref:`Object` item, :ref:`int` column=-1 **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeItem` | :ref:`get_item_at_pos` **(** :ref:`Vector2` pos **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeItem` | :ref:`get_next_selected` **(** :ref:`Object` from **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_pressed_button` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeItem` | :ref:`get_root` **(** **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_scroll` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeItem` | :ref:`get_selected` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_selected_column` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_folding_hidden` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_allow_reselect` **(** :ref:`bool` allow **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_allow_rmb_select` **(** :ref:`bool` allow **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_column_expand` **(** :ref:`int` column, :ref:`bool` expand **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_column_min_width` **(** :ref:`int` column, :ref:`int` min_width **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_column_title` **(** :ref:`int` column, :ref:`String` title **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_column_titles_visible` **(** :ref:`bool` visible **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_columns` **(** :ref:`int` amount **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_drop_mode_flags` **(** :ref:`int` flags **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_hide_folding` **(** :ref:`bool` hide **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_hide_root` **(** :ref:`bool` enable **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_select_mode` **(** :ref:`int` mode **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -239,7 +239,7 @@ Get the column of the cell for the current edited icon. This is only available f .. _class_Tree_get_item_area_rect: -- :ref:`Rect2` **get_item_area_rect** **(** :ref:`Object` item, :ref:`int` column=null **)** const +- :ref:`Rect2` **get_item_area_rect** **(** :ref:`Object` item, :ref:`int` column=-1 **)** const Get the rectangle area of the the specified item. If column is specified, only get the position and size of that column, otherwise get the rectangle containing all columns. diff --git a/classes/class_treeitem.rst b/classes/class_treeitem.rst index 134b9194d..7ac8bc6fb 100644 --- a/classes/class_treeitem.rst +++ b/classes/class_treeitem.rst @@ -18,123 +18,123 @@ Brief Description Member Functions ---------------- -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_button` **(** :ref:`int` column, :ref:`Texture` button, :ref:`int` button_idx=-1, :ref:`bool` disabled=null, :ref:`String` tooltip=null **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_custom_bg_color` **(** :ref:`int` column **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_custom_color` **(** :ref:`int` column **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`deselect` **(** :ref:`int` column **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`erase_button` **(** :ref:`int` column, :ref:`int` button_idx **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_button` **(** :ref:`int` column, :ref:`int` button_idx **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_button_count` **(** :ref:`int` column **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_cell_mode` **(** :ref:`int` column **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_children` **(** **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_custom_bg_color` **(** :ref:`int` column **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_expand_right` **(** :ref:`int` column **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_icon` **(** :ref:`int` column **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_icon_max_width` **(** :ref:`int` column **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_icon_region` **(** :ref:`int` column **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_metadata` **(** :ref:`int` column **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_next` **(** **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_next_visible` **(** **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_parent` **(** **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_prev` **(** **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_prev_visible` **(** **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_range` **(** :ref:`int` column **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_range_config` **(** :ref:`int` column **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_text` **(** :ref:`int` column **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_text_align` **(** :ref:`int` column **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_tooltip` **(** :ref:`int` column **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_button_disabled` **(** :ref:`int` column, :ref:`int` button_idx **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_checked` **(** :ref:`int` column **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_collapsed` **(** **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_custom_set_as_button` **(** :ref:`int` column **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_editable` **(** :ref:`int` column **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_folding_disabled` **(** **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_selectable` **(** :ref:`int` column **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_selected` **(** :ref:`int` column **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`move_to_bottom` **(** **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`move_to_top` **(** **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_child` **(** :ref:`Object` child **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`select` **(** :ref:`int` column **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_button` **(** :ref:`int` column, :ref:`int` button_idx, :ref:`Texture` button **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cell_mode` **(** :ref:`int` column, :ref:`int` mode **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_checked` **(** :ref:`int` column, :ref:`bool` checked **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collapsed` **(** :ref:`bool` enable **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_as_button` **(** :ref:`int` column, :ref:`bool` enable **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_bg_color` **(** :ref:`int` column, :ref:`Color` color, :ref:`bool` just_outline=null **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_color` **(** :ref:`int` column, :ref:`Color` color **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_draw` **(** :ref:`int` column, :ref:`Object` object, :ref:`String` callback **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_disable_folding` **(** :ref:`bool` disable **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_editable` **(** :ref:`int` column, :ref:`bool` enabled **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_expand_right` **(** :ref:`int` column, :ref:`bool` enable **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_icon` **(** :ref:`int` column, :ref:`Texture` texture **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_icon_max_width` **(** :ref:`int` column, :ref:`int` width **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_icon_region` **(** :ref:`int` column, :ref:`Rect2` region **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_metadata` **(** :ref:`int` column, :ref:`Variant` meta **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_range` **(** :ref:`int` column, :ref:`float` value **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_range_config` **(** :ref:`int` column, :ref:`float` min, :ref:`float` max, :ref:`float` step, :ref:`bool` expr=null **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_selectable` **(** :ref:`int` column, :ref:`bool` selectable **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_text` **(** :ref:`int` column, :ref:`String` text **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_text_align` **(** :ref:`int` column, :ref:`int` text_align **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tooltip` **(** :ref:`int` column, :ref:`String` tooltip **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_button` **(** :ref:`int` column, :ref:`Texture` button, :ref:`int` button_idx=-1, :ref:`bool` disabled=false, :ref:`String` tooltip="" **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_custom_bg_color` **(** :ref:`int` column **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_custom_color` **(** :ref:`int` column **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`deselect` **(** :ref:`int` column **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`erase_button` **(** :ref:`int` column, :ref:`int` button_idx **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_button` **(** :ref:`int` column, :ref:`int` button_idx **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_button_count` **(** :ref:`int` column **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_cell_mode` **(** :ref:`int` column **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeItem` | :ref:`get_children` **(** **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_custom_bg_color` **(** :ref:`int` column **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_expand_right` **(** :ref:`int` column **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_icon` **(** :ref:`int` column **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_icon_max_width` **(** :ref:`int` column **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_icon_region` **(** :ref:`int` column **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_metadata` **(** :ref:`int` column **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeItem` | :ref:`get_next` **(** **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeItem` | :ref:`get_next_visible` **(** **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeItem` | :ref:`get_parent` **(** **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeItem` | :ref:`get_prev` **(** **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeItem` | :ref:`get_prev_visible` **(** **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_range` **(** :ref:`int` column **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_range_config` **(** :ref:`int` column **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_text` **(** :ref:`int` column **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_text_align` **(** :ref:`int` column **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_tooltip` **(** :ref:`int` column **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_button_disabled` **(** :ref:`int` column, :ref:`int` button_idx **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_checked` **(** :ref:`int` column **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_collapsed` **(** **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_custom_set_as_button` **(** :ref:`int` column **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_editable` **(** :ref:`int` column **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_folding_disabled` **(** **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_selectable` **(** :ref:`int` column **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_selected` **(** :ref:`int` column **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`move_to_bottom` **(** **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`move_to_top` **(** **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_child` **(** :ref:`Object` child **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`select` **(** :ref:`int` column **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_button` **(** :ref:`int` column, :ref:`int` button_idx, :ref:`Texture` button **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_cell_mode` **(** :ref:`int` column, :ref:`int` mode **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_checked` **(** :ref:`int` column, :ref:`bool` checked **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collapsed` **(** :ref:`bool` enable **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_custom_as_button` **(** :ref:`int` column, :ref:`bool` enable **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_custom_bg_color` **(** :ref:`int` column, :ref:`Color` color, :ref:`bool` just_outline=false **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_custom_color` **(** :ref:`int` column, :ref:`Color` color **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_custom_draw` **(** :ref:`int` column, :ref:`Object` object, :ref:`String` callback **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_disable_folding` **(** :ref:`bool` disable **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_editable` **(** :ref:`int` column, :ref:`bool` enabled **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_expand_right` **(** :ref:`int` column, :ref:`bool` enable **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_icon` **(** :ref:`int` column, :ref:`Texture` texture **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_icon_max_width` **(** :ref:`int` column, :ref:`int` width **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_icon_region` **(** :ref:`int` column, :ref:`Rect2` region **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_metadata` **(** :ref:`int` column, :ref:`Variant` meta **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_range` **(** :ref:`int` column, :ref:`float` value **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_range_config` **(** :ref:`int` column, :ref:`float` min, :ref:`float` max, :ref:`float` step, :ref:`bool` expr=false **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_selectable` **(** :ref:`int` column, :ref:`bool` selectable **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_text` **(** :ref:`int` column, :ref:`String` text **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_text_align` **(** :ref:`int` column, :ref:`int` text_align **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tooltip` **(** :ref:`int` column, :ref:`String` tooltip **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -151,7 +151,7 @@ Member Function Description .. _class_TreeItem_add_button: -- void **add_button** **(** :ref:`int` column, :ref:`Texture` button, :ref:`int` button_idx=-1, :ref:`bool` disabled=null, :ref:`String` tooltip=null **)** +- void **add_button** **(** :ref:`int` column, :ref:`Texture` button, :ref:`int` button_idx=-1, :ref:`bool` disabled=false, :ref:`String` tooltip="" **)** .. _class_TreeItem_clear_custom_bg_color: @@ -319,7 +319,7 @@ Member Function Description .. _class_TreeItem_set_custom_bg_color: -- void **set_custom_bg_color** **(** :ref:`int` column, :ref:`Color` color, :ref:`bool` just_outline=null **)** +- void **set_custom_bg_color** **(** :ref:`int` column, :ref:`Color` color, :ref:`bool` just_outline=false **)** .. _class_TreeItem_set_custom_color: @@ -363,7 +363,7 @@ Member Function Description .. _class_TreeItem_set_range_config: -- void **set_range_config** **(** :ref:`int` column, :ref:`float` min, :ref:`float` max, :ref:`float` step, :ref:`bool` expr=null **)** +- void **set_range_config** **(** :ref:`int` column, :ref:`float` min, :ref:`float` max, :ref:`float` step, :ref:`bool` expr=false **)** .. _class_TreeItem_set_selectable: diff --git a/classes/class_tween.rst b/classes/class_tween.rst index e9ffab5fc..ded8a9979 100644 --- a/classes/class_tween.rst +++ b/classes/class_tween.rst @@ -19,9 +19,9 @@ Member Functions ---------------- +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`follow_method` **(** :ref:`Object` object, :ref:`String` method, :ref:`Variant` initial_val, :ref:`Object` target, :ref:`String` target_method, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=null **)** | +| :ref:`bool` | :ref:`follow_method` **(** :ref:`Object` object, :ref:`String` method, :ref:`Variant` initial_val, :ref:`Object` target, :ref:`String` target_method, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`follow_property` **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` initial_val, :ref:`Object` target, :ref:`String` target_property, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=null **)** | +| :ref:`bool` | :ref:`follow_property` **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` initial_val, :ref:`Object` target, :ref:`String` target_property, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_runtime` **(** **)** const | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -33,23 +33,23 @@ Member Functions +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`interpolate_deferred_callback` **(** :ref:`Object` object, :ref:`float` duration, :ref:`String` callback, :ref:`Variant` arg1=null, :ref:`Variant` arg2=null, :ref:`Variant` arg3=null, :ref:`Variant` arg4=null, :ref:`Variant` arg5=null **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`interpolate_method` **(** :ref:`Object` object, :ref:`String` method, :ref:`Variant` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=null **)** | +| :ref:`bool` | :ref:`interpolate_method` **(** :ref:`Object` object, :ref:`String` method, :ref:`Variant` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`interpolate_property` **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=null **)** | +| :ref:`bool` | :ref:`interpolate_property` **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_active` **(** **)** const | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_repeat` **(** **)** const | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`remove` **(** :ref:`Object` object, :ref:`String` key=null **)** | +| :ref:`bool` | :ref:`remove` **(** :ref:`Object` object, :ref:`String` key="" **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`remove_all` **(** **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`reset` **(** :ref:`Object` object, :ref:`String` key=null **)** | +| :ref:`bool` | :ref:`reset` **(** :ref:`Object` object, :ref:`String` key="" **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`reset_all` **(** **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`resume` **(** :ref:`Object` object, :ref:`String` key=null **)** | +| :ref:`bool` | :ref:`resume` **(** :ref:`Object` object, :ref:`String` key="" **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`resume_all` **(** **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -65,13 +65,13 @@ Member Functions +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`start` **(** **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`stop` **(** :ref:`Object` object, :ref:`String` key=null **)** | +| :ref:`bool` | :ref:`stop` **(** :ref:`Object` object, :ref:`String` key="" **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`stop_all` **(** **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`targeting_method` **(** :ref:`Object` object, :ref:`String` method, :ref:`Object` initial, :ref:`String` initial_method, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=null **)** | +| :ref:`bool` | :ref:`targeting_method` **(** :ref:`Object` object, :ref:`String` method, :ref:`Object` initial, :ref:`String` initial_method, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`targeting_property` **(** :ref:`Object` object, :ref:`String` property, :ref:`Object` initial, :ref:`String` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=null **)** | +| :ref:`bool` | :ref:`targeting_property` **(** :ref:`Object` object, :ref:`String` property, :ref:`Object` initial, :ref:`String` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`tell` **(** **)** const | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -137,7 +137,7 @@ Member Function Description .. _class_Tween_follow_method: -- :ref:`bool` **follow_method** **(** :ref:`Object` object, :ref:`String` method, :ref:`Variant` initial_val, :ref:`Object` target, :ref:`String` target_method, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=null **)** +- :ref:`bool` **follow_method** **(** :ref:`Object` object, :ref:`String` method, :ref:`Variant` initial_val, :ref:`Object` target, :ref:`String` target_method, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** Follow ``method`` of ``object`` and apply the returned value on ``target_method`` of ``target``, beginning from ``initial_val`` for ``duration`` seconds, ``delay`` later. Methods are animated by calling them with consequitive values. @@ -145,7 +145,7 @@ Follow ``method`` of ``object`` and apply the returned value on ``target_method` .. _class_Tween_follow_property: -- :ref:`bool` **follow_property** **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` initial_val, :ref:`Object` target, :ref:`String` target_property, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=null **)** +- :ref:`bool` **follow_property** **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` initial_val, :ref:`Object` target, :ref:`String` target_property, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** Follow ``property`` of ``object`` and apply it on ``target_property`` of ``target``, beginning from ``initial_val`` for ``duration`` seconds, ``delay`` seconds later. Note that ``target:target_property`` would equal ``object:property`` at the end of the tween. @@ -183,7 +183,7 @@ Call ``callback`` of ``object`` after ``duration`` on the main thread (similar t .. _class_Tween_interpolate_method: -- :ref:`bool` **interpolate_method** **(** :ref:`Object` object, :ref:`String` method, :ref:`Variant` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=null **)** +- :ref:`bool` **interpolate_method** **(** :ref:`Object` object, :ref:`String` method, :ref:`Variant` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** Animate ``method`` of ``object`` from ``initial_val`` to ``final_val`` for ``duration`` seconds, ``delay`` seconds later. Methods are animated by calling them with consecuitive values. @@ -191,7 +191,7 @@ Animate ``method`` of ``object`` from ``initial_val`` to ``final_val`` for ``dur .. _class_Tween_interpolate_property: -- :ref:`bool` **interpolate_property** **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=null **)** +- :ref:`bool` **interpolate_property** **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** Animate ``property`` of ``object`` from ``initial_val`` to ``final_val`` for ``duration`` seconds, ``delay`` seconds later. @@ -211,7 +211,7 @@ Returns true if repeat has been set from editor GUI or :ref:`set_repeat` **remove** **(** :ref:`Object` object, :ref:`String` key=null **)** +- :ref:`bool` **remove** **(** :ref:`Object` object, :ref:`String` key="" **)** Stop animating and completely remove a tween, given its object and property/method pair. Passing empty String as key will remove all tweens for given object. @@ -223,7 +223,7 @@ Stop animating and completely remove all tweens. .. _class_Tween_reset: -- :ref:`bool` **reset** **(** :ref:`Object` object, :ref:`String` key=null **)** +- :ref:`bool` **reset** **(** :ref:`Object` object, :ref:`String` key="" **)** Resets a tween to the initial value (the one given, not the one before the tween), given its object and property/method pair. Passing empty String as key will reset all tweens for given object. @@ -235,7 +235,7 @@ Resets all tweens to their initial values (the ones given, not those before the .. _class_Tween_resume: -- :ref:`bool` **resume** **(** :ref:`Object` object, :ref:`String` key=null **)** +- :ref:`bool` **resume** **(** :ref:`Object` object, :ref:`String` key="" **)** Continue animating a stopped tween, given its object and property/method pair. Passing empty String as key will resume all tweens for given object. @@ -283,7 +283,7 @@ Start the tween node. You can define tweens both before and after this. .. _class_Tween_stop: -- :ref:`bool` **stop** **(** :ref:`Object` object, :ref:`String` key=null **)** +- :ref:`bool` **stop** **(** :ref:`Object` object, :ref:`String` key="" **)** Stop animating a tween, given its object and property/method pair. Passing empty String as key will stop all tweens for given object. @@ -295,7 +295,7 @@ Stop animating all tweens. .. _class_Tween_targeting_method: -- :ref:`bool` **targeting_method** **(** :ref:`Object` object, :ref:`String` method, :ref:`Object` initial, :ref:`String` initial_method, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=null **)** +- :ref:`bool` **targeting_method** **(** :ref:`Object` object, :ref:`String` method, :ref:`Object` initial, :ref:`String` initial_method, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** Animate ``method`` of ``object`` from the value returned by ``initial.initial_method`` to ``final_val`` for ``duration`` seconds, ``delay`` seconds later. Methods are animated by calling them with consecuitive values. @@ -303,7 +303,7 @@ Animate ``method`` of ``object`` from the value returned by ``initial.initial_me .. _class_Tween_targeting_property: -- :ref:`bool` **targeting_property** **(** :ref:`Object` object, :ref:`String` property, :ref:`Object` initial, :ref:`String` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=null **)** +- :ref:`bool` **targeting_property** **(** :ref:`Object` object, :ref:`String` property, :ref:`Object` initial, :ref:`String` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** Animate ``property`` of ``object`` from the current value of the ``initial_val`` property of ``initial`` to ``final_val`` for ``duration`` seconds, ``delay`` seconds later. diff --git a/classes/class_undoredo.rst b/classes/class_undoredo.rst index ecd9d76ff..fb4fc7c8b 100644 --- a/classes/class_undoredo.rst +++ b/classes/class_undoredo.rst @@ -35,7 +35,7 @@ Member Functions +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`commit_action` **(** **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create_action` **(** :ref:`String` name, :ref:`int` merge_mode=null **)** | +| void | :ref:`create_action` **(** :ref:`String` name, :ref:`int` merge_mode=0 **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_current_action_name` **(** **)** const | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -105,7 +105,7 @@ Commit the action. All 'do' methods/properties are called/set when this function .. _class_UndoRedo_create_action: -- void **create_action** **(** :ref:`String` name, :ref:`int` merge_mode=null **)** +- void **create_action** **(** :ref:`String` name, :ref:`int` merge_mode=0 **)** Create a new action. After this is called, do all your calls to :ref:`add_do_method`, :ref:`add_undo_method`, :ref:`add_do_property` and :ref:`add_undo_property`. diff --git a/classes/class_viewport.rst b/classes/class_viewport.rst index f119f4b61..aba3a47a0 100644 --- a/classes/class_viewport.rst +++ b/classes/class_viewport.rst @@ -18,137 +18,137 @@ Creates a sub-view into the screen. Member Functions ---------------- -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`World` | :ref:`find_world` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`World2D` | :ref:`find_world_2d` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Camera` | :ref:`get_camera` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_canvas_transform` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_clear_mode` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_debug_draw` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_final_transform` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_global_canvas_transform` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_hdr` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_mouse_position` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_msaa` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_physics_object_picking` **(** **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_render_info` **(** :ref:`int` info **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_shadow_atlas_quadrant_subdiv` **(** :ref:`int` quadrant **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_shadow_atlas_size` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_size` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_size_override` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ViewportTexture` | :ref:`get_texture` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_update_mode` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_usage` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_vflip` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_viewport_rid` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_visible_rect` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`World` | :ref:`get_world` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`World2D` | :ref:`get_world_2d` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`gui_get_drag_data` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`gui_has_modal_stack` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_transparent_background` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`input` **(** :ref:`InputEvent` local_event **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_3d_disabled` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_audio_listener` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_audio_listener_2d` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_input_disabled` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_size_override_enabled` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_size_override_stretch_enabled` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_using_own_world` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_as_audio_listener` **(** :ref:`bool` enable **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_as_audio_listener_2d` **(** :ref:`bool` enable **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_attach_to_screen_rect` **(** :ref:`Rect2` rect **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_canvas_transform` **(** :ref:`Transform2D` xform **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_clear_mode` **(** :ref:`int` mode **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_debug_draw` **(** :ref:`int` debug_draw **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_disable_3d` **(** :ref:`bool` disable **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_disable_input` **(** :ref:`bool` disable **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_global_canvas_transform` **(** :ref:`Transform2D` xform **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_hdr` **(** :ref:`bool` enable **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_msaa` **(** :ref:`int` msaa **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_physics_object_picking` **(** :ref:`bool` enable **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shadow_atlas_quadrant_subdiv` **(** :ref:`int` quadrant, :ref:`int` subdiv **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shadow_atlas_size` **(** :ref:`int` size **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_size` **(** :ref:`Vector2` size **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_size_override` **(** :ref:`bool` enable, :ref:`Vector2` size=Vector2( -1, -1 ), :ref:`Vector2` margin=null **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_size_override_stretch` **(** :ref:`bool` enabled **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_transparent_background` **(** :ref:`bool` enable **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_update_mode` **(** :ref:`int` mode **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_usage` **(** :ref:`int` usage **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_arvr` **(** :ref:`bool` use **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_own_world` **(** :ref:`bool` enable **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vflip` **(** :ref:`bool` enable **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_world` **(** :ref:`World` world **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_world_2d` **(** :ref:`World2D` world_2d **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`unhandled_input` **(** :ref:`InputEvent` local_event **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`update_worlds` **(** **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`use_arvr` **(** **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`warp_mouse` **(** :ref:`Vector2` to_pos **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`World` | :ref:`find_world` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`World2D` | :ref:`find_world_2d` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Camera` | :ref:`get_camera` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_canvas_transform` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_clear_mode` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_debug_draw` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_final_transform` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_global_canvas_transform` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_hdr` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_mouse_position` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_msaa` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_physics_object_picking` **(** **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_render_info` **(** :ref:`int` info **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_shadow_atlas_quadrant_subdiv` **(** :ref:`int` quadrant **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_shadow_atlas_size` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_size` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_size_override` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ViewportTexture` | :ref:`get_texture` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_update_mode` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_usage` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_vflip` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_viewport_rid` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_visible_rect` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`World` | :ref:`get_world` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`World2D` | :ref:`get_world_2d` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`gui_get_drag_data` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`gui_has_modal_stack` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_transparent_background` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`input` **(** :ref:`InputEvent` local_event **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_3d_disabled` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_audio_listener` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_audio_listener_2d` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_input_disabled` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_size_override_enabled` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_size_override_stretch_enabled` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_using_own_world` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_as_audio_listener` **(** :ref:`bool` enable **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_as_audio_listener_2d` **(** :ref:`bool` enable **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_attach_to_screen_rect` **(** :ref:`Rect2` rect **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_canvas_transform` **(** :ref:`Transform2D` xform **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_clear_mode` **(** :ref:`int` mode **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_debug_draw` **(** :ref:`int` debug_draw **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_disable_3d` **(** :ref:`bool` disable **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_disable_input` **(** :ref:`bool` disable **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_global_canvas_transform` **(** :ref:`Transform2D` xform **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_hdr` **(** :ref:`bool` enable **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_msaa` **(** :ref:`int` msaa **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_physics_object_picking` **(** :ref:`bool` enable **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shadow_atlas_quadrant_subdiv` **(** :ref:`int` quadrant, :ref:`int` subdiv **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shadow_atlas_size` **(** :ref:`int` size **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_size` **(** :ref:`Vector2` size **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_size_override` **(** :ref:`bool` enable, :ref:`Vector2` size=Vector2( -1, -1 ), :ref:`Vector2` margin=Vector2( 0, 0 ) **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_size_override_stretch` **(** :ref:`bool` enabled **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_transparent_background` **(** :ref:`bool` enable **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_update_mode` **(** :ref:`int` mode **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_usage` **(** :ref:`int` usage **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_use_arvr` **(** :ref:`bool` use **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_use_own_world` **(** :ref:`bool` enable **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_vflip` **(** :ref:`bool` enable **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_world` **(** :ref:`World` world **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_world_2d` **(** :ref:`World2D` world_2d **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`unhandled_input` **(** :ref:`InputEvent` local_event **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`update_worlds` **(** **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`use_arvr` **(** **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`warp_mouse` **(** :ref:`Vector2` to_pos **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -507,7 +507,7 @@ Set the size of the viewport. .. _class_Viewport_set_size_override: -- void **set_size_override** **(** :ref:`bool` enable, :ref:`Vector2` size=Vector2( -1, -1 ), :ref:`Vector2` margin=null **)** +- void **set_size_override** **(** :ref:`bool` enable, :ref:`Vector2` size=Vector2( -1, -1 ), :ref:`Vector2` margin=Vector2( 0, 0 ) **)** Set the size override of the viewport. If the enable parameter is true, it would use the override, otherwise it would use the default size. If the size parameter is equal to ``(-1, -1)``, it won't update the size. diff --git a/classes/class_visualscript.rst b/classes/class_visualscript.rst index 4b88b62ff..c873adc63 100644 --- a/classes/class_visualscript.rst +++ b/classes/class_visualscript.rst @@ -23,11 +23,11 @@ Member Functions +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_function` **(** :ref:`String` name **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_node` **(** :ref:`String` func, :ref:`int` id, :ref:`VisualScriptNode` node, :ref:`Vector2` pos=null **)** | +| void | :ref:`add_node` **(** :ref:`String` func, :ref:`int` id, :ref:`VisualScriptNode` node, :ref:`Vector2` pos=Vector2( 0, 0 ) **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_variable` **(** :ref:`String` name, :ref:`Variant` default_value=null, :ref:`bool` export=null **)** | +| void | :ref:`add_variable` **(** :ref:`String` name, :ref:`Variant` default_value=null, :ref:`bool` export=false **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`custom_signal_add_argument` **(** :ref:`String` name, :ref:`int` type, :ref:`String` argname, :ref:`int` index=null **)** | +| void | :ref:`custom_signal_add_argument` **(** :ref:`String` name, :ref:`int` type, :ref:`String` argname, :ref:`int` index=-1 **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`custom_signal_get_argument_count` **(** :ref:`String` name **)** const | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -127,15 +127,15 @@ Member Function Description .. _class_VisualScript_add_node: -- void **add_node** **(** :ref:`String` func, :ref:`int` id, :ref:`VisualScriptNode` node, :ref:`Vector2` pos=null **)** +- void **add_node** **(** :ref:`String` func, :ref:`int` id, :ref:`VisualScriptNode` node, :ref:`Vector2` pos=Vector2( 0, 0 ) **)** .. _class_VisualScript_add_variable: -- void **add_variable** **(** :ref:`String` name, :ref:`Variant` default_value=null, :ref:`bool` export=null **)** +- void **add_variable** **(** :ref:`String` name, :ref:`Variant` default_value=null, :ref:`bool` export=false **)** .. _class_VisualScript_custom_signal_add_argument: -- void **custom_signal_add_argument** **(** :ref:`String` name, :ref:`int` type, :ref:`String` argname, :ref:`int` index=null **)** +- void **custom_signal_add_argument** **(** :ref:`String` name, :ref:`int` type, :ref:`String` argname, :ref:`int` index=-1 **)** .. _class_VisualScript_custom_signal_get_argument_count: diff --git a/classes/class_visualserver.rst b/classes/class_visualserver.rst index 384eba14e..6a24929a9 100644 --- a/classes/class_visualserver.rst +++ b/classes/class_visualserver.rst @@ -18,23 +18,23 @@ Server for anything visible. Member Functions ---------------- -+------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`force_draw` **(** **)** | -+------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`texture_create` **(** **)** | -+------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`texture_create_from_image` **(** :ref:`Image` image, :ref:`int` flags=null **)** | -+------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`texture_get_flags` **(** :ref:`RID` texture **)** const | -+------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`texture_get_height` **(** :ref:`RID` texture **)** const | -+------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`texture_get_width` **(** :ref:`RID` texture **)** const | -+------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`texture_set_flags` **(** :ref:`RID` texture, :ref:`int` flags **)** | -+------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`texture_set_shrink_all_x2_on_set_data` **(** :ref:`bool` shrink **)** | -+------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`force_draw` **(** **)** | ++------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`texture_create` **(** **)** | ++------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`texture_create_from_image` **(** :ref:`Image` image, :ref:`int` flags=7 **)** | ++------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`texture_get_flags` **(** :ref:`RID` texture **)** const | ++------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`texture_get_height` **(** :ref:`RID` texture **)** const | ++------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`texture_get_width` **(** :ref:`RID` texture **)** const | ++------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`texture_set_flags` **(** :ref:`RID` texture, :ref:`int` flags **)** | ++------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`texture_set_shrink_all_x2_on_set_data` **(** :ref:`bool` shrink **)** | ++------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -56,7 +56,7 @@ Member Function Description .. _class_VisualServer_texture_create_from_image: -- :ref:`RID` **texture_create_from_image** **(** :ref:`Image` image, :ref:`int` flags=null **)** +- :ref:`RID` **texture_create_from_image** **(** :ref:`Image` image, :ref:`int` flags=7 **)** .. _class_VisualServer_texture_get_flags: