diff options
author | kobewi <kobewi4e@gmail.com> | 2023-02-28 15:06:21 +0100 |
---|---|---|
committer | Yuri Sizov <yuris@humnom.net> | 2023-04-03 18:40:24 +0200 |
commit | 1c66b24325dee512c95f725783a9ae9d997ac5d1 (patch) | |
tree | c3fa8ca1a1d63df0be2ccf5aad4f39ad92ff9566 /doc | |
parent | 103d23539fdb0621383fab6afafa184c19fae8e3 (diff) |
Fill random docs
(cherry picked from commit eac65fd0a8e68512a9410e0e78a405b726d303d3)
Diffstat (limited to 'doc')
-rw-r--r-- | doc/classes/ConeTwistJoint3D.xml | 2 | ||||
-rw-r--r-- | doc/classes/FileSystemDock.xml | 12 | ||||
-rw-r--r-- | doc/classes/InputEventFromWindow.xml | 3 | ||||
-rw-r--r-- | doc/classes/InputEventGesture.xml | 1 | ||||
-rw-r--r-- | doc/classes/InputEventMagnifyGesture.xml | 3 | ||||
-rw-r--r-- | doc/classes/InputEventPanGesture.xml | 3 | ||||
-rw-r--r-- | doc/classes/InputEventShortcut.xml | 3 | ||||
-rw-r--r-- | doc/classes/Node.xml | 2 | ||||
-rw-r--r-- | doc/classes/Node3D.xml | 3 | ||||
-rw-r--r-- | doc/classes/Polygon2D.xml | 3 | ||||
-rw-r--r-- | doc/classes/ProjectSettings.xml | 3 | ||||
-rw-r--r-- | doc/classes/RenderingServer.xml | 42 | ||||
-rw-r--r-- | doc/classes/Viewport.xml | 2 |
13 files changed, 79 insertions, 3 deletions
diff --git a/doc/classes/ConeTwistJoint3D.xml b/doc/classes/ConeTwistJoint3D.xml index 1cfe9d197d..ee68b156d7 100644 --- a/doc/classes/ConeTwistJoint3D.xml +++ b/doc/classes/ConeTwistJoint3D.xml @@ -15,6 +15,7 @@ <return type="float" /> <param index="0" name="param" type="int" enum="ConeTwistJoint3D.Param" /> <description> + Returns the value of the specified parameter. </description> </method> <method name="set_param"> @@ -22,6 +23,7 @@ <param index="0" name="param" type="int" enum="ConeTwistJoint3D.Param" /> <param index="1" name="value" type="float" /> <description> + Sets the value of the specified parameter. </description> </method> </methods> diff --git a/doc/classes/FileSystemDock.xml b/doc/classes/FileSystemDock.xml index f76bc2c279..f549695e72 100644 --- a/doc/classes/FileSystemDock.xml +++ b/doc/classes/FileSystemDock.xml @@ -1,8 +1,11 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="FileSystemDock" inherits="VBoxContainer" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> + Editor dock for managing files in the project. </brief_description> <description> + This class is available only in [EditorPlugin]s and can't be instantiated. You can access it using [method EditorInterface.get_file_system_dock]. + While FileSystemDock doesn't expose any methods for file manipulation, you can listen for various file-related signals. </description> <tutorials> </tutorials> @@ -11,49 +14,58 @@ <return type="void" /> <param index="0" name="path" type="String" /> <description> + Sets the given [param path] as currently selected, ensuring that the selected file/directory is visible. </description> </method> </methods> <signals> <signal name="display_mode_changed"> <description> + Emitted when the user switches file display mode or split mode. </description> </signal> <signal name="file_removed"> <param index="0" name="file" type="String" /> <description> + Emitted when the given [param file] was removed. </description> </signal> <signal name="files_moved"> <param index="0" name="old_file" type="String" /> <param index="1" name="new_file" type="String" /> <description> + Emitted when a file is moved from [param old_file] path to [param new_file] path. </description> </signal> <signal name="folder_moved"> <param index="0" name="old_folder" type="String" /> <param index="1" name="new_folder" type="String" /> <description> + Emitted when a folder is moved from [param old_folder] path to [param new_folder] path. </description> </signal> <signal name="folder_removed"> <param index="0" name="folder" type="String" /> <description> + Emitted when the given [param folder] was removed. </description> </signal> <signal name="inherit"> <param index="0" name="file" type="String" /> <description> + Emitted when a new scene is created that inherits the scene at [param file] path. </description> </signal> <signal name="instantiate"> <param index="0" name="files" type="PackedStringArray" /> <description> + Emitted when the given scenes are being instantiated in the editor. </description> </signal> <signal name="resource_removed"> <param index="0" name="resource" type="Resource" /> <description> + Emitted when an external [param resource] had its file removed. </description> </signal> </signals> diff --git a/doc/classes/InputEventFromWindow.xml b/doc/classes/InputEventFromWindow.xml index adbf8ccc08..24b084bb5d 100644 --- a/doc/classes/InputEventFromWindow.xml +++ b/doc/classes/InputEventFromWindow.xml @@ -1,13 +1,16 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="InputEventFromWindow" inherits="InputEvent" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> + Base class for [Viewport]-based input events. </brief_description> <description> + InputEventFromWindow represents events specifically received by windows. This includes mouse events, keyboard events in focused windows or touch screen actions. </description> <tutorials> </tutorials> <members> <member name="window_id" type="int" setter="set_window_id" getter="get_window_id" default="0"> + The ID of a [Window] that received this event. </member> </members> </class> diff --git a/doc/classes/InputEventGesture.xml b/doc/classes/InputEventGesture.xml index 85d1a405b2..578faab6b5 100644 --- a/doc/classes/InputEventGesture.xml +++ b/doc/classes/InputEventGesture.xml @@ -4,6 +4,7 @@ Base class for touch control gestures. </brief_description> <description> + InputEventGesture is sent when a user performs a supported gesture on a touch screen. Gestures can't be emulated using mouse, because they typically require multi-touch. </description> <tutorials> </tutorials> diff --git a/doc/classes/InputEventMagnifyGesture.xml b/doc/classes/InputEventMagnifyGesture.xml index 2063dfda6c..838809423f 100644 --- a/doc/classes/InputEventMagnifyGesture.xml +++ b/doc/classes/InputEventMagnifyGesture.xml @@ -1,13 +1,16 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="InputEventMagnifyGesture" inherits="InputEventGesture" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> + [InputEvent] that represents a magnifying touch gesture. </brief_description> <description> + Magnify gesture is performed when the user pinches the touch screen. It's typically used for zooming. </description> <tutorials> </tutorials> <members> <member name="factor" type="float" setter="set_factor" getter="get_factor" default="1.0"> + The amount (or delta) of the event. This value is higher the faster the gesture is performed. </member> </members> </class> diff --git a/doc/classes/InputEventPanGesture.xml b/doc/classes/InputEventPanGesture.xml index deb76d5d38..e276f68cc3 100644 --- a/doc/classes/InputEventPanGesture.xml +++ b/doc/classes/InputEventPanGesture.xml @@ -1,13 +1,16 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="InputEventPanGesture" inherits="InputEventGesture" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> + [InputEvent] that represents a panning touch gesture. </brief_description> <description> + Pan gesture is performed when the user swipes the touch screen with two fingers. It's typically used for panning/scrolling. </description> <tutorials> </tutorials> <members> <member name="delta" type="Vector2" setter="set_delta" getter="get_delta" default="Vector2(0, 0)"> + Panning amount since last pan event. </member> </members> </class> diff --git a/doc/classes/InputEventShortcut.xml b/doc/classes/InputEventShortcut.xml index 58b44132bb..93c1e84be3 100644 --- a/doc/classes/InputEventShortcut.xml +++ b/doc/classes/InputEventShortcut.xml @@ -1,13 +1,16 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="InputEventShortcut" inherits="InputEvent" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> + [InputEvent] that signifies a triggered keyboard [Shortcut]. </brief_description> <description> + InputEventShortcut is a special event that can be received in [method Node._unhandled_key_input]. It's typically sent by the editor's Command Palette to trigger actions, but can also be sent manually using [method Viewport.push_unhandled_input]. </description> <tutorials> </tutorials> <members> <member name="shortcut" type="Shortcut" setter="set_shortcut" getter="get_shortcut"> + The [Shortcut] represented by this event. Its [method Shortcut.matches_event] method will always return [code]true[/code] for this event. </member> </members> </class> diff --git a/doc/classes/Node.xml b/doc/classes/Node.xml index 4aa291e2e7..62d708618a 100644 --- a/doc/classes/Node.xml +++ b/doc/classes/Node.xml @@ -954,8 +954,10 @@ Specific to the Android platform. </constant> <constant name="NOTIFICATION_WM_SIZE_CHANGED" value="1008"> + Notification received from the OS when the window is resized. </constant> <constant name="NOTIFICATION_WM_DPI_CHANGE" value="1009"> + Notification received from the OS when the screen's DPI has been changed. Only implemented on macOS. </constant> <constant name="NOTIFICATION_VP_MOUSE_ENTER" value="1010"> Notification received when the mouse enters the viewport. diff --git a/doc/classes/Node3D.xml b/doc/classes/Node3D.xml index 61e5c44251..581cb68c92 100644 --- a/doc/classes/Node3D.xml +++ b/doc/classes/Node3D.xml @@ -344,10 +344,13 @@ In order for [constant NOTIFICATION_LOCAL_TRANSFORM_CHANGED] to work, users first need to ask for it, with [method set_notify_local_transform]. </constant> <constant name="ROTATION_EDIT_MODE_EULER" value="0" enum="RotationEditMode"> + The rotation is edited using [Vector3] Euler angles. </constant> <constant name="ROTATION_EDIT_MODE_QUATERNION" value="1" enum="RotationEditMode"> + The rotation is edited using a [Quaternion]. </constant> <constant name="ROTATION_EDIT_MODE_BASIS" value="2" enum="RotationEditMode"> + The rotation is edited using a [Basis]. In this mode, [member scale] can't be edited separately. </constant> </constants> </class> diff --git a/doc/classes/Polygon2D.xml b/doc/classes/Polygon2D.xml index a3fc326351..4f24800647 100644 --- a/doc/classes/Polygon2D.xml +++ b/doc/classes/Polygon2D.xml @@ -72,11 +72,13 @@ If [code]true[/code], polygon edges will be anti-aliased. </member> <member name="bones" type="Array" setter="_set_bones" getter="_get_bones" default="[]"> + Internal list of [Bone2D] nodes used by the assigned [member skeleton]. Edited using the Polygon2D editor ("UV" button on the top toolbar). </member> <member name="color" type="Color" setter="set_color" getter="get_color" default="Color(1, 1, 1, 1)"> The polygon's fill color. If [code]texture[/code] is defined, it will be multiplied by this color. It will also be the default color for vertices not set in [code]vertex_colors[/code]. </member> <member name="internal_vertex_count" type="int" setter="set_internal_vertex_count" getter="get_internal_vertex_count" default="0"> + Number of internal vertices, used for UV mapping. </member> <member name="invert_border" type="float" setter="set_invert_border" getter="get_invert_border" default="100.0"> Added padding applied to the bounding box when [member invert_enabled] is set to [code]true[/code]. Setting this value too small may result in a "Bad Polygon" error. @@ -95,6 +97,7 @@ The list of polygons, in case more than one is being represented. Every individual polygon is stored as a [PackedInt32Array] where each [int] is an index to a point in [member polygon]. If empty, this property will be ignored, and the resulting single polygon will be composed of all points in [member polygon], using the order they are stored in. </member> <member name="skeleton" type="NodePath" setter="set_skeleton" getter="get_skeleton" default="NodePath("")"> + Path to a [Skeleton2D] node used for skeleton-based deformations of this polygon. If empty or invalid, skeletal deformations will not be used. </member> <member name="texture" type="Texture2D" setter="set_texture" getter="get_texture"> The polygon's fill texture. Use [code]uv[/code] to set texture coordinates. diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index 120dda92c4..78b7e073c7 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -1958,8 +1958,10 @@ <member name="rendering/2d/shadow_atlas/size" type="int" setter="" getter="" default="2048"> </member> <member name="rendering/2d/snap/snap_2d_transforms_to_pixel" type="bool" setter="" getter="" default="false"> + If [code]true[/code], [CanvasItem] nodes will internally snap to full pixels. Their position can still be sub-pixel, but the decimals will not have effect. </member> <member name="rendering/2d/snap/snap_2d_vertices_to_pixel" type="bool" setter="" getter="" default="false"> + If [code]true[/code], vertices of [CanvasItem] nodes will snap to full pixels. Only affects the final vertex positions, not the transforms. </member> <member name="rendering/anti_aliasing/quality/msaa_2d" type="int" setter="" getter="" default="0"> Sets the number of MSAA samples to use for 2D/Canvas rendering (as a power of two). MSAA is used to reduce aliasing around the edges of polygons. A higher MSAA value results in smoother edges but can be significantly slower on some hardware. This has no effect on shader-induced aliasing or texture aliasing. @@ -2416,6 +2418,7 @@ <member name="threading/worker_pool/low_priority_thread_ratio" type="float" setter="" getter="" default="0.3"> </member> <member name="threading/worker_pool/max_threads" type="int" setter="" getter="" default="-1"> + Maximum number of threads to be used by [WorkerThreadPool]. Value of [code]-1[/code] means no limit. </member> <member name="threading/worker_pool/use_system_threads_for_low_priority_tasks" type="bool" setter="" getter="" default="true"> </member> diff --git a/doc/classes/RenderingServer.xml b/doc/classes/RenderingServer.xml index 2ba8e40ce2..ec338cb729 100644 --- a/doc/classes/RenderingServer.xml +++ b/doc/classes/RenderingServer.xml @@ -33,6 +33,7 @@ <description> Creates a camera attributes object and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all [code]camera_attributes_[/code] RenderingServer functions. Once finished with your RID, you will want to free the RID using the RenderingServer's [method free_rid] static method. + This is the internal equivalent of the [CameraAttributes] resource. </description> </method> <method name="camera_attributes_set_auto_exposure"> @@ -100,6 +101,7 @@ <description> Creates a camera and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all [code]camera_*[/code] RenderingServer functions. Once finished with your RID, you will want to free the RID using the RenderingServer's [method free_rid] static method. + This is the internal equivalent of the [Camera3D] node. </description> </method> <method name="camera_set_camera_attributes"> @@ -178,6 +180,7 @@ <description> Creates a canvas and returns the assigned [RID]. It can be accessed with the RID that is returned. This RID will be used in all [code]canvas_*[/code] RenderingServer functions. Once finished with your RID, you will want to free the RID using the RenderingServer's [method free_rid] static method. + Canvas has no [Resource] or [Node] equivalent. </description> </method> <method name="canvas_item_add_animation_slice"> @@ -350,6 +353,7 @@ <param index="4" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> <param index="5" name="transpose" type="bool" default="false" /> <description> + Draws a 2D textured rectangle on the [CanvasItem] pointed to by the [param item] [RID]. See also [method CanvasItem.draw_texture_rect] and [method Texture2D.draw_rect]. </description> </method> <method name="canvas_item_add_texture_rect_region"> @@ -362,6 +366,7 @@ <param index="5" name="transpose" type="bool" default="false" /> <param index="6" name="clip_uv" type="bool" default="true" /> <description> + Draws the specified region of a 2D textured rectangle on the [CanvasItem] pointed to by the [param item] [RID]. See also [method CanvasItem.draw_texture_rect_region] and [method Texture2D.draw_rect_region]. </description> </method> <method name="canvas_item_add_triangle_array"> @@ -388,7 +393,9 @@ <method name="canvas_item_create"> <return type="RID" /> <description> - Creates a new [CanvasItem] instance and returns its [RID]. + Creates a canvas item and returns the assigned [RID]. It can be accessed with the RID that is returned. This RID will be used in all [code]canvas_item_*[/code] RenderingServer functions. + Once finished with your RID, you will want to free the RID using the RenderingServer's [method free_rid] static method. + This is the internal equivalent of the [CanvasItem] node. </description> </method> <method name="canvas_item_set_canvas_group_mode"> @@ -482,6 +489,7 @@ <param index="0" name="item" type="RID" /> <param index="1" name="color" type="Color" /> <description> + Sets a color modulation to the [CanvasItem]. This also affects child canvas items. </description> </method> <method name="canvas_item_set_parent"> @@ -489,6 +497,7 @@ <param index="0" name="item" type="RID" /> <param index="1" name="parent" type="RID" /> <description> + Sets a parent [CanvasItem] to the [CanvasItem]. The item will inherit transform, modulation and visibility from its parent, like [CanvasItem] nodes in the scene tree. </description> </method> <method name="canvas_item_set_self_modulate"> @@ -496,6 +505,7 @@ <param index="0" name="item" type="RID" /> <param index="1" name="color" type="Color" /> <description> + Sets a color self-modulation to the [CanvasItem]. It does not affect the child canvas items. </description> </method> <method name="canvas_item_set_sort_children_by_y"> @@ -503,6 +513,7 @@ <param index="0" name="item" type="RID" /> <param index="1" name="enabled" type="bool" /> <description> + Enables or disables Y-sorting of a [CanvasItem]. </description> </method> <method name="canvas_item_set_transform"> @@ -510,6 +521,7 @@ <param index="0" name="item" type="RID" /> <param index="1" name="transform" type="Transform2D" /> <description> + Sets the transform of the [CanvasItem]. It affects where and how the item will be drawn. Child canvas items' transforms are multiplied by their parent's transform. </description> </method> <method name="canvas_item_set_use_parent_material"> @@ -536,6 +548,8 @@ <param index="3" name="enter_callable" type="Callable" /> <param index="4" name="exit_callable" type="Callable" /> <description> + Sets the given [CanvasItem] as visibility notifier. [param area] defines the area of detecting visibility. [param enter_callable] is called when the [CanvasItem] enters the screen, [param exit_callable] is called when the [CanvasItem] exits the screen. If [param enable] is [code]false[/code], the item will no longer function as notifier. + This method can be used to manually mimic [VisibleOnScreenNotifier2D]. </description> </method> <method name="canvas_item_set_visible"> @@ -543,6 +557,7 @@ <param index="0" name="item" type="RID" /> <param index="1" name="visible" type="bool" /> <description> + Sets the visibility of the [CanvasItem]. </description> </method> <method name="canvas_item_set_z_as_relative_to_parent"> @@ -832,6 +847,9 @@ <method name="canvas_texture_create"> <return type="RID" /> <description> + Creates a canvas texture and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all [code]canvas_texture_*[/code] RenderingServer functions. + Once finished with your RID, you will want to free the RID using the RenderingServer's [method free_rid] static method. + This is the internal equivalent of the [CanvasTexture] resource. </description> </method> <method name="canvas_texture_set_channel"> @@ -855,6 +873,7 @@ <param index="0" name="canvas_texture" type="RID" /> <param index="1" name="filter" type="int" enum="RenderingServer.CanvasItemTextureFilter" /> <description> + Sets the texture filter used by the [CanvasTexture]. </description> </method> <method name="canvas_texture_set_texture_repeat"> @@ -862,6 +881,7 @@ <param index="0" name="canvas_texture" type="RID" /> <param index="1" name="repeat" type="int" enum="RenderingServer.CanvasItemTextureRepeat" /> <description> + Sets the texture repeat used by the [CanvasTexture]. </description> </method> <method name="create_local_rendering_device" qualifiers="const"> @@ -874,6 +894,9 @@ <method name="decal_create"> <return type="RID" /> <description> + Creates a decal and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all [code]decal_*[/code] RenderingServer functions. + Once finished with your RID, you will want to free the RID using the RenderingServer's [method free_rid] static method. + This is the internal equivalent of the [Decal] node. </description> </method> <method name="decal_set_albedo_mix"> @@ -919,6 +942,7 @@ <param index="0" name="decal" type="RID" /> <param index="1" name="color" type="Color" /> <description> + Sets the color modulation of the [Decal]. </description> </method> <method name="decal_set_normal_fade"> @@ -933,6 +957,7 @@ <param index="0" name="decal" type="RID" /> <param index="1" name="size" type="Vector3" /> <description> + Sets the size of the [Decal]. </description> </method> <method name="decal_set_texture"> @@ -941,6 +966,7 @@ <param index="1" name="type" type="int" enum="RenderingServer.DecalTexture" /> <param index="2" name="texture" type="RID" /> <description> + Sets the texture of the [Decal]. </description> </method> <method name="decals_set_filter"> @@ -955,6 +981,7 @@ Creates a directional light and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID can be used in most [code]light_*[/code] RenderingServer functions. Once finished with your RID, you will want to free the RID using the RenderingServer's [method free_rid] static method. To place in a scene, attach this directional light to an instance using [method instance_set_base] using the returned RID. + This is the internal equivalent of the [DirectionalLight3D] node. </description> </method> <method name="directional_shadow_atlas_set_size"> @@ -983,6 +1010,7 @@ <description> Creates an environment and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all [code]environment_*[/code] RenderingServer functions. Once finished with your RID, you will want to free the RID using the RenderingServer's [method free_rid] static method. + This is the internal equivalent of the [Environment] resource. </description> </method> <method name="environment_glow_set_use_bicubic_upscale"> @@ -1244,7 +1272,9 @@ <method name="fog_volume_create"> <return type="RID" /> <description> - Creates a new fog volume and allocates an RID. + Creates a fog volume and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all [code]fog_volume_*[/code] RenderingServer functions. + Once finished with your RID, you will want to free the RID using the RenderingServer's [method free_rid] static method. + This is the internal equivalent of the [FogVolume] node. </description> </method> <method name="fog_volume_set_material"> @@ -1461,6 +1491,7 @@ Creates a visual instance and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all [code]instance_*[/code] RenderingServer functions. Once finished with your RID, you will want to free the RID using the RenderingServer's [method free_rid] static method. An instance is a way of placing a 3D object in the scenario. Objects like particles, meshes, and reflection probes need to be associated with an instance to be visible in the scenario using [method instance_set_base]. + This is the internal equivalent of the [VisualInstance3D] node. </description> </method> <method name="instance_create2"> @@ -1821,7 +1852,9 @@ <method name="lightmap_create"> <return type="RID" /> <description> - Creates a new [LightmapGI] instance. + Creates a lightmap GI and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all [code]instance_*[/code] RenderingServer functions. + Once finished with your RID, you will want to free the RID using the RenderingServer's [method free_rid] static method. + This is the internal equivalent of the [LightmapGI] node. </description> </method> <method name="lightmap_get_probe_capture_bsp_tree" qualifiers="const"> @@ -1908,6 +1941,7 @@ <description> Creates an empty material and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all [code]material_*[/code] RenderingServer functions. Once finished with your RID, you will want to free the RID using the RenderingServer's [method free_rid] static method. + This is the internal equivalent of the [Material] resource. </description> </method> <method name="material_get_param" qualifiers="const"> @@ -1982,6 +2016,7 @@ Creates a new mesh and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all [code]mesh_*[/code] RenderingServer functions. Once finished with your RID, you will want to free the RID using the RenderingServer's [method free_rid] static method. To place in a scene, attach this mesh to an instance using [method instance_set_base] using the returned RID. + This is the internal equivalent of the [Mesh] resource. </description> </method> <method name="mesh_create_from_surfaces"> @@ -2154,6 +2189,7 @@ Creates a new multimesh on the RenderingServer and returns an [RID] handle. This RID will be used in all [code]multimesh_*[/code] RenderingServer functions. Once finished with your RID, you will want to free the RID using the RenderingServer's [method free_rid] static method. To place in a scene, attach this multimesh to an instance using [method instance_set_base] using the returned RID. + This is the internal equivalent of the [MultiMesh] resource. </description> </method> <method name="multimesh_get_aabb" qualifiers="const"> diff --git a/doc/classes/Viewport.xml b/doc/classes/Viewport.xml index e76f805e3c..8d92616d6f 100644 --- a/doc/classes/Viewport.xml +++ b/doc/classes/Viewport.xml @@ -76,6 +76,7 @@ <param index="0" name="type" type="int" enum="Viewport.RenderInfoType" /> <param index="1" name="info" type="int" enum="Viewport.RenderInfo" /> <description> + Returns rendering statistics of the given type. See [enum RenderInfoType] and [enum RenderInfo] for options. </description> </method> <method name="get_screen_transform" qualifiers="const"> @@ -165,6 +166,7 @@ <return type="void" /> <param index="0" name="text" type="String" /> <description> + Helper method which calls the [code]set_text()[/code] method on the currently focused [Control], provided that it is defined (e.g. if the focused Control is [Button] or [LineEdit]). </description> </method> <method name="push_unhandled_input"> |