From df578c300dd0d34f4eef1fecb8e24de5112bdc9a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Mon, 19 Feb 2018 10:48:33 +0100 Subject: [PATCH] Sync classref with current source --- classes/class_@gdscript.rst | 16 +- classes/class_arraymesh.rst | 6 + classes/class_audiostream.rst | 15 + classes/class_audiostreamplayer.rst | 6 +- classes/class_audiostreamplayer2d.rst | 4 + classes/class_audiostreamplayer3d.rst | 4 + classes/class_backbuffercopy.rst | 2 +- classes/class_bitmapfont.rst | 6 +- classes/class_camera2d.rst | 2 +- classes/class_collisionobject.rst | 2 +- classes/class_collisionobject2d.rst | 2 +- classes/class_collisionpolygon2d.rst | 2 +- classes/class_configfile.rst | 4 +- classes/class_control.rst | 28 +- classes/class_cubemap.rst | 8 +- classes/class_curve.rst | 2 +- classes/class_editorimportplugin.rst | 16 + classes/class_editorinterface.rst | 16 + classes/class_editorplugin.rst | 8 + classes/class_file.rst | 2 +- classes/class_geometry.rst | 2 +- classes/class_graphedit.rst | 66 ++ classes/class_httpclient.rst | 6 +- classes/class_httprequest.rst | 2 +- classes/class_image.rst | 14 +- classes/class_input.rst | 12 +- classes/class_inputeventjoypadbutton.rst | 2 +- classes/class_inputeventjoypadmotion.rst | 4 +- classes/class_inputeventkey.rst | 2 +- classes/class_itemlist.rst | 8 +- classes/class_json.rst | 2 +- classes/class_jsonparseresult.rst | 12 +- classes/class_kinematicbody.rst | 2 +- classes/class_label.rst | 4 +- classes/class_line2d.rst | 6 +- classes/class_nativescript.rst | 42 +- classes/class_networkedmultiplayerpeer.rst | 2 +- classes/class_object.rst | 2 +- classes/class_os.rst | 30 +- classes/class_packetpeer.rst | 2 +- classes/class_particles.rst | 2 +- classes/class_particles2d.rst | 2 +- classes/class_particlesmaterial.rst | 2 +- classes/class_regex.rst | 2 +- classes/class_richtextlabel.rst | 4 +- classes/class_rigidbody2d.rst | 4 +- classes/class_scenestate.rst | 2 +- classes/class_streampeerssl.rst | 8 + classes/class_streampeertcp.rst | 10 + classes/class_tabcontainer.rst | 2 +- classes/class_texturebutton.rst | 2 +- classes/class_textureprogress.rst | 2 +- classes/class_texturerect.rst | 2 +- classes/class_theme.rst | 2 +- classes/class_touchscreenbutton.rst | 2 +- classes/class_transform.rst | 4 +- classes/class_transform2d.rst | 20 +- classes/class_tree.rst | 4 +- classes/class_treeitem.rst | 6 +- classes/class_vector3.rst | 4 +- classes/class_viewport.rst | 76 +- classes/class_visualscriptbuiltinfunc.rst | 2 +- classes/class_visualserver.rst | 1178 +++++++++++++++++++- classes/class_websocketclient.rst | 59 + classes/class_websocketmultiplayerpeer.rst | 43 + classes/class_websocketpeer.rst | 68 ++ classes/class_websocketserver.rst | 67 ++ classes/class_xmlparser.rst | 2 +- 68 files changed, 1785 insertions(+), 169 deletions(-) create mode 100644 classes/class_websocketclient.rst create mode 100644 classes/class_websocketmultiplayerpeer.rst create mode 100644 classes/class_websocketpeer.rst create mode 100644 classes/class_websocketserver.rst diff --git a/classes/class_@gdscript.rst b/classes/class_@gdscript.rst index c6007f3bd..aea30f403 100644 --- a/classes/class_@gdscript.rst +++ b/classes/class_@gdscript.rst @@ -18,9 +18,9 @@ Member Functions ---------------- +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`Color8` **(** :ref:`int` r8, :ref:`int` g8, :ref:`int` b8, :ref:`int` a8 **)** | +| :ref:`Color` | :ref:`Color8` **(** :ref:`int` r8, :ref:`int` g8, :ref:`int` b8, :ref:`int` a8=255 **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`ColorN` **(** :ref:`String` name, :ref:`float` alpha **)** | +| :ref:`Color` | :ref:`ColorN` **(** :ref:`String` name, :ref:`float` alpha=1.0 **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`abs` **(** :ref:`float` s **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -176,7 +176,7 @@ Member Functions +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`wrapi` **(** :ref:`int` value, :ref:`int` min, :ref:`int` max **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`GDScriptFunctionState` | :ref:`yield` **(** :ref:`Object` object, :ref:`String` signal **)** | +| :ref:`GDScriptFunctionState` | :ref:`yield` **(** :ref:`Object` object=null, :ref:`String` signal="" **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants @@ -199,7 +199,7 @@ Member Function Description .. _class_@GDScript_Color8: -- :ref:`Color` **Color8** **(** :ref:`int` r8, :ref:`int` g8, :ref:`int` b8, :ref:`int` a8 **)** +- :ref:`Color` **Color8** **(** :ref:`int` r8, :ref:`int` g8, :ref:`int` b8, :ref:`int` a8=255 **)** Returns a 32 bit color with red, green, blue and alpha channels. Each channel has 8 bits of information ranging from 0 to 255. @@ -217,7 +217,7 @@ Returns a 32 bit color with red, green, blue and alpha channels. Each channel ha .. _class_@GDScript_ColorN: -- :ref:`Color` **ColorN** **(** :ref:`String` name, :ref:`float` alpha **)** +- :ref:`Color` **ColorN** **(** :ref:`String` name, :ref:`float` alpha=1.0 **)** Returns a color according to the standardised ``name`` with ``alpha`` ranging from 0 to 1. @@ -375,7 +375,7 @@ Returns the cosine of angle ``s`` in radians. :: # prints 1 and -1 - print(cos(PI\*2)) + print(cos(PI*2)) print(cos(PI)) .. _class_@GDScript_cosh: @@ -673,6 +673,8 @@ Parse JSON text to a Variant (use :ref:`typeof` to check Be aware that the JSON specification does not define integer or float types, but only a number type. Therefore, parsing a JSON text will convert all numerical values to :ref:`float` types. +Note that JSON objects do not preserve key order like Godot dictionaries, thus you should not rely on keys being in a certain order if a dictionary is constructed from JSON. In contrast, JSON arrays retain the order of their elements: + :: p = parse_json('["a", "b", "c"]') @@ -1124,7 +1126,7 @@ Usable for creating loop-alike behavior or infinite surfaces. .. _class_@GDScript_yield: -- :ref:`GDScriptFunctionState` **yield** **(** :ref:`Object` object, :ref:`String` signal **)** +- :ref:`GDScriptFunctionState` **yield** **(** :ref:`Object` object=null, :ref:`String` signal="" **)** Stops the function execution and returns the current state. Call :ref:`GDScriptFunctionState.resume` on the state to resume execution. This invalidates the state. diff --git a/classes/class_arraymesh.rst b/classes/class_arraymesh.rst index 5c0af7f35..8dd2765f7 100644 --- a/classes/class_arraymesh.rst +++ b/classes/class_arraymesh.rst @@ -34,6 +34,8 @@ Member Functions +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_surface_count` **(** **)** const | +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`lightmap_unwrap` **(** :ref:`Transform` arg0, :ref:`float` arg1 **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`regen_normalmaps` **(** **)** | +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`surface_get_array_index_len` **(** :ref:`int` surf_idx **)** const | @@ -149,6 +151,10 @@ Surfaces are created to be rendered using a "primitive", which may be PRIMITIVE_ Return the amount of surfaces that the ``ArrayMesh`` holds. +.. _class_ArrayMesh_lightmap_unwrap: + +- :ref:`int` **lightmap_unwrap** **(** :ref:`Transform` arg0, :ref:`float` arg1 **)** + .. _class_ArrayMesh_regen_normalmaps: - void **regen_normalmaps** **(** **)** diff --git a/classes/class_audiostream.rst b/classes/class_audiostream.rst index 70ac31caf..eabef70cf 100644 --- a/classes/class_audiostream.rst +++ b/classes/class_audiostream.rst @@ -18,8 +18,23 @@ Brief Description Base class for audio streams. +Member Functions +---------------- + ++----------------------------+-------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_length` **(** **)** const | ++----------------------------+-------------------------------------------------------------------+ + Description ----------- Base class for audio streams. Audio streams are used for music playback, or other types of streamed sounds that don't fit or require more flexibility than a Sample. +Member Function Description +--------------------------- + +.. _class_AudioStream_get_length: + +- :ref:`float` **get_length** **(** **)** const + + diff --git a/classes/class_audiostreamplayer.rst b/classes/class_audiostreamplayer.rst index f6173761f..bdfe30a55 100644 --- a/classes/class_audiostreamplayer.rst +++ b/classes/class_audiostreamplayer.rst @@ -52,7 +52,11 @@ Member Variables .. _class_AudioStreamPlayer_mix_target: -- :ref:`MixTarget` **mix_target** - If the audio configuration has more than two speakers, this sets the target channels. See ``MIX_TARGET\_\*`` constants. +- :ref:`MixTarget` **mix_target** - If the audio configuration has more than two speakers, this sets the target channels. See ``MIX_TARGET_*`` constants. + + .. _class_AudioStreamPlayer_pitch_scale: + +- :ref:`float` **pitch_scale** .. _class_AudioStreamPlayer_playing: diff --git a/classes/class_audiostreamplayer2d.rst b/classes/class_audiostreamplayer2d.rst index 947cbd28b..65f452114 100644 --- a/classes/class_audiostreamplayer2d.rst +++ b/classes/class_audiostreamplayer2d.rst @@ -62,6 +62,10 @@ Member Variables - :ref:`float` **max_distance** - Maximum distance from which audio is still hearable. + .. _class_AudioStreamPlayer2D_pitch_scale: + +- :ref:`float` **pitch_scale** + .. _class_AudioStreamPlayer2D_playing: - :ref:`bool` **playing** - If ``true`` audio is playing. diff --git a/classes/class_audiostreamplayer3d.rst b/classes/class_audiostreamplayer3d.rst index 93f98962a..0e2921075 100644 --- a/classes/class_audiostreamplayer3d.rst +++ b/classes/class_audiostreamplayer3d.rst @@ -94,6 +94,10 @@ Member Variables - :ref:`OutOfRangeMode` **out_of_range_mode** - Decides if audio should pause when source is outside of 'max_distance' range. + .. _class_AudioStreamPlayer3D_pitch_scale: + +- :ref:`float` **pitch_scale** + .. _class_AudioStreamPlayer3D_playing: - :ref:`bool` **playing** - If ``true``, audio is playing. diff --git a/classes/class_backbuffercopy.rst b/classes/class_backbuffercopy.rst index d46ff2b41..ef5e68d22 100644 --- a/classes/class_backbuffercopy.rst +++ b/classes/class_backbuffercopy.rst @@ -21,7 +21,7 @@ Member Variables .. _class_BackBufferCopy_copy_mode: -- :ref:`CopyMode` **copy_mode** - Buffer mode. See ``COPY_MODE\_\*`` constants. +- :ref:`CopyMode` **copy_mode** - Buffer mode. See ``COPY_MODE_*`` constants. .. _class_BackBufferCopy_rect: diff --git a/classes/class_bitmapfont.rst b/classes/class_bitmapfont.rst index de345032a..849436cb1 100644 --- a/classes/class_bitmapfont.rst +++ b/classes/class_bitmapfont.rst @@ -14,7 +14,7 @@ BitmapFont Brief Description ----------------- -Renders text using ``\*.fnt`` fonts. +Renders text using ``*.fnt`` fonts. Member Functions ---------------- @@ -62,7 +62,7 @@ Member Variables Description ----------- -Renders text using ``\*.fnt`` fonts containing texture atlases. Supports distance fields. For using vector font files like TTF directly, see :ref:`DynamicFont`. +Renders text using ``*.fnt`` fonts containing texture atlases. Supports distance fields. For using vector font files like TTF directly, see :ref:`DynamicFont`. Member Function Description --------------------------- @@ -95,7 +95,7 @@ Clears all the font data and settings. - :ref:`int` **create_from_fnt** **(** :ref:`String` path **)** -Creates a BitmapFont from the ``\*.fnt`` file at ``path``. +Creates a BitmapFont from the ``*.fnt`` file at ``path``. .. _class_BitmapFont_get_char_size: diff --git a/classes/class_camera2d.rst b/classes/class_camera2d.rst index 46ee8a744..9c2b6cf2c 100644 --- a/classes/class_camera2d.rst +++ b/classes/class_camera2d.rst @@ -40,7 +40,7 @@ Member Variables .. _class_Camera2D_anchor_mode: -- :ref:`AnchorMode` **anchor_mode** - The Camera2D's anchor point. See ``ANCHOR_MODE\_\*`` constants. +- :ref:`AnchorMode` **anchor_mode** - The Camera2D's anchor point. See ``ANCHOR_MODE_*`` constants. .. _class_Camera2D_current: diff --git a/classes/class_collisionobject.rst b/classes/class_collisionobject.rst index 8f1e6df36..95a663475 100644 --- a/classes/class_collisionobject.rst +++ b/classes/class_collisionobject.rst @@ -94,7 +94,7 @@ Member Variables Description ----------- -CollisionObject is the base class for physics objects. It can hold any number of collision :ref:`Shape`\ s. Each shape must be assigned to a *shape owner*. The CollisionObject can have any number of shape owners. Shape owners are not nodes and do not appear in the editor, but are accessible through code using the ``shape_owner\_\*`` methods. +CollisionObject is the base class for physics objects. It can hold any number of collision :ref:`Shape`\ s. Each shape must be assigned to a *shape owner*. The CollisionObject can have any number of shape owners. Shape owners are not nodes and do not appear in the editor, but are accessible through code using the ``shape_owner_*`` methods. Member Function Description --------------------------- diff --git a/classes/class_collisionobject2d.rst b/classes/class_collisionobject2d.rst index 7f13c7048..4887b2f99 100644 --- a/classes/class_collisionobject2d.rst +++ b/classes/class_collisionobject2d.rst @@ -94,7 +94,7 @@ Member Variables Description ----------- -CollisionObject2D is the base class for 2D physics objects. It can hold any number of 2D collision :ref:`Shape2D`\ s. Each shape must be assigned to a *shape owner*. The CollisionObject2D can have any number of shape owners. Shape owners are not nodes and do not appear in the editor, but are accessible through code using the ``shape_owner\_\*`` methods. +CollisionObject2D is the base class for 2D physics objects. It can hold any number of 2D collision :ref:`Shape2D`\ s. Each shape must be assigned to a *shape owner*. The CollisionObject2D can have any number of shape owners. Shape owners are not nodes and do not appear in the editor, but are accessible through code using the ``shape_owner_*`` methods. Member Function Description --------------------------- diff --git a/classes/class_collisionpolygon2d.rst b/classes/class_collisionpolygon2d.rst index bff30492c..1475a2470 100644 --- a/classes/class_collisionpolygon2d.rst +++ b/classes/class_collisionpolygon2d.rst @@ -21,7 +21,7 @@ Member Variables .. _class_CollisionPolygon2D_build_mode: -- :ref:`BuildMode` **build_mode** - Collision build mode. Use one of the ``BUILD\_\*`` constants. Default value: ``BUILD_SOLIDS``. +- :ref:`BuildMode` **build_mode** - Collision build mode. Use one of the ``BUILD_*`` constants. Default value: ``BUILD_SOLIDS``. .. _class_CollisionPolygon2D_disabled: diff --git a/classes/class_configfile.rst b/classes/class_configfile.rst index ac4165067..917a20c6e 100644 --- a/classes/class_configfile.rst +++ b/classes/class_configfile.rst @@ -111,13 +111,13 @@ Returns ``true`` if the specified section-key pair exists. - :ref:`int` **load** **(** :ref:`String` path **)** -Loads the config file specified as a parameter. The file's contents are parsed and loaded in the ConfigFile object which the method was called on. Returns one of the ``OK``, ``FAILED`` or ``ERR\_\*`` constants listed in :ref:`@GlobalScope`. If the load was successful, the return value is ``OK``. +Loads the config file specified as a parameter. The file's contents are parsed and loaded in the ConfigFile object which the method was called on. Returns one of the ``OK``, ``FAILED`` or ``ERR_*`` constants listed in :ref:`@GlobalScope`. If the load was successful, the return value is ``OK``. .. _class_ConfigFile_save: - :ref:`int` **save** **(** :ref:`String` path **)** -Saves the contents of the ConfigFile object to the file specified as a parameter. The output file uses an INI-style structure. Returns one of the ``OK``, ``FAILED`` or ``ERR\_\*`` constants listed in :ref:`@GlobalScope`. If the load was successful, the return value is ``OK``. +Saves the contents of the ConfigFile object to the file specified as a parameter. The output file uses an INI-style structure. Returns one of the ``OK``, ``FAILED`` or ``ERR_*`` constants listed in :ref:`@GlobalScope`. If the load was successful, the return value is ``OK``. .. _class_ConfigFile_set_value: diff --git a/classes/class_control.rst b/classes/class_control.rst index e712f48ec..a517f0e38 100644 --- a/classes/class_control.rst +++ b/classes/class_control.rst @@ -204,19 +204,19 @@ Member Variables .. _class_Control_anchor_bottom: -- :ref:`float` **anchor_bottom** - Anchors the bottom edge of the node to the origin, the center, or the end of its parent container. It changes how the bottom margin updates when the node moves or changes size. Use one of the ``ANCHOR\_\*`` constants. Default value: ``ANCHOR_BEGIN``. +- :ref:`float` **anchor_bottom** - Anchors the bottom edge of the node to the origin, the center, or the end of its parent container. It changes how the bottom margin updates when the node moves or changes size. Use one of the ``ANCHOR_*`` constants. Default value: ``ANCHOR_BEGIN``. .. _class_Control_anchor_left: -- :ref:`float` **anchor_left** - Anchors the left edge of the node to the origin, the center or the end of its parent container. It changes how the left margin updates when the node moves or changes size. Use one of the ``ANCHOR\_\*`` constants. Default value: ``ANCHOR_BEGIN``. +- :ref:`float` **anchor_left** - Anchors the left edge of the node to the origin, the center or the end of its parent container. It changes how the left margin updates when the node moves or changes size. Use one of the ``ANCHOR_*`` constants. Default value: ``ANCHOR_BEGIN``. .. _class_Control_anchor_right: -- :ref:`float` **anchor_right** - Anchors the right edge of the node to the origin, the center or the end of its parent container. It changes how the right margin updates when the node moves or changes size. Use one of the ``ANCHOR\_\*`` constants. Default value: ``ANCHOR_BEGIN``. +- :ref:`float` **anchor_right** - Anchors the right edge of the node to the origin, the center or the end of its parent container. It changes how the right margin updates when the node moves or changes size. Use one of the ``ANCHOR_*`` constants. Default value: ``ANCHOR_BEGIN``. .. _class_Control_anchor_top: -- :ref:`float` **anchor_top** - Anchors the top edge of the node to the origin, the center or the end of its parent container. It changes how the top margin updates when the node moves or changes size. Use one of the ``ANCHOR\_\*`` constants. Default value: ``ANCHOR_BEGIN``. +- :ref:`float` **anchor_top** - Anchors the top edge of the node to the origin, the center or the end of its parent container. It changes how the top margin updates when the node moves or changes size. Use one of the ``ANCHOR_*`` constants. Default value: ``ANCHOR_BEGIN``. .. _class_Control_focus_mode: @@ -284,7 +284,7 @@ Margins are often controlled by one or multiple parent :ref:`Container` **mouse_filter** - Controls whether the control will be able to receive mouse button input events through :ref:`_gui_input` and how these events should be handled. Use one of the ``MOUSE_FILTER\_\*`` constants. See the constants to learn what each does. +- :ref:`MouseFilter` **mouse_filter** - Controls whether the control will be able to receive mouse button input events through :ref:`_gui_input` and how these events should be handled. Use one of the ``MOUSE_FILTER_*`` constants. See the constants to learn what each does. .. _class_Control_rect_clip_content: @@ -320,7 +320,7 @@ Margins are often controlled by one or multiple parent :ref:`Container` **size_flags_horizontal** - Tells the parent :ref:`Container` nodes how they should resize and place the node on the X axis. Use one of the ``SIZE\_\*`` constants to change the flags. See the constants to learn what each does. +- :ref:`int` **size_flags_horizontal** - Tells the parent :ref:`Container` nodes how they should resize and place the node on the X axis. Use one of the ``SIZE_*`` constants to change the flags. See the constants to learn what each does. .. _class_Control_size_flags_stretch_ratio: @@ -328,7 +328,7 @@ Margins are often controlled by one or multiple parent :ref:`Container` **size_flags_vertical** - Tells the parent :ref:`Container` nodes how they should resize and place the node on the Y axis. Use one of the ``SIZE\_\*`` constants to change the flags. See the constants to learn what each does. +- :ref:`int` **size_flags_vertical** - Tells the parent :ref:`Container` nodes how they should resize and place the node on the Y axis. Use one of the ``SIZE_*`` constants to change the flags. See the constants to learn what each does. .. _class_Control_theme: @@ -343,7 +343,7 @@ Numeric Constants - **NOTIFICATION_MOUSE_EXIT** = **42** --- Sent when the mouse pointer exits the node's ``Rect`` area. - **NOTIFICATION_FOCUS_ENTER** = **43** --- Sent when the node grabs focus. - **NOTIFICATION_FOCUS_EXIT** = **44** --- Sent when the node loses focus. -- **NOTIFICATION_THEME_CHANGED** = **45** --- Sent when the node's :ref:`theme` changes, right before Godot redraws the ``Control``. Happens when you call one of the ``add\_\*_override`` +- **NOTIFICATION_THEME_CHANGED** = **45** --- Sent when the node's :ref:`theme` changes, right before Godot redraws the ``Control``. Happens when you call one of the ``add_*_override`` - **NOTIFICATION_MODAL_CLOSE** = **46** --- Sent when an open modal dialog closes. See :ref:`show_modal`. Enums @@ -438,8 +438,8 @@ enum **MouseFilter** enum **Anchor** -- **ANCHOR_BEGIN** = **0** --- Snaps one of the 4 anchor's sides to the origin of the node's ``Rect``, in the top left. Use it with one of the ``anchor\_\*`` member variables, like :ref:`anchor_left`. To change all 4 anchors at once, use :ref:`set_anchors_preset`. -- **ANCHOR_END** = **1** --- Snaps one of the 4 anchor's sides to the end of the node's ``Rect``, in the bottom right. Use it with one of the ``anchor\_\*`` member variables, like :ref:`anchor_left`. To change all 4 anchors at once, use :ref:`set_anchors_preset`. +- **ANCHOR_BEGIN** = **0** --- Snaps one of the 4 anchor's sides to the origin of the node's ``Rect``, in the top left. Use it with one of the ``anchor_*`` member variables, like :ref:`anchor_left`. To change all 4 anchors at once, use :ref:`set_anchors_preset`. +- **ANCHOR_END** = **1** --- Snaps one of the 4 anchor's sides to the end of the node's ``Rect``, in the bottom right. Use it with one of the ``anchor_*`` member variables, like :ref:`anchor_left`. To change all 4 anchors at once, use :ref:`set_anchors_preset`. Description @@ -453,11 +453,11 @@ For more information on Godot's UI system, anchors, margins, and containers, see Godot sends input events to the scene's root node first, by calling :ref:`Node._input`. :ref:`Node._input` forwards the event down the node tree to the nodes under the mouse cursor, or on keyboard focus. To do so, it calls :ref:`MainLoop._input_event`. Call :ref:`accept_event` so no other node receives the event. Once you accepted an input, it becomes handled so :ref:`Node._unhandled_input` will not process it. -Only one ``Control`` node can be in keyboard focus. Only the node in focus will receive keyboard events. To get the focus, call :ref:`set_focus_mode`. ``Control`` nodes lose focus when another node grabs it, or if you hide the node in focus. +Only one ``Control`` node can be in keyboard focus. Only the node in focus will receive keyboard events. To get the focus, call :ref:`grab_focus`. ``Control`` nodes lose focus when another node grabs it, or if you hide the node in focus. -Call :ref:`set_ignore_mouse` to tell a ``Control`` node to ignore mouse or touch events. You'll need it if you place an icon on top of a button. +Set :ref:`mouse_filter` to MOUSE_FILTER_IGNORE to tell a ``Control`` node to ignore mouse or touch events. You'll need it if you place an icon on top of a button. -:ref:`Theme` resources change the Control's appearance. If you change the :ref:`Theme` on a ``Control`` node, it affects all of its children. To override some of the theme's parameters, call one of the ``add\_\*_override`` methods, like :ref:`add_font_override`. You can override the theme with the inspector. +:ref:`Theme` resources change the Control's appearance. If you change the :ref:`Theme` on a ``Control`` node, it affects all of its children. To override some of the theme's parameters, call one of the ``add_*_override`` methods, like :ref:`add_font_override`. You can override the theme with the inspector. Member Function Description --------------------------- @@ -550,7 +550,7 @@ Overrides the ``name`` Stylebox in the theme resource the node uses. If ``styleb - :ref:`int` **get_cursor_shape** **(** :ref:`Vector2` position=Vector2( 0, 0 ) **)** const -Returns the mouse cursor shape the control displays on mouse hover, one of the ``CURSOR\_\*`` constants. +Returns the mouse cursor shape the control displays on mouse hover, one of the ``CURSOR_*`` constants. .. _class_Control_get_drag_data: diff --git a/classes/class_cubemap.rst b/classes/class_cubemap.rst index 76e040163..713c503ac 100644 --- a/classes/class_cubemap.rst +++ b/classes/class_cubemap.rst @@ -34,7 +34,7 @@ Member Variables .. _class_CubeMap_flags: -- :ref:`int` **flags** - The render flags for the ``CubeMap``. See the ``FLAG\_\*`` constants for details. +- :ref:`int` **flags** - The render flags for the ``CubeMap``. See the ``FLAG_*`` constants for details. .. _class_CubeMap_lossy_storage_quality: @@ -42,7 +42,7 @@ Member Variables .. _class_CubeMap_storage_mode: -- :ref:`Storage` **storage_mode** - The ``CubeMap``'s storage mode. See ``STORAGE\_\*`` constants. +- :ref:`Storage` **storage_mode** - The ``CubeMap``'s storage mode. See ``STORAGE_*`` constants. Enums @@ -95,7 +95,7 @@ Returns the ``CubeMap``'s height. - :ref:`Image` **get_side** **(** :ref:`int` side **)** const -Returns an :ref:`Image` for a side of the ``CubeMap`` using one of the ``SIDE\_\*`` constants or an integer 0-5. +Returns an :ref:`Image` for a side of the ``CubeMap`` using one of the ``SIDE_*`` constants or an integer 0-5. .. _class_CubeMap_get_width: @@ -107,6 +107,6 @@ Returns the ``CubeMap``'s width. - void **set_side** **(** :ref:`int` side, :ref:`Image` image **)** -Sets an :ref:`Image` for a side of the ``CubeMap`` using one of the ``SIDE\_\*`` constants or an integer 0-5. +Sets an :ref:`Image` for a side of the ``CubeMap`` using one of the ``SIDE_*`` constants or an integer 0-5. diff --git a/classes/class_curve.rst b/classes/class_curve.rst index 742b9a98e..6d798d3d3 100644 --- a/classes/class_curve.rst +++ b/classes/class_curve.rst @@ -107,7 +107,7 @@ Member Function Description - :ref:`int` **add_point** **(** :ref:`Vector2` position, :ref:`float` left_tangent=0, :ref:`float` right_tangent=0, :ref:`int` left_mode=0, :ref:`int` right_mode=0 **)** -Adds a point to the curve. For each side, if the ``\*_mode`` is ``TANGENT_LINEAR``, the ``\*_tangent`` angle (in degrees) uses the slope of the curve halfway to the adjacent point. Allows custom assignments to the ``\*_tangent`` angle if ``\*_mode`` is set to ``TANGENT_FREE``. +Adds a point to the curve. For each side, if the ``*_mode`` is ``TANGENT_LINEAR``, the ``*_tangent`` angle (in degrees) uses the slope of the curve halfway to the adjacent point. Allows custom assignments to the ``*_tangent`` angle if ``*_mode`` is set to ``TANGENT_FREE``. .. _class_Curve_bake: diff --git a/classes/class_editorimportplugin.rst b/classes/class_editorimportplugin.rst index 64a6b8d90..3790e6e6b 100644 --- a/classes/class_editorimportplugin.rst +++ b/classes/class_editorimportplugin.rst @@ -22,6 +22,8 @@ Member Functions +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`get_import_options` **(** :ref:`int` preset **)** virtual | +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_import_order` **(** **)** virtual | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_importer_name` **(** **)** virtual | +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_option_visibility` **(** :ref:`String` option, :ref:`Dictionary` options **)** virtual | @@ -30,6 +32,8 @@ Member Functions +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_preset_name` **(** :ref:`int` preset **)** virtual | +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_priority` **(** **)** virtual | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`get_recognized_extensions` **(** **)** virtual | +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_resource_type` **(** **)** virtual | @@ -105,6 +109,12 @@ Member Function Description Get the options and default values for the preset at this index. Returns an Array of Dictionaries with the following keys: "name", "default_value", "property_hint" (optional), "hint_string" (optional), "usage" (optional). +.. _class_EditorImportPlugin_get_import_order: + +- :ref:`int` **get_import_order** **(** **)** virtual + +Get the order of this importer to be run when importing resources. Higher values will be called later. Use this to ensure the importer runs after the dependencies are already imported. + .. _class_EditorImportPlugin_get_importer_name: - :ref:`String` **get_importer_name** **(** **)** virtual @@ -127,6 +137,12 @@ Get the number of initial presets defined by the plugin. Use :ref:`get_import_op Get the name of the options preset at this index. +.. _class_EditorImportPlugin_get_priority: + +- :ref:`float` **get_priority** **(** **)** virtual + +Get the priority of this plugin for the recognized extension. Higher priority plugins will be preferred. Default value is 1.0. + .. _class_EditorImportPlugin_get_recognized_extensions: - :ref:`Array` **get_recognized_extensions** **(** **)** virtual diff --git a/classes/class_editorinterface.rst b/classes/class_editorinterface.rst index 8977ba3e0..c5f67a3a7 100644 --- a/classes/class_editorinterface.rst +++ b/classes/class_editorinterface.rst @@ -44,6 +44,8 @@ Member Functions +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`inspect_object` **(** :ref:`Object` object, :ref:`String` for_property="" **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_plugin_enabled` **(** :ref:`String` plugin **)** const | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`make_mesh_previews` **(** :ref:`Array` meshes, :ref:`int` preview_size **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`open_scene_from_path` **(** :ref:`String` scene_filepath **)** | @@ -56,6 +58,8 @@ Member Functions +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`select_file` **(** :ref:`String` p_file **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_plugin_enabled` **(** :ref:`String` plugin, :ref:`bool` enabled **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -135,6 +139,12 @@ Returns the :ref:`EditorSelection`. Shows the given property on the given ``object`` in the Editor's Inspector dock. +.. _class_EditorInterface_is_plugin_enabled: + +- :ref:`bool` **is_plugin_enabled** **(** :ref:`String` plugin **)** const + +Returns the enabled status of a plugin. The plugin name is the same as its directory name. + .. _class_EditorInterface_make_mesh_previews: - :ref:`Array` **make_mesh_previews** **(** :ref:`Array` meshes, :ref:`int` preview_size **)** @@ -169,4 +179,10 @@ Saves the scene as a file at ``path``. - void **select_file** **(** :ref:`String` p_file **)** +.. _class_EditorInterface_set_plugin_enabled: + +- void **set_plugin_enabled** **(** :ref:`String` plugin, :ref:`bool` enabled **)** + +Sets the enabled status of a plugin. The plugin name is the same as its directory name. + diff --git a/classes/class_editorplugin.rst b/classes/class_editorplugin.rst index cf5f8454e..0ba971001 100644 --- a/classes/class_editorplugin.rst +++ b/classes/class_editorplugin.rst @@ -80,6 +80,8 @@ Member Functions +------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_control_from_bottom_panel` **(** :ref:`Control` control **)** | +------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_control_from_container` **(** :ref:`int` container, :ref:`Control` control **)** | ++------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_control_from_docks` **(** :ref:`Control` control **)** | +------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_custom_type` **(** :ref:`String` type **)** | @@ -340,6 +342,12 @@ Queue save the project's editor layout. Remove the control from the bottom panel. Don't forget to call this if you added one, so the editor can remove it cleanly. +.. _class_EditorPlugin_remove_control_from_container: + +- void **remove_control_from_container** **(** :ref:`int` container, :ref:`Control` control **)** + +Remove the control from the specified container. Use it when cleaning up after adding a control with :ref:`add_control_to_container`. Note that you can simply free the control if you won't use it anymore. + .. _class_EditorPlugin_remove_control_from_docks: - void **remove_control_from_docks** **(** :ref:`Control` control **)** diff --git a/classes/class_file.rst b/classes/class_file.rst index 57289f177..df5a20305 100644 --- a/classes/class_file.rst +++ b/classes/class_file.rst @@ -230,7 +230,7 @@ Returns the next 64 bits from the file as a floating point number. - :ref:`int` **get_error** **(** **)** const -Returns the last error that happened when trying to perform operations. Compare with the ``ERR_FILE\_\*`` constants from :ref:`@GlobalScope`. +Returns the last error that happened when trying to perform operations. Compare with the ``ERR_FILE_*`` constants from :ref:`@GlobalScope`. .. _class_File_get_float: diff --git a/classes/class_geometry.rst b/classes/class_geometry.rst index 82e8d7edf..b0cf9e1fd 100644 --- a/classes/class_geometry.rst +++ b/classes/class_geometry.rst @@ -196,6 +196,6 @@ Tests if the segment (``from``, ``to``) intersects the triangle ``a``, ``b``, `` - :ref:`PoolIntArray` **triangulate_polygon** **(** :ref:`PoolVector2Array` polygon **)** -Triangulates the polygon specified by the points in ``polygon``. Returns a :ref:`PoolIntArray` where each triangle consists of three consecutive point indices into ``polygon`` (i.e. the returned array will have ``n \* 3`` elements, with ``n`` being the number of found triangles). If the triangulation did not succeed, an empty :ref:`PoolIntArray` is returned. +Triangulates the polygon specified by the points in ``polygon``. Returns a :ref:`PoolIntArray` where each triangle consists of three consecutive point indices into ``polygon`` (i.e. the returned array will have ``n * 3`` elements, with ``n`` being the number of found triangles). If the triangulation did not succeed, an empty :ref:`PoolIntArray` is returned. diff --git a/classes/class_graphedit.rst b/classes/class_graphedit.rst index 1b14dcf14..2419a68e9 100644 --- a/classes/class_graphedit.rst +++ b/classes/class_graphedit.rst @@ -19,6 +19,14 @@ GraphEdit is an area capable of showing various GraphNodes. It manages connectio Member Functions ---------------- ++----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_valid_connection_type` **(** :ref:`int` from_type, :ref:`int` to_type **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_valid_left_disconnect_type` **(** :ref:`int` type **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_valid_right_disconnect_type` **(** :ref:`int` type **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_connections` **(** **)** | +----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`connect_node` **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port **)** | +----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -28,6 +36,14 @@ Member Functions +----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_node_connected` **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port **)** | +----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_valid_connection_type` **(** :ref:`int` from_type, :ref:`int` to_type **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_valid_connection_type` **(** :ref:`int` from_type, :ref:`int` to_type **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_valid_left_disconnect_type` **(** :ref:`int` type **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_valid_right_disconnect_type` **(** :ref:`int` type **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_selected` **(** :ref:`Node` node **)** | +----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -123,6 +139,30 @@ It is greatly advised to enable low processor usage mode (see :ref:`OS.set_low_p Member Function Description --------------------------- +.. _class_GraphEdit_add_valid_connection_type: + +- void **add_valid_connection_type** **(** :ref:`int` from_type, :ref:`int` to_type **)** + +Makes possible the connection between two different slot types. The type is defined with the :ref:`GraphNode.set_slot` method. + +.. _class_GraphEdit_add_valid_left_disconnect_type: + +- void **add_valid_left_disconnect_type** **(** :ref:`int` type **)** + +Makes possible to disconnect nodes when dragging from the slot at the left if it has the specified type. + +.. _class_GraphEdit_add_valid_right_disconnect_type: + +- void **add_valid_right_disconnect_type** **(** :ref:`int` type **)** + +Makes possible to disconnect nodes when dragging from the slot at the right if it has the specified type. + +.. _class_GraphEdit_clear_connections: + +- void **clear_connections** **(** **)** + +Remove all connections between nodes. + .. _class_GraphEdit_connect_node: - :ref:`int` **connect_node** **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port **)** @@ -147,8 +187,34 @@ Return an Array containing the list of connections. A connection consists in a s Return true if the 'from_port' slot of 'from' GraphNode is connected to the 'to_port' slot of 'to' GraphNode. +.. _class_GraphEdit_is_valid_connection_type: + +- :ref:`bool` **is_valid_connection_type** **(** :ref:`int` from_type, :ref:`int` to_type **)** const + +Returns whether it's possible to connect slots of the specified types. + +.. _class_GraphEdit_remove_valid_connection_type: + +- void **remove_valid_connection_type** **(** :ref:`int` from_type, :ref:`int` to_type **)** + +Makes it not possible to connect between two different slot types. The type is defined with the :ref:`GraphNode.set_slot` method. + +.. _class_GraphEdit_remove_valid_left_disconnect_type: + +- void **remove_valid_left_disconnect_type** **(** :ref:`int` type **)** + +Removes the possibility to disconnect nodes when dragging from the slot at the left if it has the specified type. + +.. _class_GraphEdit_remove_valid_right_disconnect_type: + +- void **remove_valid_right_disconnect_type** **(** :ref:`int` type **)** + +Removes the possibility to disconnect nodes when dragging from the slot at the right if it has the specified type. + .. _class_GraphEdit_set_selected: - void **set_selected** **(** :ref:`Node` node **)** +Sets the specified ``node`` as the one selected. + diff --git a/classes/class_httpclient.rst b/classes/class_httpclient.rst index 3cc694357..fc5dc44f9 100644 --- a/classes/class_httpclient.rst +++ b/classes/class_httpclient.rst @@ -94,7 +94,7 @@ enum **Method** - **METHOD_TRACE** = **6** --- HTTP TRACE method. The TRACE method performs a message loop-back test along the path to the target resource. Returns the entire HTTP request received in the response body. Rarely used. - **METHOD_CONNECT** = **7** --- HTTP CONNECT method. The CONNECT method establishes a tunnel to the server identified by the target resource. Rarely used. - **METHOD_PATCH** = **8** --- HTTP PATCH method. The PATCH method is used to apply partial modifications to a resource. -- **METHOD_MAX** = **9** --- Marker for end of ``METHOD\_\*`` enum. Not used. +- **METHOD_MAX** = **9** --- Marker for end of ``METHOD_*`` enum. Not used. .. _enum_HTTPClient_ResponseCode: @@ -271,7 +271,7 @@ Reads one chunk from the response. Sends a request to the connected host. The URL parameter is just the part after the host, so for ``http://somehost.com/index.php``, it is ``index.php``. -Headers are HTTP request headers. For available HTTP methods, see ``METHOD\_\*``. +Headers are HTTP request headers. For available HTTP methods, see ``METHOD_*``. To create a POST request with query strings to push to the server, do: @@ -288,7 +288,7 @@ To create a POST request with query strings to push to the server, do: Sends a raw request to the connected host. The URL parameter is just the part after the host, so for ``http://somehost.com/index.php``, it is ``index.php``. -Headers are HTTP request headers. For available HTTP methods, see ``METHOD\_\*``. +Headers are HTTP request headers. For available HTTP methods, see ``METHOD_*``. Sends the body data raw, as a byte array and does not encode it in any way. diff --git a/classes/class_httprequest.rst b/classes/class_httprequest.rst index 5122952e5..aedfb49ba 100644 --- a/classes/class_httprequest.rst +++ b/classes/class_httprequest.rst @@ -114,7 +114,7 @@ Returns the amount of bytes this HTTPRequest downloaded. - :ref:`int` **get_http_client_status** **(** **)** const -Returns the current status of the underlying :ref:`HTTPClient`. See ``STATUS\_\*`` enum on :ref:`HTTPClient`. +Returns the current status of the underlying :ref:`HTTPClient`. See ``STATUS_*`` enum on :ref:`HTTPClient`. .. _class_HTTPRequest_request: diff --git a/classes/class_image.rst b/classes/class_image.rst index 0d4ba9999..f04e72b84 100644 --- a/classes/class_image.rst +++ b/classes/class_image.rst @@ -116,7 +116,7 @@ Member Variables .. _class_Image_data: -- :ref:`Dictionary` **data** - Holds all of the image's color data in a given format. See ``FORMAT\_\*`` constants. +- :ref:`Dictionary` **data** - Holds all of the image's color data in a given format. See ``FORMAT_*`` constants. Enums @@ -242,13 +242,13 @@ Removes the image's mipmaps. - :ref:`int` **compress** **(** :ref:`int` mode, :ref:`int` source, :ref:`float` lossy_quality **)** -Compresses the image to use less memory. Can not directly access pixel data while the image is compressed. Returns error if the chosen compression mode is not available. See ``COMPRESS\_\*`` constants. +Compresses the image to use less memory. Can not directly access pixel data while the image is compressed. Returns error if the chosen compression mode is not available. See ``COMPRESS_*`` constants. .. _class_Image_convert: - void **convert** **(** :ref:`int` format **)** -Converts the image's format. See ``FORMAT\_\*`` constants. +Converts the image's format. See ``FORMAT_*`` constants. .. _class_Image_copy_from: @@ -260,13 +260,13 @@ Copies ``src`` image to this image. - void **create** **(** :ref:`int` width, :ref:`int` height, :ref:`bool` use_mipmaps, :ref:`int` format **)** -Creates an empty image of given size and format. See ``FORMAT\_\*`` constants. If ``use_mipmaps`` is true then generate mipmaps for this image. See the ``generate_mipmaps`` method. +Creates an empty image of given size and format. See ``FORMAT_*`` constants. If ``use_mipmaps`` is true then generate mipmaps for this image. See the ``generate_mipmaps`` method. .. _class_Image_create_from_data: - void **create_from_data** **(** :ref:`int` width, :ref:`int` height, :ref:`bool` use_mipmaps, :ref:`int` format, :ref:`PoolByteArray` data **)** -Creates a new image of given size and format. See ``FORMAT\_\*`` constants. Fills the image with the given raw data. If ``use_mipmaps`` is true then generate mipmaps for this image. See the ``generate_mipmaps`` method. +Creates a new image of given size and format. See ``FORMAT_*`` constants. Fills the image with the given raw data. If ``use_mipmaps`` is true then generate mipmaps for this image. See the ``generate_mipmaps`` method. .. _class_Image_crop: @@ -332,7 +332,7 @@ Returns the image's raw data. - :ref:`int` **get_format** **(** **)** const -Returns the image's raw data. +Returns the image’s format. See ``FORMAT_*`` constants. .. _class_Image_get_height: @@ -430,7 +430,7 @@ Converts the image's data to represent coordinates on a 3D plane. This is used w - void **premultiply_alpha** **(** **)** -Multiplies color values with alpha values. Resulting color values for a pixel are ``(color \* alpha)/256``. +Multiplies color values with alpha values. Resulting color values for a pixel are ``(color * alpha)/256``. .. _class_Image_resize: diff --git a/classes/class_input.rst b/classes/class_input.rst index 9cf91de54..dbbd49dea 100644 --- a/classes/class_input.rst +++ b/classes/class_input.rst @@ -190,7 +190,7 @@ If the device has a gyroscope, this will return the rate of rotation in rad/s ar - :ref:`float` **get_joy_axis** **(** :ref:`int` device, :ref:`int` axis **)** const -Returns the current value of the joypad axis at given index (see ``JOY\_\*`` constants in :ref:`@GlobalScope`) +Returns the current value of the joypad axis at given index (see ``JOY_*`` constants in :ref:`@GlobalScope`) .. _class_Input_get_joy_axis_index_from_string: @@ -278,25 +278,25 @@ Returns ``true`` if you are pressing the action event. - :ref:`bool` **is_joy_button_pressed** **(** :ref:`int` device, :ref:`int` button **)** const -Returns ``true`` if you are pressing the joypad button. (see ``JOY\_\*`` constants in :ref:`@GlobalScope`) +Returns ``true`` if you are pressing the joypad button. (see ``JOY_*`` constants in :ref:`@GlobalScope`) .. _class_Input_is_joy_known: - :ref:`bool` **is_joy_known** **(** :ref:`int` device **)** -Returns ``true`` if the system knows the specified device. This means that it sets all button and axis indices exactly as defined in the ``JOY\_\*`` constants (see :ref:`@GlobalScope`). Unknown joypads are not expected to match these constants, but you can still retrieve events from them. +Returns ``true`` if the system knows the specified device. This means that it sets all button and axis indices exactly as defined in the ``JOY_*`` constants (see :ref:`@GlobalScope`). Unknown joypads are not expected to match these constants, but you can still retrieve events from them. .. _class_Input_is_key_pressed: - :ref:`bool` **is_key_pressed** **(** :ref:`int` scancode **)** const -Returns ``true`` if you are pressing the key. You can pass ``KEY\_\*``, which are pre-defined constants listed in :ref:`@GlobalScope`. +Returns ``true`` if you are pressing the key. You can pass ``KEY_*``, which are pre-defined constants listed in :ref:`@GlobalScope`. .. _class_Input_is_mouse_button_pressed: - :ref:`bool` **is_mouse_button_pressed** **(** :ref:`int` button **)** const -Returns ``true`` if you are pressing the mouse button. You can pass ``BUTTON\_\*``, which are pre-defined constants listed in :ref:`@GlobalScope`. +Returns ``true`` if you are pressing the mouse button. You can pass ``BUTTON_*``, which are pre-defined constants listed in :ref:`@GlobalScope`. .. _class_Input_joy_connection_changed: @@ -316,7 +316,7 @@ Removes all mappings from the internal db that match the given uid. - void **set_custom_mouse_cursor** **(** :ref:`Resource` image, :ref:`int` shape=0, :ref:`Vector2` hotspot=Vector2( 0, 0 ) **)** -Set a custom mouse cursor image, which is only visible inside the game window. The hotspot can also be specified. See enum ``CURSOR\_\*`` for the list of shapes. +Set a custom mouse cursor image, which is only visible inside the game window. The hotspot can also be specified. See enum ``CURSOR_*`` for the list of shapes. .. _class_Input_set_mouse_mode: diff --git a/classes/class_inputeventjoypadbutton.rst b/classes/class_inputeventjoypadbutton.rst index ba7aab891..ef77a3afd 100644 --- a/classes/class_inputeventjoypadbutton.rst +++ b/classes/class_inputeventjoypadbutton.rst @@ -21,7 +21,7 @@ Member Variables .. _class_InputEventJoypadButton_button_index: -- :ref:`int` **button_index** - Button identifier. One of the ``JOY_BUTTON\_\*`` constants from @global Scope. +- :ref:`int` **button_index** - Button identifier. One of the ``JOY_BUTTON_*`` constants from @global Scope. .. _class_InputEventJoypadButton_pressed: diff --git a/classes/class_inputeventjoypadmotion.rst b/classes/class_inputeventjoypadmotion.rst index d25d622c9..b1de56438 100644 --- a/classes/class_inputeventjoypadmotion.rst +++ b/classes/class_inputeventjoypadmotion.rst @@ -14,14 +14,14 @@ InputEventJoypadMotion Brief Description ----------------- -Input event type for gamepad joysticks and other motions. For buttons see ``InputEventJoypadMotion``. +Input event type for gamepad joysticks and other motions. For buttons see ``InputEventJoypadButton``. Member Variables ---------------- .. _class_InputEventJoypadMotion_axis: -- :ref:`int` **axis** - Axis identifier. Use one of the ``JOY_AXIS\_\*`` constants in @global Scope. +- :ref:`int` **axis** - Axis identifier. Use one of the ``JOY_AXIS_*`` constants in @global Scope. .. _class_InputEventJoypadMotion_axis_value: diff --git a/classes/class_inputeventkey.rst b/classes/class_inputeventkey.rst index 6a4aeb45f..5c4348b9e 100644 --- a/classes/class_inputeventkey.rst +++ b/classes/class_inputeventkey.rst @@ -36,7 +36,7 @@ Member Variables .. _class_InputEventKey_scancode: -- :ref:`int` **scancode** - Key scancode, one of the ``KEY\_\*`` constants in @global Scope. +- :ref:`int` **scancode** - Key scancode, one of the ``KEY_*`` constants in @global Scope. .. _class_InputEventKey_unicode: diff --git a/classes/class_itemlist.rst b/classes/class_itemlist.rst index abd9ba9b4..3b116c1c5 100644 --- a/classes/class_itemlist.rst +++ b/classes/class_itemlist.rst @@ -126,9 +126,13 @@ Fired when a multiple selection is altered on a list allowing multiple selection Member Variables ---------------- + .. _class_ItemList_allow_reselect: + +- :ref:`bool` **allow_reselect** - If ``true`` the currently selected item may be selected again. + .. _class_ItemList_allow_rmb_select: -- :ref:`bool` **allow_rmb_select** +- :ref:`bool` **allow_rmb_select** - If ``true`` a right mouse button click can select items. .. _class_ItemList_auto_height: @@ -164,7 +168,7 @@ Member Variables .. _class_ItemList_select_mode: -- :ref:`SelectMode` **select_mode** +- :ref:`SelectMode` **select_mode** - Allow single or multiple selection. See the ``SELECT_*`` constants. Enums diff --git a/classes/class_json.rst b/classes/class_json.rst index 7e749b81a..bb99e777f 100644 --- a/classes/class_json.rst +++ b/classes/class_json.rst @@ -28,7 +28,7 @@ Member Functions Description ----------- -Helper class for parsing JSON data. For usage example, see :ref:`JSONParseResult`. +Helper class for parsing JSON data. For usage example and other important hints, see :ref:`JSONParseResult`. Member Function Description --------------------------- diff --git a/classes/class_jsonparseresult.rst b/classes/class_jsonparseresult.rst index 81661c568..f8b547e79 100644 --- a/classes/class_jsonparseresult.rst +++ b/classes/class_jsonparseresult.rst @@ -35,13 +35,15 @@ Member Variables - :ref:`Variant` **result** - A :ref:`Variant` containing the parsed JSON. Use typeof() to check if it is what you expect. For example, if JSON source starts with curly braces (``{}``) a :ref:`Dictionary` will be returned, if JSON source starts with braces (``[]``) an :ref:`Array` will be returned. -*Be aware that the JSON specification does not define integer or float types, but only a number type. Therefore, parsing a JSON text will convert all numerical values to float types.* +*Be aware that the JSON specification does not define integer or float types, but only a number type. Therefore, parsing a JSON text will convert all numerical values to float types. + +Note that JSON objects do not preserve key order like Godot dictionaries, thus you should not rely on keys being in a certain order if a dictionary is constructed from JSON. In contrast, JSON arrays retain the order of their elements:* :: - p = JSON.parse('["hello", "world", "!"]') - if typeof(p) == TYPE_ARRAY: - print(p[0]) # prints 'hello' + var p = JSON.parse('["hello", "world", "!"]') + if typeof(p.result) == TYPE_ARRAY: + print(p.result[0]) # prints 'hello' else: print("unexpected results") @@ -49,5 +51,5 @@ Member Variables Description ----------- -Returned by :ref:`JSON.parse`, ``JSONParseResult`` contains decoded JSON or error information if JSON source not successfully parsed. You can check if JSON source was successfully parsed with ``if json_result.error == 0``. +Returned by :ref:`JSON.parse`, ``JSONParseResult`` contains decoded JSON or error information if JSON source not successfully parsed. You can check if JSON source was successfully parsed with ``if json_result.error == OK``. diff --git a/classes/class_kinematicbody.rst b/classes/class_kinematicbody.rst index b1a603050..bdb7c75f3 100644 --- a/classes/class_kinematicbody.rst +++ b/classes/class_kinematicbody.rst @@ -137,7 +137,7 @@ Moves the body along a vector. If the body collides with another, it will slide If the body is standing on a slope and the horizontal speed (relative to the floor's speed) goes below ``slope_stop_min_velocity``, the body will stop completely. This prevents the body from sliding down slopes when you include gravity in ``linear_velocity``. When set to lower values, the body will not be able to stand still on steep slopes. -If the body collides, it will change direction a maximum of ``max_bounces`` times before it stops. +If the body collides, it will change direction a maximum of ``max_slides`` times before it stops. ``floor_max_angle`` is the maximum angle (in radians) where a slope is still considered a floor (or a ceiling), rather than a wall. The default value equals 45 degrees. diff --git a/classes/class_label.rst b/classes/class_label.rst index eb143410f..b1ec21bab 100644 --- a/classes/class_label.rst +++ b/classes/class_label.rst @@ -34,7 +34,7 @@ Member Variables .. _class_Label_align: -- :ref:`Align` **align** - Controls the text's horizontal align. Supports left, center, right, and fill, or justify. Set it to one of the ``ALIGN\_\*`` constants. +- :ref:`Align` **align** - Controls the text's horizontal align. Supports left, center, right, and fill, or justify. Set it to one of the ``ALIGN_*`` constants. .. _class_Label_autowrap: @@ -66,7 +66,7 @@ Member Variables .. _class_Label_valign: -- :ref:`VAlign` **valign** - Controls the text's vertical align. Supports top, center, bottom, and fill. Set it to one of the ``VALIGN\_\*`` constants. +- :ref:`VAlign` **valign** - Controls the text's vertical align. Supports top, center, bottom, and fill. Set it to one of the ``VALIGN_*`` constants. .. _class_Label_visible_characters: diff --git a/classes/class_line2d.rst b/classes/class_line2d.rst index 67ed182f5..e142cf289 100644 --- a/classes/class_line2d.rst +++ b/classes/class_line2d.rst @@ -36,7 +36,7 @@ Member Variables .. _class_Line2D_begin_cap_mode: -- :ref:`LineCapMode` **begin_cap_mode** - Controls the style of the line's first point. Use ``LINE_CAP\_\*`` constants. Default value: ``LINE_CAP_NONE``. +- :ref:`LineCapMode` **begin_cap_mode** - Controls the style of the line's first point. Use ``LINE_CAP_*`` constants. Default value: ``LINE_CAP_NONE``. .. _class_Line2D_default_color: @@ -44,7 +44,7 @@ Member Variables .. _class_Line2D_end_cap_mode: -- :ref:`LineCapMode` **end_cap_mode** - Controls the style of the line's last point. Use ``LINE_CAP\_\*`` constants. Default value: ``LINE_CAP_NONE``. +- :ref:`LineCapMode` **end_cap_mode** - Controls the style of the line's last point. Use ``LINE_CAP_*`` constants. Default value: ``LINE_CAP_NONE``. .. _class_Line2D_gradient: @@ -72,7 +72,7 @@ Member Variables .. _class_Line2D_texture_mode: -- :ref:`LineTextureMode` **texture_mode** - The style to render the ``texture`` on the line. Use ``LINE_TEXTURE\_\*`` constants. Default value: ``LINE_TEXTURE_NONE``. +- :ref:`LineTextureMode` **texture_mode** - The style to render the ``texture`` on the line. Use ``LINE_TEXTURE_*`` constants. Default value: ``LINE_TEXTURE_NONE``. .. _class_Line2D_width: diff --git a/classes/class_nativescript.rst b/classes/class_nativescript.rst index 9d53160a5..cf851aa42 100644 --- a/classes/class_nativescript.rst +++ b/classes/class_nativescript.rst @@ -19,9 +19,17 @@ Brief Description Member Functions ---------------- -+------------------------------+-------------------------------------------------------+ -| :ref:`Object` | :ref:`new` **(** **)** vararg | -+------------------------------+-------------------------------------------------------+ ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_class_documentation` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_method_documentation` **(** :ref:`String` method **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_property_documentation` **(** :ref:`String` path **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_signal_documentation` **(** :ref:`String` signal_name **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`new` **(** **)** vararg | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -38,8 +46,36 @@ Member Variables Member Function Description --------------------------- +.. _class_NativeScript_get_class_documentation: + +- :ref:`String` **get_class_documentation** **(** **)** const + +Returns the documentation string that was previously set with ``godot_nativescript_set_class_documentation``. + +.. _class_NativeScript_get_method_documentation: + +- :ref:`String` **get_method_documentation** **(** :ref:`String` method **)** const + +Returns the documentation string that was previously set with ``godot_nativescript_set_method_documentation``. + +.. _class_NativeScript_get_property_documentation: + +- :ref:`String` **get_property_documentation** **(** :ref:`String` path **)** const + +Returns the documentation string that was previously set with ``godot_nativescript_set_property_documentation``. + +.. _class_NativeScript_get_signal_documentation: + +- :ref:`String` **get_signal_documentation** **(** :ref:`String` signal_name **)** const + +Returns the documentation string that was previously set with ``godot_nativescript_set_signal_documentation``. + .. _class_NativeScript_new: - :ref:`Object` **new** **(** **)** vararg +Constructs a new object of the base type with a script of this type already attached. + +*Note*: Any arguments passed to this function will be ignored and not passed to the native constructor function. This will change with in a future API extension. + diff --git a/classes/class_networkedmultiplayerpeer.rst b/classes/class_networkedmultiplayerpeer.rst index 8aac3e0aa..5ad6c99c3 100644 --- a/classes/class_networkedmultiplayerpeer.rst +++ b/classes/class_networkedmultiplayerpeer.rst @@ -9,7 +9,7 @@ NetworkedMultiplayerPeer **Inherits:** :ref:`PacketPeer` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`NetworkedMultiplayerENet` +**Inherited By:** :ref:`NetworkedMultiplayerENet`, :ref:`WebSocketMultiplayerPeer` **Category:** Core diff --git a/classes/class_object.rst b/classes/class_object.rst index 83e3c8775..73151d9fc 100644 --- a/classes/class_object.rst +++ b/classes/class_object.rst @@ -211,7 +211,7 @@ Returns ``true`` if the object can translate strings. - :ref:`int` **connect** **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method, :ref:`Array` binds=[ ], :ref:`int` flags=0 **)** -Connects a ``signal`` to a ``method`` on a ``target`` object. Pass optional ``binds`` to the call. Use ``flags`` to set deferred or one shot connections. See ``CONNECT\_\*`` constants. A ``signal`` can only be connected once to a ``method``. It will throw an error if already connected. To avoid this, first use :ref:`is_connected` to check for existing connections. +Connects a ``signal`` to a ``method`` on a ``target`` object. Pass optional ``binds`` to the call. Use ``flags`` to set deferred or one shot connections. See ``CONNECT_*`` constants. A ``signal`` can only be connected once to a ``method``. It will throw an error if already connected. To avoid this, first use :ref:`is_connected` to check for existing connections. .. _class_Object_disconnect: diff --git a/classes/class_os.rst b/classes/class_os.rst index 6bfb8df7e..f34211cbd 100644 --- a/classes/class_os.rst +++ b/classes/class_os.rst @@ -26,6 +26,8 @@ Member Functions +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`can_use_threads` **(** **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`center_window` **(** **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`delay_msec` **(** :ref:`int` msec **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`delay_usec` **(** :ref:`int` usec **)** const | @@ -70,6 +72,8 @@ Member Functions +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_processor_count` **(** **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_real_window_size` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_scancode_string` **(** :ref:`int` code **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_screen_count` **(** **)** const | @@ -126,6 +130,8 @@ Member Functions +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_userfs_persistent` **(** **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_window_always_on_top` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`kill` **(** :ref:`int` pid **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`native_video_is_playing` **(** **)** | @@ -156,6 +162,8 @@ Member Functions +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_use_file_access_save_and_swap` **(** :ref:`bool` enabled **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_window_always_on_top` **(** :ref:`bool` enabled **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_window_title` **(** :ref:`String` title **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`shell_open` **(** :ref:`String` uri **)** | @@ -317,6 +325,10 @@ Returns ``true`` if the host OS allows drawing. Returns ``true`` if the current host platform is using multiple threads. +.. _class_OS_center_window: + +- void **center_window** **(** **)** + .. _class_OS_delay_msec: - void **delay_msec** **(** :ref:`int` msec **)** const @@ -462,7 +474,7 @@ Returns the time in seconds before the device runs out of battery. - :ref:`int` **get_power_state** **(** **)** -Returns the current state of the device regarding battery and power. See ``POWERSTATE\_\*`` constants. +Returns the current state of the device regarding battery and power. See ``POWERSTATE_*`` constants. .. _class_OS_get_process_id: @@ -476,6 +488,10 @@ Returns the game process ID Returns the number of cores available in the host machine. +.. _class_OS_get_real_window_size: + +- :ref:`Vector2` **get_real_window_size** **(** **)** const + .. _class_OS_get_scancode_string: - :ref:`String` **get_scancode_string** **(** :ref:`int` code **)** const @@ -572,7 +588,9 @@ Returns the current time zone as a dictionary with the keys: bias and name. - :ref:`String` **get_unique_id** **(** **)** const -Returns a string that is unique to the device. Currently only works on Android and iOS. Returns empty string on other platforms. +Returns a string that is unique to the device. + +Returns empty string on HTML5 and UWP which are not supported yet. .. _class_OS_get_unix_time: @@ -662,6 +680,10 @@ Returns ``true`` if the engine was executed with -v (verbose stdout). If ``true``, the ``user://`` file system is persistent, so that its state is the same after a player quits and starts the game again. Relevant to the HTML5 platform, where this persistence may be unavailable. +.. _class_OS_is_window_always_on_top: + +- :ref:`bool` **is_window_always_on_top** **(** **)** const + .. _class_OS_kill: - :ref:`int` **kill** **(** :ref:`int` pid **)** @@ -750,6 +772,10 @@ Sets the name of the current thread. Enables backup saves if ``enabled`` is ``true``. +.. _class_OS_set_window_always_on_top: + +- void **set_window_always_on_top** **(** :ref:`bool` enabled **)** + .. _class_OS_set_window_title: - void **set_window_title** **(** :ref:`String` title **)** diff --git a/classes/class_packetpeer.rst b/classes/class_packetpeer.rst index bfafe0e62..d0c9e6e27 100644 --- a/classes/class_packetpeer.rst +++ b/classes/class_packetpeer.rst @@ -9,7 +9,7 @@ PacketPeer **Inherits:** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`PacketPeerStream`, :ref:`PacketPeerUDP`, :ref:`NetworkedMultiplayerPeer` +**Inherited By:** :ref:`PacketPeerStream`, :ref:`PacketPeerUDP`, :ref:`WebSocketPeer`, :ref:`NetworkedMultiplayerPeer` **Category:** Core diff --git a/classes/class_particles.rst b/classes/class_particles.rst index 95171b829..4ea8c8e82 100644 --- a/classes/class_particles.rst +++ b/classes/class_particles.rst @@ -34,7 +34,7 @@ Member Variables .. _class_Particles_draw_order: -- :ref:`DrawOrder` **draw_order** - Particle draw order. Uses ``DRAW_ORDER\_\*`` values. Default value: ``DRAW_ORDER_INDEX``. +- :ref:`DrawOrder` **draw_order** - Particle draw order. Uses ``DRAW_ORDER_*`` values. Default value: ``DRAW_ORDER_INDEX``. .. _class_Particles_draw_pass_1: diff --git a/classes/class_particles2d.rst b/classes/class_particles2d.rst index 511e997c8..2b98620d0 100644 --- a/classes/class_particles2d.rst +++ b/classes/class_particles2d.rst @@ -34,7 +34,7 @@ Member Variables .. _class_Particles2D_draw_order: -- :ref:`DrawOrder` **draw_order** - Particle draw order. Uses ``DRAW_ORDER\_\*`` values. Default value: ``DRAW_ORDER_INDEX``. +- :ref:`DrawOrder` **draw_order** - Particle draw order. Uses ``DRAW_ORDER_*`` values. Default value: ``DRAW_ORDER_INDEX``. .. _class_Particles2D_emitting: diff --git a/classes/class_particlesmaterial.rst b/classes/class_particlesmaterial.rst index 2200d3425..0f7ed27dd 100644 --- a/classes/class_particlesmaterial.rst +++ b/classes/class_particlesmaterial.rst @@ -113,7 +113,7 @@ Member Variables .. _class_ParticlesMaterial_emission_shape: -- :ref:`EmissionShape` **emission_shape** - Particles will be emitted inside this region. Use ``EMISSION_SHAPE\_\*`` constants for values. Default value: ``EMISSION_SHAPE_POINT``. +- :ref:`EmissionShape` **emission_shape** - Particles will be emitted inside this region. Use ``EMISSION_SHAPE_*`` constants for values. Default value: ``EMISSION_SHAPE_POINT``. .. _class_ParticlesMaterial_emission_sphere_radius: diff --git a/classes/class_regex.rst b/classes/class_regex.rst index 535e251a2..041dfb66e 100644 --- a/classes/class_regex.rst +++ b/classes/class_regex.rst @@ -51,7 +51,7 @@ To begin, the RegEx object needs to be compiled with the search pattern using :r var regex = RegEx.new() regex.compile("\\w-(\\d+)") -The search pattern must be escaped first for gdscript before it is escaped for the expression. For example, ``compile("\\d+")`` would be read by RegEx as ``\d+``. Similarly, ``compile("\"(?:\\\\.|[^\"])\*\"")`` would be read as ``"(?:\\.|[^"])\*"`` +The search pattern must be escaped first for gdscript before it is escaped for the expression. For example, ``compile("\\d+")`` would be read by RegEx as ``\d+``. Similarly, ``compile("\"(?:\\\\.|[^\"])*\"")`` would be read as ``"(?:\\.|[^"])*"`` Using :ref:`search` you can find the pattern within the given text. If a pattern is found, :ref:`RegExMatch` is returned and you can retrieve details of the results using fuctions such as :ref:`RegExMatch.get_string` and :ref:`RegExMatch.get_start`. diff --git a/classes/class_richtextlabel.rst b/classes/class_richtextlabel.rst index 98a8b101f..7454f27a9 100644 --- a/classes/class_richtextlabel.rst +++ b/classes/class_richtextlabel.rst @@ -182,7 +182,7 @@ Description Rich text can contain custom text, fonts, images and some basic formatting. The label manages these as an internal tag stack. It also adapts itself to given width/heights. -Note that assignments to :ref:`bbcode_text` clear the tag stack and reconstruct it from the property's contents. Any edits made to :ref:`bbcode_text` will erase previous edits made from other manual sources such as :ref:`append_bbcode` and the ``push\_\*`` / :ref:`pop` methods. +Note that assignments to :ref:`bbcode_text` clear the tag stack and reconstruct it from the property's contents. Any edits made to :ref:`bbcode_text` will erase previous edits made from other manual sources such as :ref:`append_bbcode` and the ``push_*`` / :ref:`pop` methods. Member Function Description --------------------------- @@ -251,7 +251,7 @@ The assignment version of :ref:`append_bbcode - void **pop** **(** **)** -Terminates the current tag. Use after ``push\_\*`` methods to close bbcodes manually. Does not need to follow ``add\_\*`` methods. +Terminates the current tag. Use after ``push_*`` methods to close bbcodes manually. Does not need to follow ``add_*`` methods. .. _class_RichTextLabel_push_align: diff --git a/classes/class_rigidbody2d.rst b/classes/class_rigidbody2d.rst index 0aadaf5a9..c618290be 100644 --- a/classes/class_rigidbody2d.rst +++ b/classes/class_rigidbody2d.rst @@ -106,7 +106,7 @@ Member Variables - :ref:`CCDMode` **continuous_cd** - Continuous collision detection mode. Default value: ``CCD_MODE_DISABLED``. -Continuous collision detection tries to predict where a moving body will collide instead of moving it and correcting its movement after collision. Continuous collision detection is slower, but more precise and misses fewer collisions with small, fast-moving objects. Raycasting and shapecasting methods are available. See ``CCD_MODE\_`` constants for details. +Continuous collision detection tries to predict where a moving body will collide instead of moving it and correcting its movement after collision. Continuous collision detection is slower, but more precise and misses fewer collisions with small, fast-moving objects. Raycasting and shapecasting methods are available. See ``CCD_MODE_`` constants for details. .. _class_RigidBody2D_custom_integrator: @@ -138,7 +138,7 @@ Continuous collision detection tries to predict where a moving body will collide .. _class_RigidBody2D_mode: -- :ref:`Mode` **mode** - The body's mode. See ``MODE\_\*`` constants. Default value: ``MODE_RIGID``. +- :ref:`Mode` **mode** - The body's mode. See ``MODE_*`` constants. Default value: ``MODE_RIGID``. .. _class_RigidBody2D_sleeping: diff --git a/classes/class_scenestate.rst b/classes/class_scenestate.rst index b680ad697..097091f08 100644 --- a/classes/class_scenestate.rst +++ b/classes/class_scenestate.rst @@ -97,7 +97,7 @@ Returns the number of signal connections in the scene. - :ref:`int` **get_connection_flags** **(** :ref:`int` idx **)** const -Returns the flags for the signal at ``idx``. See :ref:`Object`'s ``CONNECT\_\*`` flags. +Returns the flags for the signal at ``idx``. See :ref:`Object`'s ``CONNECT_*`` flags. .. _class_SceneState_get_connection_method: diff --git a/classes/class_streampeerssl.rst b/classes/class_streampeerssl.rst index d119e61ad..b45086fc9 100644 --- a/classes/class_streampeerssl.rst +++ b/classes/class_streampeerssl.rst @@ -28,6 +28,8 @@ Member Functions +------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_status` **(** **)** const | +------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`poll` **(** **)** | ++------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enums ----- @@ -72,4 +74,10 @@ Disconnect from host. Return the status of the connection, one of STATUS\_\* enum. +.. _class_StreamPeerSSL_poll: + +- void **poll** **(** **)** + +Poll the connection to check for incoming bytes. Call this right before "get_available_bytes()" for it to work properly. + diff --git a/classes/class_streampeertcp.rst b/classes/class_streampeertcp.rst index cdcbe40a8..b448a7556 100644 --- a/classes/class_streampeertcp.rst +++ b/classes/class_streampeertcp.rst @@ -32,6 +32,8 @@ Member Functions +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_connected_to_host` **(** **)** const | +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_no_delay` **(** :ref:`bool` enabled **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ Enums ----- @@ -88,4 +90,12 @@ Return the status of the connection, one of STATUS\_\* enum. - :ref:`bool` **is_connected_to_host** **(** **)** const +.. _class_StreamPeerTCP_set_no_delay: + +- void **set_no_delay** **(** :ref:`bool` enabled **)** + +Disable Nagle algorithm to improve latency for small packets. + +Note that for applications that send large packets, or need to transfer a lot of data, this can reduce total bandwidth. + diff --git a/classes/class_tabcontainer.rst b/classes/class_tabcontainer.rst index 8bc0a78e7..9980c881c 100644 --- a/classes/class_tabcontainer.rst +++ b/classes/class_tabcontainer.rst @@ -76,7 +76,7 @@ Member Variables .. _class_TabContainer_tab_align: -- :ref:`TabAlign` **tab_align** - The alignment of all tabs in the tab container. See the ``ALIGN\_\*`` constants for details. +- :ref:`TabAlign` **tab_align** - The alignment of all tabs in the tab container. See the ``ALIGN_*`` constants for details. .. _class_TabContainer_tabs_visible: diff --git a/classes/class_texturebutton.rst b/classes/class_texturebutton.rst index 9336eb8eb..f504844e4 100644 --- a/classes/class_texturebutton.rst +++ b/classes/class_texturebutton.rst @@ -25,7 +25,7 @@ Member Variables .. _class_TextureButton_stretch_mode: -- :ref:`StretchMode` **stretch_mode** - Controls the texture's behavior when you resize the node's bounding rectangle, **only if** :ref:`expand` is ``true``. Set it to one of the ``STRETCH\_\*`` constants. See the constants to learn more. +- :ref:`StretchMode` **stretch_mode** - Controls the texture's behavior when you resize the node's bounding rectangle, **only if** :ref:`expand` is ``true``. Set it to one of the ``STRETCH_*`` constants. See the constants to learn more. .. _class_TextureButton_texture_click_mask: diff --git a/classes/class_textureprogress.rst b/classes/class_textureprogress.rst index 0a93f2683..2aa43b912 100644 --- a/classes/class_textureprogress.rst +++ b/classes/class_textureprogress.rst @@ -25,7 +25,7 @@ Member Variables .. _class_TextureProgress_nine_patch_stretch: -- :ref:`bool` **nine_patch_stretch** - If ``true`` Godot treats the bar's textures like :ref:`NinePatchRect`. Use ``stretch_margin\_\*``, like :ref:`stretch_margin_bottom`, to set up the nine patch's 3x3 grid. Default value: ``false``. +- :ref:`bool` **nine_patch_stretch** - If ``true`` Godot treats the bar's textures like :ref:`NinePatchRect`. Use ``stretch_margin_*``, like :ref:`stretch_margin_bottom`, to set up the nine patch's 3x3 grid. Default value: ``false``. .. _class_TextureProgress_radial_center_offset: diff --git a/classes/class_texturerect.rst b/classes/class_texturerect.rst index 04c05971d..9debf9a66 100644 --- a/classes/class_texturerect.rst +++ b/classes/class_texturerect.rst @@ -25,7 +25,7 @@ Member Variables .. _class_TextureRect_stretch_mode: -- :ref:`StretchMode` **stretch_mode** - Controls the texture's behavior when you resize the node's bounding rectangle. Set it to one of the ``STRETCH\_\*`` constants. See the constants to learn more. +- :ref:`StretchMode` **stretch_mode** - Controls the texture's behavior when you resize the node's bounding rectangle. Set it to one of the ``STRETCH_*`` constants. See the constants to learn more. .. _class_TextureRect_texture: diff --git a/classes/class_theme.rst b/classes/class_theme.rst index be5ccab24..186706b6a 100644 --- a/classes/class_theme.rst +++ b/classes/class_theme.rst @@ -90,7 +90,7 @@ Description Theme for skinning controls. Controls can be skinned individually, but for complex applications it's more efficient to just create a global theme that defines everything. This theme can be applied to any :ref:`Control`, and it and its children will automatically use it. -See the :ref:`GUI skinning tutorial` for more information. +Theme resources can be alternatively loaded by writing them in a .theme file, see docs for more info. Member Function Description --------------------------- diff --git a/classes/class_touchscreenbutton.rst b/classes/class_touchscreenbutton.rst index 87331a4a6..7a08b5733 100644 --- a/classes/class_touchscreenbutton.rst +++ b/classes/class_touchscreenbutton.rst @@ -76,7 +76,7 @@ Member Variables .. _class_TouchScreenButton_visibility_mode: -- :ref:`VisibilityMode` **visibility_mode** - The button's visibility mode. See ``VISIBILITY\_\*`` constants. +- :ref:`VisibilityMode` **visibility_mode** - The button's visibility mode. See ``VISIBILITY_*`` constants. Enums diff --git a/classes/class_transform.rst b/classes/class_transform.rst index e1ec90cc9..76b312c33 100644 --- a/classes/class_transform.rst +++ b/classes/class_transform.rst @@ -151,12 +151,12 @@ Translates the transform by the specified offset. - var **xform** **(** var v **)** -Transforms the given vector "v" by this transform. +Transforms the given :ref:`Vector3`, :ref:`Plane`, or :ref:`AABB` by this transform. .. _class_Transform_xform_inv: - var **xform_inv** **(** var v **)** -Inverse-transforms the given vector "v" by this transform. +Inverse-transforms the given :ref:`Vector3`, :ref:`Plane`, or :ref:`AABB` by this transform. diff --git a/classes/class_transform2d.rst b/classes/class_transform2d.rst index 84db84f33..53120a5bc 100644 --- a/classes/class_transform2d.rst +++ b/classes/class_transform2d.rst @@ -26,9 +26,9 @@ Member Functions +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform2D` | :ref:`affine_inverse` **(** **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`basis_xform` **(** var v **)** | +| :ref:`Vector2` | :ref:`basis_xform` **(** :ref:`Vector2` v **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`basis_xform_inv` **(** var v **)** | +| :ref:`Vector2` | :ref:`basis_xform_inv` **(** :ref:`Vector2` v **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_origin` **(** **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -48,9 +48,9 @@ Member Functions +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform2D` | :ref:`translated` **(** :ref:`Vector2` offset **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`xform` **(** var v **)** | +| var | :ref:`xform` **(** var v **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`xform_inv` **(** var v **)** | +| var | :ref:`xform_inv` **(** var v **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables @@ -103,13 +103,13 @@ Returns the inverse of the matrix. .. _class_Transform2D_basis_xform: -- :ref:`Transform2D` **basis_xform** **(** var v **)** +- :ref:`Vector2` **basis_xform** **(** :ref:`Vector2` v **)** Transforms the given vector by this transform's basis (no translation). .. _class_Transform2D_basis_xform_inv: -- :ref:`Transform2D` **basis_xform_inv** **(** var v **)** +- :ref:`Vector2` **basis_xform_inv** **(** :ref:`Vector2` v **)** Inverse-transforms the given vector by this transform's basis (no translation). @@ -169,14 +169,14 @@ Translates the transform by the given offset. .. _class_Transform2D_xform: -- :ref:`Transform2D` **xform** **(** var v **)** +- var **xform** **(** var v **)** -Transforms the given vector "v" by this transform. +Transforms the given :ref:`Vector2` or :ref:`Rect2` by this transform. .. _class_Transform2D_xform_inv: -- :ref:`Transform2D` **xform_inv** **(** var v **)** +- var **xform_inv** **(** var v **)** -Inverse-transforms the given vector "v" by this transform. +Inverse-transforms the given :ref:`Vector2` or :ref:`Rect2` by this transform. diff --git a/classes/class_tree.rst b/classes/class_tree.rst index b85255f22..0623900a7 100644 --- a/classes/class_tree.rst +++ b/classes/class_tree.rst @@ -174,7 +174,7 @@ Member Variables .. _class_Tree_drop_mode_flags: -- :ref:`int` **drop_mode_flags** - The drop mode as an OR combination of flags. See ``DROP_MODE\_\*`` constants. +- :ref:`int` **drop_mode_flags** - The drop mode as an OR combination of flags. See ``DROP_MODE_*`` constants. .. _class_Tree_hide_folding: @@ -186,7 +186,7 @@ Member Variables .. _class_Tree_select_mode: -- :ref:`SelectMode` **select_mode** - Allow single or multiple selection. See the ``SELECT\_\*`` constants. +- :ref:`SelectMode` **select_mode** - Allow single or multiple selection. See the ``SELECT_*`` constants. Enums diff --git a/classes/class_treeitem.rst b/classes/class_treeitem.rst index 1be0878d1..a875e88a4 100644 --- a/classes/class_treeitem.rst +++ b/classes/class_treeitem.rst @@ -222,7 +222,7 @@ Returns the number of buttons in column ``column``. May be used to get the most - :ref:`int` **get_cell_mode** **(** :ref:`int` column **)** const -Returns the column's cell mode. See ``CELL_MODE\_\*`` constants. +Returns the column's cell mode. See ``CELL_MODE_*`` constants. .. _class_TreeItem_get_children: @@ -388,7 +388,7 @@ Sets the given column's button :ref:`Texture` at index ``button_i - void **set_cell_mode** **(** :ref:`int` column, :ref:`int` mode **)** -Sets the given column's cell mode to ``mode``. See ``CELL_MODE\_\*`` constants. +Sets the given column's cell mode to ``mode``. See ``CELL_MODE_*`` constants. .. _class_TreeItem_set_checked: @@ -474,7 +474,7 @@ If ``true`` the given column is selectable. - void **set_text_align** **(** :ref:`int` column, :ref:`int` text_align **)** -Sets the given column's text alignment. See ``ALIGN\_\*`` constants. +Sets the given column's text alignment. See ``ALIGN_*`` constants. .. _class_TreeItem_set_tooltip: diff --git a/classes/class_vector3.rst b/classes/class_vector3.rst index 7c73d539c..47244d587 100644 --- a/classes/class_vector3.rst +++ b/classes/class_vector3.rst @@ -64,7 +64,7 @@ Member Functions +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`slide` **(** :ref:`Vector3` n **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`snapped` **(** :ref:`float` by **)** | +| :ref:`Vector3` | :ref:`snapped` **(** :ref:`Vector3` by **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Basis` | :ref:`to_diagonal_matrix` **(** **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -240,7 +240,7 @@ Slide returns the component of the vector along the given plane, specified by it .. _class_Vector3_snapped: -- :ref:`Vector3` **snapped** **(** :ref:`float` by **)** +- :ref:`Vector3` **snapped** **(** :ref:`Vector3` by **)** Returns a copy of the vector, snapped to the lowest neared multiple. diff --git a/classes/class_viewport.rst b/classes/class_viewport.rst index 9cc74a982..8e8f62d69 100644 --- a/classes/class_viewport.rst +++ b/classes/class_viewport.rst @@ -78,15 +78,15 @@ Member Variables .. _class_Viewport_arvr: -- :ref:`bool` **arvr** +- :ref:`bool` **arvr** - If ``true`` the viewport will be used in AR/VR process. Default value: ``false``. .. _class_Viewport_audio_listener_enable_2d: -- :ref:`bool` **audio_listener_enable_2d** +- :ref:`bool` **audio_listener_enable_2d** - If ``true`` the viewport will process 2D audio streams. Default value: ``false``. .. _class_Viewport_audio_listener_enable_3d: -- :ref:`bool` **audio_listener_enable_3d** +- :ref:`bool` **audio_listener_enable_3d** - If ``true`` the viewport will process 3D audio streams. Default value: ``false``. .. _class_Viewport_canvas_transform: @@ -94,11 +94,11 @@ Member Variables .. _class_Viewport_debug_draw: -- :ref:`DebugDraw` **debug_draw** +- :ref:`DebugDraw` **debug_draw** - The overlay mode for test rendered geometry in debug purposes. Default value: ``DEBUG_DRAW_DISABLED``. .. _class_Viewport_disable_3d: -- :ref:`bool` **disable_3d** +- :ref:`bool` **disable_3d** - If ``true`` the viewport will disable 3D rendering. For actual disabling use ``usage``. Default value: ``false``. .. _class_Viewport_global_canvas_transform: @@ -106,79 +106,79 @@ Member Variables .. _class_Viewport_gui_disable_input: -- :ref:`bool` **gui_disable_input** +- :ref:`bool` **gui_disable_input** - If ``true`` the viewport will not receive input event. Default value: ``false``. .. _class_Viewport_gui_snap_controls_to_pixels: -- :ref:`bool` **gui_snap_controls_to_pixels** +- :ref:`bool` **gui_snap_controls_to_pixels** - If ``true`` the GUI controls on the viewport will lay pixel perfectly. Default value: ``true``. .. _class_Viewport_hdr: -- :ref:`bool` **hdr** +- :ref:`bool` **hdr** - If ``true`` the viewport rendering will receive benefits from High Dynamic Range algorithm. Default value: ``true``. .. _class_Viewport_msaa: -- :ref:`MSAA` **msaa** +- :ref:`MSAA` **msaa** - The multisample anti-aliasing mode. Default value: ``MSAA_DISABLED``. .. _class_Viewport_own_world: -- :ref:`bool` **own_world** +- :ref:`bool` **own_world** - If ``true`` the viewport will use :ref:`World` defined in ``world`` property. Default value: ``false``. .. _class_Viewport_physics_object_picking: -- :ref:`bool` **physics_object_picking** +- :ref:`bool` **physics_object_picking** - If ``true`` the objects rendered by viewport become subjects of mouse picking process. Default value: ``false``. .. _class_Viewport_render_target_clear_mode: -- :ref:`ClearMode` **render_target_clear_mode** +- :ref:`ClearMode` **render_target_clear_mode** - The clear mode when viewport used as a render target. Default value: ``CLEAR_MODE_ALWAYS``. .. _class_Viewport_render_target_update_mode: -- :ref:`UpdateMode` **render_target_update_mode** +- :ref:`UpdateMode` **render_target_update_mode** - The update mode when viewport used as a render target. Default value: ``UPDATE_WHEN_VISIBLE``. .. _class_Viewport_render_target_v_flip: -- :ref:`bool` **render_target_v_flip** +- :ref:`bool` **render_target_v_flip** - If ``true`` the result of rendering will be flipped vertically. Default value: ``false``. .. _class_Viewport_shadow_atlas_quad_0: -- :ref:`ShadowAtlasQuadrantSubdiv` **shadow_atlas_quad_0** +- :ref:`ShadowAtlasQuadrantSubdiv` **shadow_atlas_quad_0** - The subdivision amount of first quadrant on shadow atlas. Default value: ``SHADOW_ATLAS_QUADRANT_SUBDIV_4``. .. _class_Viewport_shadow_atlas_quad_1: -- :ref:`ShadowAtlasQuadrantSubdiv` **shadow_atlas_quad_1** +- :ref:`ShadowAtlasQuadrantSubdiv` **shadow_atlas_quad_1** - The subdivision amount of second quadrant on shadow atlas. Default value: ``SHADOW_ATLAS_QUADRANT_SUBDIV_4``. .. _class_Viewport_shadow_atlas_quad_2: -- :ref:`ShadowAtlasQuadrantSubdiv` **shadow_atlas_quad_2** +- :ref:`ShadowAtlasQuadrantSubdiv` **shadow_atlas_quad_2** - The subdivision amount of third quadrant on shadow atlas. Default value: ``SHADOW_ATLAS_QUADRANT_SUBDIV_16``. .. _class_Viewport_shadow_atlas_quad_3: -- :ref:`ShadowAtlasQuadrantSubdiv` **shadow_atlas_quad_3** +- :ref:`ShadowAtlasQuadrantSubdiv` **shadow_atlas_quad_3** - The subdivision amount of fourth quadrant on shadow atlas. Default value: ``SHADOW_ATLAS_QUADRANT_SUBDIV_64``. .. _class_Viewport_shadow_atlas_size: -- :ref:`int` **shadow_atlas_size** +- :ref:`int` **shadow_atlas_size** - The resolution of shadow atlas. Both width and height is equal to one value. .. _class_Viewport_size: -- :ref:`Vector2` **size** +- :ref:`Vector2` **size** - The width and height of viewport. .. _class_Viewport_transparent_bg: -- :ref:`bool` **transparent_bg** +- :ref:`bool` **transparent_bg** - If ``true`` the viewport should render its background as transparent. Default value: ``false``. .. _class_Viewport_usage: -- :ref:`Usage` **usage** +- :ref:`Usage` **usage** - The rendering mode of viewport. Default value: ``USAGE_3D``. .. _class_Viewport_world: -- :ref:`World` **world** +- :ref:`World` **world** - The custom :ref:`World` which can be used as 3D environment source. .. _class_Viewport_world_2d: -- :ref:`World2D` **world_2d** +- :ref:`World2D` **world_2d** - The custom :ref:`World2D` which can be used as 2D environment source. Enums @@ -191,25 +191,25 @@ enum **UpdateMode** - **UPDATE_DISABLED** = **0** --- Do not update the render target. - **UPDATE_ONCE** = **1** --- Update the render target once, then switch to ``UPDATE_DISABLED`` - **UPDATE_WHEN_VISIBLE** = **2** --- Update the render target only when it is visible. This is the default value. -- **UPDATE_ALWAYS** = **3** +- **UPDATE_ALWAYS** = **3** --- Always update the render target. .. _enum_Viewport_RenderInfo: enum **RenderInfo** -- **RENDER_INFO_OBJECTS_IN_FRAME** = **0** -- **RENDER_INFO_VERTICES_IN_FRAME** = **1** -- **RENDER_INFO_MATERIAL_CHANGES_IN_FRAME** = **2** -- **RENDER_INFO_SHADER_CHANGES_IN_FRAME** = **3** -- **RENDER_INFO_SURFACE_CHANGES_IN_FRAME** = **4** -- **RENDER_INFO_DRAW_CALLS_IN_FRAME** = **5** -- **RENDER_INFO_MAX** = **6** +- **RENDER_INFO_OBJECTS_IN_FRAME** = **0** --- Amount of objects in frame. +- **RENDER_INFO_VERTICES_IN_FRAME** = **1** --- Amount of vertices in frame. +- **RENDER_INFO_MATERIAL_CHANGES_IN_FRAME** = **2** --- Amount of material changes in frame. +- **RENDER_INFO_SHADER_CHANGES_IN_FRAME** = **3** --- Amount of shader changes in frame. +- **RENDER_INFO_SURFACE_CHANGES_IN_FRAME** = **4** --- Amount of surface changes in frame. +- **RENDER_INFO_DRAW_CALLS_IN_FRAME** = **5** --- Amount of draw calls in frame. +- **RENDER_INFO_MAX** = **6** --- Enum limiter. Do not use it directly. .. _enum_Viewport_MSAA: enum **MSAA** -- **MSAA_DISABLED** = **0** +- **MSAA_DISABLED** = **0** --- Multisample anti-aliasing mode disabled. This is the default value. - **MSAA_2X** = **1** - **MSAA_4X** = **2** - **MSAA_8X** = **3** @@ -236,10 +236,10 @@ enum **Usage** enum **DebugDraw** -- **DEBUG_DRAW_DISABLED** = **0** -- **DEBUG_DRAW_UNSHADED** = **1** +- **DEBUG_DRAW_DISABLED** = **0** --- Objects are displayed normally. +- **DEBUG_DRAW_UNSHADED** = **1** --- Objects are displayed without light information. - **DEBUG_DRAW_OVERDRAW** = **2** -- **DEBUG_DRAW_WIREFRAME** = **3** +- **DEBUG_DRAW_WIREFRAME** = **3** --- Objects are displayed in wireframe style. .. _enum_Viewport_ShadowAtlasQuadrantSubdiv: @@ -252,7 +252,7 @@ enum **ShadowAtlasQuadrantSubdiv** - **SHADOW_ATLAS_QUADRANT_SUBDIV_64** = **4** - **SHADOW_ATLAS_QUADRANT_SUBDIV_256** = **5** - **SHADOW_ATLAS_QUADRANT_SUBDIV_1024** = **6** -- **SHADOW_ATLAS_QUADRANT_SUBDIV_MAX** = **7** +- **SHADOW_ATLAS_QUADRANT_SUBDIV_MAX** = **7** --- Enum limiter. Do not use it directly. Description @@ -307,6 +307,8 @@ Get the mouse position, relative to the viewport. - :ref:`int` **get_render_info** **(** :ref:`int` info **)** +Get the specific information about the viewport from rendering pipeline. + .. _class_Viewport_get_size_override: - :ref:`Vector2` **get_size_override** **(** **)** const diff --git a/classes/class_visualscriptbuiltinfunc.rst b/classes/class_visualscriptbuiltinfunc.rst index ebf595e7b..4bfad3a6b 100644 --- a/classes/class_visualscriptbuiltinfunc.rst +++ b/classes/class_visualscriptbuiltinfunc.rst @@ -57,7 +57,7 @@ enum **BuiltinFunc** - **MATH_EASE** = **23** --- Easing function, based on exponent. 0 is constant, 1 is linear, 0 to 1 is ease-in, 1+ is ease out. Negative values are in-out/out in. - **MATH_DECIMALS** = **24** --- Return the number of digit places after the decimal that the first non-zero digit occurs. - **MATH_STEPIFY** = **25** --- Return the input snapped to a given step. -- **MATH_LERP** = **26** --- Return a number linearly interpolated between the first two inputs, based on the third input. Uses the formula ``a + (a - b) \* t``. +- **MATH_LERP** = **26** --- Return a number linearly interpolated between the first two inputs, based on the third input. Uses the formula ``a + (a - b) * t``. - **MATH_INVERSE_LERP** = **27** - **MATH_RANGE_LERP** = **28** - **MATH_DECTIME** = **29** --- Return the result of 'value' decreased by 'step' \* 'amount'. diff --git a/classes/class_visualserver.rst b/classes/class_visualserver.rst index 5a1d08848..76be71cd2 100644 --- a/classes/class_visualserver.rst +++ b/classes/class_visualserver.rst @@ -24,6 +24,20 @@ Member Functions +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`black_bars_set_margins` **(** :ref:`int` left, :ref:`int` top, :ref:`int` right, :ref:`int` bottom **)** | +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`camera_create` **(** **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`camera_set_cull_mask` **(** :ref:`RID` camera, :ref:`int` layers **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`camera_set_environment` **(** :ref:`RID` camera, :ref:`RID` env **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`camera_set_orthogonal` **(** :ref:`RID` camera, :ref:`float` size, :ref:`float` z_near, :ref:`float` z_far **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`camera_set_perspective` **(** :ref:`RID` camera, :ref:`float` fovy_degrees, :ref:`float` z_near, :ref:`float` z_far **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`camera_set_transform` **(** :ref:`RID` camera, :ref:`Transform` transform **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`camera_set_use_vertical_aspect` **(** :ref:`RID` camera, :ref:`bool` enable **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`canvas_create` **(** **)** | +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_item_add_circle` **(** :ref:`RID` item, :ref:`Vector2` pos, :ref:`float` radius, :ref:`Color` color **)** | @@ -160,8 +174,46 @@ Member Functions +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_set_modulate` **(** :ref:`RID` canvas, :ref:`Color` color **)** | +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`directional_light_create` **(** **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`draw` **(** :ref:`bool` swap_buffers=true **)** | +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`environment_create` **(** **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_adjustment` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` brightness, :ref:`float` contrast, :ref:`float` saturation, :ref:`RID` ramp **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_ambient_light` **(** :ref:`RID` env, :ref:`Color` color, :ref:`float` energy=1.0, :ref:`float` sky_contibution=0.0 **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_background` **(** :ref:`RID` env, :ref:`int` bg **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_bg_color` **(** :ref:`RID` env, :ref:`Color` color **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_bg_energy` **(** :ref:`RID` env, :ref:`float` energy **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_canvas_max_layer` **(** :ref:`RID` env, :ref:`int` max_layer **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_dof_blur_far` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` distance, :ref:`float` transition, :ref:`float` far_amount, :ref:`int` quality **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_dof_blur_near` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` distance, :ref:`float` transition, :ref:`float` far_amount, :ref:`int` quality **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_fog` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`Color` color, :ref:`Color` sun_color, :ref:`float` sun_amount **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_fog_depth` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` depth_begin, :ref:`float` depth_curve, :ref:`bool` transmit, :ref:`float` transmit_curve **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_fog_height` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` min_height, :ref:`float` max_height, :ref:`float` height_curve **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_glow` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`int` level_flags, :ref:`float` intensity, :ref:`float` strength, :ref:`float` bloom_threshold, :ref:`int` blend_mode, :ref:`float` hdr_bleed_threshold, :ref:`float` hdr_bleed_scale, :ref:`bool` bicubic_upscale **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_sky` **(** :ref:`RID` env, :ref:`RID` sky **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_sky_custom_fov` **(** :ref:`RID` env, :ref:`float` scale **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_ssao` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` radius, :ref:`float` intensity, :ref:`float` radius2, :ref:`float` intensity2, :ref:`float` bias, :ref:`float` light_affect, :ref:`Color` color, :ref:`int` quality, :ref:`int` blur, :ref:`float` bilateral_sharpness **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_ssr` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`int` max_steps, :ref:`float` fade_in, :ref:`float` fade_out, :ref:`float` depth_tolerance, :ref:`bool` roughness **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_tonemap` **(** :ref:`RID` env, :ref:`int` tone_mapper, :ref:`float` exposure, :ref:`float` white, :ref:`bool` auto_exposure, :ref:`float` min_luminance, :ref:`float` max_luminance, :ref:`float` auto_exp_speed, :ref:`float` auto_exp_grey **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`finish` **(** **)** | +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`force_draw` **(** :ref:`bool` swap_buffers=true **)** | @@ -178,14 +230,180 @@ Member Functions +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_white_texture` **(** **)** | +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`gi_probe_create` **(** **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`gi_probe_get_bias` **(** :ref:`RID` arg0 **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AABB` | :ref:`gi_probe_get_bounds` **(** :ref:`RID` probe **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`gi_probe_get_cell_size` **(** :ref:`RID` probe **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`gi_probe_get_dynamic_data` **(** :ref:`RID` arg0 **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`gi_probe_get_dynamic_range` **(** :ref:`RID` arg0 **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`gi_probe_get_energy` **(** :ref:`RID` arg0 **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`gi_probe_get_normal_bias` **(** :ref:`RID` arg0 **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`gi_probe_get_propagation` **(** :ref:`RID` arg0 **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`gi_probe_get_to_cell_xform` **(** :ref:`RID` arg0 **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`gi_probe_is_compressed` **(** :ref:`RID` arg0 **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`gi_probe_is_interior` **(** :ref:`RID` arg0 **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`gi_probe_set_bias` **(** :ref:`RID` bias, :ref:`float` arg1 **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`gi_probe_set_bounds` **(** :ref:`RID` probe, :ref:`AABB` bounds **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`gi_probe_set_cell_size` **(** :ref:`RID` probe, :ref:`float` range **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`gi_probe_set_compress` **(** :ref:`RID` enable, :ref:`bool` arg1 **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`gi_probe_set_dynamic_data` **(** :ref:`RID` data, :ref:`PoolIntArray` arg1 **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`gi_probe_set_dynamic_range` **(** :ref:`RID` range, :ref:`int` arg1 **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`gi_probe_set_energy` **(** :ref:`RID` energy, :ref:`float` arg1 **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`gi_probe_set_interior` **(** :ref:`RID` enable, :ref:`bool` arg1 **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`gi_probe_set_normal_bias` **(** :ref:`RID` bias, :ref:`float` arg1 **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`gi_probe_set_propagation` **(** :ref:`RID` propagation, :ref:`float` arg1 **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`gi_probe_set_to_cell_xform` **(** :ref:`RID` xform, :ref:`Transform` arg1 **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_changed` **(** **)** const | +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_feature` **(** :ref:`int` feature **)** const | +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_os_feature` **(** :ref:`String` feature **)** const | +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`immediate_begin` **(** :ref:`RID` immediate, :ref:`int` primitive, :ref:`RID` texture **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`immediate_clear` **(** :ref:`RID` immediate **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`immediate_color` **(** :ref:`RID` immediate, :ref:`Color` color **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`immediate_create` **(** **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`immediate_end` **(** :ref:`RID` immediate **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`immediate_get_material` **(** :ref:`RID` immediate **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`immediate_normal` **(** :ref:`RID` immediate, :ref:`Vector3` normal **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`immediate_set_material` **(** :ref:`RID` immediate, :ref:`RID` material **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`immediate_tangent` **(** :ref:`RID` immediate, :ref:`Plane` tangent **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`immediate_uv` **(** :ref:`RID` immediate, :ref:`Vector2` tex_uv **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`immediate_uv2` **(** :ref:`RID` immediate, :ref:`Vector2` tex_uv **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`immediate_vertex` **(** :ref:`RID` immediate, :ref:`Vector3` vertex **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`immediate_vertex_2d` **(** :ref:`RID` immediate, :ref:`Vector2` vertex **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`init` **(** **)** | +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_attach_object_instance_id` **(** :ref:`RID` instance, :ref:`int` id **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_attach_skeleton` **(** :ref:`RID` instance, :ref:`RID` skeleton **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`instance_create` **(** **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`instance_create2` **(** :ref:`RID` base, :ref:`RID` scenario **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_geometry_set_as_instance_lod` **(** :ref:`RID` instance, :ref:`RID` as_lod_of_instance **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_geometry_set_cast_shadows_setting` **(** :ref:`RID` instance, :ref:`int` shadow_casting_setting **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_geometry_set_draw_range` **(** :ref:`RID` instance, :ref:`float` min, :ref:`float` max, :ref:`float` min_margin, :ref:`float` max_margin **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_geometry_set_flag` **(** :ref:`RID` instance, :ref:`int` flag, :ref:`bool` enabled **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_geometry_set_material_override` **(** :ref:`RID` instance, :ref:`RID` material **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_set_base` **(** :ref:`RID` instance, :ref:`RID` base **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_set_blend_shape_weight` **(** :ref:`RID` instance, :ref:`int` shape, :ref:`float` weight **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_set_custom_aabb` **(** :ref:`RID` instance, :ref:`AABB` aabb **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_set_exterior` **(** :ref:`RID` instance, :ref:`bool` enabled **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_set_extra_visibility_margin` **(** :ref:`RID` instance, :ref:`float` margin **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_set_layer_mask` **(** :ref:`RID` instance, :ref:`int` mask **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_set_scenario` **(** :ref:`RID` instance, :ref:`RID` scenario **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_set_surface_material` **(** :ref:`RID` instance, :ref:`int` surface, :ref:`RID` material **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_set_transform` **(** :ref:`RID` instance, :ref:`Transform` transform **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_set_use_lightmap` **(** :ref:`RID` instance, :ref:`RID` lightmap_instance, :ref:`RID` lightmap **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_set_visible` **(** :ref:`RID` instance, :ref:`bool` visible **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`instances_cull_aabb` **(** :ref:`AABB` aabb, :ref:`RID` scenario **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`instances_cull_convex` **(** :ref:`Array` convex, :ref:`RID` scenario **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`instances_cull_ray` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`RID` scenario **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_directional_set_blend_splits` **(** :ref:`RID` light, :ref:`bool` enable **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_directional_set_shadow_depth_range_mode` **(** :ref:`RID` light, :ref:`int` range_mode **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_directional_set_shadow_mode` **(** :ref:`RID` light, :ref:`int` mode **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_omni_set_shadow_detail` **(** :ref:`RID` light, :ref:`int` detail **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_omni_set_shadow_mode` **(** :ref:`RID` light, :ref:`int` mode **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_set_color` **(** :ref:`RID` light, :ref:`Color` color **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_set_cull_mask` **(** :ref:`RID` light, :ref:`int` mask **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_set_negative` **(** :ref:`RID` light, :ref:`bool` enable **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_set_param` **(** :ref:`RID` light, :ref:`int` param, :ref:`float` value **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_set_projector` **(** :ref:`RID` light, :ref:`RID` texture **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_set_reverse_cull_face_mode` **(** :ref:`RID` light, :ref:`bool` enabled **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_set_shadow` **(** :ref:`RID` light, :ref:`bool` enabled **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_set_shadow_color` **(** :ref:`RID` light, :ref:`Color` color **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`lightmap_capture_create` **(** **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AABB` | :ref:`lightmap_capture_get_bounds` **(** :ref:`RID` capture **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`lightmap_capture_get_energy` **(** :ref:`RID` capture **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`lightmap_capture_get_octree` **(** :ref:`RID` capture **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`lightmap_capture_get_octree_cell_subdiv` **(** :ref:`RID` capture **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`lightmap_capture_get_octree_cell_transform` **(** :ref:`RID` capture **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`lightmap_capture_set_bounds` **(** :ref:`RID` capture, :ref:`AABB` bounds **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`lightmap_capture_set_energy` **(** :ref:`RID` capture, :ref:`float` energy **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`lightmap_capture_set_octree` **(** :ref:`RID` capture, :ref:`PoolByteArray` octree **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`lightmap_capture_set_octree_cell_subdiv` **(** :ref:`RID` capture, :ref:`int` subdiv **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`lightmap_capture_set_octree_cell_transform` **(** :ref:`RID` capture, :ref:`Transform` xform **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`make_sphere_mesh` **(** :ref:`int` latitudes, :ref:`int` longitudes, :ref:`float` radius **)** | +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`material_create` **(** **)** | @@ -250,8 +468,114 @@ Member Functions +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`mesh_surface_set_material` **(** :ref:`RID` mesh, :ref:`int` surface, :ref:`RID` material **)** | +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`multimesh_allocate` **(** :ref:`RID` multimesh, :ref:`int` instances, :ref:`int` transform_format, :ref:`int` color_format **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AABB` | :ref:`multimesh_get_aabb` **(** :ref:`RID` multimesh **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`multimesh_get_instance_count` **(** :ref:`RID` multimesh **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`multimesh_get_mesh` **(** :ref:`RID` multimesh **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`multimesh_get_visible_instances` **(** :ref:`RID` multimesh **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`multimesh_instance_get_color` **(** :ref:`RID` multimesh, :ref:`int` index **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`multimesh_instance_get_transform` **(** :ref:`RID` multimesh, :ref:`int` index **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`multimesh_instance_get_transform_2d` **(** :ref:`RID` multimesh, :ref:`int` index **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`multimesh_instance_set_color` **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Color` color **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`multimesh_instance_set_transform` **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Transform` transform **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`multimesh_instance_set_transform_2d` **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Transform2D` transform **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`multimesh_set_mesh` **(** :ref:`RID` multimesh, :ref:`RID` mesh **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`multimesh_set_visible_instances` **(** :ref:`RID` multimesh, :ref:`int` visible **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`omni_light_create` **(** **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`particles_create` **(** **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AABB` | :ref:`particles_get_current_aabb` **(** :ref:`RID` particles **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`particles_get_emitting` **(** :ref:`RID` particles **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_restart` **(** :ref:`RID` particles **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_amount` **(** :ref:`RID` particles, :ref:`int` amount **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_custom_aabb` **(** :ref:`RID` particles, :ref:`AABB` aabb **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_draw_order` **(** :ref:`RID` particles, :ref:`int` order **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_draw_pass_mesh` **(** :ref:`RID` particles, :ref:`int` pass, :ref:`RID` mesh **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_draw_passes` **(** :ref:`RID` particles, :ref:`int` count **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_emission_transform` **(** :ref:`RID` particles, :ref:`Transform` transform **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_emitting` **(** :ref:`RID` particles, :ref:`bool` emitting **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_explosiveness_ratio` **(** :ref:`RID` particles, :ref:`float` ratio **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_fixed_fps` **(** :ref:`RID` particles, :ref:`int` fps **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_fractional_delta` **(** :ref:`RID` particles, :ref:`bool` enable **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_lifetime` **(** :ref:`RID` particles, :ref:`float` lifetime **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_one_shot` **(** :ref:`RID` particles, :ref:`bool` one_shot **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_pre_process_time` **(** :ref:`RID` particles, :ref:`float` time **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_process_material` **(** :ref:`RID` particles, :ref:`RID` material **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_randomness_ratio` **(** :ref:`RID` particles, :ref:`float` ratio **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_speed_scale` **(** :ref:`RID` particles, :ref:`float` scale **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_use_local_coordinates` **(** :ref:`RID` particles, :ref:`bool` enable **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`reflection_probe_create` **(** **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_as_interior` **(** :ref:`RID` probe, :ref:`bool` enable **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_cull_mask` **(** :ref:`RID` probe, :ref:`int` layers **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_enable_box_projection` **(** :ref:`RID` probe, :ref:`bool` enable **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_enable_shadows` **(** :ref:`RID` probe, :ref:`bool` enable **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_extents` **(** :ref:`RID` probe, :ref:`Vector3` extents **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_intensity` **(** :ref:`RID` probe, :ref:`float` intensity **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_interior_ambient` **(** :ref:`RID` probe, :ref:`Color` color **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_interior_ambient_energy` **(** :ref:`RID` probe, :ref:`float` energy **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_interior_ambient_probe_contribution` **(** :ref:`RID` probe, :ref:`float` contrib **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_max_distance` **(** :ref:`RID` probe, :ref:`float` distance **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_origin_offset` **(** :ref:`RID` probe, :ref:`Vector3` offset **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_update_mode` **(** :ref:`RID` probe, :ref:`int` mode **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`request_frame_drawn_callback` **(** :ref:`Object` where, :ref:`String` method, :ref:`Variant` userdata **)** | +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`scenario_create` **(** **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`scenario_set_debug` **(** :ref:`RID` scenario, :ref:`int` debug_mode **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`scenario_set_environment` **(** :ref:`RID` scenario, :ref:`RID` environment **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`scenario_set_fallback_environment` **(** :ref:`RID` scenario, :ref:`RID` environment **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`scenario_set_reflection_atlas_size` **(** :ref:`RID` scenario, :ref:`int` p_size, :ref:`int` subdiv **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_boot_image` **(** :ref:`Image` image, :ref:`Color` color, :ref:`bool` scale **)** | +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_debug_generate_wireframes` **(** :ref:`bool` generate **)** | @@ -270,10 +594,26 @@ Member Functions +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`shader_set_default_texture_param` **(** :ref:`RID` shader, :ref:`String` name, :ref:`RID` texture **)** | +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`skeleton_allocate` **(** :ref:`RID` skeleton, :ref:`int` bones, :ref:`bool` is_2d_skeleton=false **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`skeleton_bone_get_transform` **(** :ref:`RID` skeleton, :ref:`int` bone **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`skeleton_bone_get_transform_2d` **(** :ref:`RID` skeleton, :ref:`int` bone **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`skeleton_bone_set_transform` **(** :ref:`RID` skeleton, :ref:`int` bone, :ref:`Transform` transform **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`skeleton_bone_set_transform_2d` **(** :ref:`RID` skeleton, :ref:`int` bone, :ref:`Transform2D` transform **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`skeleton_create` **(** **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`skeleton_get_bone_count` **(** :ref:`RID` skeleton **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`sky_create` **(** **)** | +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`sky_set_texture` **(** :ref:`RID` sky, :ref:`RID` cube_map, :ref:`int` radiance_size **)** | +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`spot_light_create` **(** **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`sync` **(** **)** | +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`texture_allocate` **(** :ref:`RID` texture, :ref:`int` width, :ref:`int` height, :ref:`int` format, :ref:`int` flags=7 **)** | @@ -445,6 +785,15 @@ enum **BlendShapeMode** - **BLEND_SHAPE_MODE_NORMALIZED** = **0** - **BLEND_SHAPE_MODE_RELATIVE** = **1** + .. _enum_VisualServer_ShadowCastingSetting: + +enum **ShadowCastingSetting** + +- **SHADOW_CASTING_SETTING_OFF** = **0** +- **SHADOW_CASTING_SETTING_ON** = **1** +- **SHADOW_CASTING_SETTING_DOUBLE_SIDED** = **2** +- **SHADOW_CASTING_SETTING_SHADOWS_ONLY** = **3** + .. _enum_VisualServer_CanvasOccluderPolygonCullMode: enum **CanvasOccluderPolygonCullMode** @@ -453,6 +802,14 @@ enum **CanvasOccluderPolygonCullMode** - **CANVAS_OCCLUDER_POLYGON_CULL_CLOCKWISE** = **1** --- Culling of the canvas occluder is clockwise. - **CANVAS_OCCLUDER_POLYGON_CULL_COUNTER_CLOCKWISE** = **2** --- Culling of the canvas occluder is counterclockwise. + .. _enum_VisualServer_ParticlesDrawOrder: + +enum **ParticlesDrawOrder** + +- **PARTICLES_DRAW_ORDER_INDEX** = **0** +- **PARTICLES_DRAW_ORDER_LIFETIME** = **1** +- **PARTICLES_DRAW_ORDER_VIEW_DEPTH** = **2** + .. _enum_VisualServer_ViewportMSAA: enum **ViewportMSAA** @@ -472,6 +829,37 @@ enum **ViewportUpdateMode** - **VIEWPORT_UPDATE_WHEN_VISIBLE** = **2** - **VIEWPORT_UPDATE_ALWAYS** = **3** + .. _enum_VisualServer_MultimeshColorFormat: + +enum **MultimeshColorFormat** + +- **MULTIMESH_COLOR_NONE** = **0** +- **MULTIMESH_COLOR_8BIT** = **1** +- **MULTIMESH_COLOR_FLOAT** = **2** + + .. _enum_VisualServer_LightDirectionalShadowMode: + +enum **LightDirectionalShadowMode** + +- **LIGHT_DIRECTIONAL_SHADOW_ORTHOGONAL** = **0** +- **LIGHT_DIRECTIONAL_SHADOW_PARALLEL_2_SPLITS** = **1** +- **LIGHT_DIRECTIONAL_SHADOW_PARALLEL_4_SPLITS** = **2** + + .. _enum_VisualServer_LightOmniShadowMode: + +enum **LightOmniShadowMode** + +- **LIGHT_OMNI_SHADOW_DUAL_PARABOLOID** = **0** +- **LIGHT_OMNI_SHADOW_CUBE** = **1** + + .. _enum_VisualServer_EnvironmentSSAOQuality: + +enum **EnvironmentSSAOQuality** + +- **ENV_SSAO_QUALITY_LOW** = **0** +- **ENV_SSAO_QUALITY_MEDIUM** = **1** +- **ENV_SSAO_QUALITY_HIGH** = **2** + .. _enum_VisualServer_LightParam: enum **LightParam** @@ -501,6 +889,22 @@ enum **ScenarioDebugMode** - **SCENARIO_DEBUG_OVERDRAW** = **2** - **SCENARIO_DEBUG_SHADELESS** = **3** + .. _enum_VisualServer_LightDirectionalShadowDepthRangeMode: + +enum **LightDirectionalShadowDepthRangeMode** + +- **LIGHT_DIRECTIONAL_SHADOW_DEPTH_RANGE_STABLE** = **0** +- **LIGHT_DIRECTIONAL_SHADOW_DEPTH_RANGE_OPTIMIZED** = **1** + + .. _enum_VisualServer_EnvironmentGlowBlendMode: + +enum **EnvironmentGlowBlendMode** + +- **GLOW_BLEND_MODE_ADDITIVE** = **0** +- **GLOW_BLEND_MODE_SCREEN** = **1** +- **GLOW_BLEND_MODE_SOFTLIGHT** = **2** +- **GLOW_BLEND_MODE_REPLACE** = **3** + .. _enum_VisualServer_InstanceType: enum **InstanceType** @@ -535,6 +939,21 @@ enum **ViewportUsage** - **VIEWPORT_USAGE_3D** = **2** --- The Viewport renders 3D with effects. - **VIEWPORT_USAGE_3D_NO_EFFECTS** = **3** --- The Viewport renders 3D but without effects. + .. _enum_VisualServer_EnvironmentDOFBlurQuality: + +enum **EnvironmentDOFBlurQuality** + +- **ENV_DOF_BLUR_QUALITY_LOW** = **0** +- **ENV_DOF_BLUR_QUALITY_MEDIUM** = **1** +- **ENV_DOF_BLUR_QUALITY_HIGH** = **2** + + .. _enum_VisualServer_InstanceFlags: + +enum **InstanceFlags** + +- **INSTANCE_FLAG_USE_BAKED_LIGHT** = **0** +- **INSTANCE_FLAG_MAX** = **1** + .. _enum_VisualServer_ViewportClearMode: enum **ViewportClearMode** @@ -543,6 +962,13 @@ enum **ViewportClearMode** - **VIEWPORT_CLEAR_NEVER** = **1** --- The viewport is never cleared before drawing. - **VIEWPORT_CLEAR_ONLY_NEXT_FRAME** = **2** --- The viewport is cleared once, then the clear mode is set to VIEWPORT_CLEAR_NEVER. + .. _enum_VisualServer_LightOmniShadowDetail: + +enum **LightOmniShadowDetail** + +- **LIGHT_OMNI_SHADOW_DETAIL_VERTICAL** = **0** +- **LIGHT_OMNI_SHADOW_DETAIL_HORIZONTAL** = **1** + .. _enum_VisualServer_ArrayType: enum **ArrayType** @@ -567,6 +993,30 @@ enum **CanvasLightMode** - **CANVAS_LIGHT_MODE_MIX** = **2** --- The light adds color depending on transparency. - **CANVAS_LIGHT_MODE_MASK** = **3** --- The light adds color depending on mask. + .. _enum_VisualServer_NinePatchAxisMode: + +enum **NinePatchAxisMode** + +- **NINE_PATCH_STRETCH** = **0** --- The nine patch gets stretched where needed. +- **NINE_PATCH_TILE** = **1** --- The nine patch gets filled with tiles where needed. +- **NINE_PATCH_TILE_FIT** = **2** --- The nine patch gets filled with tiles where needed and stretches them a bit if needed. + + .. _enum_VisualServer_ViewportDebugDraw: + +enum **ViewportDebugDraw** + +- **VIEWPORT_DEBUG_DRAW_DISABLED** = **0** --- Debug draw is disabled. Default setting. +- **VIEWPORT_DEBUG_DRAW_UNSHADED** = **1** --- Debug draw sets objects to unshaded. +- **VIEWPORT_DEBUG_DRAW_OVERDRAW** = **2** --- Overwrites clear color to ``(0,0,0,0)``. +- **VIEWPORT_DEBUG_DRAW_WIREFRAME** = **3** --- Debug draw draws objects in wireframe. + + .. _enum_VisualServer_MultimeshTransformFormat: + +enum **MultimeshTransformFormat** + +- **MULTIMESH_TRANSFORM_2D** = **0** +- **MULTIMESH_TRANSFORM_3D** = **1** + .. _enum_VisualServer_ArrayFormat: enum **ArrayFormat** @@ -593,22 +1043,14 @@ enum **ArrayFormat** - **ARRAY_FLAG_USE_16_BIT_BONES** = **524288** --- Flag used to mark that the array uses 16 bit bones instead of 8 bit. - **ARRAY_COMPRESS_DEFAULT** = **97792** --- Used to set flags ARRAY_COMPRESS_VERTEX, ARRAY_COMPRESS_NORMAL, ARRAY_COMPRESS_TANGENT, ARRAY_COMPRESS_COLOR, ARRAY_COMPRESS_TEX_UV, ARRAY_COMPRESS_TEX_UV2 and ARRAY_COMPRESS_WEIGHTS quickly. - .. _enum_VisualServer_ViewportDebugDraw: + .. _enum_VisualServer_EnvironmentSSAOBlur: -enum **ViewportDebugDraw** +enum **EnvironmentSSAOBlur** -- **VIEWPORT_DEBUG_DRAW_DISABLED** = **0** --- Debug draw is disabled. Default setting. -- **VIEWPORT_DEBUG_DRAW_UNSHADED** = **1** --- Debug draw sets objects to unshaded. -- **VIEWPORT_DEBUG_DRAW_OVERDRAW** = **2** --- Overwrites clear color to ``(0,0,0,0)``. -- **VIEWPORT_DEBUG_DRAW_WIREFRAME** = **3** --- Debug draw draws objects in wireframe. - - .. _enum_VisualServer_NinePatchAxisMode: - -enum **NinePatchAxisMode** - -- **NINE_PATCH_STRETCH** = **0** --- The nine patch gets stretched where needed. -- **NINE_PATCH_TILE** = **1** --- The nine patch gets filled with tiles where needed. -- **NINE_PATCH_TILE_FIT** = **2** --- The nine patch gets filled with tiles where needed and stretches them a bit if needed. +- **ENV_SSAO_BLUR_DISABLED** = **0** +- **ENV_SSAO_BLUR_1x1** = **1** +- **ENV_SSAO_BLUR_2x2** = **2** +- **ENV_SSAO_BLUR_3x3** = **3** .. _enum_VisualServer_RenderInfo: @@ -625,6 +1067,25 @@ enum **RenderInfo** - **INFO_TEXTURE_MEM_USED** = **8** --- The amount of texture memory used. - **INFO_VERTEX_MEM_USED** = **9** --- The amount of vertex memory used. + .. _enum_VisualServer_ReflectionProbeUpdateMode: + +enum **ReflectionProbeUpdateMode** + +- **REFLECTION_PROBE_UPDATE_ONCE** = **0** +- **REFLECTION_PROBE_UPDATE_ALWAYS** = **1** + + .. _enum_VisualServer_EnvironmentBG: + +enum **EnvironmentBG** + +- **ENV_BG_CLEAR_COLOR** = **0** +- **ENV_BG_COLOR** = **1** +- **ENV_BG_SKY** = **2** +- **ENV_BG_COLOR_SKY** = **3** +- **ENV_BG_CANVAS** = **4** +- **ENV_BG_KEEP** = **5** +- **ENV_BG_MAX** = **6** + .. _enum_VisualServer_CanvasLightShadowFilter: enum **CanvasLightShadowFilter** @@ -659,6 +1120,15 @@ More effective on planes often shown going to the horrizon as those textures (Wa - **TEXTURE_FLAG_USED_FOR_STREAMING** = **4096** --- Texture is a video surface. - **TEXTURE_FLAGS_DEFAULT** = **7** --- Default flags. Generate mipmaps, repeat, and filter are enabled. + .. _enum_VisualServer_EnvironmentToneMapper: + +enum **EnvironmentToneMapper** + +- **ENV_TONE_MAPPER_LINEAR** = **0** +- **ENV_TONE_MAPPER_REINHARDT** = **1** +- **ENV_TONE_MAPPER_FILMIC** = **2** +- **ENV_TONE_MAPPER_ACES** = **3** + Description ----------- @@ -682,6 +1152,34 @@ Sets images to be rendered in the window margin. Sets margin size, where black bars (or images, if :ref:`black_bars_set_images` was used) are rendered. +.. _class_VisualServer_camera_create: + +- :ref:`RID` **camera_create** **(** **)** + +.. _class_VisualServer_camera_set_cull_mask: + +- void **camera_set_cull_mask** **(** :ref:`RID` camera, :ref:`int` layers **)** + +.. _class_VisualServer_camera_set_environment: + +- void **camera_set_environment** **(** :ref:`RID` camera, :ref:`RID` env **)** + +.. _class_VisualServer_camera_set_orthogonal: + +- void **camera_set_orthogonal** **(** :ref:`RID` camera, :ref:`float` size, :ref:`float` z_near, :ref:`float` z_far **)** + +.. _class_VisualServer_camera_set_perspective: + +- void **camera_set_perspective** **(** :ref:`RID` camera, :ref:`float` fovy_degrees, :ref:`float` z_near, :ref:`float` z_far **)** + +.. _class_VisualServer_camera_set_transform: + +- void **camera_set_transform** **(** :ref:`RID` camera, :ref:`Transform` transform **)** + +.. _class_VisualServer_camera_set_use_vertical_aspect: + +- void **camera_set_use_vertical_aspect** **(** :ref:`RID` camera, :ref:`bool` enable **)** + .. _class_VisualServer_canvas_create: - :ref:`RID` **canvas_create** **(** **)** @@ -1084,12 +1582,88 @@ A copy of the canvas item will be drawn with a local offset of the mirroring :re Modulates all colors in the given canvas. +.. _class_VisualServer_directional_light_create: + +- :ref:`RID` **directional_light_create** **(** **)** + .. _class_VisualServer_draw: - void **draw** **(** :ref:`bool` swap_buffers=true **)** Draws a frame. +.. _class_VisualServer_environment_create: + +- :ref:`RID` **environment_create** **(** **)** + +.. _class_VisualServer_environment_set_adjustment: + +- void **environment_set_adjustment** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` brightness, :ref:`float` contrast, :ref:`float` saturation, :ref:`RID` ramp **)** + +.. _class_VisualServer_environment_set_ambient_light: + +- void **environment_set_ambient_light** **(** :ref:`RID` env, :ref:`Color` color, :ref:`float` energy=1.0, :ref:`float` sky_contibution=0.0 **)** + +.. _class_VisualServer_environment_set_background: + +- void **environment_set_background** **(** :ref:`RID` env, :ref:`int` bg **)** + +.. _class_VisualServer_environment_set_bg_color: + +- void **environment_set_bg_color** **(** :ref:`RID` env, :ref:`Color` color **)** + +.. _class_VisualServer_environment_set_bg_energy: + +- void **environment_set_bg_energy** **(** :ref:`RID` env, :ref:`float` energy **)** + +.. _class_VisualServer_environment_set_canvas_max_layer: + +- void **environment_set_canvas_max_layer** **(** :ref:`RID` env, :ref:`int` max_layer **)** + +.. _class_VisualServer_environment_set_dof_blur_far: + +- void **environment_set_dof_blur_far** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` distance, :ref:`float` transition, :ref:`float` far_amount, :ref:`int` quality **)** + +.. _class_VisualServer_environment_set_dof_blur_near: + +- void **environment_set_dof_blur_near** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` distance, :ref:`float` transition, :ref:`float` far_amount, :ref:`int` quality **)** + +.. _class_VisualServer_environment_set_fog: + +- void **environment_set_fog** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`Color` color, :ref:`Color` sun_color, :ref:`float` sun_amount **)** + +.. _class_VisualServer_environment_set_fog_depth: + +- void **environment_set_fog_depth** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` depth_begin, :ref:`float` depth_curve, :ref:`bool` transmit, :ref:`float` transmit_curve **)** + +.. _class_VisualServer_environment_set_fog_height: + +- void **environment_set_fog_height** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` min_height, :ref:`float` max_height, :ref:`float` height_curve **)** + +.. _class_VisualServer_environment_set_glow: + +- void **environment_set_glow** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`int` level_flags, :ref:`float` intensity, :ref:`float` strength, :ref:`float` bloom_threshold, :ref:`int` blend_mode, :ref:`float` hdr_bleed_threshold, :ref:`float` hdr_bleed_scale, :ref:`bool` bicubic_upscale **)** + +.. _class_VisualServer_environment_set_sky: + +- void **environment_set_sky** **(** :ref:`RID` env, :ref:`RID` sky **)** + +.. _class_VisualServer_environment_set_sky_custom_fov: + +- void **environment_set_sky_custom_fov** **(** :ref:`RID` env, :ref:`float` scale **)** + +.. _class_VisualServer_environment_set_ssao: + +- void **environment_set_ssao** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` radius, :ref:`float` intensity, :ref:`float` radius2, :ref:`float` intensity2, :ref:`float` bias, :ref:`float` light_affect, :ref:`Color` color, :ref:`int` quality, :ref:`int` blur, :ref:`float` bilateral_sharpness **)** + +.. _class_VisualServer_environment_set_ssr: + +- void **environment_set_ssr** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`int` max_steps, :ref:`float` fade_in, :ref:`float` fade_out, :ref:`float` depth_tolerance, :ref:`bool` roughness **)** + +.. _class_VisualServer_environment_set_tonemap: + +- void **environment_set_tonemap** **(** :ref:`RID` env, :ref:`int` tone_mapper, :ref:`float` exposure, :ref:`float` white, :ref:`bool` auto_exposure, :ref:`float` min_luminance, :ref:`float` max_luminance, :ref:`float` auto_exp_speed, :ref:`float` auto_exp_grey **)** + .. _class_VisualServer_finish: - void **finish** **(** **)** @@ -1138,6 +1712,98 @@ Returns the id of the test texture. Creates one if none exists. Returns the id of a white texture. Creates one if none exists. +.. _class_VisualServer_gi_probe_create: + +- :ref:`RID` **gi_probe_create** **(** **)** + +.. _class_VisualServer_gi_probe_get_bias: + +- :ref:`float` **gi_probe_get_bias** **(** :ref:`RID` arg0 **)** const + +.. _class_VisualServer_gi_probe_get_bounds: + +- :ref:`AABB` **gi_probe_get_bounds** **(** :ref:`RID` probe **)** const + +.. _class_VisualServer_gi_probe_get_cell_size: + +- :ref:`float` **gi_probe_get_cell_size** **(** :ref:`RID` probe **)** const + +.. _class_VisualServer_gi_probe_get_dynamic_data: + +- :ref:`PoolIntArray` **gi_probe_get_dynamic_data** **(** :ref:`RID` arg0 **)** const + +.. _class_VisualServer_gi_probe_get_dynamic_range: + +- :ref:`int` **gi_probe_get_dynamic_range** **(** :ref:`RID` arg0 **)** const + +.. _class_VisualServer_gi_probe_get_energy: + +- :ref:`float` **gi_probe_get_energy** **(** :ref:`RID` arg0 **)** const + +.. _class_VisualServer_gi_probe_get_normal_bias: + +- :ref:`float` **gi_probe_get_normal_bias** **(** :ref:`RID` arg0 **)** const + +.. _class_VisualServer_gi_probe_get_propagation: + +- :ref:`float` **gi_probe_get_propagation** **(** :ref:`RID` arg0 **)** const + +.. _class_VisualServer_gi_probe_get_to_cell_xform: + +- :ref:`Transform` **gi_probe_get_to_cell_xform** **(** :ref:`RID` arg0 **)** const + +.. _class_VisualServer_gi_probe_is_compressed: + +- :ref:`bool` **gi_probe_is_compressed** **(** :ref:`RID` arg0 **)** const + +.. _class_VisualServer_gi_probe_is_interior: + +- :ref:`bool` **gi_probe_is_interior** **(** :ref:`RID` arg0 **)** const + +.. _class_VisualServer_gi_probe_set_bias: + +- void **gi_probe_set_bias** **(** :ref:`RID` bias, :ref:`float` arg1 **)** + +.. _class_VisualServer_gi_probe_set_bounds: + +- void **gi_probe_set_bounds** **(** :ref:`RID` probe, :ref:`AABB` bounds **)** + +.. _class_VisualServer_gi_probe_set_cell_size: + +- void **gi_probe_set_cell_size** **(** :ref:`RID` probe, :ref:`float` range **)** + +.. _class_VisualServer_gi_probe_set_compress: + +- void **gi_probe_set_compress** **(** :ref:`RID` enable, :ref:`bool` arg1 **)** + +.. _class_VisualServer_gi_probe_set_dynamic_data: + +- void **gi_probe_set_dynamic_data** **(** :ref:`RID` data, :ref:`PoolIntArray` arg1 **)** + +.. _class_VisualServer_gi_probe_set_dynamic_range: + +- void **gi_probe_set_dynamic_range** **(** :ref:`RID` range, :ref:`int` arg1 **)** + +.. _class_VisualServer_gi_probe_set_energy: + +- void **gi_probe_set_energy** **(** :ref:`RID` energy, :ref:`float` arg1 **)** + +.. _class_VisualServer_gi_probe_set_interior: + +- void **gi_probe_set_interior** **(** :ref:`RID` enable, :ref:`bool` arg1 **)** + +.. _class_VisualServer_gi_probe_set_normal_bias: + +- void **gi_probe_set_normal_bias** **(** :ref:`RID` bias, :ref:`float` arg1 **)** + +.. _class_VisualServer_gi_probe_set_propagation: + +- void **gi_probe_set_propagation** **(** :ref:`RID` propagation, :ref:`float` arg1 **)** + +.. _class_VisualServer_gi_probe_set_to_cell_xform: + +- void **gi_probe_set_to_cell_xform** **(** :ref:`RID` xform, :ref:`Transform` arg1 **)** + .. _class_VisualServer_has_changed: - :ref:`bool` **has_changed** **(** **)** const @@ -1154,12 +1820,252 @@ Returns ``true`` if changes have been made to the VisualServer's data. :ref:`dra Returns true, if the OS supports a certain feature. Features might be s3tc, etc, etc2 and pvrtc, +.. _class_VisualServer_immediate_begin: + +- void **immediate_begin** **(** :ref:`RID` immediate, :ref:`int` primitive, :ref:`RID` texture **)** + +.. _class_VisualServer_immediate_clear: + +- void **immediate_clear** **(** :ref:`RID` immediate **)** + +.. _class_VisualServer_immediate_color: + +- void **immediate_color** **(** :ref:`RID` immediate, :ref:`Color` color **)** + +.. _class_VisualServer_immediate_create: + +- :ref:`RID` **immediate_create** **(** **)** + +.. _class_VisualServer_immediate_end: + +- void **immediate_end** **(** :ref:`RID` immediate **)** + +.. _class_VisualServer_immediate_get_material: + +- :ref:`RID` **immediate_get_material** **(** :ref:`RID` immediate **)** const + +.. _class_VisualServer_immediate_normal: + +- void **immediate_normal** **(** :ref:`RID` immediate, :ref:`Vector3` normal **)** + +.. _class_VisualServer_immediate_set_material: + +- void **immediate_set_material** **(** :ref:`RID` immediate, :ref:`RID` material **)** + +.. _class_VisualServer_immediate_tangent: + +- void **immediate_tangent** **(** :ref:`RID` immediate, :ref:`Plane` tangent **)** + +.. _class_VisualServer_immediate_uv: + +- void **immediate_uv** **(** :ref:`RID` immediate, :ref:`Vector2` tex_uv **)** + +.. _class_VisualServer_immediate_uv2: + +- void **immediate_uv2** **(** :ref:`RID` immediate, :ref:`Vector2` tex_uv **)** + +.. _class_VisualServer_immediate_vertex: + +- void **immediate_vertex** **(** :ref:`RID` immediate, :ref:`Vector3` vertex **)** + +.. _class_VisualServer_immediate_vertex_2d: + +- void **immediate_vertex_2d** **(** :ref:`RID` immediate, :ref:`Vector2` vertex **)** + .. _class_VisualServer_init: - void **init** **(** **)** Initializes the visual server. +.. _class_VisualServer_instance_attach_object_instance_id: + +- void **instance_attach_object_instance_id** **(** :ref:`RID` instance, :ref:`int` id **)** + +.. _class_VisualServer_instance_attach_skeleton: + +- void **instance_attach_skeleton** **(** :ref:`RID` instance, :ref:`RID` skeleton **)** + +.. _class_VisualServer_instance_create: + +- :ref:`RID` **instance_create** **(** **)** + +.. _class_VisualServer_instance_create2: + +- :ref:`RID` **instance_create2** **(** :ref:`RID` base, :ref:`RID` scenario **)** + +.. _class_VisualServer_instance_geometry_set_as_instance_lod: + +- void **instance_geometry_set_as_instance_lod** **(** :ref:`RID` instance, :ref:`RID` as_lod_of_instance **)** + +.. _class_VisualServer_instance_geometry_set_cast_shadows_setting: + +- void **instance_geometry_set_cast_shadows_setting** **(** :ref:`RID` instance, :ref:`int` shadow_casting_setting **)** + +.. _class_VisualServer_instance_geometry_set_draw_range: + +- void **instance_geometry_set_draw_range** **(** :ref:`RID` instance, :ref:`float` min, :ref:`float` max, :ref:`float` min_margin, :ref:`float` max_margin **)** + +.. _class_VisualServer_instance_geometry_set_flag: + +- void **instance_geometry_set_flag** **(** :ref:`RID` instance, :ref:`int` flag, :ref:`bool` enabled **)** + +.. _class_VisualServer_instance_geometry_set_material_override: + +- void **instance_geometry_set_material_override** **(** :ref:`RID` instance, :ref:`RID` material **)** + +.. _class_VisualServer_instance_set_base: + +- void **instance_set_base** **(** :ref:`RID` instance, :ref:`RID` base **)** + +.. _class_VisualServer_instance_set_blend_shape_weight: + +- void **instance_set_blend_shape_weight** **(** :ref:`RID` instance, :ref:`int` shape, :ref:`float` weight **)** + +.. _class_VisualServer_instance_set_custom_aabb: + +- void **instance_set_custom_aabb** **(** :ref:`RID` instance, :ref:`AABB` aabb **)** + +.. _class_VisualServer_instance_set_exterior: + +- void **instance_set_exterior** **(** :ref:`RID` instance, :ref:`bool` enabled **)** + +.. _class_VisualServer_instance_set_extra_visibility_margin: + +- void **instance_set_extra_visibility_margin** **(** :ref:`RID` instance, :ref:`float` margin **)** + +.. _class_VisualServer_instance_set_layer_mask: + +- void **instance_set_layer_mask** **(** :ref:`RID` instance, :ref:`int` mask **)** + +.. _class_VisualServer_instance_set_scenario: + +- void **instance_set_scenario** **(** :ref:`RID` instance, :ref:`RID` scenario **)** + +.. _class_VisualServer_instance_set_surface_material: + +- void **instance_set_surface_material** **(** :ref:`RID` instance, :ref:`int` surface, :ref:`RID` material **)** + +.. _class_VisualServer_instance_set_transform: + +- void **instance_set_transform** **(** :ref:`RID` instance, :ref:`Transform` transform **)** + +.. _class_VisualServer_instance_set_use_lightmap: + +- void **instance_set_use_lightmap** **(** :ref:`RID` instance, :ref:`RID` lightmap_instance, :ref:`RID` lightmap **)** + +.. _class_VisualServer_instance_set_visible: + +- void **instance_set_visible** **(** :ref:`RID` instance, :ref:`bool` visible **)** + +.. _class_VisualServer_instances_cull_aabb: + +- :ref:`Array` **instances_cull_aabb** **(** :ref:`AABB` aabb, :ref:`RID` scenario **)** const + +.. _class_VisualServer_instances_cull_convex: + +- :ref:`Array` **instances_cull_convex** **(** :ref:`Array` convex, :ref:`RID` scenario **)** const + +.. _class_VisualServer_instances_cull_ray: + +- :ref:`Array` **instances_cull_ray** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`RID` scenario **)** const + +.. _class_VisualServer_light_directional_set_blend_splits: + +- void **light_directional_set_blend_splits** **(** :ref:`RID` light, :ref:`bool` enable **)** + +.. _class_VisualServer_light_directional_set_shadow_depth_range_mode: + +- void **light_directional_set_shadow_depth_range_mode** **(** :ref:`RID` light, :ref:`int` range_mode **)** + +.. _class_VisualServer_light_directional_set_shadow_mode: + +- void **light_directional_set_shadow_mode** **(** :ref:`RID` light, :ref:`int` mode **)** + +.. _class_VisualServer_light_omni_set_shadow_detail: + +- void **light_omni_set_shadow_detail** **(** :ref:`RID` light, :ref:`int` detail **)** + +.. _class_VisualServer_light_omni_set_shadow_mode: + +- void **light_omni_set_shadow_mode** **(** :ref:`RID` light, :ref:`int` mode **)** + +.. _class_VisualServer_light_set_color: + +- void **light_set_color** **(** :ref:`RID` light, :ref:`Color` color **)** + +.. _class_VisualServer_light_set_cull_mask: + +- void **light_set_cull_mask** **(** :ref:`RID` light, :ref:`int` mask **)** + +.. _class_VisualServer_light_set_negative: + +- void **light_set_negative** **(** :ref:`RID` light, :ref:`bool` enable **)** + +.. _class_VisualServer_light_set_param: + +- void **light_set_param** **(** :ref:`RID` light, :ref:`int` param, :ref:`float` value **)** + +.. _class_VisualServer_light_set_projector: + +- void **light_set_projector** **(** :ref:`RID` light, :ref:`RID` texture **)** + +.. _class_VisualServer_light_set_reverse_cull_face_mode: + +- void **light_set_reverse_cull_face_mode** **(** :ref:`RID` light, :ref:`bool` enabled **)** + +.. _class_VisualServer_light_set_shadow: + +- void **light_set_shadow** **(** :ref:`RID` light, :ref:`bool` enabled **)** + +.. _class_VisualServer_light_set_shadow_color: + +- void **light_set_shadow_color** **(** :ref:`RID` light, :ref:`Color` color **)** + +.. _class_VisualServer_lightmap_capture_create: + +- :ref:`RID` **lightmap_capture_create** **(** **)** + +.. _class_VisualServer_lightmap_capture_get_bounds: + +- :ref:`AABB` **lightmap_capture_get_bounds** **(** :ref:`RID` capture **)** const + +.. _class_VisualServer_lightmap_capture_get_energy: + +- :ref:`float` **lightmap_capture_get_energy** **(** :ref:`RID` capture **)** const + +.. _class_VisualServer_lightmap_capture_get_octree: + +- :ref:`PoolByteArray` **lightmap_capture_get_octree** **(** :ref:`RID` capture **)** const + +.. _class_VisualServer_lightmap_capture_get_octree_cell_subdiv: + +- :ref:`int` **lightmap_capture_get_octree_cell_subdiv** **(** :ref:`RID` capture **)** const + +.. _class_VisualServer_lightmap_capture_get_octree_cell_transform: + +- :ref:`Transform` **lightmap_capture_get_octree_cell_transform** **(** :ref:`RID` capture **)** const + +.. _class_VisualServer_lightmap_capture_set_bounds: + +- void **lightmap_capture_set_bounds** **(** :ref:`RID` capture, :ref:`AABB` bounds **)** + +.. _class_VisualServer_lightmap_capture_set_energy: + +- void **lightmap_capture_set_energy** **(** :ref:`RID` capture, :ref:`float` energy **)** + +.. _class_VisualServer_lightmap_capture_set_octree: + +- void **lightmap_capture_set_octree** **(** :ref:`RID` capture, :ref:`PoolByteArray` octree **)** + +.. _class_VisualServer_lightmap_capture_set_octree_cell_subdiv: + +- void **lightmap_capture_set_octree_cell_subdiv** **(** :ref:`RID` capture, :ref:`int` subdiv **)** + +.. _class_VisualServer_lightmap_capture_set_octree_cell_transform: + +- void **lightmap_capture_set_octree_cell_transform** **(** :ref:`RID` capture, :ref:`Transform` xform **)** + .. _class_VisualServer_make_sphere_mesh: - :ref:`RID` **make_sphere_mesh** **(** :ref:`int` latitudes, :ref:`int` longitudes, :ref:`float` radius **)** @@ -1352,6 +2258,198 @@ Returns the aabb of a mesh's surface's skeleton. Sets a mesh's surface's material. +.. _class_VisualServer_multimesh_allocate: + +- void **multimesh_allocate** **(** :ref:`RID` multimesh, :ref:`int` instances, :ref:`int` transform_format, :ref:`int` color_format **)** + +.. _class_VisualServer_multimesh_get_aabb: + +- :ref:`AABB` **multimesh_get_aabb** **(** :ref:`RID` multimesh **)** const + +.. _class_VisualServer_multimesh_get_instance_count: + +- :ref:`int` **multimesh_get_instance_count** **(** :ref:`RID` multimesh **)** const + +.. _class_VisualServer_multimesh_get_mesh: + +- :ref:`RID` **multimesh_get_mesh** **(** :ref:`RID` multimesh **)** const + +.. _class_VisualServer_multimesh_get_visible_instances: + +- :ref:`int` **multimesh_get_visible_instances** **(** :ref:`RID` multimesh **)** const + +.. _class_VisualServer_multimesh_instance_get_color: + +- :ref:`Color` **multimesh_instance_get_color** **(** :ref:`RID` multimesh, :ref:`int` index **)** const + +.. _class_VisualServer_multimesh_instance_get_transform: + +- :ref:`Transform` **multimesh_instance_get_transform** **(** :ref:`RID` multimesh, :ref:`int` index **)** const + +.. _class_VisualServer_multimesh_instance_get_transform_2d: + +- :ref:`Transform2D` **multimesh_instance_get_transform_2d** **(** :ref:`RID` multimesh, :ref:`int` index **)** const + +.. _class_VisualServer_multimesh_instance_set_color: + +- void **multimesh_instance_set_color** **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Color` color **)** + +.. _class_VisualServer_multimesh_instance_set_transform: + +- void **multimesh_instance_set_transform** **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Transform` transform **)** + +.. _class_VisualServer_multimesh_instance_set_transform_2d: + +- void **multimesh_instance_set_transform_2d** **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Transform2D` transform **)** + +.. _class_VisualServer_multimesh_set_mesh: + +- void **multimesh_set_mesh** **(** :ref:`RID` multimesh, :ref:`RID` mesh **)** + +.. _class_VisualServer_multimesh_set_visible_instances: + +- void **multimesh_set_visible_instances** **(** :ref:`RID` multimesh, :ref:`int` visible **)** + +.. _class_VisualServer_omni_light_create: + +- :ref:`RID` **omni_light_create** **(** **)** + +.. _class_VisualServer_particles_create: + +- :ref:`RID` **particles_create** **(** **)** + +.. _class_VisualServer_particles_get_current_aabb: + +- :ref:`AABB` **particles_get_current_aabb** **(** :ref:`RID` particles **)** + +.. _class_VisualServer_particles_get_emitting: + +- :ref:`bool` **particles_get_emitting** **(** :ref:`RID` particles **)** + +.. _class_VisualServer_particles_restart: + +- void **particles_restart** **(** :ref:`RID` particles **)** + +.. _class_VisualServer_particles_set_amount: + +- void **particles_set_amount** **(** :ref:`RID` particles, :ref:`int` amount **)** + +.. _class_VisualServer_particles_set_custom_aabb: + +- void **particles_set_custom_aabb** **(** :ref:`RID` particles, :ref:`AABB` aabb **)** + +.. _class_VisualServer_particles_set_draw_order: + +- void **particles_set_draw_order** **(** :ref:`RID` particles, :ref:`int` order **)** + +.. _class_VisualServer_particles_set_draw_pass_mesh: + +- void **particles_set_draw_pass_mesh** **(** :ref:`RID` particles, :ref:`int` pass, :ref:`RID` mesh **)** + +.. _class_VisualServer_particles_set_draw_passes: + +- void **particles_set_draw_passes** **(** :ref:`RID` particles, :ref:`int` count **)** + +.. _class_VisualServer_particles_set_emission_transform: + +- void **particles_set_emission_transform** **(** :ref:`RID` particles, :ref:`Transform` transform **)** + +.. _class_VisualServer_particles_set_emitting: + +- void **particles_set_emitting** **(** :ref:`RID` particles, :ref:`bool` emitting **)** + +.. _class_VisualServer_particles_set_explosiveness_ratio: + +- void **particles_set_explosiveness_ratio** **(** :ref:`RID` particles, :ref:`float` ratio **)** + +.. _class_VisualServer_particles_set_fixed_fps: + +- void **particles_set_fixed_fps** **(** :ref:`RID` particles, :ref:`int` fps **)** + +.. _class_VisualServer_particles_set_fractional_delta: + +- void **particles_set_fractional_delta** **(** :ref:`RID` particles, :ref:`bool` enable **)** + +.. _class_VisualServer_particles_set_lifetime: + +- void **particles_set_lifetime** **(** :ref:`RID` particles, :ref:`float` lifetime **)** + +.. _class_VisualServer_particles_set_one_shot: + +- void **particles_set_one_shot** **(** :ref:`RID` particles, :ref:`bool` one_shot **)** + +.. _class_VisualServer_particles_set_pre_process_time: + +- void **particles_set_pre_process_time** **(** :ref:`RID` particles, :ref:`float` time **)** + +.. _class_VisualServer_particles_set_process_material: + +- void **particles_set_process_material** **(** :ref:`RID` particles, :ref:`RID` material **)** + +.. _class_VisualServer_particles_set_randomness_ratio: + +- void **particles_set_randomness_ratio** **(** :ref:`RID` particles, :ref:`float` ratio **)** + +.. _class_VisualServer_particles_set_speed_scale: + +- void **particles_set_speed_scale** **(** :ref:`RID` particles, :ref:`float` scale **)** + +.. _class_VisualServer_particles_set_use_local_coordinates: + +- void **particles_set_use_local_coordinates** **(** :ref:`RID` particles, :ref:`bool` enable **)** + +.. _class_VisualServer_reflection_probe_create: + +- :ref:`RID` **reflection_probe_create** **(** **)** + +.. _class_VisualServer_reflection_probe_set_as_interior: + +- void **reflection_probe_set_as_interior** **(** :ref:`RID` probe, :ref:`bool` enable **)** + +.. _class_VisualServer_reflection_probe_set_cull_mask: + +- void **reflection_probe_set_cull_mask** **(** :ref:`RID` probe, :ref:`int` layers **)** + +.. _class_VisualServer_reflection_probe_set_enable_box_projection: + +- void **reflection_probe_set_enable_box_projection** **(** :ref:`RID` probe, :ref:`bool` enable **)** + +.. _class_VisualServer_reflection_probe_set_enable_shadows: + +- void **reflection_probe_set_enable_shadows** **(** :ref:`RID` probe, :ref:`bool` enable **)** + +.. _class_VisualServer_reflection_probe_set_extents: + +- void **reflection_probe_set_extents** **(** :ref:`RID` probe, :ref:`Vector3` extents **)** + +.. _class_VisualServer_reflection_probe_set_intensity: + +- void **reflection_probe_set_intensity** **(** :ref:`RID` probe, :ref:`float` intensity **)** + +.. _class_VisualServer_reflection_probe_set_interior_ambient: + +- void **reflection_probe_set_interior_ambient** **(** :ref:`RID` probe, :ref:`Color` color **)** + +.. _class_VisualServer_reflection_probe_set_interior_ambient_energy: + +- void **reflection_probe_set_interior_ambient_energy** **(** :ref:`RID` probe, :ref:`float` energy **)** + +.. _class_VisualServer_reflection_probe_set_interior_ambient_probe_contribution: + +- void **reflection_probe_set_interior_ambient_probe_contribution** **(** :ref:`RID` probe, :ref:`float` contrib **)** + +.. _class_VisualServer_reflection_probe_set_max_distance: + +- void **reflection_probe_set_max_distance** **(** :ref:`RID` probe, :ref:`float` distance **)** + +.. _class_VisualServer_reflection_probe_set_origin_offset: + +- void **reflection_probe_set_origin_offset** **(** :ref:`RID` probe, :ref:`Vector3` offset **)** + +.. _class_VisualServer_reflection_probe_set_update_mode: + +- void **reflection_probe_set_update_mode** **(** :ref:`RID` probe, :ref:`int` mode **)** + .. _class_VisualServer_request_frame_drawn_callback: - void **request_frame_drawn_callback** **(** :ref:`Object` where, :ref:`String` method, :ref:`Variant` userdata **)** @@ -1360,6 +2458,26 @@ Schedules a callback to the corresponding named 'method' on 'where' after a fram The callback method must use only 1 argument which will be called with 'userdata'. +.. _class_VisualServer_scenario_create: + +- :ref:`RID` **scenario_create** **(** **)** + +.. _class_VisualServer_scenario_set_debug: + +- void **scenario_set_debug** **(** :ref:`RID` scenario, :ref:`int` debug_mode **)** + +.. _class_VisualServer_scenario_set_environment: + +- void **scenario_set_environment** **(** :ref:`RID` scenario, :ref:`RID` environment **)** + +.. _class_VisualServer_scenario_set_fallback_environment: + +- void **scenario_set_fallback_environment** **(** :ref:`RID` scenario, :ref:`RID` environment **)** + +.. _class_VisualServer_scenario_set_reflection_atlas_size: + +- void **scenario_set_reflection_atlas_size** **(** :ref:`RID` scenario, :ref:`int` p_size, :ref:`int` subdiv **)** + .. _class_VisualServer_set_boot_image: - void **set_boot_image** **(** :ref:`Image` image, :ref:`Color` color, :ref:`bool` scale **)** @@ -1410,6 +2528,34 @@ Sets a shader's code. Sets a shader's default texture. Overwrites the texture given by name. +.. _class_VisualServer_skeleton_allocate: + +- void **skeleton_allocate** **(** :ref:`RID` skeleton, :ref:`int` bones, :ref:`bool` is_2d_skeleton=false **)** + +.. _class_VisualServer_skeleton_bone_get_transform: + +- :ref:`Transform` **skeleton_bone_get_transform** **(** :ref:`RID` skeleton, :ref:`int` bone **)** const + +.. _class_VisualServer_skeleton_bone_get_transform_2d: + +- :ref:`Transform2D` **skeleton_bone_get_transform_2d** **(** :ref:`RID` skeleton, :ref:`int` bone **)** const + +.. _class_VisualServer_skeleton_bone_set_transform: + +- void **skeleton_bone_set_transform** **(** :ref:`RID` skeleton, :ref:`int` bone, :ref:`Transform` transform **)** + +.. _class_VisualServer_skeleton_bone_set_transform_2d: + +- void **skeleton_bone_set_transform_2d** **(** :ref:`RID` skeleton, :ref:`int` bone, :ref:`Transform2D` transform **)** + +.. _class_VisualServer_skeleton_create: + +- :ref:`RID` **skeleton_create** **(** **)** + +.. _class_VisualServer_skeleton_get_bone_count: + +- :ref:`int` **skeleton_get_bone_count** **(** :ref:`RID` skeleton **)** const + .. _class_VisualServer_sky_create: - :ref:`RID` **sky_create** **(** **)** @@ -1422,6 +2568,10 @@ Creates an empty sky. Sets a sky's texture. +.. _class_VisualServer_spot_light_create: + +- :ref:`RID` **spot_light_create** **(** **)** + .. _class_VisualServer_sync: - void **sync** **(** **)** diff --git a/classes/class_websocketclient.rst b/classes/class_websocketclient.rst new file mode 100644 index 000000000..e3eea001e --- /dev/null +++ b/classes/class_websocketclient.rst @@ -0,0 +1,59 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the WebSocketClient.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_WebSocketClient: + +WebSocketClient +=============== + +**Inherits:** :ref:`WebSocketMultiplayerPeer` **<** :ref:`NetworkedMultiplayerPeer` **<** :ref:`PacketPeer` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`connect_to_url` **(** :ref:`String` url, :ref:`PoolStringArray` protocols=PoolStringArray( ), :ref:`bool` gd_mp_api=false **)** | ++------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`disconnect_from_host` **(** **)** | ++------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Signals +------- + +.. _class_WebSocketClient_connection_closed: + +- **connection_closed** **(** **)** + +.. _class_WebSocketClient_connection_error: + +- **connection_error** **(** **)** + +.. _class_WebSocketClient_connection_established: + +- **connection_established** **(** :ref:`String` protocol **)** + +.. _class_WebSocketClient_data_received: + +- **data_received** **(** **)** + + +Member Function Description +--------------------------- + +.. _class_WebSocketClient_connect_to_url: + +- :ref:`int` **connect_to_url** **(** :ref:`String` url, :ref:`PoolStringArray` protocols=PoolStringArray( ), :ref:`bool` gd_mp_api=false **)** + +.. _class_WebSocketClient_disconnect_from_host: + +- void **disconnect_from_host** **(** **)** + + diff --git a/classes/class_websocketmultiplayerpeer.rst b/classes/class_websocketmultiplayerpeer.rst new file mode 100644 index 000000000..7ba2f79a8 --- /dev/null +++ b/classes/class_websocketmultiplayerpeer.rst @@ -0,0 +1,43 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the WebSocketMultiplayerPeer.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_WebSocketMultiplayerPeer: + +WebSocketMultiplayerPeer +======================== + +**Inherits:** :ref:`NetworkedMultiplayerPeer` **<** :ref:`PacketPeer` **<** :ref:`Reference` **<** :ref:`Object` + +**Inherited By:** :ref:`WebSocketClient`, :ref:`WebSocketServer` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++--------------------------------------------+----------------------------------------------------------------------------------------------------------+ +| :ref:`WebSocketPeer` | :ref:`get_peer` **(** :ref:`int` peer_id **)** const | ++--------------------------------------------+----------------------------------------------------------------------------------------------------------+ + +Signals +------- + +.. _class_WebSocketMultiplayerPeer_peer_packet: + +- **peer_packet** **(** :ref:`int` peer_source **)** + + +Member Function Description +--------------------------- + +.. _class_WebSocketMultiplayerPeer_get_peer: + +- :ref:`WebSocketPeer` **get_peer** **(** :ref:`int` peer_id **)** const + + diff --git a/classes/class_websocketpeer.rst b/classes/class_websocketpeer.rst new file mode 100644 index 000000000..3c194eb99 --- /dev/null +++ b/classes/class_websocketpeer.rst @@ -0,0 +1,68 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the WebSocketPeer.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_WebSocketPeer: + +WebSocketPeer +============= + +**Inherits:** :ref:`PacketPeer` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++--------------------------+--------------------------------------------------------------------------------------------------+ +| void | :ref:`close` **(** **)** | ++--------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_write_mode` **(** **)** const | ++--------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_connected_to_host` **(** **)** const | ++--------------------------+--------------------------------------------------------------------------------------------------+ +| void | :ref:`set_write_mode` **(** :ref:`int` mode **)** | ++--------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`was_string_packet` **(** **)** const | ++--------------------------+--------------------------------------------------------------------------------------------------+ + +Enums +----- + + .. _enum_WebSocketPeer_WriteMode: + +enum **WriteMode** + +- **WRITE_MODE_TEXT** = **0** +- **WRITE_MODE_BINARY** = **1** + + +Member Function Description +--------------------------- + +.. _class_WebSocketPeer_close: + +- void **close** **(** **)** + +.. _class_WebSocketPeer_get_write_mode: + +- :ref:`int` **get_write_mode** **(** **)** const + +.. _class_WebSocketPeer_is_connected_to_host: + +- :ref:`bool` **is_connected_to_host** **(** **)** const + +.. _class_WebSocketPeer_set_write_mode: + +- void **set_write_mode** **(** :ref:`int` mode **)** + +.. _class_WebSocketPeer_was_string_packet: + +- :ref:`bool` **was_string_packet** **(** **)** const + + diff --git a/classes/class_websocketserver.rst b/classes/class_websocketserver.rst new file mode 100644 index 000000000..0d1830360 --- /dev/null +++ b/classes/class_websocketserver.rst @@ -0,0 +1,67 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the WebSocketServer.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_WebSocketServer: + +WebSocketServer +=============== + +**Inherits:** :ref:`WebSocketMultiplayerPeer` **<** :ref:`NetworkedMultiplayerPeer` **<** :ref:`PacketPeer` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_peer` **(** :ref:`int` id **)** const | ++--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_listening` **(** **)** const | ++--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`listen` **(** :ref:`int` port, :ref:`PoolStringArray` protocols=PoolStringArray( ), :ref:`bool` gd_mp_api=false **)** | ++--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`stop` **(** **)** | ++--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Signals +------- + +.. _class_WebSocketServer_client_connected: + +- **client_connected** **(** :ref:`int` id, :ref:`String` protocol **)** + +.. _class_WebSocketServer_client_disconnected: + +- **client_disconnected** **(** :ref:`int` id **)** + +.. _class_WebSocketServer_data_received: + +- **data_received** **(** :ref:`int` id **)** + + +Member Function Description +--------------------------- + +.. _class_WebSocketServer_has_peer: + +- :ref:`bool` **has_peer** **(** :ref:`int` id **)** const + +.. _class_WebSocketServer_is_listening: + +- :ref:`bool` **is_listening** **(** **)** const + +.. _class_WebSocketServer_listen: + +- :ref:`int` **listen** **(** :ref:`int` port, :ref:`PoolStringArray` protocols=PoolStringArray( ), :ref:`bool` gd_mp_api=false **)** + +.. _class_WebSocketServer_stop: + +- void **stop** **(** **)** + + diff --git a/classes/class_xmlparser.rst b/classes/class_xmlparser.rst index 7d9cc2c22..af08c3e9f 100644 --- a/classes/class_xmlparser.rst +++ b/classes/class_xmlparser.rst @@ -137,7 +137,7 @@ Get the byte offset of the current node since the beginning of the file or buffe - :ref:`int` **get_node_type** **(** **)** -Get the type of the current node. Compare with ``NODE\_\*`` constants. +Get the type of the current node. Compare with ``NODE_*`` constants. .. _class_XMLParser_has_attribute: