diff --git a/doc/classes/ConeTwistJoint3D.xml b/doc/classes/ConeTwistJoint3D.xml index 3a122fe74b3..39746b3c052 100644 --- a/doc/classes/ConeTwistJoint3D.xml +++ b/doc/classes/ConeTwistJoint3D.xml @@ -15,6 +15,7 @@ + Returns the value of the specified parameter. @@ -22,6 +23,7 @@ + Sets the value of the specified parameter. diff --git a/doc/classes/FileSystemDock.xml b/doc/classes/FileSystemDock.xml index 140785f4fbd..f8f6f26bfc6 100644 --- a/doc/classes/FileSystemDock.xml +++ b/doc/classes/FileSystemDock.xml @@ -1,8 +1,11 @@ + Editor dock for managing files in the project. + 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. @@ -11,49 +14,58 @@ + Sets the given [param path] as currently selected, ensuring that the selected file/directory is visible. + Emitted when the user switches file display mode or split mode. + Emitted when the given [param file] was removed. + Emitted when a file is moved from [param old_file] path to [param new_file] path. + Emitted when a folder is moved from [param old_folder] path to [param new_folder] path. + Emitted when the given [param folder] was removed. + Emitted when a new scene is created that inherits the scene at [param file] path. + Emitted when the given scenes are being instantiated in the editor. + Emitted when an external [param resource] had its file removed. diff --git a/doc/classes/InputEventFromWindow.xml b/doc/classes/InputEventFromWindow.xml index 752c0f67426..03813be76f5 100644 --- a/doc/classes/InputEventFromWindow.xml +++ b/doc/classes/InputEventFromWindow.xml @@ -1,13 +1,16 @@ + Base class for [Viewport]-based input events. + InputEventFromWindow represents events specifically received by windows. This includes mouse events, keyboard events in focused windows or touch screen actions. + The ID of a [Window] that received this event. diff --git a/doc/classes/InputEventGesture.xml b/doc/classes/InputEventGesture.xml index 7e21e659734..af3954c7434 100644 --- a/doc/classes/InputEventGesture.xml +++ b/doc/classes/InputEventGesture.xml @@ -4,6 +4,7 @@ Base class for touch control gestures. + 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. diff --git a/doc/classes/InputEventMagnifyGesture.xml b/doc/classes/InputEventMagnifyGesture.xml index 8c8c1e90137..fa53617418e 100644 --- a/doc/classes/InputEventMagnifyGesture.xml +++ b/doc/classes/InputEventMagnifyGesture.xml @@ -1,13 +1,16 @@ + [InputEvent] that represents a magnifying touch gesture. + Magnify gesture is performed when the user pinches the touch screen. It's typically used for zooming. + The amount (or delta) of the event. This value is higher the faster the gesture is performed. diff --git a/doc/classes/InputEventPanGesture.xml b/doc/classes/InputEventPanGesture.xml index 88abc4387b0..0ee74f13280 100644 --- a/doc/classes/InputEventPanGesture.xml +++ b/doc/classes/InputEventPanGesture.xml @@ -1,13 +1,16 @@ + [InputEvent] that represents a panning touch gesture. + Pan gesture is performed when the user swipes the touch screen with two fingers. It's typically used for panning/scrolling. + Panning amount since last pan event. diff --git a/doc/classes/InputEventShortcut.xml b/doc/classes/InputEventShortcut.xml index 42ed4bb01e1..6d7d7609b97 100644 --- a/doc/classes/InputEventShortcut.xml +++ b/doc/classes/InputEventShortcut.xml @@ -1,13 +1,16 @@ + [InputEvent] that signifies a triggered keyboard [Shortcut]. + 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]. + The [Shortcut] represented by this event. Its [method Shortcut.matches_event] method will always return [code]true[/code] for this event. diff --git a/doc/classes/Node.xml b/doc/classes/Node.xml index 5817c45f418..cb829ae1836 100644 --- a/doc/classes/Node.xml +++ b/doc/classes/Node.xml @@ -954,8 +954,10 @@ Specific to the Android platform. + Notification received from the OS when the window is resized. + Notification received from the OS when the screen's DPI has been changed. Only implemented on macOS. Notification received when the mouse enters the viewport. diff --git a/doc/classes/Node3D.xml b/doc/classes/Node3D.xml index d751f2a8687..da898a55679 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]. + The rotation is edited using [Vector3] Euler angles. + The rotation is edited using a [Quaternion]. + The rotation is edited using a [Basis]. In this mode, [member scale] can't be edited separately. diff --git a/doc/classes/Polygon2D.xml b/doc/classes/Polygon2D.xml index 550f1624663..b657e497991 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. + Internal list of [Bone2D] nodes used by the assigned [member skeleton]. Edited using the Polygon2D editor ("UV" button on the top toolbar). 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]. + Number of internal vertices, used for UV mapping. 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. + Path to a [Skeleton2D] node used for skeleton-based deformations of this polygon. If empty or invalid, skeletal deformations will not be used. 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 3024be924ef..1a77e7c5255 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -1958,8 +1958,10 @@ + 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. + If [code]true[/code], vertices of [CanvasItem] nodes will snap to full pixels. Only affects the final vertex positions, not the transforms. 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 @@ + Maximum number of threads to be used by [WorkerThreadPool]. Value of [code]-1[/code] means no limit. diff --git a/doc/classes/RenderingServer.xml b/doc/classes/RenderingServer.xml index fd4172f88a7..b73ed3ccf2f 100644 --- a/doc/classes/RenderingServer.xml +++ b/doc/classes/RenderingServer.xml @@ -33,6 +33,7 @@ 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. @@ -100,6 +101,7 @@ 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. @@ -178,6 +180,7 @@ 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. @@ -350,6 +353,7 @@ + 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]. @@ -362,6 +366,7 @@ + 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]. @@ -388,7 +393,9 @@ - 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. @@ -482,6 +489,7 @@ + Sets a color modulation to the [CanvasItem]. This also affects child canvas items. @@ -489,6 +497,7 @@ + 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. @@ -496,6 +505,7 @@ + Sets a color self-modulation to the [CanvasItem]. It does not affect the child canvas items. @@ -503,6 +513,7 @@ + Enables or disables Y-sorting of a [CanvasItem]. @@ -510,6 +521,7 @@ + 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. @@ -536,6 +548,8 @@ + 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]. @@ -543,6 +557,7 @@ + Sets the visibility of the [CanvasItem]. @@ -832,6 +847,9 @@ + 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. @@ -855,6 +873,7 @@ + Sets the texture filter used by the [CanvasTexture]. @@ -862,6 +881,7 @@ + Sets the texture repeat used by the [CanvasTexture]. @@ -874,6 +894,9 @@ + 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. @@ -919,6 +942,7 @@ + Sets the color modulation of the [Decal]. @@ -933,6 +957,7 @@ + Sets the size of the [Decal]. @@ -941,6 +966,7 @@ + Sets the texture of the [Decal]. @@ -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. @@ -983,6 +1010,7 @@ 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. @@ -1244,7 +1272,9 @@ - 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. @@ -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. @@ -1821,7 +1852,9 @@ - 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. @@ -1908,6 +1941,7 @@ 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. @@ -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. @@ -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. diff --git a/doc/classes/Viewport.xml b/doc/classes/Viewport.xml index b7d41f41e40..7c3694b32af 100644 --- a/doc/classes/Viewport.xml +++ b/doc/classes/Viewport.xml @@ -76,6 +76,7 @@ + Returns rendering statistics of the given type. See [enum RenderInfoType] and [enum RenderInfo] for options. @@ -165,6 +166,7 @@ + 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]).