diff --git a/core/doc_data.cpp b/core/doc_data.cpp index 4f72a14430f..92de0a80706 100644 --- a/core/doc_data.cpp +++ b/core/doc_data.cpp @@ -127,6 +127,13 @@ void DocData::method_doc_from_methodinfo(DocData::MethodDoc &p_method, const Met p_method.qualifiers = "virtual"; } + if (p_methodinfo.flags & METHOD_FLAG_VIRTUAL_REQUIRED) { + if (!p_method.qualifiers.is_empty()) { + p_method.qualifiers += " "; + } + p_method.qualifiers += "required"; + } + if (p_methodinfo.flags & METHOD_FLAG_CONST) { if (!p_method.qualifiers.is_empty()) { p_method.qualifiers += " "; diff --git a/doc/classes/AnimationNodeExtension.xml b/doc/classes/AnimationNodeExtension.xml index 9572573653a..c7cb411fa05 100644 --- a/doc/classes/AnimationNodeExtension.xml +++ b/doc/classes/AnimationNodeExtension.xml @@ -9,7 +9,7 @@ - + diff --git a/doc/classes/AudioEffect.xml b/doc/classes/AudioEffect.xml index bd31603517d..2d5a61512d0 100644 --- a/doc/classes/AudioEffect.xml +++ b/doc/classes/AudioEffect.xml @@ -12,7 +12,7 @@ https://godotengine.org/asset-library/asset/2760 - + Override this method to customize the [AudioEffectInstance] created when this effect is applied on a bus in the editor's Audio panel, or through [method AudioServer.add_bus_effect]. diff --git a/doc/classes/AudioEffectInstance.xml b/doc/classes/AudioEffectInstance.xml index 0f3ae11793c..058a4510aec 100644 --- a/doc/classes/AudioEffectInstance.xml +++ b/doc/classes/AudioEffectInstance.xml @@ -10,7 +10,7 @@ $DOCS_URL/tutorials/audio/audio_buses.html - + diff --git a/doc/classes/AudioStreamPlayback.xml b/doc/classes/AudioStreamPlayback.xml index f01406d0f1d..4550b1841fa 100644 --- a/doc/classes/AudioStreamPlayback.xml +++ b/doc/classes/AudioStreamPlayback.xml @@ -35,7 +35,7 @@ Overridable method. Should return [code]true[/code] if this playback is active and playing its audio stream. - + diff --git a/doc/classes/AudioStreamPlaybackResampled.xml b/doc/classes/AudioStreamPlaybackResampled.xml index 4173ee4bb45..61715c03e09 100644 --- a/doc/classes/AudioStreamPlaybackResampled.xml +++ b/doc/classes/AudioStreamPlaybackResampled.xml @@ -7,12 +7,12 @@ - + - + diff --git a/doc/classes/EditorExportPlatformExtension.xml b/doc/classes/EditorExportPlatformExtension.xml index f2d14b17107..98051094d94 100644 --- a/doc/classes/EditorExportPlatformExtension.xml +++ b/doc/classes/EditorExportPlatformExtension.xml @@ -15,7 +15,6 @@ - [b]Optional.[/b] Returns [code]true[/code], if specified [param preset] is valid and can be exported. Use [method set_config_error] and [method set_config_missing_templates] to set error details. Usual implementation can call [method _has_valid_export_configuration] and [method _has_valid_project_configuration] to determine if export is possible. @@ -23,7 +22,6 @@ - [b]Optional.[/b] Called by the editor before platform is unregistered. @@ -34,7 +32,6 @@ - [b]Optional.[/b] Creates a PCK archive at [param path] for the specified [param preset]. This method is called when "Export PCK/ZIP" button is pressed in the export dialog, with "Export as Patch" disabled, and PCK is selected as a file type. @@ -47,20 +44,18 @@ - [b]Optional.[/b] Creates a patch PCK archive at [param path] for the specified [param preset], containing only the files that have changed since the last patch. This method is called when "Export PCK/ZIP" button is pressed in the export dialog, with "Export as Patch" enabled, and PCK is selected as a file type. [b]Note:[/b] The patches provided in [param patches] have already been loaded when this method is called and are merely provided as context. When empty the patches defined in the export preset have been loaded instead. - + - [b]Required.[/b] Creates a full project at [param path] for the specified [param preset]. This method is called when "Export" button is pressed in the export dialog. This method implementation can call [method EditorExportPlatform.save_pack] or [method EditorExportPlatform.save_zip] to use default PCK/ZIP export process, or calls [method EditorExportPlatform.export_project_files] and implement custom callback for processing each exported file. @@ -73,7 +68,6 @@ - [b]Optional.[/b] Create a ZIP archive at [param path] for the specified [param preset]. This method is called when "Export PCK/ZIP" button is pressed in the export dialog, with "Export as Patch" disabled, and ZIP is selected as a file type. @@ -86,24 +80,21 @@ - [b]Optional.[/b] Create a ZIP archive at [param path] for the specified [param preset], containing only the files that have changed since the last patch. This method is called when "Export PCK/ZIP" button is pressed in the export dialog, with "Export as Patch" enabled, and ZIP is selected as a file type. [b]Note:[/b] The patches provided in [param patches] have already been loaded when this method is called and are merely provided as context. When empty the patches defined in the export preset have been loaded instead. - + - [b]Required.[/b] Returns array of supported binary extensions for the full project export. - [b]Optional.[/b] Returns protocol used for remote debugging. Default implementation return [code]tcp://[/code]. @@ -111,7 +102,6 @@ - [b]Optional.[/b] Returns device architecture for one-click deploy. @@ -120,7 +110,6 @@ - [b]Optional.[/b] Validates [param option] and returns visibility for the specified [param preset]. Default implementation return [code]true[/code] for all options. @@ -129,14 +118,12 @@ - [b]Optional.[/b] Validates [param option] and returns warning message for the specified [param preset]. Default implementation return empty string for all options. - [b]Optional.[/b] Returns a property list, as an [Array] of dictionaries. Each [Dictionary] must at least contain the [code]name: StringName[/code] and [code]type: Variant.Type[/code] entries. Additionally, the following keys are supported: - [code]hint: PropertyHint[/code] @@ -149,17 +136,15 @@ See also [method Object._get_property_list]. - + - [b]Required.[/b] Returns platform logo displayed in the export dialog, logo should be 32x32 adjusted to the current editor scale, see [method EditorInterface.get_editor_scale]. - + - [b]Required.[/b] Returns export platform name. @@ -167,7 +152,6 @@ - [b]Optional.[/b] Returns one-click deploy menu item icon for the specified [param device], icon should be 16x16 adjusted to the current editor scale, see [method EditorInterface.get_editor_scale]. @@ -175,7 +159,6 @@ - [b]Optional.[/b] Returns one-click deploy menu item label for the specified [param device]. @@ -183,67 +166,58 @@ - [b]Optional.[/b] Returns one-click deploy menu item tooltip for the specified [param device]. - [b]Optional.[/b] Returns number one-click deploy devices (or other one-click option displayed in the menu). - [b]Optional.[/b] Returns tooltip of the one-click deploy menu button. - + - [b]Required.[/b] Returns target OS name. - + - [b]Required.[/b] Returns array of platform specific features. - + - [b]Required.[/b] Returns array of platform specific features for the specified [param preset]. - [b]Optional.[/b] Returns icon of the one-click deploy menu button, icon should be 16x16 adjusted to the current editor scale, see [method EditorInterface.get_editor_scale]. - + - [b]Required.[/b] Returns [code]true[/code] if export configuration is valid. - + - [b]Required.[/b] Returns [code]true[/code] if project configuration is valid. @@ -251,14 +225,12 @@ - [b]Optional.[/b] Returns [code]true[/code] if specified file is a valid executable (native executable or script) for the target platform. - [b]Optional.[/b] Returns [code]true[/code] if one-click deploy options are changed and editor interface should be updated. @@ -268,7 +240,6 @@ - [b]Optional.[/b] This method is called when [param device] one-click deploy menu option is selected. Implementation should export project to a temporary location, upload and run it on the specific [param device], or perform another action associated with the menu item. @@ -276,7 +247,6 @@ - [b]Optional.[/b] Returns [code]true[/code] if export options list is changed and presets should be updated. diff --git a/doc/classes/EditorExportPlugin.xml b/doc/classes/EditorExportPlugin.xml index c9e34d46402..1c438711760 100644 --- a/doc/classes/EditorExportPlugin.xml +++ b/doc/classes/EditorExportPlugin.xml @@ -30,7 +30,7 @@ [b]Note:[/b] [method _customize_scene] will only be called for scenes that have been modified since the last export. - + @@ -47,7 +47,7 @@ - [CompressedTexture3D] - + @@ -152,7 +152,7 @@ [b]Note:[/b] Only supported on Android and requires [member EditorExportPlatformAndroid.gradle_build/use_gradle_build] to be enabled. - + Return a hash based on the configuration passed (for both scenes and resources). This helps keep separate caches for separate export configurations. @@ -172,7 +172,6 @@ - [b]Optional.[/b] Validates [param option] and returns the visibility for the specified [param platform]. The default implementation returns [code]true[/code] for all options. @@ -220,7 +219,7 @@ [/codeblock] - + Return the name identifier of this plugin (for future identification by the exporter). The plugins are sorted by name before exporting. diff --git a/doc/classes/EditorFileSystemImportFormatSupportQuery.xml b/doc/classes/EditorFileSystemImportFormatSupportQuery.xml index fc2feca9116..98f2cc5f771 100644 --- a/doc/classes/EditorFileSystemImportFormatSupportQuery.xml +++ b/doc/classes/EditorFileSystemImportFormatSupportQuery.xml @@ -9,19 +9,19 @@ - + Return the file extensions supported. - + Return whether this importer is active. - + Query support. Return [code]false[/code] if import must not continue. diff --git a/doc/classes/EditorScript.xml b/doc/classes/EditorScript.xml index 114fd716af4..5e16dbfb18e 100644 --- a/doc/classes/EditorScript.xml +++ b/doc/classes/EditorScript.xml @@ -35,7 +35,7 @@ - + This method is executed by the Editor when [b]File > Run[/b] is used. diff --git a/doc/classes/EditorVCSInterface.xml b/doc/classes/EditorVCSInterface.xml index 03be5c332d7..bfd312a9eb2 100644 --- a/doc/classes/EditorVCSInterface.xml +++ b/doc/classes/EditorVCSInterface.xml @@ -10,28 +10,28 @@ $DOCS_URL/tutorials/best_practices/version_control_systems.html - + Checks out a [param branch_name] in the VCS. - + Commits the currently staged changes and applies the commit [param msg] to the resulting commit. - + Creates a new branch named [param branch_name] in the VCS. - + @@ -39,33 +39,33 @@ Creates a new remote destination with name [param remote_name] and points it to [param remote_url]. This can be an HTTPS remote or an SSH remote. - + Discards the changes made in a file present at [param file_path]. - + Fetches new changes from the [param remote], but doesn't write changes to the current working directory. Equivalent to [code]git fetch[/code]. - + Gets an instance of an [Array] of [String]s containing available branch names in the VCS. - + Gets the current branch name defined in the VCS. - + @@ -73,7 +73,7 @@ Returns an array of [Dictionary] items (see [method create_diff_file], [method create_diff_hunk], [method create_diff_line], [method add_line_diffs_into_diff_hunk] and [method add_diff_hunks_into_diff_file]), each containing information about a diff. If [param identifier] is a file path, returns a file diff, and if it is a commit identifier, then returns a commit diff. - + @@ -81,46 +81,46 @@ Returns an [Array] of [Dictionary] items (see [method create_diff_hunk]), each containing a line diff between a file at [param file_path] and the [param text] which is passed in. - + Returns an [Array] of [Dictionary] items (see [method create_status_file]), each containing the status data of every modified file in the project folder. - + Returns an [Array] of [Dictionary] items (see [method create_commit]), each containing the data for a past commit. - + Returns an [Array] of [String]s, each containing the name of a remote configured in the VCS. - + Returns the name of the underlying VCS provider. - + Initializes the VCS plugin when called from the editor. Returns whether or not the plugin was successfully initialized. A VCS project is initialized at [param project_path]. - + Pulls changes from the remote. This can give rise to merge conflicts. - + @@ -128,21 +128,21 @@ Pushes changes to the [param remote]. If [param force] is [code]true[/code], a force push will override the change history already present on the remote. - + Remove a branch from the local VCS. - + Remove a remote from the local VCS. - + @@ -153,20 +153,20 @@ Set user credentials in the underlying VCS. [param username] and [param password] are used only during HTTPS authentication unless not already mentioned in the remote URL. [param ssh_public_key_path], [param ssh_private_key_path], and [param ssh_passphrase] are only used during SSH authentication. - + Shuts down VCS plugin instance. Called when the user either closes the editor or shuts down the VCS plugin through the editor UI. - + Stages the file present at [param file_path] to the staged area. - + diff --git a/doc/classes/Material.xml b/doc/classes/Material.xml index 17df3f7531a..1dab52aa276 100644 --- a/doc/classes/Material.xml +++ b/doc/classes/Material.xml @@ -24,13 +24,13 @@ Only exposed for the purpose of overriding. You cannot call this function directly. Used internally to determine if [member render_priority] should be shown in the editor or not. - + Only exposed for the purpose of overriding. You cannot call this function directly. Used internally by various editor tools. - + Only exposed for the purpose of overriding. You cannot call this function directly. Used internally by various editor tools. Used to access the RID of the [Material]'s [Shader]. diff --git a/doc/classes/Mesh.xml b/doc/classes/Mesh.xml index 0eced470973..048f971017f 100644 --- a/doc/classes/Mesh.xml +++ b/doc/classes/Mesh.xml @@ -13,32 +13,32 @@ https://godotengine.org/asset-library/asset/2710 - + Virtual method to override the [AABB] for a custom class extending [Mesh]. - + Virtual method to override the number of blend shapes for a custom class extending [Mesh]. - + Virtual method to override the retrieval of blend shape names for a custom class extending [Mesh]. - + Virtual method to override the surface count for a custom class extending [Mesh]. - + @@ -46,63 +46,63 @@ Virtual method to override the names of blend shapes for a custom class extending [Mesh]. - + Virtual method to override the surface array index length for a custom class extending [Mesh]. - + Virtual method to override the surface array length for a custom class extending [Mesh]. - + Virtual method to override the surface arrays for a custom class extending [Mesh]. - + Virtual method to override the blend shape arrays for a custom class extending [Mesh]. - + Virtual method to override the surface format for a custom class extending [Mesh]. - + Virtual method to override the surface LODs for a custom class extending [Mesh]. - + Virtual method to override the surface material for a custom class extending [Mesh]. - + Virtual method to override the surface primitive type for a custom class extending [Mesh]. - + diff --git a/doc/classes/MovieWriter.xml b/doc/classes/MovieWriter.xml index fccfd4585ec..4fa42437221 100644 --- a/doc/classes/MovieWriter.xml +++ b/doc/classes/MovieWriter.xml @@ -16,19 +16,19 @@ - + Called when the audio sample rate used for recording the audio is requested by the engine. The value returned must be specified in Hz. Defaults to 48000 Hz if [method _get_audio_mix_rate] is not overridden. - + Called when the audio speaker mode used for recording the audio is requested by the engine. This can affect the number of output channels in the resulting audio file/stream. Defaults to [constant AudioServer.SPEAKER_MODE_STEREO] if [method _get_audio_speaker_mode] is not overridden. - + @@ -41,7 +41,7 @@ [/codeblock] - + @@ -50,14 +50,14 @@ Called once before the engine starts writing video and audio data. [param movie_size] is the width and height of the video to save. [param fps] is the number of frames per second specified in the project settings or using the [code]--fixed-fps <fps>[/code] [url=$DOCS_URL/tutorials/editor/command_line_tutorial.html]command line argument[/url]. - + Called when the engine finishes writing. This occurs when the engine quits by pressing the window manager's close button, or when [method SceneTree.quit] is called. [b]Note:[/b] Pressing [kbd]Ctrl + C[/kbd] on the terminal running the editor/project does [i]not[/i] result in [method _write_end] being called. - + diff --git a/doc/classes/MultiplayerPeerExtension.xml b/doc/classes/MultiplayerPeerExtension.xml index b7d55f31b6a..a987b3b5e6c 100644 --- a/doc/classes/MultiplayerPeerExtension.xml +++ b/doc/classes/MultiplayerPeerExtension.xml @@ -9,13 +9,13 @@ - + Called when the multiplayer peer should be immediately closed (see [method MultiplayerPeer.close]). - + @@ -23,19 +23,19 @@ Called when the connected [param p_peer] should be forcibly disconnected (see [method MultiplayerPeer.disconnect_peer]). - + Called when the available packet count is internally requested by the [MultiplayerAPI]. - + Called when the connection status is requested on the [MultiplayerPeer] (see [method MultiplayerPeer.get_connection_status]). - + Called when the maximum allowed packet size (in bytes) is requested by the [MultiplayerAPI]. @@ -49,19 +49,19 @@ Called when a packet needs to be received by the [MultiplayerAPI], with [param r_buffer_size] being the size of the binary [param r_buffer] in bytes. - + Called to get the channel over which the next available packet was received. See [method MultiplayerPeer.get_packet_channel]. - + Called to get the transfer mode the remote peer used to send the next available packet. See [method MultiplayerPeer.get_packet_mode]. - + Called when the ID of the [MultiplayerPeer] who sent the most recent packet is requested (see [method MultiplayerPeer.get_packet_peer]). @@ -73,19 +73,19 @@ Called when a packet needs to be received by the [MultiplayerAPI], if [method _get_packet] isn't implemented. Use this when extending this class via GDScript. - + Called when the transfer channel to use is read on this [MultiplayerPeer] (see [member MultiplayerPeer.transfer_channel]). - + Called when the transfer mode to use is read on this [MultiplayerPeer] (see [member MultiplayerPeer.transfer_mode]). - + Called when the unique ID of this [MultiplayerPeer] is requested (see [method MultiplayerPeer.get_unique_id]). The value must be between [code]1[/code] and [code]2147483647[/code]. @@ -97,7 +97,7 @@ Called when the "refuse new connections" status is requested on this [MultiplayerPeer] (see [member MultiplayerPeer.refuse_new_connections]). - + Called when the "is server" status is requested on the [MultiplayerAPI]. See [method MultiplayerAPI.is_server]. @@ -109,7 +109,7 @@ Called to check if the server can act as a relay in the current configuration. See [method MultiplayerPeer.is_server_relay_supported]. - + Called when the [MultiplayerAPI] is polled. See [method MultiplayerAPI.poll]. @@ -137,21 +137,21 @@ Called when the "refuse new connections" status is set on this [MultiplayerPeer] (see [member MultiplayerPeer.refuse_new_connections]). - + Called when the target peer to use is set for this [MultiplayerPeer] (see [method MultiplayerPeer.set_target_peer]). - + Called when the channel to use is set for this [MultiplayerPeer] (see [member MultiplayerPeer.transfer_channel]). - + diff --git a/doc/classes/PacketPeerExtension.xml b/doc/classes/PacketPeerExtension.xml index c37da6402f9..23d95ecfd2f 100644 --- a/doc/classes/PacketPeerExtension.xml +++ b/doc/classes/PacketPeerExtension.xml @@ -7,12 +7,12 @@ - + - + diff --git a/doc/classes/PhysicsDirectBodyState2DExtension.xml b/doc/classes/PhysicsDirectBodyState2DExtension.xml index 932c1c83527..af5750fef85 100644 --- a/doc/classes/PhysicsDirectBodyState2DExtension.xml +++ b/doc/classes/PhysicsDirectBodyState2DExtension.xml @@ -10,14 +10,14 @@ - + Overridable version of [method PhysicsDirectBodyState2D.add_constant_central_force]. - + @@ -25,28 +25,28 @@ Overridable version of [method PhysicsDirectBodyState2D.add_constant_force]. - + Overridable version of [method PhysicsDirectBodyState2D.add_constant_torque]. - + Overridable version of [method PhysicsDirectBodyState2D.apply_central_force]. - + Overridable version of [method PhysicsDirectBodyState2D.apply_central_impulse]. - + @@ -54,7 +54,7 @@ Overridable version of [method PhysicsDirectBodyState2D.apply_force]. - + @@ -62,242 +62,242 @@ Overridable version of [method PhysicsDirectBodyState2D.apply_impulse]. - + Overridable version of [method PhysicsDirectBodyState2D.apply_torque]. - + Overridable version of [method PhysicsDirectBodyState2D.apply_torque_impulse]. - + Implement to override the behavior of [member PhysicsDirectBodyState2D.angular_velocity] and its respective getter. - + Implement to override the behavior of [member PhysicsDirectBodyState2D.center_of_mass] and its respective getter. - + Implement to override the behavior of [member PhysicsDirectBodyState2D.center_of_mass_local] and its respective getter. - + Overridable version of [method PhysicsDirectBodyState2D.get_constant_force]. - + Overridable version of [method PhysicsDirectBodyState2D.get_constant_torque]. - + Overridable version of [method PhysicsDirectBodyState2D.get_contact_collider]. - + Overridable version of [method PhysicsDirectBodyState2D.get_contact_collider_id]. - + Overridable version of [method PhysicsDirectBodyState2D.get_contact_collider_object]. - + Overridable version of [method PhysicsDirectBodyState2D.get_contact_collider_position]. - + Overridable version of [method PhysicsDirectBodyState2D.get_contact_collider_shape]. - + Overridable version of [method PhysicsDirectBodyState2D.get_contact_collider_velocity_at_position]. - + Overridable version of [method PhysicsDirectBodyState2D.get_contact_count]. - + Overridable version of [method PhysicsDirectBodyState2D.get_contact_impulse]. - + Overridable version of [method PhysicsDirectBodyState2D.get_contact_local_normal]. - + Overridable version of [method PhysicsDirectBodyState2D.get_contact_local_position]. - + Overridable version of [method PhysicsDirectBodyState2D.get_contact_local_shape]. - + Overridable version of [method PhysicsDirectBodyState2D.get_contact_local_velocity_at_position]. - + Implement to override the behavior of [member PhysicsDirectBodyState2D.inverse_inertia] and its respective getter. - + Implement to override the behavior of [member PhysicsDirectBodyState2D.inverse_mass] and its respective getter. - + Implement to override the behavior of [member PhysicsDirectBodyState2D.linear_velocity] and its respective getter. - + Overridable version of [method PhysicsDirectBodyState2D.get_space_state]. - + Implement to override the behavior of [member PhysicsDirectBodyState2D.step] and its respective getter. - + Implement to override the behavior of [member PhysicsDirectBodyState2D.total_angular_damp] and its respective getter. - + Implement to override the behavior of [member PhysicsDirectBodyState2D.total_gravity] and its respective getter. - + Implement to override the behavior of [member PhysicsDirectBodyState2D.total_linear_damp] and its respective getter. - + Implement to override the behavior of [member PhysicsDirectBodyState2D.transform] and its respective getter. - + Overridable version of [method PhysicsDirectBodyState2D.get_velocity_at_local_position]. - + Overridable version of [method PhysicsDirectBodyState2D.integrate_forces]. - + Implement to override the behavior of [member PhysicsDirectBodyState2D.sleeping] and its respective getter. - + Implement to override the behavior of [member PhysicsDirectBodyState2D.angular_velocity] and its respective setter. - + Overridable version of [method PhysicsDirectBodyState2D.set_constant_force]. - + Overridable version of [method PhysicsDirectBodyState2D.set_constant_torque]. - + Implement to override the behavior of [member PhysicsDirectBodyState2D.linear_velocity] and its respective setter. - + Implement to override the behavior of [member PhysicsDirectBodyState2D.sleeping] and its respective setter. - + diff --git a/doc/classes/PhysicsDirectBodyState3DExtension.xml b/doc/classes/PhysicsDirectBodyState3DExtension.xml index ddcc8a865fd..496c57fcc90 100644 --- a/doc/classes/PhysicsDirectBodyState3DExtension.xml +++ b/doc/classes/PhysicsDirectBodyState3DExtension.xml @@ -10,261 +10,261 @@ - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + diff --git a/doc/classes/PhysicsDirectSpaceState2DExtension.xml b/doc/classes/PhysicsDirectSpaceState2DExtension.xml index 8a0498cbd96..a551ab15dd9 100644 --- a/doc/classes/PhysicsDirectSpaceState2DExtension.xml +++ b/doc/classes/PhysicsDirectSpaceState2DExtension.xml @@ -10,7 +10,7 @@ - + @@ -24,7 +24,7 @@ - + @@ -39,7 +39,7 @@ - + @@ -51,7 +51,7 @@ - + @@ -63,7 +63,7 @@ - + @@ -77,7 +77,7 @@ - + diff --git a/doc/classes/PhysicsDirectSpaceState3DExtension.xml b/doc/classes/PhysicsDirectSpaceState3DExtension.xml index 372b059cb6c..f97f60a878c 100644 --- a/doc/classes/PhysicsDirectSpaceState3DExtension.xml +++ b/doc/classes/PhysicsDirectSpaceState3DExtension.xml @@ -10,7 +10,7 @@ - + @@ -25,7 +25,7 @@ - + @@ -40,14 +40,14 @@ - + - + @@ -58,7 +58,7 @@ - + @@ -72,7 +72,7 @@ - + @@ -86,7 +86,7 @@ - + diff --git a/doc/classes/PhysicsServer2DExtension.xml b/doc/classes/PhysicsServer2DExtension.xml index 07c65915c6f..1fd8523cc9e 100644 --- a/doc/classes/PhysicsServer2DExtension.xml +++ b/doc/classes/PhysicsServer2DExtension.xml @@ -10,7 +10,7 @@ - + @@ -20,7 +20,7 @@ Overridable version of [method PhysicsServer2D.area_add_shape]. - + @@ -28,7 +28,7 @@ Overridable version of [method PhysicsServer2D.area_attach_canvas_instance_id]. - + @@ -36,48 +36,48 @@ Overridable version of [method PhysicsServer2D.area_attach_object_instance_id]. - + Overridable version of [method PhysicsServer2D.area_clear_shapes]. - + Overridable version of [method PhysicsServer2D.area_create]. - + Overridable version of [method PhysicsServer2D.area_get_canvas_instance_id]. - + Overridable version of [method PhysicsServer2D.area_get_collision_layer]. - + Overridable version of [method PhysicsServer2D.area_get_collision_mask]. - + Overridable version of [method PhysicsServer2D.area_get_object_instance_id]. - + @@ -85,7 +85,7 @@ Overridable version of [method PhysicsServer2D.area_get_param]. - + @@ -93,14 +93,14 @@ Overridable version of [method PhysicsServer2D.area_get_shape]. - + Overridable version of [method PhysicsServer2D.area_get_shape_count]. - + @@ -108,21 +108,21 @@ Overridable version of [method PhysicsServer2D.area_get_shape_transform]. - + Overridable version of [method PhysicsServer2D.area_get_space]. - + Overridable version of [method PhysicsServer2D.area_get_transform]. - + @@ -130,7 +130,7 @@ Overridable version of [method PhysicsServer2D.area_remove_shape]. - + @@ -138,7 +138,7 @@ Overridable version of [method PhysicsServer2D.area_set_area_monitor_callback]. - + @@ -146,7 +146,7 @@ Overridable version of [method PhysicsServer2D.area_set_collision_layer]. - + @@ -154,7 +154,7 @@ Overridable version of [method PhysicsServer2D.area_set_collision_mask]. - + @@ -162,7 +162,7 @@ Overridable version of [method PhysicsServer2D.area_set_monitor_callback]. - + @@ -170,7 +170,7 @@ Overridable version of [method PhysicsServer2D.area_set_monitorable]. - + @@ -179,7 +179,7 @@ Overridable version of [method PhysicsServer2D.area_set_param]. - + @@ -188,7 +188,7 @@ Overridable version of [PhysicsServer2D]'s internal [code]area_set_pickable[/code] method. Corresponds to [member CollisionObject2D.input_pickable]. - + @@ -197,7 +197,7 @@ Overridable version of [method PhysicsServer2D.area_set_shape]. - + @@ -206,7 +206,7 @@ Overridable version of [method PhysicsServer2D.area_set_shape_disabled]. - + @@ -215,7 +215,7 @@ Overridable version of [method PhysicsServer2D.area_set_shape_transform]. - + @@ -223,7 +223,7 @@ Overridable version of [method PhysicsServer2D.area_set_space]. - + @@ -231,7 +231,7 @@ Overridable version of [method PhysicsServer2D.area_set_transform]. - + @@ -239,7 +239,7 @@ Overridable version of [method PhysicsServer2D.body_add_collision_exception]. - + @@ -247,7 +247,7 @@ Overridable version of [method PhysicsServer2D.body_add_constant_central_force]. - + @@ -256,7 +256,7 @@ Overridable version of [method PhysicsServer2D.body_add_constant_force]. - + @@ -264,7 +264,7 @@ Overridable version of [method PhysicsServer2D.body_add_constant_torque]. - + @@ -274,7 +274,7 @@ Overridable version of [method PhysicsServer2D.body_add_shape]. - + @@ -282,7 +282,7 @@ Overridable version of [method PhysicsServer2D.body_apply_central_force]. - + @@ -290,7 +290,7 @@ Overridable version of [method PhysicsServer2D.body_apply_central_impulse]. - + @@ -299,7 +299,7 @@ Overridable version of [method PhysicsServer2D.body_apply_force]. - + @@ -308,7 +308,7 @@ Overridable version of [method PhysicsServer2D.body_apply_impulse]. - + @@ -316,7 +316,7 @@ Overridable version of [method PhysicsServer2D.body_apply_torque]. - + @@ -324,7 +324,7 @@ Overridable version of [method PhysicsServer2D.body_apply_torque_impulse]. - + @@ -332,7 +332,7 @@ Overridable version of [method PhysicsServer2D.body_attach_canvas_instance_id]. - + @@ -340,14 +340,14 @@ Overridable version of [method PhysicsServer2D.body_attach_object_instance_id]. - + Overridable version of [method PhysicsServer2D.body_clear_shapes]. - + @@ -362,20 +362,20 @@ Overridable version of [PhysicsServer2D]'s internal [code]shape_collide[/code] method. Corresponds to [method PhysicsDirectSpaceState2D.collide_shape]. - + Overridable version of [method PhysicsServer2D.body_create]. - + Overridable version of [method PhysicsServer2D.body_get_canvas_instance_id]. - + @@ -383,42 +383,42 @@ Overridable version of [PhysicsServer2D]'s internal [code]body_get_collision_exceptions[/code] method. Corresponds to [method PhysicsBody2D.get_collision_exceptions]. - + Overridable version of [method PhysicsServer2D.body_get_collision_layer]. - + Overridable version of [method PhysicsServer2D.body_get_collision_mask]. - + Overridable version of [method PhysicsServer2D.body_get_collision_priority]. - + Overridable version of [method PhysicsServer2D.body_get_constant_force]. - + Overridable version of [method PhysicsServer2D.body_get_constant_torque]. - + @@ -426,42 +426,42 @@ [b]Note:[/b] This method is currently unused by Godot's default physics implementation. - + Overridable version of [method PhysicsServer2D.body_get_continuous_collision_detection_mode]. - + Overridable version of [method PhysicsServer2D.body_get_direct_state]. - + Overridable version of [method PhysicsServer2D.body_get_max_contacts_reported]. - + Overridable version of [method PhysicsServer2D.body_get_mode]. - + Overridable version of [method PhysicsServer2D.body_get_object_instance_id]. - + @@ -469,7 +469,7 @@ Overridable version of [method PhysicsServer2D.body_get_param]. - + @@ -477,14 +477,14 @@ Overridable version of [method PhysicsServer2D.body_get_shape]. - + Overridable version of [method PhysicsServer2D.body_get_shape_count]. - + @@ -492,14 +492,14 @@ Overridable version of [method PhysicsServer2D.body_get_shape_transform]. - + Overridable version of [method PhysicsServer2D.body_get_space]. - + @@ -507,14 +507,14 @@ Overridable version of [method PhysicsServer2D.body_get_state]. - + Overridable version of [method PhysicsServer2D.body_is_omitting_force_integration]. - + @@ -522,7 +522,7 @@ Overridable version of [method PhysicsServer2D.body_remove_collision_exception]. - + @@ -530,14 +530,14 @@ Overridable version of [method PhysicsServer2D.body_remove_shape]. - + Overridable version of [method PhysicsServer2D.body_reset_mass_properties]. - + @@ -545,7 +545,7 @@ Overridable version of [method PhysicsServer2D.body_set_axis_velocity]. - + @@ -553,7 +553,7 @@ Overridable version of [method PhysicsServer2D.body_set_collision_layer]. - + @@ -561,7 +561,7 @@ Overridable version of [method PhysicsServer2D.body_set_collision_mask]. - + @@ -569,7 +569,7 @@ Overridable version of [method PhysicsServer2D.body_set_collision_priority]. - + @@ -577,7 +577,7 @@ Overridable version of [method PhysicsServer2D.body_set_constant_force]. - + @@ -585,7 +585,7 @@ Overridable version of [method PhysicsServer2D.body_set_constant_torque]. - + @@ -594,7 +594,7 @@ [b]Note:[/b] This method is currently unused by Godot's default physics implementation. - + @@ -602,7 +602,7 @@ Overridable version of [method PhysicsServer2D.body_set_continuous_collision_detection_mode]. - + @@ -611,7 +611,7 @@ Overridable version of [method PhysicsServer2D.body_set_force_integration_callback]. - + @@ -619,7 +619,7 @@ Overridable version of [method PhysicsServer2D.body_set_max_contacts_reported]. - + @@ -627,7 +627,7 @@ Overridable version of [method PhysicsServer2D.body_set_mode]. - + @@ -635,7 +635,7 @@ Overridable version of [method PhysicsServer2D.body_set_omit_force_integration]. - + @@ -644,7 +644,7 @@ Overridable version of [method PhysicsServer2D.body_set_param]. - + @@ -653,7 +653,7 @@ Overridable version of [PhysicsServer2D]'s internal [code]body_set_pickable[/code] method. Corresponds to [member CollisionObject2D.input_pickable]. - + @@ -662,7 +662,7 @@ Overridable version of [method PhysicsServer2D.body_set_shape]. - + @@ -672,7 +672,7 @@ Overridable version of [method PhysicsServer2D.body_set_shape_as_one_way_collision]. - + @@ -681,7 +681,7 @@ Overridable version of [method PhysicsServer2D.body_set_shape_disabled]. - + @@ -690,7 +690,7 @@ Overridable version of [method PhysicsServer2D.body_set_shape_transform]. - + @@ -698,7 +698,7 @@ Overridable version of [method PhysicsServer2D.body_set_space]. - + @@ -707,7 +707,7 @@ Overridable version of [method PhysicsServer2D.body_set_state]. - + @@ -716,7 +716,7 @@ Overridable version of [method PhysicsServer2D.body_set_state_sync_callback]. - + @@ -729,31 +729,31 @@ Overridable version of [method PhysicsServer2D.body_test_motion]. Unlike the exposed implementation, this method does not receive all of the arguments inside a [PhysicsTestMotionParameters2D]. - + Overridable version of [method PhysicsServer2D.capsule_shape_create]. - + Overridable version of [method PhysicsServer2D.circle_shape_create]. - + Overridable version of [method PhysicsServer2D.concave_polygon_shape_create]. - + Overridable version of [method PhysicsServer2D.convex_polygon_shape_create]. - + @@ -761,7 +761,7 @@ Overridable version of [method PhysicsServer2D.damped_spring_joint_get_param]. - + @@ -770,69 +770,69 @@ Overridable version of [method PhysicsServer2D.damped_spring_joint_set_param]. - + Called to indicate that the physics server has stopped synchronizing. It is in the loop's iteration/physics phase, and can access physics objects even if running on a separate thread. See also [method _sync]. Overridable version of [PhysicsServer2D]'s internal [code]end_sync[/code] method. - + Called when the main loop finalizes to shut down the physics server. See also [method MainLoop._finalize] and [method _init]. Overridable version of [PhysicsServer2D]'s internal [code]finish[/code] method. - + Called every physics step before [method _step] to process all remaining queries. Overridable version of [PhysicsServer2D]'s internal [code]flush_queries[/code] method. - + Overridable version of [method PhysicsServer2D.free_rid]. - + Overridable version of [method PhysicsServer2D.get_process_info]. - + Called when the main loop is initialized and creates a new instance of this physics server. See also [method MainLoop._initialize] and [method _finish]. Overridable version of [PhysicsServer2D]'s internal [code]init[/code] method. - + Overridable method that should return [code]true[/code] when the physics server is processing queries. See also [method _flush_queries]. Overridable version of [PhysicsServer2D]'s internal [code]is_flushing_queries[/code] method. - + Overridable version of [method PhysicsServer2D.joint_clear]. - + Overridable version of [method PhysicsServer2D.joint_create]. - + @@ -840,7 +840,7 @@ Overridable version of [method PhysicsServer2D.joint_disable_collisions_between_bodies]. - + @@ -848,21 +848,21 @@ Overridable version of [method PhysicsServer2D.joint_get_param]. - + Overridable version of [method PhysicsServer2D.joint_get_type]. - + Overridable version of [method PhysicsServer2D.joint_is_disabled_collisions_between_bodies]. - + @@ -873,7 +873,7 @@ Overridable version of [method PhysicsServer2D.joint_make_damped_spring]. - + @@ -885,7 +885,7 @@ Overridable version of [method PhysicsServer2D.joint_make_groove]. - + @@ -895,7 +895,7 @@ Overridable version of [method PhysicsServer2D.joint_make_pin]. - + @@ -904,7 +904,7 @@ Overridable version of [method PhysicsServer2D.joint_set_param]. - + @@ -912,7 +912,7 @@ Overridable version of [method PhysicsServer2D.pin_joint_get_flag]. - + @@ -920,7 +920,7 @@ Overridable version of [method PhysicsServer2D.pin_joint_get_param]. - + @@ -929,7 +929,7 @@ Overridable version of [method PhysicsServer2D.pin_joint_set_flag]. - + @@ -938,32 +938,32 @@ Overridable version of [method PhysicsServer2D.pin_joint_set_param]. - + Overridable version of [method PhysicsServer2D.rectangle_shape_create]. - + Overridable version of [method PhysicsServer2D.segment_shape_create]. - + Overridable version of [method PhysicsServer2D.separation_ray_shape_create]. - + Overridable version of [method PhysicsServer2D.set_active]. - + @@ -979,7 +979,7 @@ Overridable version of [PhysicsServer2D]'s internal [code]shape_collide[/code] method. Corresponds to [method PhysicsDirectSpaceState2D.collide_shape]. - + @@ -987,21 +987,21 @@ Overridable version of [PhysicsServer2D]'s internal [code]shape_get_custom_solver_bias[/code] method. Corresponds to [member Shape2D.custom_solver_bias]. - + Overridable version of [method PhysicsServer2D.shape_get_data]. - + Overridable version of [method PhysicsServer2D.shape_get_type]. - + @@ -1010,7 +1010,7 @@ Overridable version of [PhysicsServer2D]'s internal [code]shape_get_custom_solver_bias[/code] method. Corresponds to [member Shape2D.custom_solver_bias]. - + @@ -1018,13 +1018,13 @@ Overridable version of [method PhysicsServer2D.shape_set_data]. - + Overridable version of [method PhysicsServer2D.space_create]. - + @@ -1032,7 +1032,7 @@ Overridable version of [PhysicsServer2D]'s internal [code]space_get_contact_count[/code] method. - + @@ -1040,14 +1040,14 @@ Overridable version of [PhysicsServer2D]'s internal [code]space_get_contacts[/code] method. - + Overridable version of [method PhysicsServer2D.space_get_direct_state]. - + @@ -1055,14 +1055,14 @@ Overridable version of [method PhysicsServer2D.space_get_param]. - + Overridable version of [method PhysicsServer2D.space_is_active]. - + @@ -1070,7 +1070,7 @@ Overridable version of [method PhysicsServer2D.space_set_active]. - + @@ -1079,7 +1079,7 @@ Overridable version of [PhysicsServer2D]'s internal [code]space_set_debug_contacts[/code] method. - + @@ -1088,7 +1088,7 @@ Overridable version of [method PhysicsServer2D.space_set_param]. - + @@ -1096,14 +1096,14 @@ Overridable version of [PhysicsServer2D]'s internal [code skip-lint]step[/code] method. - + Called to indicate that the physics server is synchronizing and cannot access physics states if running on a separate thread. See also [method _end_sync]. Overridable version of [PhysicsServer2D]'s internal [code]sync[/code] method. - + Overridable version of [method PhysicsServer2D.world_boundary_shape_create]. diff --git a/doc/classes/PhysicsServer3DExtension.xml b/doc/classes/PhysicsServer3DExtension.xml index fdc110d0be9..3e283fb26c7 100644 --- a/doc/classes/PhysicsServer3DExtension.xml +++ b/doc/classes/PhysicsServer3DExtension.xml @@ -10,7 +10,7 @@ - + @@ -19,124 +19,124 @@ - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -144,14 +144,14 @@ - + - + @@ -159,7 +159,7 @@ - + @@ -167,7 +167,7 @@ - + @@ -175,35 +175,35 @@ - + - + - + - + - + @@ -211,14 +211,14 @@ - + - + @@ -227,21 +227,21 @@ - + - + - + @@ -249,7 +249,7 @@ - + @@ -257,190 +257,190 @@ - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -448,63 +448,63 @@ - + - + - + - + - + - + - + - + - + @@ -512,28 +512,28 @@ - + - + - + - + @@ -541,14 +541,14 @@ - + - + @@ -556,7 +556,7 @@ - + @@ -564,7 +564,7 @@ - + @@ -572,14 +572,14 @@ - + - + @@ -587,21 +587,21 @@ - + - + - + @@ -614,29 +614,29 @@ - + - + - + - + - + @@ -644,43 +644,43 @@ - + - + - + - + - + - + - + - + @@ -688,7 +688,7 @@ - + @@ -696,7 +696,7 @@ - + @@ -705,7 +705,7 @@ - + @@ -714,32 +714,32 @@ - + - + - + - + - + @@ -747,7 +747,7 @@ - + @@ -755,53 +755,53 @@ - + - + - + - + - + - + - + - + - + @@ -811,7 +811,7 @@ - + @@ -821,7 +821,7 @@ - + @@ -831,7 +831,7 @@ - + @@ -843,7 +843,7 @@ - + @@ -853,7 +853,7 @@ - + @@ -863,47 +863,47 @@ - + - + - + - + - + - + - + @@ -911,70 +911,70 @@ - + - + - + - + - + - + - + - + - + - + - + @@ -982,28 +982,28 @@ - + - + - + - + @@ -1011,7 +1011,7 @@ - + @@ -1019,105 +1019,105 @@ - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -1125,7 +1125,7 @@ - + @@ -1133,97 +1133,97 @@ - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -1231,78 +1231,78 @@ - + - + - + - + - + - + - + - + - + - + - + - + @@ -1310,23 +1310,23 @@ - + - + - + - + diff --git a/doc/classes/PhysicsServer3DRenderingServerHandler.xml b/doc/classes/PhysicsServer3DRenderingServerHandler.xml index c04dbf2bd70..e266a1c8f34 100644 --- a/doc/classes/PhysicsServer3DRenderingServerHandler.xml +++ b/doc/classes/PhysicsServer3DRenderingServerHandler.xml @@ -8,14 +8,14 @@ - + Called by the [PhysicsServer3D] to set the bounding box for the [SoftBody3D]. - + @@ -24,7 +24,7 @@ [b]Note:[/b] The [param normal] parameter used to be of type [code]const void*[/code] prior to Godot 4.2. - + diff --git a/doc/classes/ScriptExtension.xml b/doc/classes/ScriptExtension.xml index 17742534b18..a9a1d7046a6 100644 --- a/doc/classes/ScriptExtension.xml +++ b/doc/classes/ScriptExtension.xml @@ -7,17 +7,17 @@ - + - + - + @@ -27,60 +27,60 @@ - + - + - + - + - + - + - + - + - + - + - + @@ -92,68 +92,68 @@ Return the expected argument count for the given [param method], or [code]null[/code] if it can't be determined (which will then fall back to the default behavior). - + - + - + - + - + - + - + - + - + - + - + - + @@ -165,17 +165,17 @@ Returns [code]true[/code] if the script is an abstract script. Abstract scripts cannot be instantiated directly, instead other scripts should inherit them. Abstract scripts will be either unselectable or hidden in the Create New Node dialog (unselectable if there are non-abstract classes inheriting it, otherwise hidden). - + - + - + @@ -186,25 +186,25 @@ - + - + - + - + diff --git a/doc/classes/ScriptLanguageExtension.xml b/doc/classes/ScriptLanguageExtension.xml index 40e56478c51..8621424400b 100644 --- a/doc/classes/ScriptLanguageExtension.xml +++ b/doc/classes/ScriptLanguageExtension.xml @@ -7,21 +7,21 @@ - + - + - + @@ -29,17 +29,17 @@ - + - + - + @@ -47,52 +47,52 @@ - + - + - + - + - + - + - + - + - + @@ -100,7 +100,7 @@ - + @@ -108,14 +108,14 @@ - + Returns the source associated with a given debug stack position. - + @@ -124,7 +124,7 @@ - + @@ -132,23 +132,23 @@ Returns the line where the function is defined in the code, or [code]-1[/code] if the function is not present. - + - + - + - + @@ -158,85 +158,85 @@ - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -245,7 +245,7 @@ - + @@ -253,7 +253,7 @@ - + @@ -261,7 +261,7 @@ - + @@ -269,7 +269,7 @@ - + @@ -279,82 +279,82 @@ - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -365,7 +365,7 @@ - + diff --git a/doc/classes/StreamPeerExtension.xml b/doc/classes/StreamPeerExtension.xml index 84a5f1716a0..05c967ee0b2 100644 --- a/doc/classes/StreamPeerExtension.xml +++ b/doc/classes/StreamPeerExtension.xml @@ -7,7 +7,7 @@ - + diff --git a/doc/classes/StyleBox.xml b/doc/classes/StyleBox.xml index 53db6c258ce..07a31336494 100644 --- a/doc/classes/StyleBox.xml +++ b/doc/classes/StyleBox.xml @@ -10,7 +10,7 @@ - + diff --git a/doc/classes/TextServerExtension.xml b/doc/classes/TextServerExtension.xml index 65bfbe35541..00326119efb 100644 --- a/doc/classes/TextServerExtension.xml +++ b/doc/classes/TextServerExtension.xml @@ -12,14 +12,12 @@ - [b]Optional.[/b] This method is called before text server is unregistered. - + - [b]Required.[/b] Creates a new, empty font cache entry resource. @@ -31,12 +29,11 @@ Creates a new variation existing font which is reusing the same glyph cache and font data. - + - [b]Required.[/b] Creates a new buffer for complex text layout, with the given [param direction] and [param orientation]. @@ -48,16 +45,14 @@ - [b]Optional.[/b] Draws box displaying character hexadecimal code. - + - [b]Required.[/b] Removes all rendered glyph information from the cache entry. @@ -66,35 +61,31 @@ - [b]Optional.[/b] Removes all kerning overrides. - + - [b]Required.[/b] Removes all font sizes from the cache entry. - [b]Optional.[/b] Frees all automatically loaded system fonts. - + - [b]Required.[/b] Removes all textures from font cache entry. - + @@ -104,11 +95,10 @@ - [b]Required.[/b] Draws single glyph into a canvas item at the position, using [param font_rid] at the size [param size]. If [param oversampling] is greater than zero, it is used as font oversampling factor, otherwise viewport oversampling settings are used. - + @@ -119,7 +109,6 @@ - [b]Required.[/b] Draws single glyph outline of size [param outline_size] into a canvas item at the position, using [param font_rid] at the size [param size]. If [param oversampling] is greater than zero, it is used as font oversampling factor, otherwise viewport oversampling settings are used. @@ -127,16 +116,14 @@ - [b]Optional.[/b] Returns font anti-aliasing mode. - + - [b]Required.[/b] Returns the font ascent (number of pixels above the baseline). @@ -144,26 +131,23 @@ - [b]Optional.[/b] Returns extra baseline offset (as a fraction of font height). - + - [b]Required.[/b] Returns character code associated with [param glyph_index], or [code]0[/code] if [param glyph_index] is invalid. - + - [b]Required.[/b] Returns the font descent (number of pixels below the baseline). @@ -171,7 +155,6 @@ - [b]Optional.[/b] Returns whether the font's embedded bitmap loading is disabled. @@ -179,7 +162,6 @@ - [b]Optional.[/b] Returns font embolden strength. @@ -187,7 +169,6 @@ - [b]Optional.[/b] Returns number of faces in the TrueType / OpenType collection. @@ -195,23 +176,20 @@ - [b]Optional.[/b] Returns an active face index in the TrueType / OpenType collection. - + - [b]Required.[/b] Returns bitmap font fixed size. - + - [b]Required.[/b] Returns bitmap font scaling mode. @@ -219,24 +197,21 @@ - [b]Optional.[/b] Returns [code]true[/code] if font texture mipmap generation is enabled. - [b]Optional.[/b] Returns the font oversampling factor, shared by all fonts in the TextServer. - + - [b]Required.[/b] Returns glyph advance (offset of the next glyph). @@ -246,87 +221,78 @@ - [b]Optional.[/b] Returns outline contours of the glyph. - + - [b]Required.[/b] Returns the glyph index of a [param char], optionally modified by the [param variation_selector]. - + - [b]Required.[/b] Returns list of rendered glyphs in the cache entry. - + - [b]Required.[/b] Returns glyph offset from the baseline. - + - [b]Required.[/b] Returns size of the glyph. - + - [b]Required.[/b] Returns index of the cache texture containing the glyph. - + - [b]Required.[/b] Returns resource ID of the cache texture containing the glyph. - + - [b]Required.[/b] Returns size of the cache texture containing the glyph. - + - [b]Required.[/b] Returns rectangle in the cache texture containing the glyph. @@ -334,7 +300,6 @@ - [b]Optional.[/b] Returns the font hinting mode. Used by dynamic fonts only. @@ -342,7 +307,6 @@ - [b]Optional.[/b] Returns glyph position rounding behavior. If set to [code]true[/code], when aligning glyphs to the pixel boundaries rounding remainders are accumulated to ensure more uniform glyph distribution. This setting has no effect if subpixel positioning is enabled. @@ -352,7 +316,6 @@ - [b]Optional.[/b] Returns kerning for the pair of glyphs. @@ -361,7 +324,6 @@ - [b]Optional.[/b] Returns list of the kerning overrides. @@ -370,7 +332,6 @@ - [b]Optional.[/b] Returns [code]true[/code] if support override is enabled for the [param language]. @@ -378,7 +339,6 @@ - [b]Optional.[/b] Returns list of language support overrides. @@ -386,7 +346,6 @@ - [b]Optional.[/b] Returns the width of the range around the shape between the minimum and maximum representable signed distance. @@ -394,7 +353,6 @@ - [b]Optional.[/b] Returns source font size used to generate MSDF textures. @@ -402,7 +360,6 @@ - [b]Optional.[/b] Returns font family name. @@ -410,7 +367,6 @@ - [b]Optional.[/b] Returns font OpenType feature set override. @@ -418,7 +374,6 @@ - [b]Optional.[/b] Returns [Dictionary] with OpenType font name strings (localized font names, version, description, license information, sample text, etc.). @@ -426,16 +381,14 @@ - [b]Optional.[/b] Returns font oversampling factor, if set to [code]0.0[/code] global oversampling factor is used instead. Used by dynamic fonts only. - + - [b]Required.[/b] Returns scaling factor of the color bitmap font. @@ -444,7 +397,6 @@ - [b]Optional.[/b] Returns [code]true[/code] if support override is enabled for the [param script]. @@ -452,7 +404,6 @@ - [b]Optional.[/b] Returns list of script support overrides. @@ -460,15 +411,13 @@ - [b]Optional.[/b] Returns font cache information, each entry contains the following fields: [code]Vector2i size_px[/code] - font size in pixels, [code]float viewport_oversampling[/code] - viewport oversampling factor, [code]int glyphs[/code] - number of rendered glyphs, [code]int textures[/code] - number of used textures, [code]int textures_size[/code] - size of texture data in bytes. - + - [b]Required.[/b] Returns list of the font sizes in the cache. Each size is [Vector2i] with font size and outline size. @@ -477,7 +426,6 @@ - [b]Optional.[/b] Returns the spacing for [param spacing] in pixels (not relative to the font size). @@ -485,7 +433,6 @@ - [b]Optional.[/b] Returns font stretch amount, compared to a normal width. A percentage value between [code]50%[/code] and [code]200%[/code]. @@ -493,7 +440,6 @@ - [b]Optional.[/b] Returns font style flags. @@ -501,7 +447,6 @@ - [b]Optional.[/b] Returns font style name. @@ -509,42 +454,37 @@ - [b]Optional.[/b] Returns font subpixel glyph positioning mode. - + - [b]Required.[/b] Returns a string containing all the characters available in the font. - + - [b]Required.[/b] Returns an array containing all glyph indices in the font. - + - [b]Required.[/b] Returns number of textures used by font cache entry. - + - [b]Required.[/b] Returns font cache texture image data. @@ -554,7 +494,6 @@ - [b]Optional.[/b] Returns array containing glyph packing data. @@ -562,25 +501,22 @@ - [b]Optional.[/b] Returns 2D transform applied to the font outlines. - + - [b]Required.[/b] Returns pixel offset of the underline below the baseline. - + - [b]Required.[/b] Returns thickness of the underline in pixels. @@ -588,7 +524,6 @@ - [b]Optional.[/b] Returns variation coordinates for the specified font cache entry. @@ -596,16 +531,14 @@ - [b]Optional.[/b] Returns weight (boldness) of the font. A value in the [code]100...999[/code] range, normal font weight is [code]400[/code], bold font weight is [code]700[/code]. - + - [b]Required.[/b] Returns [code]true[/code] if a Unicode [param char] is available in the font. @@ -613,7 +546,6 @@ - [b]Optional.[/b] Returns [code]true[/code] if system fonts can be automatically used as fallbacks. @@ -621,7 +553,6 @@ - [b]Optional.[/b] Returns [code]true[/code] if auto-hinting is supported and preferred over font built-in hinting. @@ -630,7 +561,6 @@ - [b]Optional.[/b] Returns [code]true[/code], if font supports given language ([url=https://en.wikipedia.org/wiki/ISO_639-1]ISO 639[/url] code). @@ -638,7 +568,6 @@ - [b]Optional.[/b] Returns [code]true[/code], if color modulation is applied when drawing colored glyphs. @@ -646,7 +575,6 @@ - [b]Optional.[/b] Returns [code]true[/code] if glyphs of all sizes are rendered using single multichannel signed distance field generated from the dynamic font vector data. @@ -655,17 +583,15 @@ - [b]Optional.[/b] Returns [code]true[/code], if font supports given script (ISO 15924 code). - + - [b]Required.[/b] Removes specified rendered glyph information from the cache entry. @@ -675,7 +601,6 @@ - [b]Optional.[/b] Removes kerning override for the pair of glyphs. @@ -684,7 +609,6 @@ - [b]Optional.[/b] Remove language support override. @@ -693,26 +617,23 @@ - [b]Optional.[/b] Removes script support override. - + - [b]Required.[/b] Removes specified font size from the cache entry. - + - [b]Required.[/b] Removes specified texture from the cache entry. @@ -722,7 +643,6 @@ - [b]Optional.[/b] Renders specified glyph to the font cache texture. @@ -733,7 +653,6 @@ - [b]Optional.[/b] Renders the range of characters to the font cache texture. @@ -742,7 +661,6 @@ - [b]Optional.[/b] If set to [code]true[/code], system fonts can be automatically used as fallbacks. @@ -751,17 +669,15 @@ - [b]Optional.[/b] Sets font anti-aliasing mode. - + - [b]Required.[/b] Sets the font ascent (number of pixels above the baseline). @@ -770,7 +686,6 @@ - [b]Optional.[/b] Sets extra baseline offset (as a fraction of font height). @@ -779,7 +694,6 @@ - [b]Optional.[/b] Sets font source data, e.g contents of the dynamic font source file. @@ -789,17 +703,15 @@ - [b]Optional.[/b] Sets pointer to the font source data, e.g contents of the dynamic font source file. - + - [b]Required.[/b] Sets the font descent (number of pixels below the baseline). @@ -808,7 +720,6 @@ - [b]Optional.[/b] If set to [code]true[/code], embedded font bitmap loading is disabled. @@ -825,25 +736,22 @@ - [b]Optional.[/b] Sets an active face index in the TrueType / OpenType collection. - + - [b]Required.[/b] Sets bitmap font fixed size. If set to value greater than zero, same cache entry will be used for all font sizes. - + - [b]Required.[/b] Sets bitmap font scaling mode. This property is used only if [code]fixed_size[/code] is greater than zero. @@ -852,7 +760,6 @@ - [b]Optional.[/b] If set to [code]true[/code] auto-hinting is preferred over font built-in hinting. @@ -861,7 +768,6 @@ - [b]Optional.[/b] If set to [code]true[/code] font texture mipmap generation is enabled. @@ -869,62 +775,56 @@ - [b]Optional.[/b] Sets oversampling factor, shared by all font in the TextServer. - + - [b]Required.[/b] Sets glyph advance (offset of the next glyph). - + - [b]Required.[/b] Sets glyph offset from the baseline. - + - [b]Required.[/b] Sets size of the glyph. - + - [b]Required.[/b] Sets index of the cache texture containing the glyph. - + - [b]Required.[/b] Sets rectangle in the cache texture containing the glyph. @@ -933,7 +833,6 @@ - [b]Optional.[/b] Sets font hinting mode. Used by dynamic fonts only. @@ -942,7 +841,6 @@ - [b]Optional.[/b] Sets glyph position rounding behavior. If set to [code]true[/code], when aligning glyphs to the pixel boundaries rounding remainders are accumulated to ensure more uniform glyph distribution. This setting has no effect if subpixel positioning is enabled. @@ -953,7 +851,6 @@ - [b]Optional.[/b] Sets kerning for the pair of glyphs. @@ -963,7 +860,6 @@ - [b]Optional.[/b] Adds override for [method _font_is_language_supported]. @@ -972,7 +868,6 @@ - [b]Optional.[/b] If set to [code]true[/code], color modulation is applied when drawing colored glyphs, otherwise it's applied to the monochrome glyphs only. @@ -981,7 +876,6 @@ - [b]Optional.[/b] Sets the width of the range around the shape between the minimum and maximum representable signed distance. @@ -990,7 +884,6 @@ - [b]Optional.[/b] Sets source font size used to generate MSDF textures. @@ -999,7 +892,6 @@ - [b]Optional.[/b] If set to [code]true[/code], glyphs of all sizes are rendered using single multichannel signed distance field generated from the dynamic font vector data. MSDF rendering allows displaying the font at any scaling factor without blurriness, and without incurring a CPU cost when the font size changes (since the font no longer needs to be rasterized on the CPU). As a downside, font hinting is not available with MSDF. The lack of font hinting may result in less crisp and less readable fonts at small sizes. @@ -1008,7 +900,6 @@ - [b]Optional.[/b] Sets the font family name. @@ -1017,7 +908,6 @@ - [b]Optional.[/b] Sets font OpenType feature set override. @@ -1026,17 +916,15 @@ - [b]Optional.[/b] Sets font oversampling factor, if set to [code]0.0[/code] global oversampling factor is used instead. Used by dynamic fonts only. - + - [b]Required.[/b] Sets scaling factor of the color bitmap font. @@ -1046,7 +934,6 @@ - [b]Optional.[/b] Adds override for [method _font_is_script_supported]. @@ -1056,7 +943,6 @@ - [b]Optional.[/b] Sets the spacing for [param spacing] to [param value] in pixels (not relative to the font size). @@ -1065,7 +951,6 @@ - [b]Optional.[/b] Sets font stretch amount, compared to a normal width. A percentage value between [code]50%[/code] and [code]200%[/code]. @@ -1074,7 +959,6 @@ - [b]Optional.[/b] Sets the font style flags. @@ -1083,7 +967,6 @@ - [b]Optional.[/b] Sets the font style name. @@ -1092,18 +975,16 @@ - [b]Optional.[/b] Sets font subpixel glyph positioning mode. - + - [b]Required.[/b] Sets font cache texture image data. @@ -1114,7 +995,6 @@ - [b]Optional.[/b] Sets array containing glyph packing data. @@ -1123,27 +1003,24 @@ - [b]Optional.[/b] Sets 2D transform, applied to the font outlines, can be used for slanting, flipping, and rotating glyphs. - + - [b]Required.[/b] Sets pixel offset of the underline below the baseline. - + - [b]Required.[/b] Sets thickness of the underline in pixels. @@ -1152,7 +1029,6 @@ - [b]Optional.[/b] Sets variation coordinates for the specified font cache entry. @@ -1161,7 +1037,6 @@ - [b]Optional.[/b] Sets weight (boldness) of the font. A value in the [code]100...999[/code] range, normal font weight is [code]400[/code], bold font weight is [code]700[/code]. @@ -1169,7 +1044,6 @@ - [b]Optional.[/b] Returns the dictionary of the supported OpenType features. @@ -1177,7 +1051,6 @@ - [b]Optional.[/b] Returns the dictionary of the supported OpenType variation coordinates. @@ -1186,22 +1059,19 @@ - [b]Optional.[/b] Converts a number from the Western Arabic (0..9) to the numeral systems used in [param language]. - + - [b]Required.[/b] Frees an object created by this [TextServer]. - + - [b]Required.[/b] Returns text server features, see [enum TextServer.Feature]. @@ -1210,51 +1080,44 @@ - [b]Optional.[/b] Returns size of the replacement character (box with character hexadecimal code that is drawn in place of invalid characters). - + - [b]Required.[/b] Returns the name of the server interface. - [b]Optional.[/b] Returns default TextServer database (e.g. ICU break iterators and dictionaries). - [b]Optional.[/b] Returns default TextServer database (e.g. ICU break iterators and dictionaries) filename. - [b]Optional.[/b] Returns TextServer database (e.g. ICU break iterators and dictionaries) description. - + - [b]Required.[/b] Returns [code]true[/code] if [param rid] is valid resource owned by this text server. - + - [b]Required.[/b] Returns [code]true[/code] if the server supports a feature. @@ -1263,7 +1126,6 @@ - [b]Optional.[/b] Returns index of the first string in [param dict] which is visually confusable with the [param string], or [code]-1[/code] if none is found. @@ -1271,7 +1133,6 @@ - [b]Required.[/b] Returns [code]true[/code] if locale is right-to-left. @@ -1279,7 +1140,6 @@ - [b]Optional.[/b] Returns [code]true[/code] if [param string] is a valid identifier. @@ -1293,7 +1153,6 @@ - [b]Optional.[/b] Loads optional TextServer database (e.g. ICU break iterators and dictionaries). @@ -1301,7 +1160,6 @@ - [b]Optional.[/b] Converts readable feature, variation, script, or language name to OpenType tag. @@ -1310,7 +1168,6 @@ - [b]Optional.[/b] Converts [param number] from the numeral systems used in [param language] to Western Arabic (0..9). @@ -1320,7 +1177,6 @@ - [b]Optional.[/b] Default implementation of the BiDi algorithm override function. @@ -1328,7 +1184,6 @@ - [b]Optional.[/b] Returns percent sign used in the [param language]. @@ -1336,7 +1191,6 @@ - [b]Required.[/b] Increases the reference count of the specified oversampling level. This method is called by [Viewport], and should not be used directly. @@ -1344,7 +1198,6 @@ - [b]Optional.[/b] Saves optional TextServer database (e.g. ICU break iterators and dictionaries) to the file. @@ -1352,7 +1205,6 @@ - [b]Required.[/b] Returns the number of uniform text runs in the buffer. @@ -1361,7 +1213,6 @@ - [b]Required.[/b] Returns the direction of the [param index] text run (in visual order). @@ -1370,7 +1221,6 @@ - [b]Required.[/b] Returns the font RID of the [param index] text run (in visual order). @@ -1379,7 +1229,6 @@ - [b]Required.[/b] Returns the font size of the [param index] text run (in visual order). @@ -1388,7 +1237,6 @@ - [b]Required.[/b] Returns the language of the [param index] text run (in visual order). @@ -1397,7 +1245,6 @@ - [b]Required.[/b] Returns the embedded object of the [param index] text run (in visual order). @@ -1406,7 +1253,6 @@ - [b]Required.[/b] Returns the source text range of the [param index] text run (in visual order). @@ -1415,63 +1261,56 @@ - [b]Required.[/b] Returns the source text of the [param index] text run (in visual order). - + - [b]Required.[/b] Returns number of text spans added using [method _shaped_text_add_string] or [method _shaped_text_add_object]. - + - [b]Required.[/b] Returns text embedded object key. - + - [b]Required.[/b] Returns text span metadata. - + - [b]Required.[/b] Returns the text span embedded object key. - + - [b]Required.[/b] Returns the text span source text. - + - [b]Required.[/b] Returns the text buffer source text, including object replacement characters. - + @@ -1479,11 +1318,10 @@ - [b]Required.[/b] Changes text span font, font size, and OpenType features, without changing the text. - + @@ -1492,11 +1330,10 @@ - [b]Required.[/b] Adds inline object to the text buffer, [param key] must be unique. In the text, object is represented as [param length] object replacement characters. - + @@ -1506,15 +1343,13 @@ - [b]Required.[/b] Adds text span and font to draw it to the text buffer. - + - [b]Required.[/b] Clears text buffer (removes text and inline objects). @@ -1523,7 +1358,6 @@ - [b]Optional.[/b] Returns composite character position closest to the [param pos]. @@ -1537,7 +1371,6 @@ - [b]Optional.[/b] Draw shaped text into a canvas item at a given position, with [param color]. [param pos] specifies the leftmost point of the baseline (for horizontal layout) or topmost point of the baseline (for vertical layout). If [param oversampling] is greater than zero, it is used as font oversampling factor, otherwise viewport oversampling settings are used. @@ -1552,7 +1385,6 @@ - [b]Optional.[/b] Draw the outline of the shaped text into a canvas item at a given position, with [param color]. [param pos] specifies the leftmost point of the baseline (for horizontal layout) or topmost point of the baseline (for vertical layout). If [param oversampling] is greater than zero, it is used as font oversampling factor, otherwise viewport oversampling settings are used. @@ -1562,15 +1394,13 @@ - [b]Optional.[/b] Adjusts text width to fit to specified width, returns new text width. - + - [b]Required.[/b] Returns the text ascent (number of pixels above the baseline for horizontal layout or to the left of baseline for vertical). @@ -1580,7 +1410,6 @@ - [b]Optional.[/b] Returns shapes of the carets corresponding to the character offset [param position] in the text. Returned caret shape is 1 pixel wide rectangle. @@ -1588,7 +1417,6 @@ - [b]Optional.[/b] Returns array of the composite character boundaries. @@ -1596,7 +1424,6 @@ - [b]Optional.[/b] Returns ellipsis character used for text clipping. @@ -1604,15 +1431,13 @@ - [b]Optional.[/b] Returns custom punctuation character list, used for word breaking. If set to empty string, server defaults are used. - + - [b]Required.[/b] Returns the text descent (number of pixels below the baseline for horizontal layout or to the right of baseline for vertical). @@ -1620,7 +1445,6 @@ - [b]Optional.[/b] Returns direction of the text. @@ -1630,47 +1454,41 @@ - [b]Optional.[/b] Returns dominant direction of in the range of text. - + - [b]Required.[/b] Returns number of glyphs in the ellipsis. - + - [b]Required.[/b] Returns array of the glyphs in the ellipsis. - + - [b]Required.[/b] Returns position of the ellipsis. - + - [b]Required.[/b] Returns number of glyphs in the buffer. - + - [b]Required.[/b] Returns an array of glyphs in the visual order. @@ -1679,7 +1497,6 @@ - [b]Optional.[/b] Returns composite character's bounds as offsets from the start of the line. @@ -1687,7 +1504,6 @@ - [b]Optional.[/b] Returns direction of the text, inferred by the BiDi algorithm. @@ -1698,7 +1514,6 @@ - [b]Optional.[/b] Breaks text to the lines and returns character ranges for each line. @@ -1710,42 +1525,37 @@ - [b]Optional.[/b] Breaks text to the lines and columns. Returns character ranges for each segment. - + - [b]Required.[/b] Returns the glyph index of the inline object. - + - [b]Required.[/b] Returns the character range of the inline object. - + - [b]Required.[/b] Returns bounding rectangle of the inline object. - + - [b]Required.[/b] Returns array of inline objects. @@ -1753,15 +1563,13 @@ - [b]Optional.[/b] Returns text orientation. - + - [b]Required.[/b] Returns the parent buffer from which the substring originates. @@ -1769,7 +1577,6 @@ - [b]Optional.[/b] Returns [code]true[/code] if text buffer is configured to display control characters. @@ -1777,15 +1584,13 @@ - [b]Optional.[/b] Returns [code]true[/code] if text buffer is configured to display hexadecimal codes in place of invalid characters. - + - [b]Required.[/b] Returns substring buffer character range in the parent buffer. @@ -1795,15 +1600,13 @@ - [b]Optional.[/b] Returns selection rectangles for the specified character range. - + - [b]Required.[/b] Returns size of the text. @@ -1812,39 +1615,34 @@ - [b]Optional.[/b] Returns extra spacing added between glyphs or lines in pixels. - + - [b]Required.[/b] Returns the position of the overrun trim. - + - [b]Required.[/b] Returns pixel offset of the underline below the baseline. - + - [b]Required.[/b] Returns thickness of the underline. - + - [b]Required.[/b] Returns width (for horizontal layout) or height (for vertical) of the text. @@ -1854,7 +1652,6 @@ - [b]Optional.[/b] Breaks text into words and returns array of character ranges. Use [param grapheme_flags] to set what characters are used for breaking. @@ -1863,7 +1660,6 @@ - [b]Optional.[/b] Returns grapheme index at the specified pixel offset at the baseline, or [code]-1[/code] if none is found. @@ -1872,15 +1668,13 @@ - [b]Optional.[/b] Returns caret character offset at the specified pixel offset at the baseline. This function always returns a valid position. - + - [b]Required.[/b] Returns [code]true[/code] if buffer is successfully shaped. @@ -1889,7 +1683,6 @@ - [b]Optional.[/b] Returns composite character end position closest to the [param pos]. @@ -1898,7 +1691,6 @@ - [b]Optional.[/b] Returns grapheme end position closest to the [param pos]. @@ -1908,7 +1700,6 @@ - [b]Optional.[/b] Trims text if it exceeds the given width. @@ -1917,7 +1708,6 @@ - [b]Optional.[/b] Returns composite character start position closest to the [param pos]. @@ -1926,11 +1716,10 @@ - [b]Optional.[/b] Returns grapheme start position closest to the [param pos]. - + @@ -1938,7 +1727,6 @@ - [b]Required.[/b] Sets new size and alignment of embedded object. @@ -1947,7 +1735,6 @@ - [b]Optional.[/b] Overrides BiDi for the structured text. @@ -1956,7 +1743,6 @@ - [b]Optional.[/b] Sets ellipsis character used for text clipping. @@ -1965,7 +1751,6 @@ - [b]Optional.[/b] Sets custom punctuation character list, used for word breaking. If set to empty string, server defaults are used. @@ -1974,7 +1759,6 @@ - [b]Optional.[/b] Sets desired text direction. If set to [constant TextServer.DIRECTION_AUTO], direction will be detected based on the buffer contents and current locale. @@ -1983,7 +1767,6 @@ - [b]Optional.[/b] Sets desired text orientation. @@ -1992,7 +1775,6 @@ - [b]Optional.[/b] If set to [code]true[/code] text buffer will display control characters. @@ -2001,7 +1783,6 @@ - [b]Optional.[/b] If set to [code]true[/code] text buffer will display invalid characters as hexadecimal codes, otherwise nothing is displayed. @@ -2011,33 +1792,29 @@ - [b]Optional.[/b] Sets extra spacing added between glyphs or lines in pixels. - + - [b]Required.[/b] Shapes buffer if it's not shaped. Returns [code]true[/code] if the string is shaped successfully. - + - [b]Required.[/b] Returns text glyphs in the logical order. - + - [b]Required.[/b] Returns text buffer for the substring of the text in the [param shaped] text buffer (including inline objects). @@ -2046,7 +1823,6 @@ - [b]Optional.[/b] Aligns shaped text to the given tab-stops. @@ -2054,7 +1830,6 @@ - [b]Optional.[/b] Updates break points in the shaped text. This method is called by default implementation of text breaking functions. @@ -2062,7 +1837,6 @@ - [b]Optional.[/b] Updates justification points in the shaped text. This method is called by default implementation of text justification functions. @@ -2070,7 +1844,6 @@ - [b]Optional.[/b] Returns [code]true[/code] if [param string] is likely to be an attempt at confusing the reader. @@ -2079,7 +1852,6 @@ - [b]Optional.[/b] Returns array of the composite character boundaries. @@ -2089,7 +1861,6 @@ - [b]Optional.[/b] Returns an array of the word break boundaries. Elements in the returned array are the offsets of the start and end of words. Therefore the length of the array is always even. @@ -2098,7 +1869,6 @@ - [b]Optional.[/b] Returns the string converted to lowercase. @@ -2107,7 +1877,6 @@ - [b]Optional.[/b] Returns the string converted to title case. @@ -2116,7 +1885,6 @@ - [b]Optional.[/b] Returns the string converted to uppercase. @@ -2124,7 +1892,6 @@ - [b]Optional.[/b] Strips diacritics from the string. @@ -2132,7 +1899,6 @@ - [b]Optional.[/b] Converts OpenType tag to readable feature, variation, script, or language name. @@ -2140,7 +1906,6 @@ - [b]Required.[/b] Decreases the reference count of the specified oversampling level, and frees the font cache for oversampling level when the reference count reaches zero. This method is called by [Viewport], and should not be used directly. diff --git a/doc/classes/Texture2D.xml b/doc/classes/Texture2D.xml index c153a796578..d8b32f2c1b0 100644 --- a/doc/classes/Texture2D.xml +++ b/doc/classes/Texture2D.xml @@ -48,13 +48,13 @@ [b]Note:[/b] This is only used in 2D rendering, not 3D. - + Called when the [Texture2D]'s height is queried. - + Called when the [Texture2D]'s width is queried. diff --git a/doc/classes/Texture3D.xml b/doc/classes/Texture3D.xml index 4886bd60ff2..5c335aeb0c5 100644 --- a/doc/classes/Texture3D.xml +++ b/doc/classes/Texture3D.xml @@ -11,37 +11,37 @@ - + Called when the [Texture3D]'s data is queried. - + Called when the [Texture3D]'s depth is queried. - + Called when the [Texture3D]'s format is queried. - + Called when the [Texture3D]'s height is queried. - + Called when the [Texture3D]'s width is queried. - + Called when the presence of mipmaps in the [Texture3D] is queried. diff --git a/doc/classes/TextureLayered.xml b/doc/classes/TextureLayered.xml index f4a4ce51f33..d7c830dae08 100644 --- a/doc/classes/TextureLayered.xml +++ b/doc/classes/TextureLayered.xml @@ -13,44 +13,44 @@ - + Called when the [TextureLayered]'s format is queried. - + Called when the [TextureLayered]'s height is queried. - + Called when the data for a layer in the [TextureLayered] is queried. - + Called when the layers' type in the [TextureLayered] is queried. - + Called when the number of layers in the [TextureLayered] is queried. - + Called when the [TextureLayered]'s width queried. - + Called when the presence of mipmaps in the [TextureLayered] is queried. diff --git a/doc/classes/VideoStreamPlayback.xml b/doc/classes/VideoStreamPlayback.xml index 17e29ae337a..05f641e7907 100644 --- a/doc/classes/VideoStreamPlayback.xml +++ b/doc/classes/VideoStreamPlayback.xml @@ -84,7 +84,7 @@ Stops playback. May be called multiple times before [method _play], or in response to [method VideoStreamPlayer.stop]. [method _is_playing] should return [code]false[/code] once stopped. - + diff --git a/doc/tools/make_rst.py b/doc/tools/make_rst.py index 243c08ba1c8..1eaef528dc6 100755 --- a/doc/tools/make_rst.py +++ b/doc/tools/make_rst.py @@ -59,6 +59,7 @@ BASE_STRINGS = [ "value", "Getter", "This method should typically be overridden by the user to have any effect.", + "This method is required to be overridden when extending its base class.", "This method has no side effects. It doesn't modify any of the instance's member variables.", "This method accepts any number of arguments after the ones described here.", "This method is used to construct a type.", @@ -1663,6 +1664,7 @@ def make_footer() -> str: # Generate reusable abbreviation substitutions. # This way, we avoid bloating the generated rST with duplicate abbreviations. virtual_msg = translate("This method should typically be overridden by the user to have any effect.") + required_msg = translate("This method is required to be overridden when extending its base class.") const_msg = translate("This method has no side effects. It doesn't modify any of the instance's member variables.") vararg_msg = translate("This method accepts any number of arguments after the ones described here.") constructor_msg = translate("This method is used to construct a type.") @@ -1675,6 +1677,7 @@ def make_footer() -> str: return ( f".. |virtual| replace:: :abbr:`virtual ({virtual_msg})`\n" + f".. |required| replace:: :abbr:`required ({required_msg})`\n" f".. |const| replace:: :abbr:`const ({const_msg})`\n" f".. |vararg| replace:: :abbr:`vararg ({vararg_msg})`\n" f".. |constructor| replace:: :abbr:`constructor ({constructor_msg})`\n" diff --git a/editor/editor_help.cpp b/editor/editor_help.cpp index 45c0716fc9e..536e7dab064 100644 --- a/editor/editor_help.cpp +++ b/editor/editor_help.cpp @@ -148,6 +148,8 @@ static void _add_qualifiers_to_rt(const String &p_qualifiers, RichTextLabel *p_r hint = TTR("This method supports a variable number of arguments."); } else if (qualifier == "virtual") { hint = TTR("This method is called by the engine.\nIt can be overridden to customize built-in behavior."); + } else if (qualifier == "required") { + hint = TTR("This method is required to be overridden when extending its base class."); } else if (qualifier == "const") { hint = TTR("This method has no side effects.\nIt does not modify the object in any way."); } else if (qualifier == "static") { diff --git a/modules/openxr/doc_classes/OpenXRBindingModifier.xml b/modules/openxr/doc_classes/OpenXRBindingModifier.xml index 2553f8d5baf..697756ba1d4 100644 --- a/modules/openxr/doc_classes/OpenXRBindingModifier.xml +++ b/modules/openxr/doc_classes/OpenXRBindingModifier.xml @@ -9,13 +9,13 @@ - + Return the description of this class that is used for the title bar of the binding modifier editor. - + Returns the data that is sent to OpenXR when submitting the suggested interacting bindings this modifier is a part of. diff --git a/modules/webrtc/doc_classes/WebRTCDataChannelExtension.xml b/modules/webrtc/doc_classes/WebRTCDataChannelExtension.xml index b34fd68aee4..dc10428bbcb 100644 --- a/modules/webrtc/doc_classes/WebRTCDataChannelExtension.xml +++ b/modules/webrtc/doc_classes/WebRTCDataChannelExtension.xml @@ -7,42 +7,42 @@ - + - + - + - + - + - + - + - + @@ -54,32 +54,32 @@ - + - + - + - + - + - + @@ -91,13 +91,13 @@ - + - + diff --git a/modules/webrtc/doc_classes/WebRTCPeerConnectionExtension.xml b/modules/webrtc/doc_classes/WebRTCPeerConnectionExtension.xml index e90a36a76c3..570a68f750e 100644 --- a/modules/webrtc/doc_classes/WebRTCPeerConnectionExtension.xml +++ b/modules/webrtc/doc_classes/WebRTCPeerConnectionExtension.xml @@ -7,7 +7,7 @@ - + @@ -15,57 +15,57 @@ - + - + - + - + - + - + - + - + - + - +