From 9e7daa26fa3d19d2076729f8897369096915d1cb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Tue, 24 Sep 2019 13:39:50 +0200 Subject: [PATCH] Sync classref with current source --- classes/class_@gdscript.rst | 6 + classes/class_acceptdialog.rst | 16 +- classes/class_animatedtexture.rst | 14 +- classes/class_animationnode.rst | 2 +- ...lass_animationnodestatemachineplayback.rst | 7 + classes/class_animationplayer.rst | 6 +- classes/class_array.rst | 8 + classes/class_atlastexture.rst | 6 +- classes/class_basebutton.rst | 44 ++--- classes/class_boxcontainer.rst | 8 +- classes/class_button.rst | 38 +++-- classes/class_buttongroup.rst | 7 + classes/class_camera2d.rst | 2 +- classes/class_cameratexture.rst | 16 +- classes/class_charfxtransform.rst | 154 +++++++++++++++++ classes/class_checkbox.rst | 9 + classes/class_checkbutton.rst | 9 + classes/class_colorpickerbutton.rst | 6 + classes/class_confirmationdialog.rst | 9 + classes/class_control.rst | 10 +- classes/class_directionallight.rst | 40 ++--- classes/class_editorfeatureprofile.rst | 50 +++--- classes/class_editorfiledialog.rst | 40 +++-- classes/class_editorinspector.rst | 7 + classes/class_editorinterface.rst | 6 + classes/class_editorspatialgizmo.rst | 4 +- classes/class_editorvcsinterface.rst | 147 +++++++++++++++++ classes/class_environment.rst | 2 +- classes/class_filedialog.rst | 38 +++-- classes/class_graphedit.rst | 26 +-- classes/class_graphnode.rst | 2 + classes/class_gridcontainer.rst | 8 +- classes/class_image.rst | 6 +- classes/class_imagetexture.rst | 12 +- classes/class_input.rst | 6 +- classes/class_itemlist.rst | 4 + classes/class_label.rst | 46 +++--- classes/class_largetexture.rst | 7 + classes/class_lineedit.rst | 120 +++++++++----- classes/class_linkbutton.rst | 16 +- classes/class_mainloop.rst | 12 ++ classes/class_menubutton.rst | 16 +- classes/class_meshinstance.rst | 12 ++ classes/class_meshtexture.rst | 2 + classes/class_networkedmultiplayerenet.rst | 22 ++- classes/class_ninepatchrect.rst | 4 +- classes/class_node.rst | 14 ++ classes/class_node2d.rst | 2 +- classes/class_noisetexture.rst | 28 ++-- classes/class_object.rst | 2 +- classes/class_optionbutton.rst | 12 +- classes/class_os.rst | 10 +- classes/class_parallaxbackground.rst | 2 + classes/class_path2d.rst | 8 +- classes/class_physics2dserver.rst | 2 +- classes/class_physicsbody2d.rst | 16 +- classes/class_popup.rst | 8 +- classes/class_popupmenu.rst | 26 +-- classes/class_progressbar.rst | 10 +- classes/class_projectsettings.rst | 4 +- classes/class_proxytexture.rst | 8 +- classes/class_reference.rst | 2 +- classes/class_resource.rst | 2 +- classes/class_richtexteffect.rst | 34 ++++ classes/class_richtextlabel.rst | 100 ++++++++--- classes/class_script.rst | 64 +++++-- classes/class_scriptcreatedialog.rst | 15 ++ classes/class_scrollbar.rst | 10 +- classes/class_scrollcontainer.rst | 24 +-- classes/class_skeleton.rst | 156 +++++++----------- classes/class_skin.rst | 76 +++++++++ classes/class_skinreference.rst | 40 +++++ classes/class_slider.rst | 36 ++-- classes/class_streamtexture.rst | 8 +- classes/class_string.rst | 8 + classes/class_textedit.rst | 122 +++++++++----- classes/class_texture3d.rst | 7 + classes/class_textureprogress.rst | 64 +++---- classes/class_texturerect.rst | 24 +-- classes/class_tilemap.rst | 88 +++++----- classes/class_toolbutton.rst | 7 + classes/class_tree.rst | 36 ++-- classes/class_vehiclebody.rst | 18 +- classes/class_viewport.rst | 4 +- classes/class_viewporttexture.rst | 4 + classes/class_visibilityenabler2d.rst | 2 +- classes/class_visualscriptbuiltinfunc.rst | 6 +- classes/class_visualserver.rst | 6 +- classes/class_visualshader.rst | 8 +- .../class_visualshadernodebooleanconstant.rst | 8 +- .../class_visualshadernodecolorconstant.rst | 2 + classes/class_visualshadernodecolorop.rst | 8 +- classes/class_visualshadernodecompare.rst | 16 +- classes/class_visualshadernodecubemap.rst | 12 +- .../class_visualshadernodecubemapuniform.rst | 7 + classes/class_visualshadernodecustom.rst | 7 + classes/class_visualshadernodedeterminant.rst | 7 + classes/class_visualshadernodedotproduct.rst | 7 + classes/class_visualshadernodeexpression.rst | 8 +- classes/class_visualshadernodefaceforward.rst | 7 + classes/class_visualshadernodefresnel.rst | 7 + ...class_visualshadernodeglobalexpression.rst | 7 + classes/class_visualshadernodegroupbase.rst | 24 +-- classes/class_visualshadernodeif.rst | 7 + classes/class_visualshadernodeinput.rst | 8 +- classes/class_visualshadernodeis.rst | 8 +- .../class_visualshadernodeouterproduct.rst | 7 + classes/class_visualshadernodescalarclamp.rst | 7 + .../class_visualshadernodescalarconstant.rst | 8 +- ...s_visualshadernodescalarderivativefunc.rst | 8 +- classes/class_visualshadernodescalarfunc.rst | 8 +- .../class_visualshadernodescalarinterp.rst | 7 + classes/class_visualshadernodescalarop.rst | 8 +- ...class_visualshadernodescalarsmoothstep.rst | 7 + .../class_visualshadernodescalarswitch.rst | 20 +++ classes/class_visualshadernodeswitch.rst | 9 + classes/class_visualshadernodetexture.rst | 16 +- ...class_visualshadernodetransformcompose.rst | 7 + ...lass_visualshadernodetransformconstant.rst | 2 + ...ass_visualshadernodetransformdecompose.rst | 7 + .../class_visualshadernodetransformfunc.rst | 8 +- .../class_visualshadernodetransformmult.rst | 8 +- ...class_visualshadernodetransformvecmult.rst | 8 +- classes/class_visualshadernodeuniform.rst | 8 +- .../class_visualshadernodevec3constant.rst | 2 + classes/class_visualshadernodevectorclamp.rst | 7 + .../class_visualshadernodevectorcompose.rst | 7 + .../class_visualshadernodevectordistance.rst | 7 + .../class_visualshadernodevectorinterp.rst | 7 + classes/class_visualshadernodevectorop.rst | 8 +- .../class_visualshadernodevectorrefract.rst | 7 + .../class_visualshadernodevectorscalarmix.rst | 7 + ...visualshadernodevectorscalarsmoothstep.rst | 7 + ...class_visualshadernodevectorscalarstep.rst | 7 + ...class_visualshadernodevectorsmoothstep.rst | 7 + classes/class_vscrollbar.rst | 9 + classes/class_vslider.rst | 9 + classes/class_webrtcmultiplayer.rst | 9 + classes/class_websocketmultiplayerpeer.rst | 9 + 139 files changed, 1840 insertions(+), 727 deletions(-) create mode 100644 classes/class_charfxtransform.rst create mode 100644 classes/class_editorvcsinterface.rst create mode 100644 classes/class_richtexteffect.rst create mode 100644 classes/class_skin.rst create mode 100644 classes/class_skinreference.rst create mode 100644 classes/class_visualshadernodescalarswitch.rst diff --git a/classes/class_@gdscript.rst b/classes/class_@gdscript.rst index 2f4517510..beef94e1b 100644 --- a/classes/class_@gdscript.rst +++ b/classes/class_@gdscript.rst @@ -114,6 +114,8 @@ Methods +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`nearest_po2` **(** :ref:`int` value **)** | +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`ord` **(** :ref:`String` char **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`parse_json` **(** :ref:`String` json **)** | +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`polar2cartesian` **(** :ref:`float` r, :ref:`float` th **)** | @@ -785,6 +787,10 @@ Returns the nearest larger power of 2 for integer ``value``. nearest_po2(4) # Returns 4 nearest_po2(5) # Returns 8 +.. _class_@GDScript_method_ord: + +- :ref:`int` **ord** **(** :ref:`String` char **)** + .. _class_@GDScript_method_parse_json: - :ref:`Variant` **parse_json** **(** :ref:`String` json **)** diff --git a/classes/class_acceptdialog.rst b/classes/class_acceptdialog.rst index 83b19f047..f9e7feb89 100644 --- a/classes/class_acceptdialog.rst +++ b/classes/class_acceptdialog.rst @@ -23,13 +23,15 @@ Base dialog for user notification. Properties ---------- -+-----------------------------+-------------------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`dialog_autowrap` | false | -+-----------------------------+-------------------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`dialog_hide_on_ok` | true | -+-----------------------------+-------------------------------------------------------------------------+-------+ -| :ref:`String` | :ref:`dialog_text` | "" | -+-----------------------------+-------------------------------------------------------------------------+-------+ ++-----------------------------+-------------------------------------------------------------------------+-----------------+ +| :ref:`bool` | :ref:`dialog_autowrap` | false | ++-----------------------------+-------------------------------------------------------------------------+-----------------+ +| :ref:`bool` | :ref:`dialog_hide_on_ok` | true | ++-----------------------------+-------------------------------------------------------------------------+-----------------+ +| :ref:`String` | :ref:`dialog_text` | "" | ++-----------------------------+-------------------------------------------------------------------------+-----------------+ +| :ref:`String` | window_title | **O:** "Alert!" | ++-----------------------------+-------------------------------------------------------------------------+-----------------+ Methods ------- diff --git a/classes/class_animatedtexture.rst b/classes/class_animatedtexture.rst index 938c608d9..8a22ff5cc 100644 --- a/classes/class_animatedtexture.rst +++ b/classes/class_animatedtexture.rst @@ -21,11 +21,13 @@ Proxy texture for simple frame-based animations. Properties ---------- -+---------------------------+------------------------------------------------------+-----+ -| :ref:`float` | :ref:`fps` | 4.0 | -+---------------------------+------------------------------------------------------+-----+ -| :ref:`int` | :ref:`frames` | 1 | -+---------------------------+------------------------------------------------------+-----+ ++---------------------------+------------------------------------------------------+----------+ +| :ref:`int` | flags | **O:** 0 | ++---------------------------+------------------------------------------------------+----------+ +| :ref:`float` | :ref:`fps` | 4.0 | ++---------------------------+------------------------------------------------------+----------+ +| :ref:`int` | :ref:`frames` | 1 | ++---------------------------+------------------------------------------------------+----------+ Methods ------- @@ -54,7 +56,7 @@ Description The playback of the animation is controlled by the :ref:`fps` property as well as each frame's optional delay (see :ref:`set_frame_delay`). The animation loops, i.e. it will restart at frame 0 automatically after playing the last frame. -``AnimatedTexture`` currently requires all frame textures to have the same size, otherwise the bigger ones will be cropped to match the smallest one. +``AnimatedTexture`` currently requires all frame textures to have the same size, otherwise the bigger ones will be cropped to match the smallest one. Also, it doesn't support :ref:`AtlasTexture`. Each frame needs to be separate image. Property Descriptions --------------------- diff --git a/classes/class_animationnode.rst b/classes/class_animationnode.rst index b85136278..0a1972233 100644 --- a/classes/class_animationnode.rst +++ b/classes/class_animationnode.rst @@ -153,7 +153,7 @@ Blend an input. This is only useful for nodes created for an :ref:`AnimationNode - :ref:`float` **blend_node** **(** :ref:`String` name, :ref:`AnimationNode` node, :ref:`float` time, :ref:`bool` seek, :ref:`float` blend, :ref:`FilterAction` filter=0, :ref:`bool` optimize=true **)** -Blend another animaiton node (in case this node contains children animation nodes). This function is only useful if you inherit from :ref:`AnimationRootNode` instead, else editors will not display your node for addition. +Blend another animation node (in case this node contains children animation nodes). This function is only useful if you inherit from :ref:`AnimationRootNode` instead, else editors will not display your node for addition. .. _class_AnimationNode_method_get_caption: diff --git a/classes/class_animationnodestatemachineplayback.rst b/classes/class_animationnodestatemachineplayback.rst index d1b0d69fc..b0936fecd 100644 --- a/classes/class_animationnodestatemachineplayback.rst +++ b/classes/class_animationnodestatemachineplayback.rst @@ -18,6 +18,13 @@ Brief Description Playback control for AnimationNodeStateMachine. +Properties +---------- + ++-------------------------+-------------------------+-------------+ +| :ref:`bool` | resource_local_to_scene | **O:** true | ++-------------------------+-------------------------+-------------+ + Methods ------- diff --git a/classes/class_animationplayer.rst b/classes/class_animationplayer.rst index a5276e312..7eb40e728 100644 --- a/classes/class_animationplayer.rst +++ b/classes/class_animationplayer.rst @@ -119,6 +119,8 @@ Notifies when an animation starts playing. - **caches_cleared** **(** **)** +Notifies when the caches have been cleared, either automatically, or manually via :ref:`clear_caches`. + Enumerations ------------ @@ -350,7 +352,7 @@ Clears all queued, unplayed animations. - :ref:`String` **find_animation** **(** :ref:`Animation` animation **)** const -Returns the name of ``animation`` or empty string if not found. +Returns the name of ``animation`` or an empty string if not found. .. _class_AnimationPlayer_method_get_animation: @@ -380,6 +382,8 @@ Gets the actual playing speed of current animation or 0 if not playing. This spe - :ref:`PoolStringArray` **get_queue** **(** **)** +Returns a list of the animation names that are currently queued to play. + .. _class_AnimationPlayer_method_has_animation: - :ref:`bool` **has_animation** **(** :ref:`String` name **)** const diff --git a/classes/class_array.rst b/classes/class_array.rst index 0f303cbd3..643c7a11c 100644 --- a/classes/class_array.rst +++ b/classes/class_array.rst @@ -88,6 +88,8 @@ Methods +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`size` **(** **)** | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`slice` **(** :ref:`int` begin, :ref:`int` end, :ref:`int` step=1, :ref:`bool` deep=False **)** | ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`sort` **(** **)** | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`sort_custom` **(** :ref:`Object` obj, :ref:`String` func **)** | @@ -319,6 +321,12 @@ Shuffles the array such that the items will have a random order. This method use Returns the number of elements in the array. +.. _class_Array_method_slice: + +- :ref:`Array` **slice** **(** :ref:`int` begin, :ref:`int` end, :ref:`int` step=1, :ref:`bool` deep=False **)** + +Duplicates the subset described in the function and returns it in an array, deeply copying the array if ``deep`` is true. Lower and upper index are inclusive, with the ``step`` describing the change between indices while slicing. + .. _class_Array_method_sort: - void **sort** **(** **)** diff --git a/classes/class_atlastexture.rst b/classes/class_atlastexture.rst index 3ef790f04..8c406dacf 100644 --- a/classes/class_atlastexture.rst +++ b/classes/class_atlastexture.rst @@ -26,6 +26,8 @@ Properties +-------------------------------+-------------------------------------------------------------+---------------------+ | :ref:`bool` | :ref:`filter_clip` | false | +-------------------------------+-------------------------------------------------------------+---------------------+ +| :ref:`int` | flags | **O:** 0 | ++-------------------------------+-------------------------------------------------------------+---------------------+ | :ref:`Rect2` | :ref:`margin` | Rect2( 0, 0, 0, 0 ) | +-------------------------------+-------------------------------------------------------------+---------------------+ | :ref:`Rect2` | :ref:`region` | Rect2( 0, 0, 0, 0 ) | @@ -34,9 +36,7 @@ Properties Description ----------- -:ref:`Texture` resource aimed at managing big textures files that pack multiple smaller textures. Consists of a :ref:`Texture`, a margin that defines the border width, - -and a region that defines the actual area of the AtlasTexture. +:ref:`Texture` resource aimed at managing big textures files that pack multiple smaller textures. Consists of a :ref:`Texture`, a margin that defines the border width, and a region that defines the actual area of the AtlasTexture. Property Descriptions --------------------- diff --git a/classes/class_basebutton.rst b/classes/class_basebutton.rst index d088eba37..ce536cc74 100644 --- a/classes/class_basebutton.rst +++ b/classes/class_basebutton.rst @@ -23,27 +23,29 @@ Base class for different kinds of buttons. Properties ---------- -+-----------------------------------------------+-----------------------------------------------------------------------------+-------+ -| :ref:`ActionMode` | :ref:`action_mode` | 1 | -+-----------------------------------------------+-----------------------------------------------------------------------------+-------+ -| :ref:`int` | :ref:`button_mask` | 1 | -+-----------------------------------------------+-----------------------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`disabled` | false | -+-----------------------------------------------+-----------------------------------------------------------------------------+-------+ -| :ref:`FocusMode` | :ref:`enabled_focus_mode` | 2 | -+-----------------------------------------------+-----------------------------------------------------------------------------+-------+ -| :ref:`ButtonGroup` | :ref:`group` | | -+-----------------------------------------------+-----------------------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`keep_pressed_outside` | false | -+-----------------------------------------------+-----------------------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`pressed` | false | -+-----------------------------------------------+-----------------------------------------------------------------------------+-------+ -| :ref:`ShortCut` | :ref:`shortcut` | | -+-----------------------------------------------+-----------------------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`shortcut_in_tooltip` | true | -+-----------------------------------------------+-----------------------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`toggle_mode` | false | -+-----------------------------------------------+-----------------------------------------------------------------------------+-------+ ++-----------------------------------------------+-----------------------------------------------------------------------------+----------+ +| :ref:`ActionMode` | :ref:`action_mode` | 1 | ++-----------------------------------------------+-----------------------------------------------------------------------------+----------+ +| :ref:`int` | :ref:`button_mask` | 1 | ++-----------------------------------------------+-----------------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`disabled` | false | ++-----------------------------------------------+-----------------------------------------------------------------------------+----------+ +| :ref:`FocusMode` | :ref:`enabled_focus_mode` | 2 | ++-----------------------------------------------+-----------------------------------------------------------------------------+----------+ +| :ref:`FocusMode` | focus_mode | **O:** 2 | ++-----------------------------------------------+-----------------------------------------------------------------------------+----------+ +| :ref:`ButtonGroup` | :ref:`group` | | ++-----------------------------------------------+-----------------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`keep_pressed_outside` | false | ++-----------------------------------------------+-----------------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`pressed` | false | ++-----------------------------------------------+-----------------------------------------------------------------------------+----------+ +| :ref:`ShortCut` | :ref:`shortcut` | | ++-----------------------------------------------+-----------------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`shortcut_in_tooltip` | true | ++-----------------------------------------------+-----------------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`toggle_mode` | false | ++-----------------------------------------------+-----------------------------------------------------------------------------+----------+ Methods ------- diff --git a/classes/class_boxcontainer.rst b/classes/class_boxcontainer.rst index 59c12e360..981060314 100644 --- a/classes/class_boxcontainer.rst +++ b/classes/class_boxcontainer.rst @@ -23,9 +23,11 @@ Base class for box containers. Properties ---------- -+-----------------------------------------------+---------------------------------------------------------+---+ -| :ref:`AlignMode` | :ref:`alignment` | 0 | -+-----------------------------------------------+---------------------------------------------------------+---+ ++-----------------------------------------------+---------------------------------------------------------+----------+ +| :ref:`AlignMode` | :ref:`alignment` | 0 | ++-----------------------------------------------+---------------------------------------------------------+----------+ +| :ref:`MouseFilter` | mouse_filter | **O:** 1 | ++-----------------------------------------------+---------------------------------------------------------+----------+ Methods ------- diff --git a/classes/class_button.rst b/classes/class_button.rst index aeb7d1236..748da3eaf 100644 --- a/classes/class_button.rst +++ b/classes/class_button.rst @@ -23,17 +23,19 @@ Standard themed Button. Properties ---------- -+-----------------------------------------+---------------------------------------------------+-------+ -| :ref:`TextAlign` | :ref:`align` | 1 | -+-----------------------------------------+---------------------------------------------------+-------+ -| :ref:`bool` | :ref:`clip_text` | false | -+-----------------------------------------+---------------------------------------------------+-------+ -| :ref:`bool` | :ref:`flat` | false | -+-----------------------------------------+---------------------------------------------------+-------+ -| :ref:`Texture` | :ref:`icon` | | -+-----------------------------------------+---------------------------------------------------+-------+ -| :ref:`String` | :ref:`text` | "" | -+-----------------------------------------+---------------------------------------------------+-------+ ++-----------------------------------------+-------------------------------------------------------+-------+ +| :ref:`TextAlign` | :ref:`align` | 1 | ++-----------------------------------------+-------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`clip_text` | false | ++-----------------------------------------+-------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`expand_icon` | false | ++-----------------------------------------+-------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`flat` | false | ++-----------------------------------------+-------------------------------------------------------+-------+ +| :ref:`Texture` | :ref:`icon` | | ++-----------------------------------------+-------------------------------------------------------+-------+ +| :ref:`String` | :ref:`text` | "" | ++-----------------------------------------+-------------------------------------------------------+-------+ Theme Properties ---------------- @@ -117,6 +119,20 @@ Text alignment policy for the button's text, use one of the ``ALIGN_*`` constant When this property is enabled, text that is too large to fit the button is clipped, when disabled the Button will always be wide enough to hold the text. +.. _class_Button_property_expand_icon: + +- :ref:`bool` **expand_icon** + ++-----------+------------------------+ +| *Default* | false | ++-----------+------------------------+ +| *Setter* | set_expand_icon(value) | ++-----------+------------------------+ +| *Getter* | is_expand_icon() | ++-----------+------------------------+ + +When enabled, the button's icon will expand/shrink to fit the button's size while keeping its aspect. + .. _class_Button_property_flat: - :ref:`bool` **flat** diff --git a/classes/class_buttongroup.rst b/classes/class_buttongroup.rst index f11bb98da..8155dd50e 100644 --- a/classes/class_buttongroup.rst +++ b/classes/class_buttongroup.rst @@ -18,6 +18,13 @@ Brief Description Group of Buttons. +Properties +---------- + ++-------------------------+-------------------------+-------------+ +| :ref:`bool` | resource_local_to_scene | **O:** true | ++-------------------------+-------------------------+-------------+ + Methods ------- diff --git a/classes/class_camera2d.rst b/classes/class_camera2d.rst index 005808a59..e72ad3274 100644 --- a/classes/class_camera2d.rst +++ b/classes/class_camera2d.rst @@ -399,7 +399,7 @@ The camera's offset, useful for looking around or camera shake animations. The horizontal offset of the camera, relative to the drag margins. -**Note:** Offset H is used only to force offset relative to margins. It's not updated in any way if drag margins are enabled and can be used to set inital offset. +**Note:** Offset H is used only to force offset relative to margins. It's not updated in any way if drag margins are enabled and can be used to set initial offset. .. _class_Camera2D_property_offset_v: diff --git a/classes/class_cameratexture.rst b/classes/class_cameratexture.rst index 5f098a9a9..dc8156e54 100644 --- a/classes/class_cameratexture.rst +++ b/classes/class_cameratexture.rst @@ -23,13 +23,15 @@ This texture gives access to the camera texture provided by a :ref:`CameraFeed` | :ref:`camera_feed_id` | 0 | -+-----------------------------------------------+------------------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`camera_is_active` | false | -+-----------------------------------------------+------------------------------------------------------------------------+-------+ -| :ref:`FeedImage` | :ref:`which_feed` | 0 | -+-----------------------------------------------+------------------------------------------------------------------------+-------+ ++-----------------------------------------------+------------------------------------------------------------------------+----------+ +| :ref:`int` | :ref:`camera_feed_id` | 0 | ++-----------------------------------------------+------------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`camera_is_active` | false | ++-----------------------------------------------+------------------------------------------------------------------------+----------+ +| :ref:`int` | flags | **O:** 0 | ++-----------------------------------------------+------------------------------------------------------------------------+----------+ +| :ref:`FeedImage` | :ref:`which_feed` | 0 | ++-----------------------------------------------+------------------------------------------------------------------------+----------+ Property Descriptions --------------------- diff --git a/classes/class_charfxtransform.rst b/classes/class_charfxtransform.rst new file mode 100644 index 000000000..9501a5d58 --- /dev/null +++ b/classes/class_charfxtransform.rst @@ -0,0 +1,154 @@ +:github_url: hide + +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the CharFXTransform.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_CharFXTransform: + +CharFXTransform +=============== + +**Inherits:** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Properties +---------- + ++-------------------------------------+----------------------------------------------------------------------+---------------------+ +| :ref:`int` | :ref:`absolute_index` | 0 | ++-------------------------------------+----------------------------------------------------------------------+---------------------+ +| :ref:`int` | :ref:`character` | 0 | ++-------------------------------------+----------------------------------------------------------------------+---------------------+ +| :ref:`Color` | :ref:`color` | Color( 0, 0, 0, 1 ) | ++-------------------------------------+----------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`elapsed_time` | 0.0 | ++-------------------------------------+----------------------------------------------------------------------+---------------------+ +| :ref:`Dictionary` | :ref:`env` | {} | ++-------------------------------------+----------------------------------------------------------------------+---------------------+ +| :ref:`Vector2` | :ref:`offset` | Vector2( 0, 0 ) | ++-------------------------------------+----------------------------------------------------------------------+---------------------+ +| :ref:`int` | :ref:`relative_index` | 0 | ++-------------------------------------+----------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`visible` | true | ++-------------------------------------+----------------------------------------------------------------------+---------------------+ + +Methods +------- + ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_value_or` **(** :ref:`String` key, :ref:`Variant` default_value **)** | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Property Descriptions +--------------------- + +.. _class_CharFXTransform_property_absolute_index: + +- :ref:`int` **absolute_index** + ++-----------+---------------------------+ +| *Default* | 0 | ++-----------+---------------------------+ +| *Setter* | set_absolute_index(value) | ++-----------+---------------------------+ +| *Getter* | get_absolute_index() | ++-----------+---------------------------+ + +.. _class_CharFXTransform_property_character: + +- :ref:`int` **character** + ++-----------+----------------------+ +| *Default* | 0 | ++-----------+----------------------+ +| *Setter* | set_character(value) | ++-----------+----------------------+ +| *Getter* | get_character() | ++-----------+----------------------+ + +.. _class_CharFXTransform_property_color: + +- :ref:`Color` **color** + ++-----------+---------------------+ +| *Default* | Color( 0, 0, 0, 1 ) | ++-----------+---------------------+ +| *Setter* | set_color(value) | ++-----------+---------------------+ +| *Getter* | get_color() | ++-----------+---------------------+ + +.. _class_CharFXTransform_property_elapsed_time: + +- :ref:`float` **elapsed_time** + ++-----------+-------------------------+ +| *Default* | 0.0 | ++-----------+-------------------------+ +| *Setter* | set_elapsed_time(value) | ++-----------+-------------------------+ +| *Getter* | get_elapsed_time() | ++-----------+-------------------------+ + +.. _class_CharFXTransform_property_env: + +- :ref:`Dictionary` **env** + ++-----------+------------------------+ +| *Default* | {} | ++-----------+------------------------+ +| *Setter* | set_environment(value) | ++-----------+------------------------+ +| *Getter* | get_environment() | ++-----------+------------------------+ + +.. _class_CharFXTransform_property_offset: + +- :ref:`Vector2` **offset** + ++-----------+-------------------+ +| *Default* | Vector2( 0, 0 ) | ++-----------+-------------------+ +| *Setter* | set_offset(value) | ++-----------+-------------------+ +| *Getter* | get_offset() | ++-----------+-------------------+ + +.. _class_CharFXTransform_property_relative_index: + +- :ref:`int` **relative_index** + ++-----------+---------------------------+ +| *Default* | 0 | ++-----------+---------------------------+ +| *Setter* | set_relative_index(value) | ++-----------+---------------------------+ +| *Getter* | get_relative_index() | ++-----------+---------------------------+ + +.. _class_CharFXTransform_property_visible: + +- :ref:`bool` **visible** + ++-----------+-----------------------+ +| *Default* | true | ++-----------+-----------------------+ +| *Setter* | set_visibility(value) | ++-----------+-----------------------+ +| *Getter* | is_visible() | ++-----------+-----------------------+ + +Method Descriptions +------------------- + +.. _class_CharFXTransform_method_get_value_or: + +- :ref:`Variant` **get_value_or** **(** :ref:`String` key, :ref:`Variant` default_value **)** + diff --git a/classes/class_checkbox.rst b/classes/class_checkbox.rst index 6fddc3c85..9f617bc1c 100644 --- a/classes/class_checkbox.rst +++ b/classes/class_checkbox.rst @@ -18,6 +18,15 @@ Brief Description Binary choice user interface widget. +Properties +---------- + ++-----------------------------------------+-------------+-------------+ +| :ref:`TextAlign` | align | **O:** 0 | ++-----------------------------------------+-------------+-------------+ +| :ref:`bool` | toggle_mode | **O:** true | ++-----------------------------------------+-------------+-------------+ + Theme Properties ---------------- diff --git a/classes/class_checkbutton.rst b/classes/class_checkbutton.rst index d5b7b1747..9f3fd30b8 100644 --- a/classes/class_checkbutton.rst +++ b/classes/class_checkbutton.rst @@ -18,6 +18,15 @@ Brief Description Checkable button. +Properties +---------- + ++-----------------------------------------+-------------+-------------+ +| :ref:`TextAlign` | align | **O:** 0 | ++-----------------------------------------+-------------+-------------+ +| :ref:`bool` | toggle_mode | **O:** true | ++-----------------------------------------+-------------+-------------+ + Theme Properties ---------------- diff --git a/classes/class_colorpickerbutton.rst b/classes/class_colorpickerbutton.rst index a491fb243..591c06673 100644 --- a/classes/class_colorpickerbutton.rst +++ b/classes/class_colorpickerbutton.rst @@ -26,6 +26,8 @@ Properties +---------------------------+----------------------------------------------------------------+---------------------+ | :ref:`bool` | :ref:`edit_alpha` | true | +---------------------------+----------------------------------------------------------------+---------------------+ +| :ref:`bool` | toggle_mode | **O:** true | ++---------------------------+----------------------------------------------------------------+---------------------+ Methods ------- @@ -74,6 +76,10 @@ Signals Emitted when the color changes. +.. _class_ColorPickerButton_signal_picker_created: + +- **picker_created** **(** **)** + .. _class_ColorPickerButton_signal_popup_closed: - **popup_closed** **(** **)** diff --git a/classes/class_confirmationdialog.rst b/classes/class_confirmationdialog.rst index fd2da5723..8963d0f4a 100644 --- a/classes/class_confirmationdialog.rst +++ b/classes/class_confirmationdialog.rst @@ -20,6 +20,15 @@ Brief Description Dialog for confirmation of actions. +Properties +---------- + ++-------------------------------+---------------+----------------------------+ +| :ref:`Vector2` | rect_min_size | **O:** Vector2( 200, 70 ) | ++-------------------------------+---------------+----------------------------+ +| :ref:`String` | window_title | **O:** "Please Confirm..." | ++-------------------------------+---------------+----------------------------+ + Methods ------- diff --git a/classes/class_control.rst b/classes/class_control.rst index f35ecebde..6c583b9e4 100644 --- a/classes/class_control.rst +++ b/classes/class_control.rst @@ -1053,7 +1053,7 @@ Method Descriptions Virtual method to be implemented by the user. Returns whether :ref:`_gui_input` should not be called for children controls outside this control's rectangle. Input will be clipped to the Rect of this ``Control``. Similar to :ref:`rect_clip_content`, but doesn't affect visibility. -If not overriden, defaults to ``false``. +If not overridden, defaults to ``false``. .. _class_Control_method__get_minimum_size: @@ -1061,7 +1061,7 @@ If not overriden, defaults to ``false``. Virtual method to be implemented by the user. Returns the minimum size for this control. Alternative to :ref:`rect_min_size` for controlling minimum size via code. The actual minimum size will be the max value of these two (in each axis separately). -If not overriden, defaults to :ref:`Vector2.ZERO`. +If not overridden, defaults to :ref:`Vector2.ZERO`. .. _class_Control_method__gui_input: @@ -1341,7 +1341,7 @@ Returns the tooltip, which will appear when the cursor is resting over this cont - void **grab_click_focus** **(** **)** -Creates an :ref:`InputEventMouseButton` that attempts to click the control. If the event is received, the control aquires focus. +Creates an :ref:`InputEventMouseButton` that attempts to click the control. If the event is received, the control acquires focus. :: @@ -1414,7 +1414,7 @@ Returns ``true`` if icon with given ``name`` has a valid override in this ``Cont Virtual method to be implemented by the user. Returns whether the given ``point`` is inside this control. -If not overriden, default behavior is checking if the point is within control's Rect. +If not overridden, default behavior is checking if the point is within control's Rect. **Node:** If you want to check if a point is inside the control, you can use ``get_rect().has_point(point)``. @@ -1456,7 +1456,7 @@ Sets the anchor identified by ``margin`` constant from :ref:`Margin` | :ref:`directional_shadow_bias_split_scale` | 0.25 | -+-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`directional_shadow_blend_splits` | false | -+-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+-------+ -| :ref:`ShadowDepthRange` | :ref:`directional_shadow_depth_range` | 0 | -+-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+-------+ -| :ref:`float` | :ref:`directional_shadow_max_distance` | 100.0 | -+-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+-------+ -| :ref:`ShadowMode` | :ref:`directional_shadow_mode` | 2 | -+-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+-------+ -| :ref:`float` | :ref:`directional_shadow_normal_bias` | 0.8 | -+-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+-------+ -| :ref:`float` | :ref:`directional_shadow_split_1` | 0.1 | -+-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+-------+ -| :ref:`float` | :ref:`directional_shadow_split_2` | 0.2 | -+-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+-------+ -| :ref:`float` | :ref:`directional_shadow_split_3` | 0.5 | -+-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+-------+ ++-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+------------+ +| :ref:`float` | :ref:`directional_shadow_bias_split_scale` | 0.25 | ++-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+------------+ +| :ref:`bool` | :ref:`directional_shadow_blend_splits` | false | ++-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+------------+ +| :ref:`ShadowDepthRange` | :ref:`directional_shadow_depth_range` | 0 | ++-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+------------+ +| :ref:`float` | :ref:`directional_shadow_max_distance` | 100.0 | ++-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+------------+ +| :ref:`ShadowMode` | :ref:`directional_shadow_mode` | 2 | ++-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+------------+ +| :ref:`float` | :ref:`directional_shadow_normal_bias` | 0.8 | ++-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+------------+ +| :ref:`float` | :ref:`directional_shadow_split_1` | 0.1 | ++-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+------------+ +| :ref:`float` | :ref:`directional_shadow_split_2` | 0.2 | ++-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+------------+ +| :ref:`float` | :ref:`directional_shadow_split_3` | 0.5 | ++-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+------------+ +| :ref:`float` | shadow_bias | **O:** 0.1 | ++-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+------------+ Enumerations ------------ diff --git a/classes/class_editorfeatureprofile.rst b/classes/class_editorfeatureprofile.rst index db5bf6fd3..9b6c680a6 100644 --- a/classes/class_editorfeatureprofile.rst +++ b/classes/class_editorfeatureprofile.rst @@ -21,29 +21,29 @@ Brief Description Methods ------- -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_feature_name` **(** :ref:`Feature` feature **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_class_disabled` **(** :ref:`String` class_name **)** const | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_class_editor_disabled` **(** :ref:`String` class_name **)** const | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_class_property_disabled` **(** :ref:`String` class_name, :ref:`String` arg1 **)** const | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_feature_disabled` **(** :ref:`Feature` feature **)** const | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`load_from_file` **(** :ref:`String` path **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`save_to_file` **(** :ref:`String` path **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_disable_class` **(** :ref:`String` class_name, :ref:`bool` disable **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_disable_class_editor` **(** :ref:`String` class_name, :ref:`bool` disable **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_disable_class_property` **(** :ref:`String` class_name, :ref:`String` property, :ref:`bool` arg2 **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_disable_feature` **(** :ref:`Feature` feature, :ref:`bool` disable **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_feature_name` **(** :ref:`Feature` feature **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_class_disabled` **(** :ref:`String` class_name **)** const | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_class_editor_disabled` **(** :ref:`String` class_name **)** const | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_class_property_disabled` **(** :ref:`String` class_name, :ref:`String` property **)** const | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_feature_disabled` **(** :ref:`Feature` feature **)** const | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`load_from_file` **(** :ref:`String` path **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`save_to_file` **(** :ref:`String` path **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_disable_class` **(** :ref:`String` class_name, :ref:`bool` disable **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_disable_class_editor` **(** :ref:`String` class_name, :ref:`bool` disable **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_disable_class_property` **(** :ref:`String` class_name, :ref:`String` property, :ref:`bool` disable **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_disable_feature` **(** :ref:`Feature` feature, :ref:`bool` disable **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ @@ -101,7 +101,7 @@ Method Descriptions .. _class_EditorFeatureProfile_method_is_class_property_disabled: -- :ref:`bool` **is_class_property_disabled** **(** :ref:`String` class_name, :ref:`String` arg1 **)** const +- :ref:`bool` **is_class_property_disabled** **(** :ref:`String` class_name, :ref:`String` property **)** const .. _class_EditorFeatureProfile_method_is_feature_disabled: @@ -125,7 +125,7 @@ Method Descriptions .. _class_EditorFeatureProfile_method_set_disable_class_property: -- void **set_disable_class_property** **(** :ref:`String` class_name, :ref:`String` property, :ref:`bool` arg2 **)** +- void **set_disable_class_property** **(** :ref:`String` class_name, :ref:`String` property, :ref:`bool` disable **)** .. _class_EditorFeatureProfile_method_set_disable_feature: diff --git a/classes/class_editorfiledialog.rst b/classes/class_editorfiledialog.rst index e0e487c99..0ccbe1eb2 100644 --- a/classes/class_editorfiledialog.rst +++ b/classes/class_editorfiledialog.rst @@ -21,23 +21,29 @@ Brief Description Properties ---------- -+-------------------------------------------------------+---------------------------------------------------------------------------------------------+----------+ -| :ref:`Access` | :ref:`access` | 0 | -+-------------------------------------------------------+---------------------------------------------------------------------------------------------+----------+ -| :ref:`String` | :ref:`current_dir` | "res://" | -+-------------------------------------------------------+---------------------------------------------------------------------------------------------+----------+ -| :ref:`String` | :ref:`current_file` | "" | -+-------------------------------------------------------+---------------------------------------------------------------------------------------------+----------+ -| :ref:`String` | :ref:`current_path` | "res://" | -+-------------------------------------------------------+---------------------------------------------------------------------------------------------+----------+ -| :ref:`bool` | :ref:`disable_overwrite_warning` | false | -+-------------------------------------------------------+---------------------------------------------------------------------------------------------+----------+ -| :ref:`DisplayMode` | :ref:`display_mode` | 0 | -+-------------------------------------------------------+---------------------------------------------------------------------------------------------+----------+ -| :ref:`Mode` | :ref:`mode` | 4 | -+-------------------------------------------------------+---------------------------------------------------------------------------------------------+----------+ -| :ref:`bool` | :ref:`show_hidden_files` | false | -+-------------------------------------------------------+---------------------------------------------------------------------------------------------+----------+ ++-------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------+ +| :ref:`Access` | :ref:`access` | 0 | ++-------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------+ +| :ref:`String` | :ref:`current_dir` | "res://" | ++-------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------+ +| :ref:`String` | :ref:`current_file` | "" | ++-------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------+ +| :ref:`String` | :ref:`current_path` | "res://" | ++-------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------+ +| :ref:`bool` | dialog_hide_on_ok | **O:** false | ++-------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------+ +| :ref:`bool` | :ref:`disable_overwrite_warning` | false | ++-------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------+ +| :ref:`DisplayMode` | :ref:`display_mode` | 0 | ++-------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------+ +| :ref:`Mode` | :ref:`mode` | 4 | ++-------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------+ +| :ref:`bool` | resizable | **O:** true | ++-------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------+ +| :ref:`bool` | :ref:`show_hidden_files` | false | ++-------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------+ +| :ref:`String` | window_title | **O:** "Save a File" | ++-------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------+ Methods ------- diff --git a/classes/class_editorinspector.rst b/classes/class_editorinspector.rst index 965190779..3cb5bcbc3 100644 --- a/classes/class_editorinspector.rst +++ b/classes/class_editorinspector.rst @@ -18,6 +18,13 @@ Brief Description +Properties +---------- + ++-------------------------+---------------------------+--------------+ +| :ref:`bool` | scroll_horizontal_enabled | **O:** false | ++-------------------------+---------------------------+--------------+ + Methods ------- diff --git a/classes/class_editorinterface.rst b/classes/class_editorinterface.rst index 74d2e40ac..2d89dea83 100644 --- a/classes/class_editorinterface.rst +++ b/classes/class_editorinterface.rst @@ -26,6 +26,8 @@ Methods +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Control` | :ref:`get_base_control` **(** **)** | +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_current_path` **(** **)** const | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Node` | :ref:`get_edited_scene_root` **(** **)** | +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`EditorSettings` | :ref:`get_editor_settings` **(** **)** | @@ -89,6 +91,10 @@ Edits the given :ref:`Resource`. Returns the main container of Godot editor's window. You can use it, for example, to retrieve the size of the container and place your controls accordingly. +.. _class_EditorInterface_method_get_current_path: + +- :ref:`String` **get_current_path** **(** **)** const + .. _class_EditorInterface_method_get_edited_scene_root: - :ref:`Node` **get_edited_scene_root** **(** **)** diff --git a/classes/class_editorspatialgizmo.rst b/classes/class_editorspatialgizmo.rst index 3ec59d8fd..bbb9cc3d6 100644 --- a/classes/class_editorspatialgizmo.rst +++ b/classes/class_editorspatialgizmo.rst @@ -30,7 +30,7 @@ Methods +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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, :ref:`Material` material=null **)** | +| void | :ref:`add_mesh` **(** :ref:`ArrayMesh` mesh, :ref:`bool` billboard=false, :ref:`SkinReference` skeleton, :ref:`Material` material=null **)** | +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_unscaled_billboard` **(** :ref:`Material` material, :ref:`float` default_scale=1 **)** | +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -91,7 +91,7 @@ Adds lines to the gizmo (as sets of 2 points), with a given material. The lines .. _class_EditorSpatialGizmo_method_add_mesh: -- void **add_mesh** **(** :ref:`ArrayMesh` mesh, :ref:`bool` billboard=false, :ref:`RID` skeleton, :ref:`Material` material=null **)** +- void **add_mesh** **(** :ref:`ArrayMesh` mesh, :ref:`bool` billboard=false, :ref:`SkinReference` skeleton, :ref:`Material` material=null **)** .. _class_EditorSpatialGizmo_method_add_unscaled_billboard: diff --git a/classes/class_editorvcsinterface.rst b/classes/class_editorvcsinterface.rst new file mode 100644 index 000000000..301e013b7 --- /dev/null +++ b/classes/class_editorvcsinterface.rst @@ -0,0 +1,147 @@ +:github_url: hide + +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the EditorVCSInterface.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_EditorVCSInterface: + +EditorVCSInterface +================== + +**Inherits:** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + +Version Control System (VCS) interface which reads and writes to the local VCS in use. + +Methods +------- + ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`commit` **(** :ref:`String` msg **)** | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_file_diff` **(** :ref:`String` file_path **)** | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_is_vcs_intialized` **(** **)** | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_modified_files_data` **(** **)** | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_project_name` **(** **)** | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_vcs_name` **(** **)** | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`initialize` **(** :ref:`String` project_root_path **)** | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_addon_ready` **(** **)** | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`shut_down` **(** **)** | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`stage_file` **(** :ref:`String` file_path **)** | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`unstage_file` **(** :ref:`String` file_path **)** | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ + +Description +----------- + +Used by the editor to display VCS extracted information in the editor. The implementation of this API is included in VCS addons, which are essentially GDNative plugins that need to be put into the project folder. These VCS addons are scripts which are attached (on demand) to the object instance of ``EditorVCSInterface``. All the functions listed below, instead of performing the task themselves, they call the internally defined functions in the VCS addons to provide a plug-n-play experience. + +Method Descriptions +------------------- + +.. _class_EditorVCSInterface_method_commit: + +- void **commit** **(** :ref:`String` msg **)** + +Creates a version commit if the addon is initialized, else returns without doing anything. Uses the files which have been staged previously, with the commit message set to a value as provided as in the argument. + +.. _class_EditorVCSInterface_method_get_file_diff: + +- :ref:`Array` **get_file_diff** **(** :ref:`String` file_path **)** + +Returns an :ref:`Array` of :ref:`Dictionary` objects containing the diff output from the VCS in use, if a VCS addon is initialized, else returns an empty :ref:`Array` object. The diff contents also consist of some contextual lines which provide context to the observed line change in the file. + +Each :ref:`Dictionary` object has the line diff contents under the keys: + +- ``"content"`` to store a :ref:`String` containing the line contents + +- ``"status"`` to store a :ref:`String` which contains ``"+"`` in case the content is a line addition but it stores a ``"-"`` in case of deletion and an empty string in the case the line content is neither an addition nor a deletion. + +- ``"new_line_number"`` to store an integer containing the new line number of the line content. + +- ``"line_count"`` to store an integer containing the number of lines in the line content. + +- ``"old_line_number"`` to store an integer containing the old line number of the line content. + +- ``"offset"`` to store the offset of the line change since the first contextual line content. + +.. _class_EditorVCSInterface_method_get_is_vcs_intialized: + +- :ref:`bool` **get_is_vcs_intialized** **(** **)** + +Returns ``true`` if the VCS addon has been initialized, else returns ``false``. + +.. _class_EditorVCSInterface_method_get_modified_files_data: + +- :ref:`Dictionary` **get_modified_files_data** **(** **)** + +Returns a :ref:`Dictionary` containing the path of the detected file change mapped to an integer signifying what kind of a change the corresponding file has experienced. + +The following integer values are being used to signify that the detected file is: + +- ``0``: New to the VCS working directory + +- ``1``: Modified + +- ``2``: Renamed + +- ``3``: Deleted + +- ``4``: Typechanged + +.. _class_EditorVCSInterface_method_get_project_name: + +- :ref:`String` **get_project_name** **(** **)** + +Return the project name of the VCS working directory + +.. _class_EditorVCSInterface_method_get_vcs_name: + +- :ref:`String` **get_vcs_name** **(** **)** + +Return the name of the VCS if the VCS has been initialized, else return an empty string. + +.. _class_EditorVCSInterface_method_initialize: + +- :ref:`bool` **initialize** **(** :ref:`String` project_root_path **)** + +Initialize the VCS addon if not already. Uses the argument value as the path to the working directory of the project. Creates the initial commit if required. Returns ``true`` if no failure occurs, else returns ``false``. + +.. _class_EditorVCSInterface_method_is_addon_ready: + +- :ref:`bool` **is_addon_ready** **(** **)** + +Returns ``true`` if the addon is ready to respond to function calls, else returns ``false``. + +.. _class_EditorVCSInterface_method_shut_down: + +- :ref:`bool` **shut_down** **(** **)** + +Shuts down the VCS addon to allow cleanup code to run on call. Returns ``true`` is no failure occurs, else returns ``false``. + +.. _class_EditorVCSInterface_method_stage_file: + +- void **stage_file** **(** :ref:`String` file_path **)** + +Stage the file which should be committed when :ref:`commit` is called. Argument should contain the absolute path. + +.. _class_EditorVCSInterface_method_unstage_file: + +- void **unstage_file** **(** :ref:`String` file_path **)** + +Unstage the file which was staged previously to be committed, so that it is no longer committed when :ref:`commit` is called. Argument should contain the absolute path. + diff --git a/classes/class_environment.rst b/classes/class_environment.rst index 82f07c9a3..9e1259ec2 100644 --- a/classes/class_environment.rst +++ b/classes/class_environment.rst @@ -271,7 +271,7 @@ enum **GlowBlendMode**: enum **ToneMapper**: -- **TONE_MAPPER_LINEAR** = **0** --- Linear tonemapper operator. Reads the linear data and performs an exposure adjustment. +- **TONE_MAPPER_LINEAR** = **0** --- Linear tonemapper operator. Reads the linear data and passes it on unmodified. - **TONE_MAPPER_REINHARDT** = **1** --- Reinhardt tonemapper operator. Performs a variation on rendered pixels' colors by this formula: ``color = color / (1 + color)``. diff --git a/classes/class_filedialog.rst b/classes/class_filedialog.rst index c4dd6b8b1..981d54200 100644 --- a/classes/class_filedialog.rst +++ b/classes/class_filedialog.rst @@ -21,23 +21,27 @@ Dialog for selecting files or directories in the filesystem. Properties ---------- -+-----------------------------------------------+-----------------------------------------------------------------------------+---------------------+ -| :ref:`Access` | :ref:`access` | 0 | -+-----------------------------------------------+-----------------------------------------------------------------------------+---------------------+ -| :ref:`String` | :ref:`current_dir` | "res://" | -+-----------------------------------------------+-----------------------------------------------------------------------------+---------------------+ -| :ref:`String` | :ref:`current_file` | "" | -+-----------------------------------------------+-----------------------------------------------------------------------------+---------------------+ -| :ref:`String` | :ref:`current_path` | "res://" | -+-----------------------------------------------+-----------------------------------------------------------------------------+---------------------+ -| :ref:`PoolStringArray` | :ref:`filters` | PoolStringArray( ) | -+-----------------------------------------------+-----------------------------------------------------------------------------+---------------------+ -| :ref:`Mode` | :ref:`mode` | 4 | -+-----------------------------------------------+-----------------------------------------------------------------------------+---------------------+ -| :ref:`bool` | :ref:`mode_overrides_title` | true | -+-----------------------------------------------+-----------------------------------------------------------------------------+---------------------+ -| :ref:`bool` | :ref:`show_hidden_files` | false | -+-----------------------------------------------+-----------------------------------------------------------------------------+---------------------+ ++-----------------------------------------------+-----------------------------------------------------------------------------+----------------------+ +| :ref:`Access` | :ref:`access` | 0 | ++-----------------------------------------------+-----------------------------------------------------------------------------+----------------------+ +| :ref:`String` | :ref:`current_dir` | "res://" | ++-----------------------------------------------+-----------------------------------------------------------------------------+----------------------+ +| :ref:`String` | :ref:`current_file` | "" | ++-----------------------------------------------+-----------------------------------------------------------------------------+----------------------+ +| :ref:`String` | :ref:`current_path` | "res://" | ++-----------------------------------------------+-----------------------------------------------------------------------------+----------------------+ +| :ref:`bool` | dialog_hide_on_ok | **O:** false | ++-----------------------------------------------+-----------------------------------------------------------------------------+----------------------+ +| :ref:`PoolStringArray` | :ref:`filters` | PoolStringArray( ) | ++-----------------------------------------------+-----------------------------------------------------------------------------+----------------------+ +| :ref:`Mode` | :ref:`mode` | 4 | ++-----------------------------------------------+-----------------------------------------------------------------------------+----------------------+ +| :ref:`bool` | :ref:`mode_overrides_title` | true | ++-----------------------------------------------+-----------------------------------------------------------------------------+----------------------+ +| :ref:`bool` | :ref:`show_hidden_files` | false | ++-----------------------------------------------+-----------------------------------------------------------------------------+----------------------+ +| :ref:`String` | window_title | **O:** "Save a File" | ++-----------------------------------------------+-----------------------------------------------------------------------------+----------------------+ Methods ------- diff --git a/classes/class_graphedit.rst b/classes/class_graphedit.rst index a5e8a4973..5fac4167b 100644 --- a/classes/class_graphedit.rst +++ b/classes/class_graphedit.rst @@ -21,17 +21,21 @@ GraphEdit is an area capable of showing various GraphNodes. It manages connectio Properties ---------- -+-------------------------------+----------------------------------------------------------------------+-----------------+ -| :ref:`bool` | :ref:`right_disconnects` | false | -+-------------------------------+----------------------------------------------------------------------+-----------------+ -| :ref:`Vector2` | :ref:`scroll_offset` | Vector2( 0, 0 ) | -+-------------------------------+----------------------------------------------------------------------+-----------------+ -| :ref:`int` | :ref:`snap_distance` | 20 | -+-------------------------------+----------------------------------------------------------------------+-----------------+ -| :ref:`bool` | :ref:`use_snap` | true | -+-------------------------------+----------------------------------------------------------------------+-----------------+ -| :ref:`float` | :ref:`zoom` | 1.0 | -+-------------------------------+----------------------------------------------------------------------+-----------------+ ++------------------------------------------+----------------------------------------------------------------------+-----------------+ +| :ref:`FocusMode` | focus_mode | **O:** 2 | ++------------------------------------------+----------------------------------------------------------------------+-----------------+ +| :ref:`bool` | rect_clip_content | **O:** true | ++------------------------------------------+----------------------------------------------------------------------+-----------------+ +| :ref:`bool` | :ref:`right_disconnects` | false | ++------------------------------------------+----------------------------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`scroll_offset` | Vector2( 0, 0 ) | ++------------------------------------------+----------------------------------------------------------------------+-----------------+ +| :ref:`int` | :ref:`snap_distance` | 20 | ++------------------------------------------+----------------------------------------------------------------------+-----------------+ +| :ref:`bool` | :ref:`use_snap` | true | ++------------------------------------------+----------------------------------------------------------------------+-----------------+ +| :ref:`float` | :ref:`zoom` | 1.0 | ++------------------------------------------+----------------------------------------------------------------------+-----------------+ Methods ------- diff --git a/classes/class_graphnode.rst b/classes/class_graphnode.rst index 491576e83..399f310f1 100644 --- a/classes/class_graphnode.rst +++ b/classes/class_graphnode.rst @@ -189,6 +189,8 @@ Property Descriptions | *Getter* | is_comment() | +-----------+--------------------+ +If ``true``, the GraphNode is a comment node. + .. _class_GraphNode_property_offset: - :ref:`Vector2` **offset** diff --git a/classes/class_gridcontainer.rst b/classes/class_gridcontainer.rst index fb64806dd..e6cd486e0 100644 --- a/classes/class_gridcontainer.rst +++ b/classes/class_gridcontainer.rst @@ -21,9 +21,11 @@ Grid container used to arrange elements in a grid like layout. Properties ---------- -+-----------------------+------------------------------------------------------+---+ -| :ref:`int` | :ref:`columns` | 1 | -+-----------------------+------------------------------------------------------+---+ ++----------------------------------------------+------------------------------------------------------+----------+ +| :ref:`int` | :ref:`columns` | 1 | ++----------------------------------------------+------------------------------------------------------+----------+ +| :ref:`MouseFilter` | mouse_filter | **O:** 1 | ++----------------------------------------------+------------------------------------------------------+----------+ Theme Properties ---------------- diff --git a/classes/class_image.rst b/classes/class_image.rst index dc9214e50..daad23886 100644 --- a/classes/class_image.rst +++ b/classes/class_image.rst @@ -577,12 +577,14 @@ Returns the offset where the image's mipmap with index ``mipmap`` is stored in t - :ref:`Color` **get_pixel** **(** :ref:`int` x, :ref:`int` y **)** const -Returns the color of the pixel at ``(x, y)`` if the image is locked. If the image is unlocked it always returns a :ref:`Color` with the value ``(0, 0, 0, 1.0)``. +Returns the color of the pixel at ``(x, y)`` if the image is locked. If the image is unlocked, it always returns a :ref:`Color` with the value ``(0, 0, 0, 1.0)``. This is the same as :ref:`get_pixelv`, but two integer arguments instead of a Vector2 argument. .. _class_Image_method_get_pixelv: - :ref:`Color` **get_pixelv** **(** :ref:`Vector2` src **)** const +Returns the color of the pixel at ``src`` if the image is locked. If the image is unlocked, it always returns a :ref:`Color` with the value ``(0, 0, 0, 1.0)``. This is the same as :ref:`get_pixel`, but with a Vector2 argument instead of two integer arguments. + .. _class_Image_method_get_rect: - :ref:`Image` **get_rect** **(** :ref:`Rect2` rect **)** const @@ -693,7 +695,7 @@ Resizes the image to the nearest power of 2 for the width and height. If ``squar - :ref:`Error` **save_exr** **(** :ref:`String` path, :ref:`bool` grayscale=false **)** const -Saves the image as an EXR file to ``path``. If grayscale is true and the image has only one channel, it will be saved explicitely as monochrome rather than one red channel. This function will return :ref:`@GlobalScope.ERR_UNAVAILABLE` if Godot was compiled without the TinyEXR module. +Saves the image as an EXR file to ``path``. If grayscale is true and the image has only one channel, it will be saved explicitly as monochrome rather than one red channel. This function will return :ref:`@GlobalScope.ERR_UNAVAILABLE` if Godot was compiled without the TinyEXR module. .. _class_Image_method_save_png: diff --git a/classes/class_imagetexture.rst b/classes/class_imagetexture.rst index d08fd1358..6b357c613 100644 --- a/classes/class_imagetexture.rst +++ b/classes/class_imagetexture.rst @@ -21,11 +21,13 @@ A :ref:`Texture` based on an :ref:`Image`. Properties ---------- -+-------------------------------------------+-----------------------------------------------------------------+-----+ -| :ref:`float` | :ref:`lossy_quality` | 0.7 | -+-------------------------------------------+-----------------------------------------------------------------+-----+ -| :ref:`Storage` | :ref:`storage` | 0 | -+-------------------------------------------+-----------------------------------------------------------------+-----+ ++-------------------------------------------+-----------------------------------------------------------------+----------+ +| :ref:`int` | flags | **O:** 7 | ++-------------------------------------------+-----------------------------------------------------------------+----------+ +| :ref:`float` | :ref:`lossy_quality` | 0.7 | ++-------------------------------------------+-----------------------------------------------------------------+----------+ +| :ref:`Storage` | :ref:`storage` | 0 | ++-------------------------------------------+-----------------------------------------------------------------+----------+ Methods ------- diff --git a/classes/class_input.rst b/classes/class_input.rst index bc5e1f4cd..625086250 100644 --- a/classes/class_input.rst +++ b/classes/class_input.rst @@ -376,7 +376,7 @@ Returns ``true`` when the user stops pressing the action event, meaning it's ``t - :ref:`bool` **is_action_pressed** **(** :ref:`String` action **)** const -Returns ``true`` if you are pressing the action event. Note that if an action has multiple buttons asigned and more than one of them is pressed, releasing one button will release the action, even if some other button assigned to this action is still pressed. +Returns ``true`` if you are pressing the action event. Note that if an action has multiple buttons assigned and more than one of them is pressed, releasing one button will release the action, even if some other button assigned to this action is still pressed. .. _class_Input_method_is_joy_button_pressed: @@ -437,6 +437,10 @@ Sets a custom mouse cursor image, which is only visible inside the game window. ``hotspot`` must be within ``image``'s size. +**Note:** :ref:`AnimatedTexture`\ s aren't supported as custom mouse cursors. If using an :ref:`AnimatedTexture`, only the first frame will be displayed. + +**Note:** Only images imported with the **Lossless**, **Lossy** or **Uncompressed** compression modes are supported. The **Video RAM** compression mode can't be used for custom cursors. + .. _class_Input_method_set_default_cursor_shape: - void **set_default_cursor_shape** **(** :ref:`CursorShape` shape=0 **)** diff --git a/classes/class_itemlist.rst b/classes/class_itemlist.rst index 42e420b79..1af702f7c 100644 --- a/classes/class_itemlist.rst +++ b/classes/class_itemlist.rst @@ -32,6 +32,8 @@ Properties +---------------------------------------------+-----------------------------------------------------------------------+-----------------+ | :ref:`Vector2` | :ref:`fixed_icon_size` | Vector2( 0, 0 ) | +---------------------------------------------+-----------------------------------------------------------------------+-----------------+ +| :ref:`FocusMode` | focus_mode | **O:** 2 | ++---------------------------------------------+-----------------------------------------------------------------------+-----------------+ | :ref:`IconMode` | :ref:`icon_mode` | 1 | +---------------------------------------------+-----------------------------------------------------------------------+-----------------+ | :ref:`float` | :ref:`icon_scale` | 1.0 | @@ -40,6 +42,8 @@ Properties +---------------------------------------------+-----------------------------------------------------------------------+-----------------+ | :ref:`int` | :ref:`max_text_lines` | 1 | +---------------------------------------------+-----------------------------------------------------------------------+-----------------+ +| :ref:`bool` | rect_clip_content | **O:** true | ++---------------------------------------------+-----------------------------------------------------------------------+-----------------+ | :ref:`bool` | :ref:`same_column_width` | false | +---------------------------------------------+-----------------------------------------------------------------------+-----------------+ | :ref:`SelectMode` | :ref:`select_mode` | 0 | diff --git a/classes/class_label.rst b/classes/class_label.rst index 6c394aa10..4d6b12350 100644 --- a/classes/class_label.rst +++ b/classes/class_label.rst @@ -21,27 +21,31 @@ Displays plain text in a line or wrapped inside a rectangle. For formatted text, Properties ---------- -+----------------------------------+--------------------------------------------------------------------+-------+ -| :ref:`Align` | :ref:`align` | 0 | -+----------------------------------+--------------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`autowrap` | false | -+----------------------------------+--------------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`clip_text` | false | -+----------------------------------+--------------------------------------------------------------------+-------+ -| :ref:`int` | :ref:`lines_skipped` | 0 | -+----------------------------------+--------------------------------------------------------------------+-------+ -| :ref:`int` | :ref:`max_lines_visible` | -1 | -+----------------------------------+--------------------------------------------------------------------+-------+ -| :ref:`float` | :ref:`percent_visible` | 1.0 | -+----------------------------------+--------------------------------------------------------------------+-------+ -| :ref:`String` | :ref:`text` | "" | -+----------------------------------+--------------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`uppercase` | false | -+----------------------------------+--------------------------------------------------------------------+-------+ -| :ref:`VAlign` | :ref:`valign` | 0 | -+----------------------------------+--------------------------------------------------------------------+-------+ -| :ref:`int` | :ref:`visible_characters` | -1 | -+----------------------------------+--------------------------------------------------------------------+-------+ ++----------------------------------------------+--------------------------------------------------------------------+----------+ +| :ref:`Align` | :ref:`align` | 0 | ++----------------------------------------------+--------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`autowrap` | false | ++----------------------------------------------+--------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`clip_text` | false | ++----------------------------------------------+--------------------------------------------------------------------+----------+ +| :ref:`int` | :ref:`lines_skipped` | 0 | ++----------------------------------------------+--------------------------------------------------------------------+----------+ +| :ref:`int` | :ref:`max_lines_visible` | -1 | ++----------------------------------------------+--------------------------------------------------------------------+----------+ +| :ref:`MouseFilter` | mouse_filter | **O:** 2 | ++----------------------------------------------+--------------------------------------------------------------------+----------+ +| :ref:`float` | :ref:`percent_visible` | 1.0 | ++----------------------------------------------+--------------------------------------------------------------------+----------+ +| :ref:`int` | size_flags_vertical | **O:** 4 | ++----------------------------------------------+--------------------------------------------------------------------+----------+ +| :ref:`String` | :ref:`text` | "" | ++----------------------------------------------+--------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`uppercase` | false | ++----------------------------------------------+--------------------------------------------------------------------+----------+ +| :ref:`VAlign` | :ref:`valign` | 0 | ++----------------------------------------------+--------------------------------------------------------------------+----------+ +| :ref:`int` | :ref:`visible_characters` | -1 | ++----------------------------------------------+--------------------------------------------------------------------+----------+ Methods ------- diff --git a/classes/class_largetexture.rst b/classes/class_largetexture.rst index fd144a880..0f9db2c44 100644 --- a/classes/class_largetexture.rst +++ b/classes/class_largetexture.rst @@ -18,6 +18,13 @@ Brief Description A :ref:`Texture` capable of storing many smaller textures with offsets. +Properties +---------- + ++-----------------------+-------+----------+ +| :ref:`int` | flags | **O:** 0 | ++-----------------------+-------+----------+ + Methods ------- diff --git a/classes/class_lineedit.rst b/classes/class_lineedit.rst index 77e330b50..4696a8b34 100644 --- a/classes/class_lineedit.rst +++ b/classes/class_lineedit.rst @@ -21,37 +21,45 @@ Control that provides single-line string editing. Properties ---------- -+------------------------------------------+-----------------------------------------------------------------------------+-------+ -| :ref:`Align` | :ref:`align` | 0 | -+------------------------------------------+-----------------------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`caret_blink` | false | -+------------------------------------------+-----------------------------------------------------------------------------+-------+ -| :ref:`float` | :ref:`caret_blink_speed` | 0.65 | -+------------------------------------------+-----------------------------------------------------------------------------+-------+ -| :ref:`int` | :ref:`caret_position` | 0 | -+------------------------------------------+-----------------------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`clear_button_enabled` | false | -+------------------------------------------+-----------------------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`context_menu_enabled` | true | -+------------------------------------------+-----------------------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`editable` | true | -+------------------------------------------+-----------------------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`expand_to_text_length` | false | -+------------------------------------------+-----------------------------------------------------------------------------+-------+ -| :ref:`FocusMode` | :ref:`focus_mode` | 2 | -+------------------------------------------+-----------------------------------------------------------------------------+-------+ -| :ref:`int` | :ref:`max_length` | 0 | -+------------------------------------------+-----------------------------------------------------------------------------+-------+ -| :ref:`float` | :ref:`placeholder_alpha` | 0.6 | -+------------------------------------------+-----------------------------------------------------------------------------+-------+ -| :ref:`String` | :ref:`placeholder_text` | "" | -+------------------------------------------+-----------------------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`secret` | false | -+------------------------------------------+-----------------------------------------------------------------------------+-------+ -| :ref:`String` | :ref:`secret_character` | "*" | -+------------------------------------------+-----------------------------------------------------------------------------+-------+ -| :ref:`String` | :ref:`text` | "" | -+------------------------------------------+-----------------------------------------------------------------------------+-------+ ++----------------------------------------------+-----------------------------------------------------------------------------+----------+ +| :ref:`Align` | :ref:`align` | 0 | ++----------------------------------------------+-----------------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`caret_blink` | false | ++----------------------------------------------+-----------------------------------------------------------------------------+----------+ +| :ref:`float` | :ref:`caret_blink_speed` | 0.65 | ++----------------------------------------------+-----------------------------------------------------------------------------+----------+ +| :ref:`int` | :ref:`caret_position` | 0 | ++----------------------------------------------+-----------------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`clear_button_enabled` | false | ++----------------------------------------------+-----------------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`context_menu_enabled` | true | ++----------------------------------------------+-----------------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`editable` | true | ++----------------------------------------------+-----------------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`expand_to_text_length` | false | ++----------------------------------------------+-----------------------------------------------------------------------------+----------+ +| :ref:`FocusMode` | focus_mode | **O:** 2 | ++----------------------------------------------+-----------------------------------------------------------------------------+----------+ +| :ref:`int` | :ref:`max_length` | 0 | ++----------------------------------------------+-----------------------------------------------------------------------------+----------+ +| :ref:`CursorShape` | mouse_default_cursor_shape | **O:** 1 | ++----------------------------------------------+-----------------------------------------------------------------------------+----------+ +| :ref:`float` | :ref:`placeholder_alpha` | 0.6 | ++----------------------------------------------+-----------------------------------------------------------------------------+----------+ +| :ref:`String` | :ref:`placeholder_text` | "" | ++----------------------------------------------+-----------------------------------------------------------------------------+----------+ +| :ref:`Texture` | :ref:`right_icon` | | ++----------------------------------------------+-----------------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`secret` | false | ++----------------------------------------------+-----------------------------------------------------------------------------+----------+ +| :ref:`String` | :ref:`secret_character` | "*" | ++----------------------------------------------+-----------------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`selecting_enabled` | true | ++----------------------------------------------+-----------------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`shortcut_keys_enabled` | true | ++----------------------------------------------+-----------------------------------------------------------------------------+----------+ +| :ref:`String` | :ref:`text` | "" | ++----------------------------------------------+-----------------------------------------------------------------------------+----------+ Methods ------- @@ -317,20 +325,6 @@ If ``false``, existing text cannot be modified and new text cannot be added. If ``true``, the ``LineEdit`` width will increase to stay longer than the :ref:`text`. It will **not** compress if the :ref:`text` is shortened. -.. _class_LineEdit_property_focus_mode: - -- :ref:`FocusMode` **focus_mode** - -+-----------+-----------------------+ -| *Default* | 2 | -+-----------+-----------------------+ -| *Setter* | set_focus_mode(value) | -+-----------+-----------------------+ -| *Getter* | get_focus_mode() | -+-----------+-----------------------+ - -Defines how the ``LineEdit`` can grab focus (Keyboard and mouse, only keyboard, or none). See :ref:`FocusMode` for details. - .. _class_LineEdit_property_max_length: - :ref:`int` **max_length** @@ -373,6 +367,18 @@ Opacity of the :ref:`placeholder_text` Text shown when the ``LineEdit`` is empty. It is **not** the ``LineEdit``'s default value (see :ref:`text`). +.. _class_LineEdit_property_right_icon: + +- :ref:`Texture` **right_icon** + ++----------+-----------------------+ +| *Setter* | set_right_icon(value) | ++----------+-----------------------+ +| *Getter* | get_right_icon() | ++----------+-----------------------+ + +Sets the icon that will appear in the right end of the ``LineEdit`` if there's no :ref:`text`, or always, if :ref:`clear_button_enabled` is set to ``false``. + .. _class_LineEdit_property_secret: - :ref:`bool` **secret** @@ -401,6 +407,30 @@ If ``true``, every character is replaced with the secret character (see :ref:`se The character to use to mask secret input (defaults to "\*"). Only a single character can be used as the secret character. +.. _class_LineEdit_property_selecting_enabled: + +- :ref:`bool` **selecting_enabled** + ++-----------+------------------------------+ +| *Default* | true | ++-----------+------------------------------+ +| *Setter* | set_selecting_enabled(value) | ++-----------+------------------------------+ +| *Getter* | is_selecting_enabled() | ++-----------+------------------------------+ + +.. _class_LineEdit_property_shortcut_keys_enabled: + +- :ref:`bool` **shortcut_keys_enabled** + ++-----------+----------------------------------+ +| *Default* | true | ++-----------+----------------------------------+ +| *Setter* | set_shortcut_keys_enabled(value) | ++-----------+----------------------------------+ +| *Getter* | is_shortcut_keys_enabled() | ++-----------+----------------------------------+ + .. _class_LineEdit_property_text: - :ref:`String` **text** diff --git a/classes/class_linkbutton.rst b/classes/class_linkbutton.rst index b305e4f10..039c9755c 100644 --- a/classes/class_linkbutton.rst +++ b/classes/class_linkbutton.rst @@ -21,11 +21,17 @@ Simple button used to represent a link to some resource. Properties ---------- -+-----------------------------------------------------+-------------------------------------------------------+----+ -| :ref:`String` | :ref:`text` | "" | -+-----------------------------------------------------+-------------------------------------------------------+----+ -| :ref:`UnderlineMode` | :ref:`underline` | 0 | -+-----------------------------------------------------+-------------------------------------------------------+----+ ++-----------------------------------------------------+-------------------------------------------------------+----------+ +| :ref:`FocusMode` | enabled_focus_mode | **O:** 0 | ++-----------------------------------------------------+-------------------------------------------------------+----------+ +| :ref:`FocusMode` | focus_mode | **O:** 0 | ++-----------------------------------------------------+-------------------------------------------------------+----------+ +| :ref:`CursorShape` | mouse_default_cursor_shape | **O:** 2 | ++-----------------------------------------------------+-------------------------------------------------------+----------+ +| :ref:`String` | :ref:`text` | "" | ++-----------------------------------------------------+-------------------------------------------------------+----------+ +| :ref:`UnderlineMode` | :ref:`underline` | 0 | ++-----------------------------------------------------+-------------------------------------------------------+----------+ Theme Properties ---------------- diff --git a/classes/class_mainloop.rst b/classes/class_mainloop.rst index aabb44407..95bf4487b 100644 --- a/classes/class_mainloop.rst +++ b/classes/class_mainloop.rst @@ -80,6 +80,10 @@ Constants .. _class_MainLoop_constant_NOTIFICATION_OS_IME_UPDATE: +.. _class_MainLoop_constant_NOTIFICATION_APP_RESUMED: + +.. _class_MainLoop_constant_NOTIFICATION_APP_PAUSED: + - **NOTIFICATION_WM_MOUSE_ENTER** = **1002** --- Notification received from the OS when the mouse enters the game window. Implemented on desktop and web platforms. @@ -126,6 +130,14 @@ Implemented on desktop platforms if the crash handler is enabled. Specific to the macOS platform. +- **NOTIFICATION_APP_RESUMED** = **1014** --- Notification received from the OS when the app is resumed. + +Specific to the Android platform. + +- **NOTIFICATION_APP_PAUSED** = **1015** --- Notification received from the OS when the app is paused. + +Specific to the Android platform. + Description ----------- diff --git a/classes/class_menubutton.rst b/classes/class_menubutton.rst index 97c016d72..7a0299472 100644 --- a/classes/class_menubutton.rst +++ b/classes/class_menubutton.rst @@ -21,9 +21,19 @@ Special button that brings up a :ref:`PopupMenu` when clicked. Properties ---------- -+-------------------------+-------------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`switch_on_hover` | false | -+-------------------------+-------------------------------------------------------------------+-------+ ++-----------------------------------------------+-------------------------------------------------------------------+-------------+ +| :ref:`ActionMode` | action_mode | **O:** 0 | ++-----------------------------------------------+-------------------------------------------------------------------+-------------+ +| :ref:`FocusMode` | enabled_focus_mode | **O:** 0 | ++-----------------------------------------------+-------------------------------------------------------------------+-------------+ +| :ref:`bool` | flat | **O:** true | ++-----------------------------------------------+-------------------------------------------------------------------+-------------+ +| :ref:`FocusMode` | focus_mode | **O:** 0 | ++-----------------------------------------------+-------------------------------------------------------------------+-------------+ +| :ref:`bool` | :ref:`switch_on_hover` | false | ++-----------------------------------------------+-------------------------------------------------------------------+-------------+ +| :ref:`bool` | toggle_mode | **O:** true | ++-----------------------------------------------+-------------------------------------------------------------------+-------------+ Methods ------- diff --git a/classes/class_meshinstance.rst b/classes/class_meshinstance.rst index 0da214e3a..b675cc436 100644 --- a/classes/class_meshinstance.rst +++ b/classes/class_meshinstance.rst @@ -28,6 +28,8 @@ Properties +---------------------------------+-------------------------------------------------------+----------------+ | :ref:`NodePath` | :ref:`skeleton` | NodePath("..") | +---------------------------------+-------------------------------------------------------+----------------+ +| :ref:`Skin` | :ref:`skin` | | ++---------------------------------+-------------------------------------------------------+----------------+ Methods ------- @@ -80,6 +82,16 @@ The :ref:`Mesh` resource for the instance. :ref:`NodePath` to the :ref:`Skeleton` associated with the instance. +.. _class_MeshInstance_property_skin: + +- :ref:`Skin` **skin** + ++----------+-----------------+ +| *Setter* | set_skin(value) | ++----------+-----------------+ +| *Getter* | get_skin() | ++----------+-----------------+ + Method Descriptions ------------------- diff --git a/classes/class_meshtexture.rst b/classes/class_meshtexture.rst index 02000ccf4..f244dd0c5 100644 --- a/classes/class_meshtexture.rst +++ b/classes/class_meshtexture.rst @@ -24,6 +24,8 @@ Properties +-------------------------------+--------------------------------------------------------------+-----------------+ | :ref:`Texture` | :ref:`base_texture` | | +-------------------------------+--------------------------------------------------------------+-----------------+ +| :ref:`int` | flags | **O:** 0 | ++-------------------------------+--------------------------------------------------------------+-----------------+ | :ref:`Vector2` | :ref:`image_size` | Vector2( 0, 0 ) | +-------------------------------+--------------------------------------------------------------+-----------------+ | :ref:`Mesh` | :ref:`mesh` | | diff --git a/classes/class_networkedmultiplayerenet.rst b/classes/class_networkedmultiplayerenet.rst index 07b5ad1a0..50987ef95 100644 --- a/classes/class_networkedmultiplayerenet.rst +++ b/classes/class_networkedmultiplayerenet.rst @@ -21,15 +21,19 @@ PacketPeer implementation using the `ENet `_ Properties ---------- -+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`always_ordered` | false | -+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+-------+ -| :ref:`int` | :ref:`channel_count` | 3 | -+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+-------+ -| :ref:`CompressionMode` | :ref:`compression_mode` | 0 | -+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+-------+ -| :ref:`int` | :ref:`transfer_channel` | -1 | -+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+-------+ ++-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------+ +| :ref:`bool` | :ref:`always_ordered` | false | ++-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------+ +| :ref:`int` | :ref:`channel_count` | 3 | ++-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------+ +| :ref:`CompressionMode` | :ref:`compression_mode` | 0 | ++-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------+ +| :ref:`bool` | refuse_new_connections | **O:** false | ++-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------+ +| :ref:`int` | :ref:`transfer_channel` | -1 | ++-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------+ +| :ref:`TransferMode` | transfer_mode | **O:** 2 | ++-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------+ Methods ------- diff --git a/classes/class_ninepatchrect.rst b/classes/class_ninepatchrect.rst index 851e2c039..372a27869 100644 --- a/classes/class_ninepatchrect.rst +++ b/classes/class_ninepatchrect.rst @@ -28,6 +28,8 @@ Properties +------------------------------------------------------------+--------------------------------------------------------------------------------------+---------------------+ | :ref:`bool` | :ref:`draw_center` | true | +------------------------------------------------------------+--------------------------------------------------------------------------------------+---------------------+ +| :ref:`MouseFilter` | mouse_filter | **O:** 2 | ++------------------------------------------------------------+--------------------------------------------------------------------------------------+---------------------+ | :ref:`int` | :ref:`patch_margin_bottom` | 0 | +------------------------------------------------------------+--------------------------------------------------------------------------------------+---------------------+ | :ref:`int` | :ref:`patch_margin_left` | 0 | @@ -196,7 +198,7 @@ The height of the 9-slice's top row. | *Getter* | get_region_rect() | +-----------+------------------------+ -Rectangular region of the texture to sample from. If you're working with an atlas, use this property to define the area the 9-slice should use. All other properties are relative to this one. +Rectangular region of the texture to sample from. If you're working with an atlas, use this property to define the area the 9-slice should use. All other properties are relative to this one. If the rect is empty, NinePatchRect will use the whole texture. .. _class_NinePatchRect_property_texture: diff --git a/classes/class_node.rst b/classes/class_node.rst index 00741aadc..89095f4b6 100644 --- a/classes/class_node.rst +++ b/classes/class_node.rst @@ -339,6 +339,10 @@ Constants .. _class_Node_constant_NOTIFICATION_OS_IME_UPDATE: +.. _class_Node_constant_NOTIFICATION_APP_RESUMED: + +.. _class_Node_constant_NOTIFICATION_APP_PAUSED: + - **NOTIFICATION_ENTER_TREE** = **10** --- Notification received when the node enters a :ref:`SceneTree`. - **NOTIFICATION_EXIT_TREE** = **11** --- Notification received when the node is about to exit a :ref:`SceneTree`. @@ -419,6 +423,14 @@ Implemented on desktop platforms if the crash handler is enabled. Specific to the macOS platform. +- **NOTIFICATION_APP_RESUMED** = **1014** --- Notification received from the OS when the app is resumed. + +Specific to the Android platform. + +- **NOTIFICATION_APP_PAUSED** = **1015** --- Notification received from the OS when the app is paused. + +Specific to the Android platform. + Description ----------- @@ -665,6 +677,8 @@ Duplicates the node, returning a new node. You can fine-tune the behavior using the ``flags`` (see :ref:`DuplicateFlags`). +**Note:** It will not work properly if the node contains a script with constructor arguments (i.e. needs to supply arguments to :ref:`Object._init` method). In that case, the node will be duplicated without a script. + .. _class_Node_method_find_node: - :ref:`Node` **find_node** **(** :ref:`String` mask, :ref:`bool` recursive=true, :ref:`bool` owned=true **)** const diff --git a/classes/class_node2d.rst b/classes/class_node2d.rst index 93617c7d0..5cc5dac8c 100644 --- a/classes/class_node2d.rst +++ b/classes/class_node2d.rst @@ -276,7 +276,7 @@ Adds the ``offset`` vector to the node's global position. - void **look_at** **(** :ref:`Vector2` point **)** -Rotates the node so it points towards the ``point``. +Rotates the node so it points towards the ``point``, which is expected to use global coordinates. .. _class_Node2D_method_move_local_x: diff --git a/classes/class_noisetexture.rst b/classes/class_noisetexture.rst index 29aec6c46..5be5a4f3e 100644 --- a/classes/class_noisetexture.rst +++ b/classes/class_noisetexture.rst @@ -21,19 +21,21 @@ Brief Description Properties ---------- -+-------------------------------------------------+-----------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`as_normalmap` | false | -+-------------------------------------------------+-----------------------------------------------------------------+-------+ -| :ref:`float` | :ref:`bump_strength` | 8.0 | -+-------------------------------------------------+-----------------------------------------------------------------+-------+ -| :ref:`int` | :ref:`height` | 512 | -+-------------------------------------------------+-----------------------------------------------------------------+-------+ -| :ref:`OpenSimplexNoise` | :ref:`noise` | | -+-------------------------------------------------+-----------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`seamless` | false | -+-------------------------------------------------+-----------------------------------------------------------------+-------+ -| :ref:`int` | :ref:`width` | 512 | -+-------------------------------------------------+-----------------------------------------------------------------+-------+ ++-------------------------------------------------+-----------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`as_normalmap` | false | ++-------------------------------------------------+-----------------------------------------------------------------+----------+ +| :ref:`float` | :ref:`bump_strength` | 8.0 | ++-------------------------------------------------+-----------------------------------------------------------------+----------+ +| :ref:`int` | flags | **O:** 7 | ++-------------------------------------------------+-----------------------------------------------------------------+----------+ +| :ref:`int` | :ref:`height` | 512 | ++-------------------------------------------------+-----------------------------------------------------------------+----------+ +| :ref:`OpenSimplexNoise` | :ref:`noise` | | ++-------------------------------------------------+-----------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`seamless` | false | ++-------------------------------------------------+-----------------------------------------------------------------+----------+ +| :ref:`int` | :ref:`width` | 512 | ++-------------------------------------------------+-----------------------------------------------------------------+----------+ Description ----------- diff --git a/classes/class_object.rst b/classes/class_object.rst index 049ebcb62..7baf4b7bb 100644 --- a/classes/class_object.rst +++ b/classes/class_object.rst @@ -9,7 +9,7 @@ Object ====== -**Inherited By:** :ref:`ARVRPositionalTracker`, :ref:`ARVRServer`, :ref:`AudioServer`, :ref:`CameraServer`, :ref:`ClassDB`, :ref:`EditorFileSystemDirectory`, :ref:`EditorNavigationMeshGenerator`, :ref:`EditorSelection`, :ref:`Engine`, :ref:`Geometry`, :ref:`GodotSharp`, :ref:`IP`, :ref:`Input`, :ref:`InputMap`, :ref:`JSON`, :ref:`JSONRPC`, :ref:`JavaScript`, :ref:`MainLoop`, :ref:`Node`, :ref:`OS`, :ref:`Performance`, :ref:`Physics2DDirectBodyState`, :ref:`Physics2DDirectSpaceState`, :ref:`Physics2DServer`, :ref:`PhysicsDirectBodyState`, :ref:`PhysicsDirectSpaceState`, :ref:`PhysicsServer`, :ref:`ProjectSettings`, :ref:`Reference`, :ref:`ResourceLoader`, :ref:`ResourceSaver`, :ref:`TranslationServer`, :ref:`TreeItem`, :ref:`UndoRedo`, :ref:`VisualScriptEditor`, :ref:`VisualServer` +**Inherited By:** :ref:`ARVRPositionalTracker`, :ref:`ARVRServer`, :ref:`AudioServer`, :ref:`CameraServer`, :ref:`ClassDB`, :ref:`EditorFileSystemDirectory`, :ref:`EditorNavigationMeshGenerator`, :ref:`EditorSelection`, :ref:`EditorVCSInterface`, :ref:`Engine`, :ref:`Geometry`, :ref:`GodotSharp`, :ref:`IP`, :ref:`Input`, :ref:`InputMap`, :ref:`JSON`, :ref:`JSONRPC`, :ref:`JavaScript`, :ref:`MainLoop`, :ref:`Node`, :ref:`OS`, :ref:`Performance`, :ref:`Physics2DDirectBodyState`, :ref:`Physics2DDirectSpaceState`, :ref:`Physics2DServer`, :ref:`PhysicsDirectBodyState`, :ref:`PhysicsDirectSpaceState`, :ref:`PhysicsServer`, :ref:`ProjectSettings`, :ref:`Reference`, :ref:`ResourceLoader`, :ref:`ResourceSaver`, :ref:`TranslationServer`, :ref:`TreeItem`, :ref:`UndoRedo`, :ref:`VisualScriptEditor`, :ref:`VisualServer` **Category:** Core diff --git a/classes/class_optionbutton.rst b/classes/class_optionbutton.rst index 9ebad9ee6..34ef19e28 100644 --- a/classes/class_optionbutton.rst +++ b/classes/class_optionbutton.rst @@ -21,9 +21,15 @@ Button control that provides selectable options when pressed. Properties ---------- -+-----------------------+-------------------------------------------------------+----+ -| :ref:`int` | :ref:`selected` | -1 | -+-----------------------+-------------------------------------------------------+----+ ++-----------------------------------------------+-------------------------------------------------------+-------------+ +| :ref:`ActionMode` | action_mode | **O:** 0 | ++-----------------------------------------------+-------------------------------------------------------+-------------+ +| :ref:`TextAlign` | align | **O:** 0 | ++-----------------------------------------------+-------------------------------------------------------+-------------+ +| :ref:`int` | :ref:`selected` | -1 | ++-----------------------------------------------+-------------------------------------------------------+-------------+ +| :ref:`bool` | toggle_mode | **O:** true | ++-----------------------------------------------+-------------------------------------------------------+-------------+ Methods ------- diff --git a/classes/class_os.rst b/classes/class_os.rst index 9ed0e3b4e..7a6beee43 100644 --- a/classes/class_os.rst +++ b/classes/class_os.rst @@ -1348,15 +1348,19 @@ Sets whether the window should always be on top. Sets the window title to the specified string. +**Note:** This should be used sporadically. Don't set this every frame, as that will negatively affect performance on some window managers. + .. _class_OS_method_shell_open: - :ref:`Error` **shell_open** **(** :ref:`String` uri **)** -Requests the OS to open a resource with the most appropriate program. For example. +Requests the OS to open a resource with the most appropriate program. For example: -``OS.shell_open("C:\\Users\name\Downloads")`` on Windows opens the file explorer at the downloads folders of the user. +- ``OS.shell_open("C:\\Users\name\Downloads")`` on Windows opens the file explorer at the user's Downloads folder. -``OS.shell_open("https://godotengine.org")`` opens the default web browser on the official Godot website. +- ``OS.shell_open("https://godotengine.org")`` opens the default web browser on the official Godot website. + +- ``OS.shell_open("mailto:example@example.com")`` opens the default email client with the "To" field set to ``example@example.com``. See `Customizing ``mailto:`` Links `_ for a list of fields that can be added. .. _class_OS_method_show_virtual_keyboard: diff --git a/classes/class_parallaxbackground.rst b/classes/class_parallaxbackground.rst index ff5612ddf..813ead0d1 100644 --- a/classes/class_parallaxbackground.rst +++ b/classes/class_parallaxbackground.rst @@ -21,6 +21,8 @@ A node used to create a parallax scrolling background. Properties ---------- ++-------------------------------+-----------------------------------------------------------------------------------------------+-----------------+ +| :ref:`int` | layer | **O:** -100 | +-------------------------------+-----------------------------------------------------------------------------------------------+-----------------+ | :ref:`Vector2` | :ref:`scroll_base_offset` | Vector2( 0, 0 ) | +-------------------------------+-----------------------------------------------------------------------------------------------+-----------------+ diff --git a/classes/class_path2d.rst b/classes/class_path2d.rst index 2ce9deb53..d93b77435 100644 --- a/classes/class_path2d.rst +++ b/classes/class_path2d.rst @@ -21,9 +21,11 @@ Contains a :ref:`Curve2D` path for :ref:`PathFollow2D` | :ref:`curve` | -+-------------------------------+-------------------------------------------+ ++-------------------------------+-------------------------------------------+----------------------------------+ +| :ref:`Curve2D` | :ref:`curve` | | ++-------------------------------+-------------------------------------------+----------------------------------+ +| :ref:`Color` | self_modulate | **O:** Color( 0.5, 0.6, 1, 0.7 ) | ++-------------------------------+-------------------------------------------+----------------------------------+ Description ----------- diff --git a/classes/class_physics2dserver.rst b/classes/class_physics2dserver.rst index d19f54991..6fd8936cb 100644 --- a/classes/class_physics2dserver.rst +++ b/classes/class_physics2dserver.rst @@ -982,7 +982,7 @@ Sets a body state using one of the :ref:`BodyState` **body_test_motion** **(** :ref:`RID` body, :ref:`Transform2D` from, :ref:`Vector2` motion, :ref:`bool` infinite_inertia, :ref:`float` margin=0.08, :ref:`Physics2DTestMotionResult` result=null **)** -Returns 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. +Returns ``true`` if a collision would result from moving in the given direction from a given point in space. Margin increases the size of the shapes involved in the collision detection. :ref:`Physics2DTestMotionResult` can be passed to return additional information in. .. _class_Physics2DServer_method_capsule_shape_create: diff --git a/classes/class_physicsbody2d.rst b/classes/class_physicsbody2d.rst index ae578ce16..e27fa043e 100644 --- a/classes/class_physicsbody2d.rst +++ b/classes/class_physicsbody2d.rst @@ -23,13 +23,15 @@ Base class for all objects affected by physics in 2D space. Properties ---------- -+-----------------------+----------------------------------------------------------------------+---+ -| :ref:`int` | :ref:`collision_layer` | 1 | -+-----------------------+----------------------------------------------------------------------+---+ -| :ref:`int` | :ref:`collision_mask` | 1 | -+-----------------------+----------------------------------------------------------------------+---+ -| :ref:`int` | :ref:`layers` | | -+-----------------------+----------------------------------------------------------------------+---+ ++-------------------------+----------------------------------------------------------------------+--------------+ +| :ref:`int` | :ref:`collision_layer` | 1 | ++-------------------------+----------------------------------------------------------------------+--------------+ +| :ref:`int` | :ref:`collision_mask` | 1 | ++-------------------------+----------------------------------------------------------------------+--------------+ +| :ref:`bool` | input_pickable | **O:** false | ++-------------------------+----------------------------------------------------------------------+--------------+ +| :ref:`int` | :ref:`layers` | | ++-------------------------+----------------------------------------------------------------------+--------------+ Methods ------- diff --git a/classes/class_popup.rst b/classes/class_popup.rst index 38cfac0d6..c7d0d4920 100644 --- a/classes/class_popup.rst +++ b/classes/class_popup.rst @@ -23,9 +23,11 @@ Base container control for popups and dialogs. Properties ---------- -+-------------------------+--------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`popup_exclusive` | false | -+-------------------------+--------------------------------------------------------------+-------+ ++-------------------------+--------------------------------------------------------------+--------------+ +| :ref:`bool` | :ref:`popup_exclusive` | false | ++-------------------------+--------------------------------------------------------------+--------------+ +| :ref:`bool` | visible | **O:** false | ++-------------------------+--------------------------------------------------------------+--------------+ Methods ------- diff --git a/classes/class_popupmenu.rst b/classes/class_popupmenu.rst index 89fc66b9a..bc0fab372 100644 --- a/classes/class_popupmenu.rst +++ b/classes/class_popupmenu.rst @@ -21,17 +21,19 @@ PopupMenu displays a list of options. Properties ---------- -+---------------------------+----------------------------------------------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`allow_search` | false | -+---------------------------+----------------------------------------------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`hide_on_checkable_item_selection` | true | -+---------------------------+----------------------------------------------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`hide_on_item_selection` | true | -+---------------------------+----------------------------------------------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`hide_on_state_item_selection` | false | -+---------------------------+----------------------------------------------------------------------------------------------------+-------+ -| :ref:`float` | :ref:`submenu_popup_delay` | 0.3 | -+---------------------------+----------------------------------------------------------------------------------------------------+-------+ ++------------------------------------------+----------------------------------------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`allow_search` | false | ++------------------------------------------+----------------------------------------------------------------------------------------------------+----------+ +| :ref:`FocusMode` | focus_mode | **O:** 2 | ++------------------------------------------+----------------------------------------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`hide_on_checkable_item_selection` | true | ++------------------------------------------+----------------------------------------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`hide_on_item_selection` | true | ++------------------------------------------+----------------------------------------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`hide_on_state_item_selection` | false | ++------------------------------------------+----------------------------------------------------------------------------------------------------+----------+ +| :ref:`float` | :ref:`submenu_popup_delay` | 0.3 | ++------------------------------------------+----------------------------------------------------------------------------------------------------+----------+ Methods ------- @@ -419,7 +421,7 @@ Returns the id of the item at index ``idx``. ``id`` can be manually assigned, wh - :ref:`int` **get_item_index** **(** :ref:`int` id **)** const -Returns the index of the item containing the specified ``id``. Index is automatically assigned to each item by the engine. Index can not be set manualy. +Returns the index of the item containing the specified ``id``. Index is automatically assigned to each item by the engine. Index can not be set manually. .. _class_PopupMenu_method_get_item_metadata: diff --git a/classes/class_progressbar.rst b/classes/class_progressbar.rst index 69c046a91..c6ca52982 100644 --- a/classes/class_progressbar.rst +++ b/classes/class_progressbar.rst @@ -21,9 +21,13 @@ General-purpose progress bar. Properties ---------- -+-------------------------+--------------------------------------------------------------------+------+ -| :ref:`bool` | :ref:`percent_visible` | true | -+-------------------------+--------------------------------------------------------------------+------+ ++---------------------------+--------------------------------------------------------------------+-------------+ +| :ref:`bool` | :ref:`percent_visible` | true | ++---------------------------+--------------------------------------------------------------------+-------------+ +| :ref:`int` | size_flags_vertical | **O:** 0 | ++---------------------------+--------------------------------------------------------------------+-------------+ +| :ref:`float` | step | **O:** 0.01 | ++---------------------------+--------------------------------------------------------------------+-------------+ Theme Properties ---------------- diff --git a/classes/class_projectsettings.rst b/classes/class_projectsettings.rst index fac98adfe..0db45b0fd 100644 --- a/classes/class_projectsettings.rst +++ b/classes/class_projectsettings.rst @@ -2646,7 +2646,7 @@ Fix to improve physics jitter, specially on monitors where refresh rate is diffe | *Default* | Color( 0.3, 0.3, 0.3, 1 ) | +-----------+---------------------------+ -Default background clear color. Overriddable per :ref:`Viewport` using its :ref:`Environment`. See :ref:`Environment.background_mode` and :ref:`Environment.background_color` in particular. To change this default color programmatically, use :ref:`VisualServer.set_default_clear_color`. +Default background clear color. Overridable per :ref:`Viewport` using its :ref:`Environment`. See :ref:`Environment.background_mode` and :ref:`Environment.background_color` in particular. To change this default color programmatically, use :ref:`VisualServer.set_default_clear_color`. .. _class_ProjectSettings_property_rendering/limits/buffers/blend_shape_max_buffer_size_kb: @@ -2778,7 +2778,7 @@ If ``true``, performs a previous depth pass before rendering materials. This inc | *Default* | 4096 | +-----------+------+ -The directional shadow's size in pixels. Higher values will result in sharper shadows, at the cost of performance. +The directional shadow's size in pixels. Higher values will result in sharper shadows, at the cost of performance. The value will be rounded up to the nearest power of 2. .. _class_ProjectSettings_property_rendering/quality/directional_shadow/size.mobile: diff --git a/classes/class_proxytexture.rst b/classes/class_proxytexture.rst index b3ffe011b..116b1e444 100644 --- a/classes/class_proxytexture.rst +++ b/classes/class_proxytexture.rst @@ -21,9 +21,11 @@ Brief Description Properties ---------- -+-------------------------------+-----------------------------------------------+ -| :ref:`Texture` | :ref:`base` | -+-------------------------------+-----------------------------------------------+ ++-------------------------------+-----------------------------------------------+----------+ +| :ref:`Texture` | :ref:`base` | | ++-------------------------------+-----------------------------------------------+----------+ +| :ref:`int` | flags | **O:** 0 | ++-------------------------------+-----------------------------------------------+----------+ Property Descriptions --------------------- diff --git a/classes/class_reference.rst b/classes/class_reference.rst index 699208d22..14ff7e010 100644 --- a/classes/class_reference.rst +++ b/classes/class_reference.rst @@ -11,7 +11,7 @@ Reference **Inherits:** :ref:`Object` -**Inherited By:** :ref:`ARVRInterface`, :ref:`AStar`, :ref:`AStar2D`, :ref:`AnimationTrackEditPlugin`, :ref:`AudioEffectInstance`, :ref:`AudioStreamPlayback`, :ref:`CameraFeed`, :ref:`ConfigFile`, :ref:`Crypto`, :ref:`Directory`, :ref:`EditorExportPlugin`, :ref:`EditorFeatureProfile`, :ref:`EditorInspectorPlugin`, :ref:`EditorResourceConversionPlugin`, :ref:`EditorResourcePreviewGenerator`, :ref:`EditorSceneImporter`, :ref:`EditorScenePostImport`, :ref:`EditorScript`, :ref:`EncodedObjectAsID`, :ref:`Expression`, :ref:`File`, :ref:`FuncRef`, :ref:`GDNative`, :ref:`GDScriptFunctionState`, :ref:`GDScriptNativeClass`, :ref:`HTTPClient`, :ref:`HashingContext`, :ref:`JSONParseResult`, :ref:`KinematicCollision`, :ref:`KinematicCollision2D`, :ref:`Marshalls`, :ref:`MeshDataTool`, :ref:`MultiplayerAPI`, :ref:`Mutex`, :ref:`PCKPacker`, :ref:`PackedDataContainerRef`, :ref:`PacketPeer`, :ref:`Physics2DShapeQueryParameters`, :ref:`Physics2DShapeQueryResult`, :ref:`Physics2DTestMotionResult`, :ref:`PhysicsShapeQueryParameters`, :ref:`PhysicsShapeQueryResult`, :ref:`RandomNumberGenerator`, :ref:`RegEx`, :ref:`RegExMatch`, :ref:`Resource`, :ref:`ResourceFormatLoader`, :ref:`ResourceFormatSaver`, :ref:`ResourceImporter`, :ref:`ResourceInteractiveLoader`, :ref:`SceneState`, :ref:`SceneTreeTimer`, :ref:`Semaphore`, :ref:`SpatialGizmo`, :ref:`SpatialVelocityTracker`, :ref:`StreamPeer`, :ref:`SurfaceTool`, :ref:`TCP_Server`, :ref:`Thread`, :ref:`TriangleMesh`, :ref:`UPNP`, :ref:`UPNPDevice`, :ref:`VisualScriptFunctionState`, :ref:`WeakRef`, :ref:`WebRTCPeerConnection`, :ref:`XMLParser` +**Inherited By:** :ref:`ARVRInterface`, :ref:`AStar`, :ref:`AStar2D`, :ref:`AnimationTrackEditPlugin`, :ref:`AudioEffectInstance`, :ref:`AudioStreamPlayback`, :ref:`CameraFeed`, :ref:`CharFXTransform`, :ref:`ConfigFile`, :ref:`Crypto`, :ref:`Directory`, :ref:`EditorExportPlugin`, :ref:`EditorFeatureProfile`, :ref:`EditorInspectorPlugin`, :ref:`EditorResourceConversionPlugin`, :ref:`EditorResourcePreviewGenerator`, :ref:`EditorSceneImporter`, :ref:`EditorScenePostImport`, :ref:`EditorScript`, :ref:`EncodedObjectAsID`, :ref:`Expression`, :ref:`File`, :ref:`FuncRef`, :ref:`GDNative`, :ref:`GDScriptFunctionState`, :ref:`GDScriptNativeClass`, :ref:`HTTPClient`, :ref:`HashingContext`, :ref:`JSONParseResult`, :ref:`KinematicCollision`, :ref:`KinematicCollision2D`, :ref:`Marshalls`, :ref:`MeshDataTool`, :ref:`MultiplayerAPI`, :ref:`Mutex`, :ref:`PCKPacker`, :ref:`PackedDataContainerRef`, :ref:`PacketPeer`, :ref:`Physics2DShapeQueryParameters`, :ref:`Physics2DShapeQueryResult`, :ref:`Physics2DTestMotionResult`, :ref:`PhysicsShapeQueryParameters`, :ref:`PhysicsShapeQueryResult`, :ref:`RandomNumberGenerator`, :ref:`RegEx`, :ref:`RegExMatch`, :ref:`Resource`, :ref:`ResourceFormatLoader`, :ref:`ResourceFormatSaver`, :ref:`ResourceImporter`, :ref:`ResourceInteractiveLoader`, :ref:`SceneState`, :ref:`SceneTreeTimer`, :ref:`Semaphore`, :ref:`SkinReference`, :ref:`SpatialGizmo`, :ref:`SpatialVelocityTracker`, :ref:`StreamPeer`, :ref:`SurfaceTool`, :ref:`TCP_Server`, :ref:`Thread`, :ref:`TriangleMesh`, :ref:`UPNP`, :ref:`UPNPDevice`, :ref:`VisualScriptFunctionState`, :ref:`WeakRef`, :ref:`WebRTCPeerConnection`, :ref:`XMLParser` **Category:** Core diff --git a/classes/class_resource.rst b/classes/class_resource.rst index b270dc15a..5ba9babda 100644 --- a/classes/class_resource.rst +++ b/classes/class_resource.rst @@ -11,7 +11,7 @@ Resource **Inherits:** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`Animation`, :ref:`AnimationNode`, :ref:`AnimationNodeStateMachinePlayback`, :ref:`AnimationNodeStateMachineTransition`, :ref:`AudioBusLayout`, :ref:`AudioEffect`, :ref:`AudioStream`, :ref:`BakedLightmapData`, :ref:`BitMap`, :ref:`ButtonGroup`, :ref:`CryptoKey`, :ref:`CubeMap`, :ref:`Curve`, :ref:`Curve2D`, :ref:`Curve3D`, :ref:`DynamicFontData`, :ref:`EditorSettings`, :ref:`EditorSpatialGizmoPlugin`, :ref:`Environment`, :ref:`Font`, :ref:`GDNativeLibrary`, :ref:`GIProbeData`, :ref:`Gradient`, :ref:`Image`, :ref:`InputEvent`, :ref:`Material`, :ref:`Mesh`, :ref:`MeshLibrary`, :ref:`MultiMesh`, :ref:`NavigationMesh`, :ref:`NavigationPolygon`, :ref:`OccluderPolygon2D`, :ref:`OpenSimplexNoise`, :ref:`PackedDataContainer`, :ref:`PackedScene`, :ref:`PhysicsMaterial`, :ref:`PolygonPathFinder`, :ref:`Script`, :ref:`Shader`, :ref:`Shape`, :ref:`Shape2D`, :ref:`ShortCut`, :ref:`Sky`, :ref:`SpriteFrames`, :ref:`StyleBox`, :ref:`TextFile`, :ref:`Texture`, :ref:`TextureLayered`, :ref:`Theme`, :ref:`TileSet`, :ref:`Translation`, :ref:`VideoStream`, :ref:`VisualScriptNode`, :ref:`VisualShaderNode`, :ref:`World`, :ref:`World2D`, :ref:`X509Certificate` +**Inherited By:** :ref:`Animation`, :ref:`AnimationNode`, :ref:`AnimationNodeStateMachinePlayback`, :ref:`AnimationNodeStateMachineTransition`, :ref:`AudioBusLayout`, :ref:`AudioEffect`, :ref:`AudioStream`, :ref:`BakedLightmapData`, :ref:`BitMap`, :ref:`ButtonGroup`, :ref:`CryptoKey`, :ref:`CubeMap`, :ref:`Curve`, :ref:`Curve2D`, :ref:`Curve3D`, :ref:`DynamicFontData`, :ref:`EditorSettings`, :ref:`EditorSpatialGizmoPlugin`, :ref:`Environment`, :ref:`Font`, :ref:`GDNativeLibrary`, :ref:`GIProbeData`, :ref:`Gradient`, :ref:`Image`, :ref:`InputEvent`, :ref:`Material`, :ref:`Mesh`, :ref:`MeshLibrary`, :ref:`MultiMesh`, :ref:`NavigationMesh`, :ref:`NavigationPolygon`, :ref:`OccluderPolygon2D`, :ref:`OpenSimplexNoise`, :ref:`PackedDataContainer`, :ref:`PackedScene`, :ref:`PhysicsMaterial`, :ref:`PolygonPathFinder`, :ref:`RichTextEffect`, :ref:`Script`, :ref:`Shader`, :ref:`Shape`, :ref:`Shape2D`, :ref:`ShortCut`, :ref:`Skin`, :ref:`Sky`, :ref:`SpriteFrames`, :ref:`StyleBox`, :ref:`TextFile`, :ref:`Texture`, :ref:`TextureLayered`, :ref:`Theme`, :ref:`TileSet`, :ref:`Translation`, :ref:`VideoStream`, :ref:`VisualScriptNode`, :ref:`VisualShaderNode`, :ref:`World`, :ref:`World2D`, :ref:`X509Certificate` **Category:** Core diff --git a/classes/class_richtexteffect.rst b/classes/class_richtexteffect.rst new file mode 100644 index 000000000..6c8b65ac5 --- /dev/null +++ b/classes/class_richtexteffect.rst @@ -0,0 +1,34 @@ +:github_url: hide + +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the RichTextEffect.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_RichTextEffect: + +RichTextEffect +============== + +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Methods +------- + ++-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`_process_custom_fx` **(** :ref:`CharFXTransform` char_fx **)** virtual | ++-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ + +Method Descriptions +------------------- + +.. _class_RichTextEffect_method__process_custom_fx: + +- :ref:`bool` **_process_custom_fx** **(** :ref:`CharFXTransform` char_fx **)** virtual + diff --git a/classes/class_richtextlabel.rst b/classes/class_richtextlabel.rst index 875eaee45..de1600669 100644 --- a/classes/class_richtextlabel.rst +++ b/classes/class_richtextlabel.rst @@ -21,29 +21,33 @@ Label that displays rich text. Properties ---------- -+-----------------------------+------------------------------------------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`bbcode_enabled` | false | -+-----------------------------+------------------------------------------------------------------------------------------------+-------+ -| :ref:`String` | :ref:`bbcode_text` | "" | -+-----------------------------+------------------------------------------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`meta_underlined` | true | -+-----------------------------+------------------------------------------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`override_selected_font_color` | false | -+-----------------------------+------------------------------------------------------------------------------------------------+-------+ -| :ref:`float` | :ref:`percent_visible` | 1.0 | -+-----------------------------+------------------------------------------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`scroll_active` | true | -+-----------------------------+------------------------------------------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`scroll_following` | false | -+-----------------------------+------------------------------------------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`selection_enabled` | false | -+-----------------------------+------------------------------------------------------------------------------------------------+-------+ -| :ref:`int` | :ref:`tab_size` | 4 | -+-----------------------------+------------------------------------------------------------------------------------------------+-------+ -| :ref:`String` | :ref:`text` | "" | -+-----------------------------+------------------------------------------------------------------------------------------------+-------+ -| :ref:`int` | :ref:`visible_characters` | -1 | -+-----------------------------+------------------------------------------------------------------------------------------------+-------+ ++-----------------------------+------------------------------------------------------------------------------------------------+-------------+ +| :ref:`bool` | :ref:`bbcode_enabled` | false | ++-----------------------------+------------------------------------------------------------------------------------------------+-------------+ +| :ref:`String` | :ref:`bbcode_text` | "" | ++-----------------------------+------------------------------------------------------------------------------------------------+-------------+ +| :ref:`Array` | :ref:`custom_effects` | [ ] | ++-----------------------------+------------------------------------------------------------------------------------------------+-------------+ +| :ref:`bool` | :ref:`meta_underlined` | true | ++-----------------------------+------------------------------------------------------------------------------------------------+-------------+ +| :ref:`bool` | :ref:`override_selected_font_color` | false | ++-----------------------------+------------------------------------------------------------------------------------------------+-------------+ +| :ref:`float` | :ref:`percent_visible` | 1.0 | ++-----------------------------+------------------------------------------------------------------------------------------------+-------------+ +| :ref:`bool` | rect_clip_content | **O:** true | ++-----------------------------+------------------------------------------------------------------------------------------------+-------------+ +| :ref:`bool` | :ref:`scroll_active` | true | ++-----------------------------+------------------------------------------------------------------------------------------------+-------------+ +| :ref:`bool` | :ref:`scroll_following` | false | ++-----------------------------+------------------------------------------------------------------------------------------------+-------------+ +| :ref:`bool` | :ref:`selection_enabled` | false | ++-----------------------------+------------------------------------------------------------------------------------------------+-------------+ +| :ref:`int` | :ref:`tab_size` | 4 | ++-----------------------------+------------------------------------------------------------------------------------------------+-------------+ +| :ref:`String` | :ref:`text` | "" | ++-----------------------------+------------------------------------------------------------------------------------------------+-------------+ +| :ref:`int` | :ref:`visible_characters` | -1 | ++-----------------------------+------------------------------------------------------------------------------------------------+-------------+ Methods ------- @@ -67,10 +71,14 @@ Methods +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_visible_line_count` **(** **)** const | +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`install_effect` **(** :ref:`Variant` effect **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`newline` **(** **)** | +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`parse_bbcode` **(** :ref:`String` bbcode **)** | +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`parse_expressions_for_values` **(** :ref:`PoolStringArray` expressions **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`pop` **(** **)** | +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`push_align` **(** :ref:`Align` align **)** | @@ -225,6 +233,18 @@ enum **ListType**: .. _class_RichTextLabel_constant_ITEM_TABLE: +.. _class_RichTextLabel_constant_ITEM_FADE: + +.. _class_RichTextLabel_constant_ITEM_SHAKE: + +.. _class_RichTextLabel_constant_ITEM_WAVE: + +.. _class_RichTextLabel_constant_ITEM_TORNADO: + +.. _class_RichTextLabel_constant_ITEM_RAINBOW: + +.. _class_RichTextLabel_constant_ITEM_CUSTOMFX: + .. _class_RichTextLabel_constant_ITEM_META: enum **ItemType**: @@ -253,7 +273,19 @@ enum **ItemType**: - **ITEM_TABLE** = **11** -- **ITEM_META** = **12** +- **ITEM_FADE** = **12** + +- **ITEM_SHAKE** = **13** + +- **ITEM_WAVE** = **14** + +- **ITEM_TORNADO** = **15** + +- **ITEM_RAINBOW** = **16** + +- **ITEM_CUSTOMFX** = **18** + +- **ITEM_META** = **17** Description ----------- @@ -298,6 +330,18 @@ If ``true``, the label uses BBCode formatting. The label's text in BBCode format. Is not representative of manual modifications to the internal tag stack. Erases changes made by other methods when edited. +.. _class_RichTextLabel_property_custom_effects: + +- :ref:`Array` **custom_effects** + ++-----------+--------------------+ +| *Default* | [ ] | ++-----------+--------------------+ +| *Setter* | set_effects(value) | ++-----------+--------------------+ +| *Getter* | get_effects() | ++-----------+--------------------+ + .. _class_RichTextLabel_property_meta_underlined: - :ref:`bool` **meta_underlined** @@ -483,6 +527,10 @@ Returns the vertical scrollbar. Returns the number of visible lines. +.. _class_RichTextLabel_method_install_effect: + +- void **install_effect** **(** :ref:`Variant` effect **)** + .. _class_RichTextLabel_method_newline: - void **newline** **(** **)** @@ -495,6 +543,10 @@ Adds a newline tag to the tag stack. The assignment version of :ref:`append_bbcode`. Clears the tag stack and inserts the new content. Returns :ref:`@GlobalScope.OK` if parses ``bbcode`` successfully. +.. _class_RichTextLabel_method_parse_expressions_for_values: + +- :ref:`Dictionary` **parse_expressions_for_values** **(** :ref:`PoolStringArray` expressions **)** + .. _class_RichTextLabel_method_pop: - void **pop** **(** **)** diff --git a/classes/class_script.rst b/classes/class_script.rst index 55cee37ec..75a1e3349 100644 --- a/classes/class_script.rst +++ b/classes/class_script.rst @@ -30,23 +30,33 @@ Properties Methods ------- -+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_instance` **(** **)** const | -+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Script` | :ref:`get_base_script` **(** **)** const | -+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_instance_base_type` **(** **)** const | -+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_script_signal` **(** :ref:`String` signal_name **)** const | -+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_source_code` **(** **)** const | -+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`instance_has` **(** :ref:`Object` base_object **)** const | -+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_tool` **(** **)** const | -+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`reload` **(** :ref:`bool` keep_state=false **)** | -+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`can_instance` **(** **)** const | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Script` | :ref:`get_base_script` **(** **)** const | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_instance_base_type` **(** **)** const | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_property_default_value` **(** :ref:`String` property **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_script_constant_map` **(** **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_script_method_list` **(** **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_script_property_list` **(** **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_script_signal_list` **(** **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_script_signal` **(** :ref:`String` signal_name **)** const | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_source_code` **(** **)** const | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`instance_has` **(** :ref:`Object` base_object **)** const | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_tool` **(** **)** const | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`reload` **(** :ref:`bool` keep_state=false **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -96,6 +106,26 @@ Returns the script directly inherited by this script. Returns the script's base type. +.. _class_Script_method_get_property_default_value: + +- :ref:`Variant` **get_property_default_value** **(** :ref:`String` property **)** + +.. _class_Script_method_get_script_constant_map: + +- :ref:`Dictionary` **get_script_constant_map** **(** **)** + +.. _class_Script_method_get_script_method_list: + +- :ref:`Array` **get_script_method_list** **(** **)** + +.. _class_Script_method_get_script_property_list: + +- :ref:`Array` **get_script_property_list** **(** **)** + +.. _class_Script_method_get_script_signal_list: + +- :ref:`Array` **get_script_signal_list** **(** **)** + .. _class_Script_method_has_script_signal: - :ref:`bool` **has_script_signal** **(** :ref:`String` signal_name **)** const diff --git a/classes/class_scriptcreatedialog.rst b/classes/class_scriptcreatedialog.rst index c643d8a3c..1170c1426 100644 --- a/classes/class_scriptcreatedialog.rst +++ b/classes/class_scriptcreatedialog.rst @@ -18,6 +18,21 @@ Brief Description The Editor's popup dialog for creating new :ref:`Script` files. +Properties +---------- + ++-------------------------------+-------------------+-----------------------------+ +| :ref:`bool` | dialog_hide_on_ok | **O:** false | ++-------------------------------+-------------------+-----------------------------+ +| :ref:`float` | margin_bottom | **O:** 76.0 | ++-------------------------------+-------------------+-----------------------------+ +| :ref:`float` | margin_right | **O:** 200.0 | ++-------------------------------+-------------------+-----------------------------+ +| :ref:`Vector2` | rect_size | **O:** Vector2( 200, 76 ) | ++-------------------------------+-------------------+-----------------------------+ +| :ref:`String` | window_title | **O:** "Attach Node Script" | ++-------------------------------+-------------------+-----------------------------+ + Methods ------- diff --git a/classes/class_scrollbar.rst b/classes/class_scrollbar.rst index 9fe3b3334..758ecf03e 100644 --- a/classes/class_scrollbar.rst +++ b/classes/class_scrollbar.rst @@ -23,9 +23,13 @@ Base class for scroll bars. Properties ---------- -+---------------------------+----------------------------------------------------------+------+ -| :ref:`float` | :ref:`custom_step` | -1.0 | -+---------------------------+----------------------------------------------------------+------+ ++---------------------------+----------------------------------------------------------+------------+ +| :ref:`float` | :ref:`custom_step` | -1.0 | ++---------------------------+----------------------------------------------------------+------------+ +| :ref:`int` | size_flags_vertical | **O:** 0 | ++---------------------------+----------------------------------------------------------+------------+ +| :ref:`float` | step | **O:** 0.0 | ++---------------------------+----------------------------------------------------------+------------+ Signals ------- diff --git a/classes/class_scrollcontainer.rst b/classes/class_scrollcontainer.rst index 98ff70fc7..3613ce6a5 100644 --- a/classes/class_scrollcontainer.rst +++ b/classes/class_scrollcontainer.rst @@ -23,17 +23,19 @@ A helper node for displaying scrollable elements such as lists. Properties ---------- -+-------------------------+--------------------------------------------------------------------------------------------+------+ -| :ref:`int` | :ref:`scroll_deadzone` | 0 | -+-------------------------+--------------------------------------------------------------------------------------------+------+ -| :ref:`int` | :ref:`scroll_horizontal` | 0 | -+-------------------------+--------------------------------------------------------------------------------------------+------+ -| :ref:`bool` | :ref:`scroll_horizontal_enabled` | true | -+-------------------------+--------------------------------------------------------------------------------------------+------+ -| :ref:`int` | :ref:`scroll_vertical` | 0 | -+-------------------------+--------------------------------------------------------------------------------------------+------+ -| :ref:`bool` | :ref:`scroll_vertical_enabled` | true | -+-------------------------+--------------------------------------------------------------------------------------------+------+ ++-------------------------+--------------------------------------------------------------------------------------------+-------------+ +| :ref:`bool` | rect_clip_content | **O:** true | ++-------------------------+--------------------------------------------------------------------------------------------+-------------+ +| :ref:`int` | :ref:`scroll_deadzone` | 0 | ++-------------------------+--------------------------------------------------------------------------------------------+-------------+ +| :ref:`int` | :ref:`scroll_horizontal` | 0 | ++-------------------------+--------------------------------------------------------------------------------------------+-------------+ +| :ref:`bool` | :ref:`scroll_horizontal_enabled` | true | ++-------------------------+--------------------------------------------------------------------------------------------+-------------+ +| :ref:`int` | :ref:`scroll_vertical` | 0 | ++-------------------------+--------------------------------------------------------------------------------------------+-------------+ +| :ref:`bool` | :ref:`scroll_vertical_enabled` | true | ++-------------------------+--------------------------------------------------------------------------------------------+-------------+ Methods ------- diff --git a/classes/class_skeleton.rst b/classes/class_skeleton.rst index e9f2f9d36..e9eb2524c 100644 --- a/classes/class_skeleton.rst +++ b/classes/class_skeleton.rst @@ -18,73 +18,60 @@ Brief Description Skeleton for characters and animated objects. -Properties ----------- - -+-------------------------+-----------------------------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`bones_in_world_transform` | false | -+-------------------------+-----------------------------------------------------------------------------------+-------+ - Methods ------- -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_bone` **(** :ref:`String` name **)** | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`bind_child_node_to_bone` **(** :ref:`int` bone_idx, :ref:`Node` node **)** | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_bones` **(** **)** | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find_bone` **(** :ref:`String` name **)** const | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_bone_count` **(** **)** const | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`get_bone_custom_pose` **(** :ref:`int` bone_idx **)** const | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`get_bone_global_pose` **(** :ref:`int` bone_idx **)** const | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_bone_name` **(** :ref:`int` bone_idx **)** const | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_bone_parent` **(** :ref:`int` bone_idx **)** const | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`get_bone_pose` **(** :ref:`int` bone_idx **)** const | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`get_bone_rest` **(** :ref:`int` bone_idx **)** const | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`get_bone_transform` **(** :ref:`int` bone_idx **)** const | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_bound_child_nodes_to_bone` **(** :ref:`int` bone_idx **)** const | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_bone_rest_disabled` **(** :ref:`int` bone_idx **)** const | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`localize_rests` **(** **)** | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`physical_bones_add_collision_exception` **(** :ref:`RID` exception **)** | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`physical_bones_remove_collision_exception` **(** :ref:`RID` exception **)** | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`physical_bones_start_simulation` **(** :ref:`Array` bones=[ ] **)** | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`physical_bones_stop_simulation` **(** **)** | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bone_custom_pose` **(** :ref:`int` bone_idx, :ref:`Transform` custom_pose **)** | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bone_disable_rest` **(** :ref:`int` bone_idx, :ref:`bool` disable **)** | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bone_global_pose` **(** :ref:`int` bone_idx, :ref:`Transform` pose **)** | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bone_ignore_animation` **(** :ref:`int` bone, :ref:`bool` ignore **)** | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bone_parent` **(** :ref:`int` bone_idx, :ref:`int` parent_idx **)** | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bone_pose` **(** :ref:`int` bone_idx, :ref:`Transform` pose **)** | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bone_rest` **(** :ref:`int` bone_idx, :ref:`Transform` rest **)** | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`unbind_child_node_from_bone` **(** :ref:`int` bone_idx, :ref:`Node` node **)** | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`unparent_bone_and_rest` **(** :ref:`int` bone_idx **)** | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_bone` **(** :ref:`String` name **)** | ++-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`bind_child_node_to_bone` **(** :ref:`int` bone_idx, :ref:`Node` node **)** | ++-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_bones` **(** **)** | ++-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`find_bone` **(** :ref:`String` name **)** const | ++-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_bone_count` **(** **)** const | ++-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`get_bone_global_pose` **(** :ref:`int` bone_idx **)** const | ++-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_bone_name` **(** :ref:`int` bone_idx **)** const | ++-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_bone_parent` **(** :ref:`int` bone_idx **)** const | ++-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`get_bone_pose` **(** :ref:`int` bone_idx **)** const | ++-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`get_bone_rest` **(** :ref:`int` bone_idx **)** const | ++-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_bound_child_nodes_to_bone` **(** :ref:`int` bone_idx **)** const | ++-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_bone_rest_disabled` **(** :ref:`int` bone_idx **)** const | ++-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`localize_rests` **(** **)** | ++-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`physical_bones_add_collision_exception` **(** :ref:`RID` exception **)** | ++-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`physical_bones_remove_collision_exception` **(** :ref:`RID` exception **)** | ++-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`physical_bones_start_simulation` **(** :ref:`Array` bones=[ ] **)** | ++-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`physical_bones_stop_simulation` **(** **)** | ++-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`SkinReference` | :ref:`register_skin` **(** :ref:`Skin` skin **)** | ++-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bone_disable_rest` **(** :ref:`int` bone_idx, :ref:`bool` disable **)** | ++-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bone_global_pose_override` **(** :ref:`int` bone_idx, :ref:`Transform` pose, :ref:`float` amount, :ref:`bool` persistent=false **)** | ++-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bone_parent` **(** :ref:`int` bone_idx, :ref:`int` parent_idx **)** | ++-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bone_pose` **(** :ref:`int` bone_idx, :ref:`Transform` pose **)** | ++-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bone_rest` **(** :ref:`int` bone_idx, :ref:`Transform` rest **)** | ++-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`unbind_child_node_from_bone` **(** :ref:`int` bone_idx, :ref:`Node` node **)** | ++-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`unparent_bone_and_rest` **(** :ref:`int` bone_idx **)** | ++-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Constants --------- @@ -96,27 +83,12 @@ Constants Description ----------- -Skeleton provides a hierarchical interface for managing bones, including pose, rest and animation (see :ref:`Animation`). Skeleton will support rag doll dynamics in the future. +Skeleton provides a hierarchical interface for managing bones, including pose, rest and animation (see :ref:`Animation`). It can also use ragdoll physics. The overall transform of a bone with respect to the skeleton is determined by the following hierarchical order: rest pose, custom pose and pose. Note that "global pose" below refers to the overall transform of the bone with respect to skeleton, so it not the actual global/world transform of the bone. -Property Descriptions ---------------------- - -.. _class_Skeleton_property_bones_in_world_transform: - -- :ref:`bool` **bones_in_world_transform** - -+-----------+-----------------------------------------+ -| *Default* | false | -+-----------+-----------------------------------------+ -| *Setter* | set_use_bones_in_world_transform(value) | -+-----------+-----------------------------------------+ -| *Getter* | is_using_bones_in_world_transform() | -+-----------+-----------------------------------------+ - Method Descriptions ------------------- @@ -150,12 +122,6 @@ Returns the bone index that matches ``name`` as its name. Returns the amount of bones in the skeleton. -.. _class_Skeleton_method_get_bone_custom_pose: - -- :ref:`Transform` **get_bone_custom_pose** **(** :ref:`int` bone_idx **)** const - -Returns the custom pose of the specified bone. Custom pose is applied on top of the rest pose. - .. _class_Skeleton_method_get_bone_global_pose: - :ref:`Transform` **get_bone_global_pose** **(** :ref:`int` bone_idx **)** const @@ -188,12 +154,6 @@ Returns the pose transform of the specified bone. Pose is applied on top of the Returns the rest transform for a bone ``bone_idx``. -.. _class_Skeleton_method_get_bone_transform: - -- :ref:`Transform` **get_bone_transform** **(** :ref:`int` bone_idx **)** const - -Returns the combination of custom pose and pose. The returned transform is in skeleton's reference frame. - .. _class_Skeleton_method_get_bound_child_nodes_to_bone: - :ref:`Array` **get_bound_child_nodes_to_bone** **(** :ref:`int` bone_idx **)** const @@ -224,21 +184,17 @@ Returns the combination of custom pose and pose. The returned transform is in sk - void **physical_bones_stop_simulation** **(** **)** -.. _class_Skeleton_method_set_bone_custom_pose: +.. _class_Skeleton_method_register_skin: -- void **set_bone_custom_pose** **(** :ref:`int` bone_idx, :ref:`Transform` custom_pose **)** +- :ref:`SkinReference` **register_skin** **(** :ref:`Skin` skin **)** .. _class_Skeleton_method_set_bone_disable_rest: - void **set_bone_disable_rest** **(** :ref:`int` bone_idx, :ref:`bool` disable **)** -.. _class_Skeleton_method_set_bone_global_pose: +.. _class_Skeleton_method_set_bone_global_pose_override: -- void **set_bone_global_pose** **(** :ref:`int` bone_idx, :ref:`Transform` pose **)** - -.. _class_Skeleton_method_set_bone_ignore_animation: - -- void **set_bone_ignore_animation** **(** :ref:`int` bone, :ref:`bool` ignore **)** +- void **set_bone_global_pose_override** **(** :ref:`int` bone_idx, :ref:`Transform` pose, :ref:`float` amount, :ref:`bool` persistent=false **)** .. _class_Skeleton_method_set_bone_parent: diff --git a/classes/class_skin.rst b/classes/class_skin.rst new file mode 100644 index 000000000..8c88fb92f --- /dev/null +++ b/classes/class_skin.rst @@ -0,0 +1,76 @@ +:github_url: hide + +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the Skin.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_Skin: + +Skin +==== + +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Methods +------- + ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_bind` **(** :ref:`int` bone, :ref:`Transform` pose **)** | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_binds` **(** **)** | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_bind_bone` **(** :ref:`int` bind_index **)** const | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_bind_count` **(** **)** const | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`get_bind_pose` **(** :ref:`int` bind_index **)** const | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bind_bone` **(** :ref:`int` bind_index, :ref:`int` bone **)** | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bind_count` **(** :ref:`int` bind_count **)** | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bind_pose` **(** :ref:`int` bind_index, :ref:`Transform` pose **)** | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + +Method Descriptions +------------------- + +.. _class_Skin_method_add_bind: + +- void **add_bind** **(** :ref:`int` bone, :ref:`Transform` pose **)** + +.. _class_Skin_method_clear_binds: + +- void **clear_binds** **(** **)** + +.. _class_Skin_method_get_bind_bone: + +- :ref:`int` **get_bind_bone** **(** :ref:`int` bind_index **)** const + +.. _class_Skin_method_get_bind_count: + +- :ref:`int` **get_bind_count** **(** **)** const + +.. _class_Skin_method_get_bind_pose: + +- :ref:`Transform` **get_bind_pose** **(** :ref:`int` bind_index **)** const + +.. _class_Skin_method_set_bind_bone: + +- void **set_bind_bone** **(** :ref:`int` bind_index, :ref:`int` bone **)** + +.. _class_Skin_method_set_bind_count: + +- void **set_bind_count** **(** :ref:`int` bind_count **)** + +.. _class_Skin_method_set_bind_pose: + +- void **set_bind_pose** **(** :ref:`int` bind_index, :ref:`Transform` pose **)** + diff --git a/classes/class_skinreference.rst b/classes/class_skinreference.rst new file mode 100644 index 000000000..cc61c3594 --- /dev/null +++ b/classes/class_skinreference.rst @@ -0,0 +1,40 @@ +:github_url: hide + +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the SkinReference.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_SkinReference: + +SkinReference +============= + +**Inherits:** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Methods +------- + ++-------------------------+--------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_skeleton` **(** **)** const | ++-------------------------+--------------------------------------------------------------------------------+ +| :ref:`Skin` | :ref:`get_skin` **(** **)** const | ++-------------------------+--------------------------------------------------------------------------------+ + +Method Descriptions +------------------- + +.. _class_SkinReference_method_get_skeleton: + +- :ref:`RID` **get_skeleton** **(** **)** const + +.. _class_SkinReference_method_get_skin: + +- :ref:`Skin` **get_skin** **(** **)** const + diff --git a/classes/class_slider.rst b/classes/class_slider.rst index f23047cdc..54ce2f349 100644 --- a/classes/class_slider.rst +++ b/classes/class_slider.rst @@ -23,17 +23,19 @@ Base class for GUI sliders. Properties ---------- -+------------------------------------------+-----------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`editable` | true | -+------------------------------------------+-----------------------------------------------------------------+-------+ -| :ref:`FocusMode` | :ref:`focus_mode` | 2 | -+------------------------------------------+-----------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`scrollable` | true | -+------------------------------------------+-----------------------------------------------------------------+-------+ -| :ref:`int` | :ref:`tick_count` | 0 | -+------------------------------------------+-----------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`ticks_on_borders` | false | -+------------------------------------------+-----------------------------------------------------------------+-------+ ++------------------------------------------+-----------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`editable` | true | ++------------------------------------------+-----------------------------------------------------------------+----------+ +| :ref:`FocusMode` | focus_mode | **O:** 2 | ++------------------------------------------+-----------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`scrollable` | true | ++------------------------------------------+-----------------------------------------------------------------+----------+ +| :ref:`int` | size_flags_vertical | **O:** 0 | ++------------------------------------------+-----------------------------------------------------------------+----------+ +| :ref:`int` | :ref:`tick_count` | 0 | ++------------------------------------------+-----------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`ticks_on_borders` | false | ++------------------------------------------+-----------------------------------------------------------------+----------+ Description ----------- @@ -57,18 +59,6 @@ Property Descriptions If ``true``, the slider can be interacted with. If ``false``, the value can be changed only by code. -.. _class_Slider_property_focus_mode: - -- :ref:`FocusMode` **focus_mode** - -+-----------+-----------------------+ -| *Default* | 2 | -+-----------+-----------------------+ -| *Setter* | set_focus_mode(value) | -+-----------+-----------------------+ -| *Getter* | get_focus_mode() | -+-----------+-----------------------+ - .. _class_Slider_property_scrollable: - :ref:`bool` **scrollable** diff --git a/classes/class_streamtexture.rst b/classes/class_streamtexture.rst index 02817ec22..9173c5427 100644 --- a/classes/class_streamtexture.rst +++ b/classes/class_streamtexture.rst @@ -21,9 +21,11 @@ A ``.stex`` texture. Properties ---------- -+-----------------------------+----------------------------------------------------------+----+ -| :ref:`String` | :ref:`load_path` | "" | -+-----------------------------+----------------------------------------------------------+----+ ++-----------------------------+----------------------------------------------------------+----------+ +| :ref:`int` | flags | **O:** 0 | ++-----------------------------+----------------------------------------------------------+----------+ +| :ref:`String` | :ref:`load_path` | "" | ++-----------------------------+----------------------------------------------------------+----------+ Methods ------- diff --git a/classes/class_string.rst b/classes/class_string.rst index 8b043a1c5..6f043794d 100644 --- a/classes/class_string.rst +++ b/classes/class_string.rst @@ -174,6 +174,8 @@ Methods +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`replacen` **(** :ref:`String` what, :ref:`String` forwhat **)** | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`repeat` **(** :ref:`int` count **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`rfind` **(** :ref:`String` what, :ref:`int` from=-1 **)** | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`rfindn` **(** :ref:`String` what, :ref:`int` from=-1 **)** | @@ -668,6 +670,12 @@ Replaces occurrences of a case-sensitive substring with the given one inside the Replaces occurrences of a case-insensitive substring with the given one inside the string. +.. _class_String_method_repeat: + +- :ref:`String` **repeat** **(** :ref:`int` count **)** + +Returns original string repeated a number of times. The number of repetitions is given by the argument. + .. _class_String_method_rfind: - :ref:`int` **rfind** **(** :ref:`String` what, :ref:`int` from=-1 **)** diff --git a/classes/class_textedit.rst b/classes/class_textedit.rst index e3519613b..f63a9eab6 100644 --- a/classes/class_textedit.rst +++ b/classes/class_textedit.rst @@ -21,51 +21,59 @@ Multiline text editing control. Properties ---------- -+-----------------------------+-------------------------------------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`breakpoint_gutter` | false | -+-----------------------------+-------------------------------------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`caret_blink` | false | -+-----------------------------+-------------------------------------------------------------------------------------------+-------+ -| :ref:`float` | :ref:`caret_blink_speed` | 0.65 | -+-----------------------------+-------------------------------------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`caret_block_mode` | false | -+-----------------------------+-------------------------------------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`caret_moving_by_right_click` | true | -+-----------------------------+-------------------------------------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`context_menu_enabled` | true | -+-----------------------------+-------------------------------------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`draw_spaces` | false | -+-----------------------------+-------------------------------------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`draw_tabs` | false | -+-----------------------------+-------------------------------------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`fold_gutter` | false | -+-----------------------------+-------------------------------------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`hiding_enabled` | false | -+-----------------------------+-------------------------------------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`highlight_all_occurrences` | false | -+-----------------------------+-------------------------------------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`highlight_current_line` | false | -+-----------------------------+-------------------------------------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`minimap_draw` | false | -+-----------------------------+-------------------------------------------------------------------------------------------+-------+ -| :ref:`int` | :ref:`minimap_width` | 80 | -+-----------------------------+-------------------------------------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`override_selected_font_color` | false | -+-----------------------------+-------------------------------------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`readonly` | false | -+-----------------------------+-------------------------------------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`show_line_numbers` | false | -+-----------------------------+-------------------------------------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`smooth_scrolling` | false | -+-----------------------------+-------------------------------------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`syntax_highlighting` | false | -+-----------------------------+-------------------------------------------------------------------------------------------+-------+ -| :ref:`String` | :ref:`text` | "" | -+-----------------------------+-------------------------------------------------------------------------------------------+-------+ -| :ref:`float` | :ref:`v_scroll_speed` | 80.0 | -+-----------------------------+-------------------------------------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`wrap_enabled` | false | -+-----------------------------+-------------------------------------------------------------------------------------------+-------+ ++----------------------------------------------+-------------------------------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`breakpoint_gutter` | false | ++----------------------------------------------+-------------------------------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`caret_blink` | false | ++----------------------------------------------+-------------------------------------------------------------------------------------------+----------+ +| :ref:`float` | :ref:`caret_blink_speed` | 0.65 | ++----------------------------------------------+-------------------------------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`caret_block_mode` | false | ++----------------------------------------------+-------------------------------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`caret_moving_by_right_click` | true | ++----------------------------------------------+-------------------------------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`context_menu_enabled` | true | ++----------------------------------------------+-------------------------------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`draw_spaces` | false | ++----------------------------------------------+-------------------------------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`draw_tabs` | false | ++----------------------------------------------+-------------------------------------------------------------------------------------------+----------+ +| :ref:`FocusMode` | focus_mode | **O:** 2 | ++----------------------------------------------+-------------------------------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`fold_gutter` | false | ++----------------------------------------------+-------------------------------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`hiding_enabled` | false | ++----------------------------------------------+-------------------------------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`highlight_all_occurrences` | false | ++----------------------------------------------+-------------------------------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`highlight_current_line` | false | ++----------------------------------------------+-------------------------------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`minimap_draw` | false | ++----------------------------------------------+-------------------------------------------------------------------------------------------+----------+ +| :ref:`int` | :ref:`minimap_width` | 80 | ++----------------------------------------------+-------------------------------------------------------------------------------------------+----------+ +| :ref:`CursorShape` | mouse_default_cursor_shape | **O:** 1 | ++----------------------------------------------+-------------------------------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`override_selected_font_color` | false | ++----------------------------------------------+-------------------------------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`readonly` | false | ++----------------------------------------------+-------------------------------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`selecting_enabled` | true | ++----------------------------------------------+-------------------------------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`shortcut_keys_enabled` | true | ++----------------------------------------------+-------------------------------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`show_line_numbers` | false | ++----------------------------------------------+-------------------------------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`smooth_scrolling` | false | ++----------------------------------------------+-------------------------------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`syntax_highlighting` | false | ++----------------------------------------------+-------------------------------------------------------------------------------------------+----------+ +| :ref:`String` | :ref:`text` | "" | ++----------------------------------------------+-------------------------------------------------------------------------------------------+----------+ +| :ref:`float` | :ref:`v_scroll_speed` | 80.0 | ++----------------------------------------------+-------------------------------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`wrap_enabled` | false | ++----------------------------------------------+-------------------------------------------------------------------------------------------+----------+ Methods ------- @@ -561,6 +569,30 @@ If ``true``, the line containing the cursor is highlighted. If ``true``, read-only mode is enabled. Existing text cannot be modified and new text cannot be added. +.. _class_TextEdit_property_selecting_enabled: + +- :ref:`bool` **selecting_enabled** + ++-----------+------------------------------+ +| *Default* | true | ++-----------+------------------------------+ +| *Setter* | set_selecting_enabled(value) | ++-----------+------------------------------+ +| *Getter* | is_selecting_enabled() | ++-----------+------------------------------+ + +.. _class_TextEdit_property_shortcut_keys_enabled: + +- :ref:`bool` **shortcut_keys_enabled** + ++-----------+----------------------------------+ +| *Default* | true | ++-----------+----------------------------------+ +| *Setter* | set_shortcut_keys_enabled(value) | ++-----------+----------------------------------+ +| *Getter* | is_shortcut_keys_enabled() | ++-----------+----------------------------------+ + .. _class_TextEdit_property_show_line_numbers: - :ref:`bool` **show_line_numbers** diff --git a/classes/class_texture3d.rst b/classes/class_texture3d.rst index 28564320e..b5685c528 100644 --- a/classes/class_texture3d.rst +++ b/classes/class_texture3d.rst @@ -18,3 +18,10 @@ Brief Description +Properties +---------- + ++-------------------------------------+------+-----------------------------------------------------------------------------------+ +| :ref:`Dictionary` | data | **O:** {"depth": 0,"flags": 4,"format": 37,"height": 0,"layers": [ ],"width": 0} | ++-------------------------------------+------+-----------------------------------------------------------------------------------+ + diff --git a/classes/class_textureprogress.rst b/classes/class_textureprogress.rst index f43fd351f..f1d346e3e 100644 --- a/classes/class_textureprogress.rst +++ b/classes/class_textureprogress.rst @@ -21,37 +21,39 @@ Texture-based progress bar. Useful for loading screens and life or stamina bars. Properties ---------- -+-------------------------------+------------------------------------------------------------------------------------+---------------------+ -| :ref:`int` | :ref:`fill_mode` | 0 | -+-------------------------------+------------------------------------------------------------------------------------+---------------------+ -| :ref:`bool` | :ref:`nine_patch_stretch` | false | -+-------------------------------+------------------------------------------------------------------------------------+---------------------+ -| :ref:`Vector2` | :ref:`radial_center_offset` | Vector2( 0, 0 ) | -+-------------------------------+------------------------------------------------------------------------------------+---------------------+ -| :ref:`float` | :ref:`radial_fill_degrees` | 360.0 | -+-------------------------------+------------------------------------------------------------------------------------+---------------------+ -| :ref:`float` | :ref:`radial_initial_angle` | 0.0 | -+-------------------------------+------------------------------------------------------------------------------------+---------------------+ -| :ref:`int` | :ref:`stretch_margin_bottom` | 0 | -+-------------------------------+------------------------------------------------------------------------------------+---------------------+ -| :ref:`int` | :ref:`stretch_margin_left` | 0 | -+-------------------------------+------------------------------------------------------------------------------------+---------------------+ -| :ref:`int` | :ref:`stretch_margin_right` | 0 | -+-------------------------------+------------------------------------------------------------------------------------+---------------------+ -| :ref:`int` | :ref:`stretch_margin_top` | 0 | -+-------------------------------+------------------------------------------------------------------------------------+---------------------+ -| :ref:`Texture` | :ref:`texture_over` | | -+-------------------------------+------------------------------------------------------------------------------------+---------------------+ -| :ref:`Texture` | :ref:`texture_progress` | | -+-------------------------------+------------------------------------------------------------------------------------+---------------------+ -| :ref:`Texture` | :ref:`texture_under` | | -+-------------------------------+------------------------------------------------------------------------------------+---------------------+ -| :ref:`Color` | :ref:`tint_over` | Color( 1, 1, 1, 1 ) | -+-------------------------------+------------------------------------------------------------------------------------+---------------------+ -| :ref:`Color` | :ref:`tint_progress` | Color( 1, 1, 1, 1 ) | -+-------------------------------+------------------------------------------------------------------------------------+---------------------+ -| :ref:`Color` | :ref:`tint_under` | Color( 1, 1, 1, 1 ) | -+-------------------------------+------------------------------------------------------------------------------------+---------------------+ ++----------------------------------------------+------------------------------------------------------------------------------------+---------------------+ +| :ref:`int` | :ref:`fill_mode` | 0 | ++----------------------------------------------+------------------------------------------------------------------------------------+---------------------+ +| :ref:`MouseFilter` | mouse_filter | **O:** 1 | ++----------------------------------------------+------------------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`nine_patch_stretch` | false | ++----------------------------------------------+------------------------------------------------------------------------------------+---------------------+ +| :ref:`Vector2` | :ref:`radial_center_offset` | Vector2( 0, 0 ) | ++----------------------------------------------+------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`radial_fill_degrees` | 360.0 | ++----------------------------------------------+------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`radial_initial_angle` | 0.0 | ++----------------------------------------------+------------------------------------------------------------------------------------+---------------------+ +| :ref:`int` | :ref:`stretch_margin_bottom` | 0 | ++----------------------------------------------+------------------------------------------------------------------------------------+---------------------+ +| :ref:`int` | :ref:`stretch_margin_left` | 0 | ++----------------------------------------------+------------------------------------------------------------------------------------+---------------------+ +| :ref:`int` | :ref:`stretch_margin_right` | 0 | ++----------------------------------------------+------------------------------------------------------------------------------------+---------------------+ +| :ref:`int` | :ref:`stretch_margin_top` | 0 | ++----------------------------------------------+------------------------------------------------------------------------------------+---------------------+ +| :ref:`Texture` | :ref:`texture_over` | | ++----------------------------------------------+------------------------------------------------------------------------------------+---------------------+ +| :ref:`Texture` | :ref:`texture_progress` | | ++----------------------------------------------+------------------------------------------------------------------------------------+---------------------+ +| :ref:`Texture` | :ref:`texture_under` | | ++----------------------------------------------+------------------------------------------------------------------------------------+---------------------+ +| :ref:`Color` | :ref:`tint_over` | Color( 1, 1, 1, 1 ) | ++----------------------------------------------+------------------------------------------------------------------------------------+---------------------+ +| :ref:`Color` | :ref:`tint_progress` | Color( 1, 1, 1, 1 ) | ++----------------------------------------------+------------------------------------------------------------------------------------+---------------------+ +| :ref:`Color` | :ref:`tint_under` | Color( 1, 1, 1, 1 ) | ++----------------------------------------------+------------------------------------------------------------------------------------+---------------------+ Methods ------- diff --git a/classes/class_texturerect.rst b/classes/class_texturerect.rst index 47b65c1f9..597d74299 100644 --- a/classes/class_texturerect.rst +++ b/classes/class_texturerect.rst @@ -21,17 +21,19 @@ Control for drawing textures. Properties ---------- -+--------------------------------------------------+--------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`expand` | false | -+--------------------------------------------------+--------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`flip_h` | false | -+--------------------------------------------------+--------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`flip_v` | false | -+--------------------------------------------------+--------------------------------------------------------------+-------+ -| :ref:`StretchMode` | :ref:`stretch_mode` | 0 | -+--------------------------------------------------+--------------------------------------------------------------+-------+ -| :ref:`Texture` | :ref:`texture` | | -+--------------------------------------------------+--------------------------------------------------------------+-------+ ++--------------------------------------------------+--------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`expand` | false | ++--------------------------------------------------+--------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`flip_h` | false | ++--------------------------------------------------+--------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`flip_v` | false | ++--------------------------------------------------+--------------------------------------------------------------+----------+ +| :ref:`MouseFilter` | mouse_filter | **O:** 1 | ++--------------------------------------------------+--------------------------------------------------------------+----------+ +| :ref:`StretchMode` | :ref:`stretch_mode` | 0 | ++--------------------------------------------------+--------------------------------------------------------------+----------+ +| :ref:`Texture` | :ref:`texture` | | ++--------------------------------------------------+--------------------------------------------------------------+----------+ Enumerations ------------ diff --git a/classes/class_tilemap.rst b/classes/class_tilemap.rst index 4652cddb7..8294d38bd 100644 --- a/classes/class_tilemap.rst +++ b/classes/class_tilemap.rst @@ -21,43 +21,43 @@ Node for 2D tile-based maps. Properties ---------- -+--------------------------------------------+--------------------------------------------------------------------------------+---------------------------------+ -| :ref:`bool` | :ref:`cell_clip_uv` | false | -+--------------------------------------------+--------------------------------------------------------------------------------+---------------------------------+ -| :ref:`Transform2D` | :ref:`cell_custom_transform` | Transform2D( 1, 0, 0, 1, 0, 0 ) | -+--------------------------------------------+--------------------------------------------------------------------------------+---------------------------------+ -| :ref:`HalfOffset` | :ref:`cell_half_offset` | 2 | -+--------------------------------------------+--------------------------------------------------------------------------------+---------------------------------+ -| :ref:`int` | :ref:`cell_quadrant_size` | 16 | -+--------------------------------------------+--------------------------------------------------------------------------------+---------------------------------+ -| :ref:`Vector2` | :ref:`cell_size` | Vector2( 64, 64 ) | -+--------------------------------------------+--------------------------------------------------------------------------------+---------------------------------+ -| :ref:`TileOrigin` | :ref:`cell_tile_origin` | 0 | -+--------------------------------------------+--------------------------------------------------------------------------------+---------------------------------+ -| :ref:`bool` | :ref:`cell_y_sort` | false | -+--------------------------------------------+--------------------------------------------------------------------------------+---------------------------------+ -| :ref:`bool` | :ref:`centered_textures` | false | -+--------------------------------------------+--------------------------------------------------------------------------------+---------------------------------+ -| :ref:`float` | :ref:`collision_bounce` | 0.0 | -+--------------------------------------------+--------------------------------------------------------------------------------+---------------------------------+ -| :ref:`float` | :ref:`collision_friction` | 1.0 | -+--------------------------------------------+--------------------------------------------------------------------------------+---------------------------------+ -| :ref:`int` | :ref:`collision_layer` | 1 | -+--------------------------------------------+--------------------------------------------------------------------------------+---------------------------------+ -| :ref:`int` | :ref:`collision_mask` | 1 | -+--------------------------------------------+--------------------------------------------------------------------------------+---------------------------------+ -| :ref:`bool` | :ref:`collision_use_kinematic` | false | -+--------------------------------------------+--------------------------------------------------------------------------------+---------------------------------+ -| :ref:`bool` | :ref:`collision_use_parent` | false | -+--------------------------------------------+--------------------------------------------------------------------------------+---------------------------------+ -| :ref:`bool` | :ref:`compatibility_mode` | false | -+--------------------------------------------+--------------------------------------------------------------------------------+---------------------------------+ -| :ref:`Mode` | :ref:`mode` | 0 | -+--------------------------------------------+--------------------------------------------------------------------------------+---------------------------------+ -| :ref:`int` | :ref:`occluder_light_mask` | 1 | -+--------------------------------------------+--------------------------------------------------------------------------------+---------------------------------+ -| :ref:`TileSet` | :ref:`tile_set` | | -+--------------------------------------------+--------------------------------------------------------------------------------+---------------------------------+ ++--------------------------------------------+--------------------------------------------------------------------------------+-----------------------------------+ +| :ref:`bool` | :ref:`cell_clip_uv` | false | ++--------------------------------------------+--------------------------------------------------------------------------------+-----------------------------------+ +| :ref:`Transform2D` | :ref:`cell_custom_transform` | Transform2D( 64, 0, 0, 64, 0, 0 ) | ++--------------------------------------------+--------------------------------------------------------------------------------+-----------------------------------+ +| :ref:`HalfOffset` | :ref:`cell_half_offset` | 2 | ++--------------------------------------------+--------------------------------------------------------------------------------+-----------------------------------+ +| :ref:`int` | :ref:`cell_quadrant_size` | 16 | ++--------------------------------------------+--------------------------------------------------------------------------------+-----------------------------------+ +| :ref:`Vector2` | :ref:`cell_size` | Vector2( 64, 64 ) | ++--------------------------------------------+--------------------------------------------------------------------------------+-----------------------------------+ +| :ref:`TileOrigin` | :ref:`cell_tile_origin` | 0 | ++--------------------------------------------+--------------------------------------------------------------------------------+-----------------------------------+ +| :ref:`bool` | :ref:`cell_y_sort` | false | ++--------------------------------------------+--------------------------------------------------------------------------------+-----------------------------------+ +| :ref:`bool` | :ref:`centered_textures` | false | ++--------------------------------------------+--------------------------------------------------------------------------------+-----------------------------------+ +| :ref:`float` | :ref:`collision_bounce` | 0.0 | ++--------------------------------------------+--------------------------------------------------------------------------------+-----------------------------------+ +| :ref:`float` | :ref:`collision_friction` | 1.0 | ++--------------------------------------------+--------------------------------------------------------------------------------+-----------------------------------+ +| :ref:`int` | :ref:`collision_layer` | 1 | ++--------------------------------------------+--------------------------------------------------------------------------------+-----------------------------------+ +| :ref:`int` | :ref:`collision_mask` | 1 | ++--------------------------------------------+--------------------------------------------------------------------------------+-----------------------------------+ +| :ref:`bool` | :ref:`collision_use_kinematic` | false | ++--------------------------------------------+--------------------------------------------------------------------------------+-----------------------------------+ +| :ref:`bool` | :ref:`collision_use_parent` | false | ++--------------------------------------------+--------------------------------------------------------------------------------+-----------------------------------+ +| :ref:`bool` | :ref:`compatibility_mode` | false | ++--------------------------------------------+--------------------------------------------------------------------------------+-----------------------------------+ +| :ref:`Mode` | :ref:`mode` | 0 | ++--------------------------------------------+--------------------------------------------------------------------------------+-----------------------------------+ +| :ref:`int` | :ref:`occluder_light_mask` | 1 | ++--------------------------------------------+--------------------------------------------------------------------------------+-----------------------------------+ +| :ref:`TileSet` | :ref:`tile_set` | | ++--------------------------------------------+--------------------------------------------------------------------------------+-----------------------------------+ Methods ------- @@ -212,13 +212,13 @@ Property Descriptions - :ref:`Transform2D` **cell_custom_transform** -+-----------+---------------------------------+ -| *Default* | Transform2D( 1, 0, 0, 1, 0, 0 ) | -+-----------+---------------------------------+ -| *Setter* | set_custom_transform(value) | -+-----------+---------------------------------+ -| *Getter* | get_custom_transform() | -+-----------+---------------------------------+ ++-----------+-----------------------------------+ +| *Default* | Transform2D( 64, 0, 0, 64, 0, 0 ) | ++-----------+-----------------------------------+ +| *Setter* | set_custom_transform(value) | ++-----------+-----------------------------------+ +| *Getter* | get_custom_transform() | ++-----------+-----------------------------------+ The custom :ref:`Transform2D` to be applied to the TileMap's cells. diff --git a/classes/class_toolbutton.rst b/classes/class_toolbutton.rst index be3f69ac3..bb1ce1f1c 100644 --- a/classes/class_toolbutton.rst +++ b/classes/class_toolbutton.rst @@ -18,6 +18,13 @@ Brief Description Flat button helper class. +Properties +---------- + ++-------------------------+------+-------------+ +| :ref:`bool` | flat | **O:** true | ++-------------------------+------+-------------+ + Theme Properties ---------------- diff --git a/classes/class_tree.rst b/classes/class_tree.rst index f996020a6..3a23e9f54 100644 --- a/classes/class_tree.rst +++ b/classes/class_tree.rst @@ -21,21 +21,25 @@ Control to show a tree of items. Properties ---------- -+-----------------------------------------+---------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`allow_reselect` | false | -+-----------------------------------------+---------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`allow_rmb_select` | false | -+-----------------------------------------+---------------------------------------------------------------+-------+ -| :ref:`int` | :ref:`columns` | 1 | -+-----------------------------------------+---------------------------------------------------------------+-------+ -| :ref:`int` | :ref:`drop_mode_flags` | 0 | -+-----------------------------------------+---------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`hide_folding` | false | -+-----------------------------------------+---------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`hide_root` | false | -+-----------------------------------------+---------------------------------------------------------------+-------+ -| :ref:`SelectMode` | :ref:`select_mode` | 0 | -+-----------------------------------------+---------------------------------------------------------------+-------+ ++------------------------------------------+---------------------------------------------------------------+-------------+ +| :ref:`bool` | :ref:`allow_reselect` | false | ++------------------------------------------+---------------------------------------------------------------+-------------+ +| :ref:`bool` | :ref:`allow_rmb_select` | false | ++------------------------------------------+---------------------------------------------------------------+-------------+ +| :ref:`int` | :ref:`columns` | 1 | ++------------------------------------------+---------------------------------------------------------------+-------------+ +| :ref:`int` | :ref:`drop_mode_flags` | 0 | ++------------------------------------------+---------------------------------------------------------------+-------------+ +| :ref:`FocusMode` | focus_mode | **O:** 2 | ++------------------------------------------+---------------------------------------------------------------+-------------+ +| :ref:`bool` | :ref:`hide_folding` | false | ++------------------------------------------+---------------------------------------------------------------+-------------+ +| :ref:`bool` | :ref:`hide_root` | false | ++------------------------------------------+---------------------------------------------------------------+-------------+ +| :ref:`bool` | rect_clip_content | **O:** true | ++------------------------------------------+---------------------------------------------------------------+-------------+ +| :ref:`SelectMode` | :ref:`select_mode` | 0 | ++------------------------------------------+---------------------------------------------------------------+-------------+ Methods ------- @@ -134,8 +138,6 @@ Theme Properties +---------------------------------+------------------------------+------------------------------+ | :ref:`Color` | guide_color | Color( 0, 0, 0, 0.1 ) | +---------------------------------+------------------------------+------------------------------+ -| :ref:`int` | guide_width | 2 | -+---------------------------------+------------------------------+------------------------------+ | :ref:`int` | hseparation | 4 | +---------------------------------+------------------------------+------------------------------+ | :ref:`int` | item_margin | 12 | diff --git a/classes/class_vehiclebody.rst b/classes/class_vehiclebody.rst index 4c5e0a39d..ed9441876 100644 --- a/classes/class_vehiclebody.rst +++ b/classes/class_vehiclebody.rst @@ -21,13 +21,17 @@ Physics body that simulates the behavior of a car. Properties ---------- -+---------------------------+--------------------------------------------------------------+-----+ -| :ref:`float` | :ref:`brake` | 0.0 | -+---------------------------+--------------------------------------------------------------+-----+ -| :ref:`float` | :ref:`engine_force` | 0.0 | -+---------------------------+--------------------------------------------------------------+-----+ -| :ref:`float` | :ref:`steering` | 0.0 | -+---------------------------+--------------------------------------------------------------+-----+ ++---------------------------+--------------------------------------------------------------+--------------+ +| :ref:`float` | :ref:`brake` | 0.0 | ++---------------------------+--------------------------------------------------------------+--------------+ +| :ref:`float` | :ref:`engine_force` | 0.0 | ++---------------------------+--------------------------------------------------------------+--------------+ +| :ref:`float` | mass | **O:** 40.0 | ++---------------------------+--------------------------------------------------------------+--------------+ +| :ref:`float` | :ref:`steering` | 0.0 | ++---------------------------+--------------------------------------------------------------+--------------+ +| :ref:`float` | weight | **O:** 392.0 | ++---------------------------+--------------------------------------------------------------+--------------+ Description ----------- diff --git a/classes/class_viewport.rst b/classes/class_viewport.rst index 792ec76a1..b195fa3c4 100644 --- a/classes/class_viewport.rst +++ b/classes/class_viewport.rst @@ -671,7 +671,9 @@ The subdivision amount of fourth quadrant on shadow atlas. | *Getter* | get_shadow_atlas_size() | +-----------+------------------------------+ -The resolution of shadow atlas. Both width and height is equal to one value. +The shadow atlas' resolution (used for omni and spot lights). The value will be rounded up to the nearest power of 2. + +**Note:** If this is set to 0, shadows won't be visible. Since user-created viewports default to a value of 0, this value must be set above 0 manually. .. _class_Viewport_property_size: diff --git a/classes/class_viewporttexture.rst b/classes/class_viewporttexture.rst index f05ba36cf..47f1e612d 100644 --- a/classes/class_viewporttexture.rst +++ b/classes/class_viewporttexture.rst @@ -21,6 +21,10 @@ Texture which displays the content of a :ref:`Viewport`. Properties ---------- ++---------------------------------+--------------------------------------------------------------------+--------------+ +| :ref:`int` | flags | **O:** 0 | ++---------------------------------+--------------------------------------------------------------------+--------------+ +| :ref:`bool` | resource_local_to_scene | **O:** true | +---------------------------------+--------------------------------------------------------------------+--------------+ | :ref:`NodePath` | :ref:`viewport_path` | NodePath("") | +---------------------------------+--------------------------------------------------------------------+--------------+ diff --git a/classes/class_visibilityenabler2d.rst b/classes/class_visibilityenabler2d.rst index 78fc86abe..6a473bed6 100644 --- a/classes/class_visibilityenabler2d.rst +++ b/classes/class_visibilityenabler2d.rst @@ -82,7 +82,7 @@ enum **Enabler**: Description ----------- -The VisibilityEnabler2D will disable :ref:`RigidBody2D`, :ref:`AnimationPlayer`, and other nodes when they are not visible. It will only affect other nodes within the same scene as the VisibilityEnabler2D itself. +The VisibilityEnabler2D will disable :ref:`RigidBody2D`, :ref:`AnimationPlayer`, and other nodes when they are not visible. It will only affect nodes with the same root node as the VisibilityEnabler2D, and the root node itself. Property Descriptions --------------------- diff --git a/classes/class_visualscriptbuiltinfunc.rst b/classes/class_visualscriptbuiltinfunc.rst index 7d32be51c..0030961b8 100644 --- a/classes/class_visualscriptbuiltinfunc.rst +++ b/classes/class_visualscriptbuiltinfunc.rst @@ -164,6 +164,8 @@ Enumerations .. _class_VisualScriptBuiltinFunc_constant_MATH_LERP_ANGLE: +.. _class_VisualScriptBuiltinFunc_constant_TEXT_ORD: + .. _class_VisualScriptBuiltinFunc_constant_FUNC_MAX: enum **BuiltinFunc**: @@ -309,7 +311,9 @@ enum **BuiltinFunc**: - **MATH_LERP_ANGLE** = **66** -- **FUNC_MAX** = **67** --- Represents the size of the :ref:`BuiltinFunc` enum. +- **TEXT_ORD** = **67** + +- **FUNC_MAX** = **68** --- Represents the size of the :ref:`BuiltinFunc` enum. Description ----------- diff --git a/classes/class_visualserver.rst b/classes/class_visualserver.rst index 04ce21c5d..1f4a755bf 100644 --- a/classes/class_visualserver.rst +++ b/classes/class_visualserver.rst @@ -50,7 +50,7 @@ Methods +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_item_add_line` **(** :ref:`RID` item, :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_mesh` **(** :ref:`RID` item, :ref:`RID` mesh, :ref:`Transform2D` texture, :ref:`Color` normal_map, :ref:`RID` arg4, :ref:`RID` arg5 **)** | +| void | :ref:`canvas_item_add_mesh` **(** :ref:`RID` item, :ref:`RID` mesh, :ref:`Transform2D` transform=Transform2D( 1, 0, 0, 1, 0, 0 ), :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`RID` texture, :ref:`RID` normal_map **)** | +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_item_add_multimesh` **(** :ref:`RID` item, :ref:`RID` mesh, :ref:`RID` texture, :ref:`RID` normal_map **)** | +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -1858,7 +1858,7 @@ Adds a line command to the :ref:`CanvasItem`'s draw commands. .. _class_VisualServer_method_canvas_item_add_mesh: -- void **canvas_item_add_mesh** **(** :ref:`RID` item, :ref:`RID` mesh, :ref:`Transform2D` texture, :ref:`Color` normal_map, :ref:`RID` arg4, :ref:`RID` arg5 **)** +- void **canvas_item_add_mesh** **(** :ref:`RID` item, :ref:`RID` mesh, :ref:`Transform2D` transform=Transform2D( 1, 0, 0, 1, 0, 0 ), :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`RID` texture, :ref:`RID` normal_map **)** .. _class_VisualServer_method_canvas_item_add_multimesh: @@ -3538,7 +3538,7 @@ Sets the shadow atlas quadrant's subdivision. - void **viewport_set_shadow_atlas_size** **(** :ref:`RID` viewport, :ref:`int` size **)** -Sets the size of the shadow atlas's images. +Sets the size of the shadow atlas's images (used for omni and spot lights). The value will be rounded up to the nearest power of 2. .. _class_VisualServer_method_viewport_set_size: diff --git a/classes/class_visualshader.rst b/classes/class_visualshader.rst index a069a8521..136625b59 100644 --- a/classes/class_visualshader.rst +++ b/classes/class_visualshader.rst @@ -21,9 +21,11 @@ Brief Description Properties ---------- -+-------------------------------+---------------------------------------------------------------+-----------------+ -| :ref:`Vector2` | :ref:`graph_offset` | Vector2( 0, 0 ) | -+-------------------------------+---------------------------------------------------------------+-----------------+ ++-------------------------------+---------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | code | **O:** "shader_type spatial;void vertex() {// Output:0}void fragment() {// Output:0}void light() {// Output:0}" | ++-------------------------------+---------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`graph_offset` | Vector2( 0, 0 ) | ++-------------------------------+---------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ Methods ------- diff --git a/classes/class_visualshadernodebooleanconstant.rst b/classes/class_visualshadernodebooleanconstant.rst index 23838e642..6515258b1 100644 --- a/classes/class_visualshadernodebooleanconstant.rst +++ b/classes/class_visualshadernodebooleanconstant.rst @@ -21,9 +21,11 @@ Brief Description Properties ---------- -+-------------------------+--------------------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`constant` | false | -+-------------------------+--------------------------------------------------------------------------+-------+ ++---------------------------+--------------------------------------------------------------------------+-------------+ +| :ref:`bool` | :ref:`constant` | false | ++---------------------------+--------------------------------------------------------------------------+-------------+ +| :ref:`Array` | default_input_values | **O:** [ ] | ++---------------------------+--------------------------------------------------------------------------+-------------+ Property Descriptions --------------------- diff --git a/classes/class_visualshadernodecolorconstant.rst b/classes/class_visualshadernodecolorconstant.rst index 8fff81a37..9dffb3b34 100644 --- a/classes/class_visualshadernodecolorconstant.rst +++ b/classes/class_visualshadernodecolorconstant.rst @@ -24,6 +24,8 @@ Properties +---------------------------+------------------------------------------------------------------------+---------------------+ | :ref:`Color` | :ref:`constant` | Color( 1, 1, 1, 1 ) | +---------------------------+------------------------------------------------------------------------+---------------------+ +| :ref:`Array` | default_input_values | **O:** [ ] | ++---------------------------+------------------------------------------------------------------------+---------------------+ Property Descriptions --------------------- diff --git a/classes/class_visualshadernodecolorop.rst b/classes/class_visualshadernodecolorop.rst index 7b3a8d9b5..7b205b27e 100644 --- a/classes/class_visualshadernodecolorop.rst +++ b/classes/class_visualshadernodecolorop.rst @@ -21,9 +21,11 @@ Brief Description Properties ---------- -+--------------------------------------------------------+------------------------------------------------------------------+---+ -| :ref:`Operator` | :ref:`operator` | 0 | -+--------------------------------------------------------+------------------------------------------------------------------+---+ ++--------------------------------------------------------+------------------------------------------------------------------+---------------------------------------------------------+ +| :ref:`Array` | default_input_values | **O:** [ 0, Vector3( 0, 0, 0 ), 1, Vector3( 0, 0, 0 ) ] | ++--------------------------------------------------------+------------------------------------------------------------------+---------------------------------------------------------+ +| :ref:`Operator` | :ref:`operator` | 0 | ++--------------------------------------------------------+------------------------------------------------------------------+---------------------------------------------------------+ Enumerations ------------ diff --git a/classes/class_visualshadernodecompare.rst b/classes/class_visualshadernodecompare.rst index 0bfa9239b..1c20a0bee 100644 --- a/classes/class_visualshadernodecompare.rst +++ b/classes/class_visualshadernodecompare.rst @@ -21,13 +21,15 @@ Brief Description Properties ---------- -+--------------------------------------------------------------------+--------------------------------------------------------------------+---+ -| :ref:`Condition` | :ref:`condition` | 0 | -+--------------------------------------------------------------------+--------------------------------------------------------------------+---+ -| :ref:`Function` | :ref:`function` | 0 | -+--------------------------------------------------------------------+--------------------------------------------------------------------+---+ -| :ref:`ComparsionType` | :ref:`type` | 0 | -+--------------------------------------------------------------------+--------------------------------------------------------------------+---+ ++--------------------------------------------------------------------+--------------------------------------------------------------------+-------------------------------------+ +| :ref:`Condition` | :ref:`condition` | 0 | ++--------------------------------------------------------------------+--------------------------------------------------------------------+-------------------------------------+ +| :ref:`Array` | default_input_values | **O:** [ 0, 0.0, 1, 0.0, 2, 1e-05 ] | ++--------------------------------------------------------------------+--------------------------------------------------------------------+-------------------------------------+ +| :ref:`Function` | :ref:`function` | 0 | ++--------------------------------------------------------------------+--------------------------------------------------------------------+-------------------------------------+ +| :ref:`ComparsionType` | :ref:`type` | 0 | ++--------------------------------------------------------------------+--------------------------------------------------------------------+-------------------------------------+ Enumerations ------------ diff --git a/classes/class_visualshadernodecubemap.rst b/classes/class_visualshadernodecubemap.rst index 4ef76b755..a6087129b 100644 --- a/classes/class_visualshadernodecubemap.rst +++ b/classes/class_visualshadernodecubemap.rst @@ -21,11 +21,13 @@ Brief Description Properties ---------- -+--------------------------------------------------------------+--------------------------------------------------------------------------+---+ -| :ref:`CubeMap` | :ref:`cube_map` | | -+--------------------------------------------------------------+--------------------------------------------------------------------------+---+ -| :ref:`TextureType` | :ref:`texture_type` | 0 | -+--------------------------------------------------------------+--------------------------------------------------------------------------+---+ ++--------------------------------------------------------------+--------------------------------------------------------------------------+-------------+ +| :ref:`CubeMap` | :ref:`cube_map` | | ++--------------------------------------------------------------+--------------------------------------------------------------------------+-------------+ +| :ref:`Array` | default_input_values | **O:** [ ] | ++--------------------------------------------------------------+--------------------------------------------------------------------------+-------------+ +| :ref:`TextureType` | :ref:`texture_type` | 0 | ++--------------------------------------------------------------+--------------------------------------------------------------------------+-------------+ Enumerations ------------ diff --git a/classes/class_visualshadernodecubemapuniform.rst b/classes/class_visualshadernodecubemapuniform.rst index 5fd802b46..53e71ea70 100644 --- a/classes/class_visualshadernodecubemapuniform.rst +++ b/classes/class_visualshadernodecubemapuniform.rst @@ -18,3 +18,10 @@ Brief Description +Properties +---------- + ++---------------------------+----------------------+-------------+ +| :ref:`Array` | default_input_values | **O:** [ ] | ++---------------------------+----------------------+-------------+ + diff --git a/classes/class_visualshadernodecustom.rst b/classes/class_visualshadernodecustom.rst index ca73651d6..80d40a380 100644 --- a/classes/class_visualshadernodecustom.rst +++ b/classes/class_visualshadernodecustom.rst @@ -18,6 +18,13 @@ Brief Description Virtual class to define custom :ref:`VisualShaderNode`\ s for use in the Visual Shader Editor. +Properties +---------- + ++---------------------------+----------------------+-------------+ +| :ref:`Array` | default_input_values | **O:** [ ] | ++---------------------------+----------------------+-------------+ + Methods ------- diff --git a/classes/class_visualshadernodedeterminant.rst b/classes/class_visualshadernodedeterminant.rst index ab801f4de..e216be1a4 100644 --- a/classes/class_visualshadernodedeterminant.rst +++ b/classes/class_visualshadernodedeterminant.rst @@ -18,3 +18,10 @@ Brief Description +Properties +---------- + ++---------------------------+----------------------+---------------------------------------------------------------+ +| :ref:`Array` | default_input_values | **O:** [ 0, Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ) ] | ++---------------------------+----------------------+---------------------------------------------------------------+ + diff --git a/classes/class_visualshadernodedotproduct.rst b/classes/class_visualshadernodedotproduct.rst index eb6dbd72d..2868ef1d2 100644 --- a/classes/class_visualshadernodedotproduct.rst +++ b/classes/class_visualshadernodedotproduct.rst @@ -18,3 +18,10 @@ Brief Description +Properties +---------- + ++---------------------------+----------------------+---------------------------------------------------------+ +| :ref:`Array` | default_input_values | **O:** [ 0, Vector3( 0, 0, 0 ), 1, Vector3( 0, 0, 0 ) ] | ++---------------------------+----------------------+---------------------------------------------------------+ + diff --git a/classes/class_visualshadernodeexpression.rst b/classes/class_visualshadernodeexpression.rst index ae85f0a2d..20c366e9e 100644 --- a/classes/class_visualshadernodeexpression.rst +++ b/classes/class_visualshadernodeexpression.rst @@ -23,9 +23,11 @@ Brief Description Properties ---------- -+-----------------------------+-------------------------------------------------------------------------+----+ -| :ref:`String` | :ref:`expression` | "" | -+-----------------------------+-------------------------------------------------------------------------+----+ ++-----------------------------+-------------------------------------------------------------------------+-------------+ +| :ref:`bool` | editable | **O:** true | ++-----------------------------+-------------------------------------------------------------------------+-------------+ +| :ref:`String` | :ref:`expression` | "" | ++-----------------------------+-------------------------------------------------------------------------+-------------+ Methods ------- diff --git a/classes/class_visualshadernodefaceforward.rst b/classes/class_visualshadernodefaceforward.rst index 8326acfdd..4f6c05c0c 100644 --- a/classes/class_visualshadernodefaceforward.rst +++ b/classes/class_visualshadernodefaceforward.rst @@ -18,3 +18,10 @@ Brief Description +Properties +---------- + ++---------------------------+----------------------+--------------------------------------------------------------------------------+ +| :ref:`Array` | default_input_values | **O:** [ 0, Vector3( 0, 0, 0 ), 1, Vector3( 0, 0, 0 ), 2, Vector3( 0, 0, 0 ) ] | ++---------------------------+----------------------+--------------------------------------------------------------------------------+ + diff --git a/classes/class_visualshadernodefresnel.rst b/classes/class_visualshadernodefresnel.rst index d300569a9..bffc90b8d 100644 --- a/classes/class_visualshadernodefresnel.rst +++ b/classes/class_visualshadernodefresnel.rst @@ -18,3 +18,10 @@ Brief Description +Properties +---------- + ++---------------------------+----------------------+---------------------------------------------------------------------------+ +| :ref:`Array` | default_input_values | **O:** [ 0, Vector3( 0, 0, 0 ), 1, Vector3( 0, 0, 0 ), 2, false, 3, 1.0 ] | ++---------------------------+----------------------+---------------------------------------------------------------------------+ + diff --git a/classes/class_visualshadernodeglobalexpression.rst b/classes/class_visualshadernodeglobalexpression.rst index 28e536937..1649f46d8 100644 --- a/classes/class_visualshadernodeglobalexpression.rst +++ b/classes/class_visualshadernodeglobalexpression.rst @@ -18,3 +18,10 @@ Brief Description +Properties +---------- + ++-------------------------+----------+--------------+ +| :ref:`bool` | editable | **O:** false | ++-------------------------+----------+--------------+ + diff --git a/classes/class_visualshadernodegroupbase.rst b/classes/class_visualshadernodegroupbase.rst index ce7697114..4e7a139a2 100644 --- a/classes/class_visualshadernodegroupbase.rst +++ b/classes/class_visualshadernodegroupbase.rst @@ -23,9 +23,11 @@ Brief Description Properties ---------- -+-------------------------+--------------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`editable` | false | -+-------------------------+--------------------------------------------------------------------+-------+ ++---------------------------+--------------------------------------------------------------------+-------------+ +| :ref:`Array` | default_input_values | **O:** [ ] | ++---------------------------+--------------------------------------------------------------------+-------------+ +| :ref:`bool` | :ref:`editable` | false | ++---------------------------+--------------------------------------------------------------------+-------------+ Methods ------- @@ -67,15 +69,15 @@ Methods +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_control` **(** :ref:`Control` control, :ref:`int` index **)** | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_input_port_name` **(** :ref:`int` arg0, :ref:`String` arg1 **)** | +| void | :ref:`set_input_port_name` **(** :ref:`int` id, :ref:`String` name **)** | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_input_port_type` **(** :ref:`int` arg0, :ref:`int` arg1 **)** | +| void | :ref:`set_input_port_type` **(** :ref:`int` id, :ref:`int` type **)** | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_inputs` **(** :ref:`String` inputs **)** | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_output_port_name` **(** :ref:`int` arg0, :ref:`String` arg1 **)** | +| void | :ref:`set_output_port_name` **(** :ref:`int` id, :ref:`String` name **)** | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_output_port_type` **(** :ref:`int` arg0, :ref:`int` arg1 **)** | +| void | :ref:`set_output_port_type` **(** :ref:`int` id, :ref:`int` type **)** | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_outputs` **(** :ref:`String` outputs **)** | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -174,11 +176,11 @@ Method Descriptions .. _class_VisualShaderNodeGroupBase_method_set_input_port_name: -- void **set_input_port_name** **(** :ref:`int` arg0, :ref:`String` arg1 **)** +- void **set_input_port_name** **(** :ref:`int` id, :ref:`String` name **)** .. _class_VisualShaderNodeGroupBase_method_set_input_port_type: -- void **set_input_port_type** **(** :ref:`int` arg0, :ref:`int` arg1 **)** +- void **set_input_port_type** **(** :ref:`int` id, :ref:`int` type **)** .. _class_VisualShaderNodeGroupBase_method_set_inputs: @@ -186,11 +188,11 @@ Method Descriptions .. _class_VisualShaderNodeGroupBase_method_set_output_port_name: -- void **set_output_port_name** **(** :ref:`int` arg0, :ref:`String` arg1 **)** +- void **set_output_port_name** **(** :ref:`int` id, :ref:`String` name **)** .. _class_VisualShaderNodeGroupBase_method_set_output_port_type: -- void **set_output_port_type** **(** :ref:`int` arg0, :ref:`int` arg1 **)** +- void **set_output_port_type** **(** :ref:`int` id, :ref:`int` type **)** .. _class_VisualShaderNodeGroupBase_method_set_outputs: diff --git a/classes/class_visualshadernodeif.rst b/classes/class_visualshadernodeif.rst index 7ed866c22..24cd7d003 100644 --- a/classes/class_visualshadernodeif.rst +++ b/classes/class_visualshadernodeif.rst @@ -18,3 +18,10 @@ Brief Description +Properties +---------- + ++---------------------------+----------------------+----------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | default_input_values | **O:** [ 0, 0.0, 1, 0.0, 2, 1e-05, 3, Vector3( 0, 0, 0 ), 4, Vector3( 0, 0, 0 ), 5, Vector3( 0, 0, 0 ) ] | ++---------------------------+----------------------+----------------------------------------------------------------------------------------------------------+ + diff --git a/classes/class_visualshadernodeinput.rst b/classes/class_visualshadernodeinput.rst index 9c1a52ccd..0ef85e9d8 100644 --- a/classes/class_visualshadernodeinput.rst +++ b/classes/class_visualshadernodeinput.rst @@ -21,9 +21,11 @@ Brief Description Properties ---------- -+-----------------------------+--------------------------------------------------------------------+----------+ -| :ref:`String` | :ref:`input_name` | "[None]" | -+-----------------------------+--------------------------------------------------------------------+----------+ ++-----------------------------+--------------------------------------------------------------------+-------------+ +| :ref:`Array` | default_input_values | **O:** [ ] | ++-----------------------------+--------------------------------------------------------------------+-------------+ +| :ref:`String` | :ref:`input_name` | "[None]" | ++-----------------------------+--------------------------------------------------------------------+-------------+ Signals ------- diff --git a/classes/class_visualshadernodeis.rst b/classes/class_visualshadernodeis.rst index 368ac27a1..2e12f1b48 100644 --- a/classes/class_visualshadernodeis.rst +++ b/classes/class_visualshadernodeis.rst @@ -21,9 +21,11 @@ Brief Description Properties ---------- -+---------------------------------------------------+-------------------------------------------------------------+---+ -| :ref:`Function` | :ref:`function` | 0 | -+---------------------------------------------------+-------------------------------------------------------------+---+ ++---------------------------------------------------+-------------------------------------------------------------+-------------------+ +| :ref:`Array` | default_input_values | **O:** [ 0, 0.0 ] | ++---------------------------------------------------+-------------------------------------------------------------+-------------------+ +| :ref:`Function` | :ref:`function` | 0 | ++---------------------------------------------------+-------------------------------------------------------------+-------------------+ Enumerations ------------ diff --git a/classes/class_visualshadernodeouterproduct.rst b/classes/class_visualshadernodeouterproduct.rst index 9f3cafd7c..9695cd850 100644 --- a/classes/class_visualshadernodeouterproduct.rst +++ b/classes/class_visualshadernodeouterproduct.rst @@ -18,3 +18,10 @@ Brief Description +Properties +---------- + ++---------------------------+----------------------+---------------------------------------------------------+ +| :ref:`Array` | default_input_values | **O:** [ 0, Vector3( 0, 0, 0 ), 1, Vector3( 0, 0, 0 ) ] | ++---------------------------+----------------------+---------------------------------------------------------+ + diff --git a/classes/class_visualshadernodescalarclamp.rst b/classes/class_visualshadernodescalarclamp.rst index 0aef90d08..f2e8854de 100644 --- a/classes/class_visualshadernodescalarclamp.rst +++ b/classes/class_visualshadernodescalarclamp.rst @@ -18,3 +18,10 @@ Brief Description +Properties +---------- + ++---------------------------+----------------------+-----------------------------------+ +| :ref:`Array` | default_input_values | **O:** [ 0, 0.0, 1, 0.0, 2, 1.0 ] | ++---------------------------+----------------------+-----------------------------------+ + diff --git a/classes/class_visualshadernodescalarconstant.rst b/classes/class_visualshadernodescalarconstant.rst index d13c60d3e..987d8dbef 100644 --- a/classes/class_visualshadernodescalarconstant.rst +++ b/classes/class_visualshadernodescalarconstant.rst @@ -21,9 +21,11 @@ Brief Description Properties ---------- -+---------------------------+-------------------------------------------------------------------------+-----+ -| :ref:`float` | :ref:`constant` | 0.0 | -+---------------------------+-------------------------------------------------------------------------+-----+ ++---------------------------+-------------------------------------------------------------------------+-------------+ +| :ref:`float` | :ref:`constant` | 0.0 | ++---------------------------+-------------------------------------------------------------------------+-------------+ +| :ref:`Array` | default_input_values | **O:** [ ] | ++---------------------------+-------------------------------------------------------------------------+-------------+ Property Descriptions --------------------- diff --git a/classes/class_visualshadernodescalarderivativefunc.rst b/classes/class_visualshadernodescalarderivativefunc.rst index da11ac58a..ea123a68e 100644 --- a/classes/class_visualshadernodescalarderivativefunc.rst +++ b/classes/class_visualshadernodescalarderivativefunc.rst @@ -21,9 +21,11 @@ Brief Description Properties ---------- -+---------------------------------------------------------------------+-------------------------------------------------------------------------------+---+ -| :ref:`Function` | :ref:`function` | 0 | -+---------------------------------------------------------------------+-------------------------------------------------------------------------------+---+ ++---------------------------------------------------------------------+-------------------------------------------------------------------------------+-------------------+ +| :ref:`Array` | default_input_values | **O:** [ 0, 0.0 ] | ++---------------------------------------------------------------------+-------------------------------------------------------------------------------+-------------------+ +| :ref:`Function` | :ref:`function` | 0 | ++---------------------------------------------------------------------+-------------------------------------------------------------------------------+-------------------+ Enumerations ------------ diff --git a/classes/class_visualshadernodescalarfunc.rst b/classes/class_visualshadernodescalarfunc.rst index f32b37c07..ec0cfc95e 100644 --- a/classes/class_visualshadernodescalarfunc.rst +++ b/classes/class_visualshadernodescalarfunc.rst @@ -21,9 +21,11 @@ Brief Description Properties ---------- -+-----------------------------------------------------------+---------------------------------------------------------------------+----+ -| :ref:`Function` | :ref:`function` | 13 | -+-----------------------------------------------------------+---------------------------------------------------------------------+----+ ++-----------------------------------------------------------+---------------------------------------------------------------------+-------------------+ +| :ref:`Array` | default_input_values | **O:** [ 0, 0.0 ] | ++-----------------------------------------------------------+---------------------------------------------------------------------+-------------------+ +| :ref:`Function` | :ref:`function` | 13 | ++-----------------------------------------------------------+---------------------------------------------------------------------+-------------------+ Enumerations ------------ diff --git a/classes/class_visualshadernodescalarinterp.rst b/classes/class_visualshadernodescalarinterp.rst index 3ed47785c..32b5d684b 100644 --- a/classes/class_visualshadernodescalarinterp.rst +++ b/classes/class_visualshadernodescalarinterp.rst @@ -18,3 +18,10 @@ Brief Description +Properties +---------- + ++---------------------------+----------------------+-----------------------------------+ +| :ref:`Array` | default_input_values | **O:** [ 0, 0.0, 1, 1.0, 2, 0.5 ] | ++---------------------------+----------------------+-----------------------------------+ + diff --git a/classes/class_visualshadernodescalarop.rst b/classes/class_visualshadernodescalarop.rst index f7a6d8a7d..8b3eac597 100644 --- a/classes/class_visualshadernodescalarop.rst +++ b/classes/class_visualshadernodescalarop.rst @@ -21,9 +21,11 @@ Brief Description Properties ---------- -+---------------------------------------------------------+-------------------------------------------------------------------+---+ -| :ref:`Operator` | :ref:`operator` | 0 | -+---------------------------------------------------------+-------------------------------------------------------------------+---+ ++---------------------------------------------------------+-------------------------------------------------------------------+---------------------------+ +| :ref:`Array` | default_input_values | **O:** [ 0, 0.0, 1, 0.0 ] | ++---------------------------------------------------------+-------------------------------------------------------------------+---------------------------+ +| :ref:`Operator` | :ref:`operator` | 0 | ++---------------------------------------------------------+-------------------------------------------------------------------+---------------------------+ Enumerations ------------ diff --git a/classes/class_visualshadernodescalarsmoothstep.rst b/classes/class_visualshadernodescalarsmoothstep.rst index 2c8cc28d8..ac07a0f36 100644 --- a/classes/class_visualshadernodescalarsmoothstep.rst +++ b/classes/class_visualshadernodescalarsmoothstep.rst @@ -18,3 +18,10 @@ Brief Description +Properties +---------- + ++---------------------------+----------------------+-----------------------------------+ +| :ref:`Array` | default_input_values | **O:** [ 0, 0.0, 1, 0.0, 2, 0.0 ] | ++---------------------------+----------------------+-----------------------------------+ + diff --git a/classes/class_visualshadernodescalarswitch.rst b/classes/class_visualshadernodescalarswitch.rst new file mode 100644 index 000000000..9c7a5d662 --- /dev/null +++ b/classes/class_visualshadernodescalarswitch.rst @@ -0,0 +1,20 @@ +:github_url: hide + +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VisualShaderNodeScalarSwitch.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VisualShaderNodeScalarSwitch: + +VisualShaderNodeScalarSwitch +============================ + +**Inherits:** :ref:`VisualShaderNodeSwitch` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_visualshadernodeswitch.rst b/classes/class_visualshadernodeswitch.rst index bb8884d93..681233f91 100644 --- a/classes/class_visualshadernodeswitch.rst +++ b/classes/class_visualshadernodeswitch.rst @@ -11,6 +11,8 @@ VisualShaderNodeSwitch **Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +**Inherited By:** :ref:`VisualShaderNodeScalarSwitch` + **Category:** Core Brief Description @@ -18,3 +20,10 @@ Brief Description +Properties +---------- + ++---------------------------+----------------------+-------------------------------------------------------------------+ +| :ref:`Array` | default_input_values | **O:** [ 0, false, 1, Vector3( 0, 0, 0 ), 2, Vector3( 0, 0, 0 ) ] | ++---------------------------+----------------------+-------------------------------------------------------------------+ + diff --git a/classes/class_visualshadernodetexture.rst b/classes/class_visualshadernodetexture.rst index 492d21b4c..e487cfbfd 100644 --- a/classes/class_visualshadernodetexture.rst +++ b/classes/class_visualshadernodetexture.rst @@ -21,13 +21,15 @@ Brief Description Properties ---------- -+--------------------------------------------------------------+--------------------------------------------------------------------------+---+ -| :ref:`Source` | :ref:`source` | 0 | -+--------------------------------------------------------------+--------------------------------------------------------------------------+---+ -| :ref:`Texture` | :ref:`texture` | | -+--------------------------------------------------------------+--------------------------------------------------------------------------+---+ -| :ref:`TextureType` | :ref:`texture_type` | 0 | -+--------------------------------------------------------------+--------------------------------------------------------------------------+---+ ++--------------------------------------------------------------+--------------------------------------------------------------------------+-------------+ +| :ref:`Array` | default_input_values | **O:** [ ] | ++--------------------------------------------------------------+--------------------------------------------------------------------------+-------------+ +| :ref:`Source` | :ref:`source` | 0 | ++--------------------------------------------------------------+--------------------------------------------------------------------------+-------------+ +| :ref:`Texture` | :ref:`texture` | | ++--------------------------------------------------------------+--------------------------------------------------------------------------+-------------+ +| :ref:`TextureType` | :ref:`texture_type` | 0 | ++--------------------------------------------------------------+--------------------------------------------------------------------------+-------------+ Enumerations ------------ diff --git a/classes/class_visualshadernodetransformcompose.rst b/classes/class_visualshadernodetransformcompose.rst index b2c453760..3f1e16f45 100644 --- a/classes/class_visualshadernodetransformcompose.rst +++ b/classes/class_visualshadernodetransformcompose.rst @@ -18,3 +18,10 @@ Brief Description +Properties +---------- + ++---------------------------+----------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | default_input_values | **O:** [ 0, Vector3( 0, 0, 0 ), 1, Vector3( 0, 0, 0 ), 2, Vector3( 0, 0, 0 ), 3, Vector3( 0, 0, 0 ) ] | ++---------------------------+----------------------+-------------------------------------------------------------------------------------------------------+ + diff --git a/classes/class_visualshadernodetransformconstant.rst b/classes/class_visualshadernodetransformconstant.rst index 453ac851c..599688473 100644 --- a/classes/class_visualshadernodetransformconstant.rst +++ b/classes/class_visualshadernodetransformconstant.rst @@ -24,6 +24,8 @@ Properties +-----------------------------------+----------------------------------------------------------------------------+-------------------------------------------------+ | :ref:`Transform` | :ref:`constant` | Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ) | +-----------------------------------+----------------------------------------------------------------------------+-------------------------------------------------+ +| :ref:`Array` | default_input_values | **O:** [ ] | ++-----------------------------------+----------------------------------------------------------------------------+-------------------------------------------------+ Property Descriptions --------------------- diff --git a/classes/class_visualshadernodetransformdecompose.rst b/classes/class_visualshadernodetransformdecompose.rst index 264a67b87..2c4c87709 100644 --- a/classes/class_visualshadernodetransformdecompose.rst +++ b/classes/class_visualshadernodetransformdecompose.rst @@ -18,3 +18,10 @@ Brief Description +Properties +---------- + ++---------------------------+----------------------+---------------------------------------------------------------+ +| :ref:`Array` | default_input_values | **O:** [ 0, Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ) ] | ++---------------------------+----------------------+---------------------------------------------------------------+ + diff --git a/classes/class_visualshadernodetransformfunc.rst b/classes/class_visualshadernodetransformfunc.rst index 32c8a7e21..c9a19391a 100644 --- a/classes/class_visualshadernodetransformfunc.rst +++ b/classes/class_visualshadernodetransformfunc.rst @@ -21,9 +21,11 @@ Brief Description Properties ---------- -+--------------------------------------------------------------+------------------------------------------------------------------------+---+ -| :ref:`Function` | :ref:`function` | 0 | -+--------------------------------------------------------------+------------------------------------------------------------------------+---+ ++--------------------------------------------------------------+------------------------------------------------------------------------+---------------------------------------------------------------+ +| :ref:`Array` | default_input_values | **O:** [ 0, Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ) ] | ++--------------------------------------------------------------+------------------------------------------------------------------------+---------------------------------------------------------------+ +| :ref:`Function` | :ref:`function` | 0 | ++--------------------------------------------------------------+------------------------------------------------------------------------+---------------------------------------------------------------+ Enumerations ------------ diff --git a/classes/class_visualshadernodetransformmult.rst b/classes/class_visualshadernodetransformmult.rst index 7c4849367..d77aed7f1 100644 --- a/classes/class_visualshadernodetransformmult.rst +++ b/classes/class_visualshadernodetransformmult.rst @@ -21,9 +21,11 @@ Brief Description Properties ---------- -+--------------------------------------------------------------+------------------------------------------------------------------------+---+ -| :ref:`Operator` | :ref:`operator` | 0 | -+--------------------------------------------------------------+------------------------------------------------------------------------+---+ ++--------------------------------------------------------------+------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | default_input_values | **O:** [ 0, Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ), 1, Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ) ] | ++--------------------------------------------------------------+------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`Operator` | :ref:`operator` | 0 | ++--------------------------------------------------------------+------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ diff --git a/classes/class_visualshadernodetransformvecmult.rst b/classes/class_visualshadernodetransformvecmult.rst index 82a3861eb..01b3cec11 100644 --- a/classes/class_visualshadernodetransformvecmult.rst +++ b/classes/class_visualshadernodetransformvecmult.rst @@ -21,9 +21,11 @@ Brief Description Properties ---------- -+-----------------------------------------------------------------+---------------------------------------------------------------------------+---+ -| :ref:`Operator` | :ref:`operator` | 0 | -+-----------------------------------------------------------------+---------------------------------------------------------------------------+---+ ++-----------------------------------------------------------------+---------------------------------------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`Array` | default_input_values | **O:** [ 0, Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ), 1, Vector3( 0, 0, 0 ) ] | ++-----------------------------------------------------------------+---------------------------------------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`Operator` | :ref:`operator` | 0 | ++-----------------------------------------------------------------+---------------------------------------------------------------------------+--------------------------------------------------------------------------------------+ Enumerations ------------ diff --git a/classes/class_visualshadernodeuniform.rst b/classes/class_visualshadernodeuniform.rst index e50037590..dcab963ae 100644 --- a/classes/class_visualshadernodeuniform.rst +++ b/classes/class_visualshadernodeuniform.rst @@ -23,9 +23,11 @@ Brief Description Properties ---------- -+-----------------------------+--------------------------------------------------------------------------+----+ -| :ref:`String` | :ref:`uniform_name` | "" | -+-----------------------------+--------------------------------------------------------------------------+----+ ++-----------------------------+--------------------------------------------------------------------------+-------------+ +| :ref:`Array` | default_input_values | **O:** [ ] | ++-----------------------------+--------------------------------------------------------------------------+-------------+ +| :ref:`String` | :ref:`uniform_name` | "" | ++-----------------------------+--------------------------------------------------------------------------+-------------+ Property Descriptions --------------------- diff --git a/classes/class_visualshadernodevec3constant.rst b/classes/class_visualshadernodevec3constant.rst index 31dac3925..aac1e6b68 100644 --- a/classes/class_visualshadernodevec3constant.rst +++ b/classes/class_visualshadernodevec3constant.rst @@ -24,6 +24,8 @@ Properties +-------------------------------+-----------------------------------------------------------------------+--------------------+ | :ref:`Vector3` | :ref:`constant` | Vector3( 0, 0, 0 ) | +-------------------------------+-----------------------------------------------------------------------+--------------------+ +| :ref:`Array` | default_input_values | **O:** [ ] | ++-------------------------------+-----------------------------------------------------------------------+--------------------+ Property Descriptions --------------------- diff --git a/classes/class_visualshadernodevectorclamp.rst b/classes/class_visualshadernodevectorclamp.rst index adc60dae4..dc60178fa 100644 --- a/classes/class_visualshadernodevectorclamp.rst +++ b/classes/class_visualshadernodevectorclamp.rst @@ -18,3 +18,10 @@ Brief Description +Properties +---------- + ++---------------------------+----------------------+--------------------------------------------------------------------------------+ +| :ref:`Array` | default_input_values | **O:** [ 0, Vector3( 0, 0, 0 ), 1, Vector3( 0, 0, 0 ), 2, Vector3( 1, 1, 1 ) ] | ++---------------------------+----------------------+--------------------------------------------------------------------------------+ + diff --git a/classes/class_visualshadernodevectorcompose.rst b/classes/class_visualshadernodevectorcompose.rst index e83ad8bda..a67f8153c 100644 --- a/classes/class_visualshadernodevectorcompose.rst +++ b/classes/class_visualshadernodevectorcompose.rst @@ -18,3 +18,10 @@ Brief Description +Properties +---------- + ++---------------------------+----------------------+-----------------------------------+ +| :ref:`Array` | default_input_values | **O:** [ 0, 0.0, 1, 0.0, 2, 0.0 ] | ++---------------------------+----------------------+-----------------------------------+ + diff --git a/classes/class_visualshadernodevectordistance.rst b/classes/class_visualshadernodevectordistance.rst index 9f73dd7a7..b9657dd86 100644 --- a/classes/class_visualshadernodevectordistance.rst +++ b/classes/class_visualshadernodevectordistance.rst @@ -18,3 +18,10 @@ Brief Description +Properties +---------- + ++---------------------------+----------------------+---------------------------------------------------------+ +| :ref:`Array` | default_input_values | **O:** [ 0, Vector3( 0, 0, 0 ), 1, Vector3( 0, 0, 0 ) ] | ++---------------------------+----------------------+---------------------------------------------------------+ + diff --git a/classes/class_visualshadernodevectorinterp.rst b/classes/class_visualshadernodevectorinterp.rst index bff2f65cf..c800f86f8 100644 --- a/classes/class_visualshadernodevectorinterp.rst +++ b/classes/class_visualshadernodevectorinterp.rst @@ -18,3 +18,10 @@ Brief Description +Properties +---------- + ++---------------------------+----------------------+--------------------------------------------------------------------------------------+ +| :ref:`Array` | default_input_values | **O:** [ 0, Vector3( 0, 0, 0 ), 1, Vector3( 1, 1, 1 ), 2, Vector3( 0.5, 0.5, 0.5 ) ] | ++---------------------------+----------------------+--------------------------------------------------------------------------------------+ + diff --git a/classes/class_visualshadernodevectorop.rst b/classes/class_visualshadernodevectorop.rst index b2f3e5a0b..2af56bd3c 100644 --- a/classes/class_visualshadernodevectorop.rst +++ b/classes/class_visualshadernodevectorop.rst @@ -21,9 +21,11 @@ Brief Description Properties ---------- -+---------------------------------------------------------+-------------------------------------------------------------------+---+ -| :ref:`Operator` | :ref:`operator` | 0 | -+---------------------------------------------------------+-------------------------------------------------------------------+---+ ++---------------------------------------------------------+-------------------------------------------------------------------+---------------------------------------------------------+ +| :ref:`Array` | default_input_values | **O:** [ 0, Vector3( 0, 0, 0 ), 1, Vector3( 0, 0, 0 ) ] | ++---------------------------------------------------------+-------------------------------------------------------------------+---------------------------------------------------------+ +| :ref:`Operator` | :ref:`operator` | 0 | ++---------------------------------------------------------+-------------------------------------------------------------------+---------------------------------------------------------+ Enumerations ------------ diff --git a/classes/class_visualshadernodevectorrefract.rst b/classes/class_visualshadernodevectorrefract.rst index c8f730d11..3eb179174 100644 --- a/classes/class_visualshadernodevectorrefract.rst +++ b/classes/class_visualshadernodevectorrefract.rst @@ -18,3 +18,10 @@ Brief Description +Properties +---------- + ++---------------------------+----------------------+-----------------------------------------------------------------+ +| :ref:`Array` | default_input_values | **O:** [ 0, Vector3( 0, 0, 0 ), 1, Vector3( 0, 0, 0 ), 2, 0.0 ] | ++---------------------------+----------------------+-----------------------------------------------------------------+ + diff --git a/classes/class_visualshadernodevectorscalarmix.rst b/classes/class_visualshadernodevectorscalarmix.rst index f61c085bf..a0271a771 100644 --- a/classes/class_visualshadernodevectorscalarmix.rst +++ b/classes/class_visualshadernodevectorscalarmix.rst @@ -18,3 +18,10 @@ Brief Description +Properties +---------- + ++---------------------------+----------------------+-----------------------------------------------------------------+ +| :ref:`Array` | default_input_values | **O:** [ 0, Vector3( 0, 0, 0 ), 1, Vector3( 1, 1, 1 ), 2, 0.5 ] | ++---------------------------+----------------------+-----------------------------------------------------------------+ + diff --git a/classes/class_visualshadernodevectorscalarsmoothstep.rst b/classes/class_visualshadernodevectorscalarsmoothstep.rst index 4aa996c36..d5d6f592c 100644 --- a/classes/class_visualshadernodevectorscalarsmoothstep.rst +++ b/classes/class_visualshadernodevectorscalarsmoothstep.rst @@ -18,3 +18,10 @@ Brief Description +Properties +---------- + ++---------------------------+----------------------+--------------------------------------------------+ +| :ref:`Array` | default_input_values | **O:** [ 0, 0.0, 1, 0.0, 2, Vector3( 0, 0, 0 ) ] | ++---------------------------+----------------------+--------------------------------------------------+ + diff --git a/classes/class_visualshadernodevectorscalarstep.rst b/classes/class_visualshadernodevectorscalarstep.rst index 154a9d6bf..b0c819c0d 100644 --- a/classes/class_visualshadernodevectorscalarstep.rst +++ b/classes/class_visualshadernodevectorscalarstep.rst @@ -18,3 +18,10 @@ Brief Description +Properties +---------- + ++---------------------------+----------------------+------------------------------------------+ +| :ref:`Array` | default_input_values | **O:** [ 0, 0.0, 1, Vector3( 0, 0, 0 ) ] | ++---------------------------+----------------------+------------------------------------------+ + diff --git a/classes/class_visualshadernodevectorsmoothstep.rst b/classes/class_visualshadernodevectorsmoothstep.rst index 8d91c4c4f..50170f827 100644 --- a/classes/class_visualshadernodevectorsmoothstep.rst +++ b/classes/class_visualshadernodevectorsmoothstep.rst @@ -18,3 +18,10 @@ Brief Description +Properties +---------- + ++---------------------------+----------------------+--------------------------------------------------------------------------------+ +| :ref:`Array` | default_input_values | **O:** [ 0, Vector3( 0, 0, 0 ), 1, Vector3( 0, 0, 0 ), 2, Vector3( 0, 0, 0 ) ] | ++---------------------------+----------------------+--------------------------------------------------------------------------------+ + diff --git a/classes/class_vscrollbar.rst b/classes/class_vscrollbar.rst index ac666e256..cda2adbe8 100644 --- a/classes/class_vscrollbar.rst +++ b/classes/class_vscrollbar.rst @@ -18,6 +18,15 @@ Brief Description Vertical version of :ref:`ScrollBar`, which goes from left (min) to right (max). +Properties +---------- + ++-----------------------+-----------------------+----------+ +| :ref:`int` | size_flags_horizontal | **O:** 0 | ++-----------------------+-----------------------+----------+ +| :ref:`int` | size_flags_vertical | **O:** 1 | ++-----------------------+-----------------------+----------+ + Theme Properties ---------------- diff --git a/classes/class_vslider.rst b/classes/class_vslider.rst index 2ffd5dbcc..fe924121a 100644 --- a/classes/class_vslider.rst +++ b/classes/class_vslider.rst @@ -18,6 +18,15 @@ Brief Description Vertical slider. +Properties +---------- + ++-----------------------+-----------------------+----------+ +| :ref:`int` | size_flags_horizontal | **O:** 0 | ++-----------------------+-----------------------+----------+ +| :ref:`int` | size_flags_vertical | **O:** 1 | ++-----------------------+-----------------------+----------+ + Theme Properties ---------------- diff --git a/classes/class_webrtcmultiplayer.rst b/classes/class_webrtcmultiplayer.rst index 16e0a17c3..cb097970c 100644 --- a/classes/class_webrtcmultiplayer.rst +++ b/classes/class_webrtcmultiplayer.rst @@ -18,6 +18,15 @@ Brief Description A simple interface to create a peer-to-peer mesh network composed of :ref:`WebRTCPeerConnection` that is compatible with the :ref:`MultiplayerAPI`. +Properties +---------- + ++-----------------------------------------------------------------+------------------------+--------------+ +| :ref:`bool` | refuse_new_connections | **O:** false | ++-----------------------------------------------------------------+------------------------+--------------+ +| :ref:`TransferMode` | transfer_mode | **O:** 2 | ++-----------------------------------------------------------------+------------------------+--------------+ + Methods ------- diff --git a/classes/class_websocketmultiplayerpeer.rst b/classes/class_websocketmultiplayerpeer.rst index 8ee4661ed..62be4de8d 100644 --- a/classes/class_websocketmultiplayerpeer.rst +++ b/classes/class_websocketmultiplayerpeer.rst @@ -20,6 +20,15 @@ Brief Description Base class for WebSocket server and client. +Properties +---------- + ++-----------------------------------------------------------------+------------------------+--------------+ +| :ref:`bool` | refuse_new_connections | **O:** false | ++-----------------------------------------------------------------+------------------------+--------------+ +| :ref:`TransferMode` | transfer_mode | **O:** 2 | ++-----------------------------------------------------------------+------------------------+--------------+ + Methods -------